Use the script library to automate the application serving environment
The script library provides Jython script procedures to assist in automating the environment. Use the sample scripts to manage applications, resources, servers, nodes, and clusters. We can also use the script procedures as examples to learn the Jython syntax.
The Jython script library provides a set of procedures to automate the most common application server administration functions. For example, we can use the script library to easily configure servers, applications, mail settings, resources, nodes, business-level applications, clusters, authorization groups, and more. We can run each script procedure individually, or combine several procedures to quickly develop new scripts.
The scripting library provides a set of procedures to automate the most common application server administration functions. There are three ways to use the Jython script library.
- Run scripts from the Jython script library in interactive mode with wsadmin.sh. We can launch wsadmin.sh, and run individual scripts that are included in the script library using the following syntax:
wsadmin>AdminServerManagement.createApplicationServer("myNode", "myServer", "default")
- Use a text editor to combine several scripts from the Jython script library, as the following sample displays:
# # myscript.py # AdminServerManagement.createApplicationServer("myNode", "Server1", "default") AdminServerManagement.createApplicationServer("myNode", "Server2", "default") # Use one of them as the first member of a cluster AdminClusterManagement.createClusterWithFirstMember("myCluster", "APPLICATION_SERVER", "myNode", "Server1") # Add a second member to the cluster AdminClusterManagement.createClusterMember("myCluster", "myNode", "Server3") # Install an application AdminApplication.installAppWithClusterOption("DefaultApplication", "..\installableApps\DefaultApplication.ear", "myCluster") # Start all servers and applications on the node AdminServerManagement.startAllServers("myNode")Save the custom script and run it from the command line, as the following syntax demonstrates:bin>wsadmin -language jython -f path/to/your/jython/file.py
- Use the Jython scripting library code as sample syntax to write custom scripts. Each script example in the script library demonstrates best practices for writing wsadmin scripts. The script library code is located in the app_server_root/scriptLibraries directory. Within this directory, the scripts are organized into subdirectories according to functionality. For example, the app_server_root/scriptLibraries/application/V70 subdirectory contains procedures that perform application management tasks that are applicable to Version 7.0 and later of the product. The subdirectory V70 in the script library paths does not mean the scripts in that subdirectory are Version 7.0 scripts.
Each script from the script library directory automatically loads when you launch wsadmin.sh. To automatically load our own Jython scripts (*.py) when wsadmin.sh starts, create a new subdirectory, and save existing automation scripts in the app_server_root/scriptLibraries directory. Each script library name must be unique and cannot be duplicated.
Avoid trouble: Do not edit the script procedures in the script library. To customize script library procedures, save the modified scripts to a new subdirectory to avoid overwriting the library.gotcha
To automatically load Jython scripts (*.py) that are not located in the app_server_root/scriptLibraries directory when wsadmin.sh starts, set the wsadmin.script.libraries system property to the script location. For example, if the script libraries are saved in the temp directory on a Windows operating system, the following example sets the script path in the wsadmin tool:
bin>wsadmin -lang jython -javaoption "-Dwsadmin.script.libraries=c:/myJythonScripts"
To load multiple directories, specify each directory in the system property separated by a semicolon (;):
bin>wsadmin -lang jython -javaoption "-Dwsadmin.script.libraries=c:/myJythonScripts;c:/AdminScripts;c:/configScripts"
The script library provides automation scripts for the following application server administration functions:
- Manage application servers.
We can use the AdminServerManagement scripts to configure classloaders, JVM settings, EJB containers, performance monitoring, dynamic cache, and so on.
- Manage server and system architecture.
We can use the AdminServerManagement, AdminNodeManagement, and AdminClusterManagement script libraries to manage clusters, nodes, and node groups.
- Manage applications.
We can use the AdminApplication scripts to install, uninstall, and update the applications with various options.
- Manage data access resources.
We can use the AdminJDBC and AdminJ2C script libraries to manage data sources and JDBC providers, and to create and configure Java 2 Connector (J2C) resource adapters.
- Manage messaging resources.
We can use the AdminJMS script library to configure and manage your Java Messaging Service (JMS) configurations.
- Manage mail resources.
We can use the AdminResources scripts in the script library to configure mail, URL, and resource settings.
- Manage authorization groups.
We can use the AdminAuthorizations scripts to configure authorization groups.
- Monitor performance and troubleshoot configurations. We can use the AdminUtilities scripts to configure trace, debugging, logs, and performance monitoring. See the Utility scripts topic.
- Get script library help using wsadmin
We can use the AdminLibHelp script library to list each available script library, display information for specific script libraries, and to display information for specific script procedures.
What to do next
Determine which scripts to use to automate the environment, or create custom scripts using assembly tools.
Subtopics
- Automating server administration
The scripting library provides Jython script procedures to assist in automating the environment. Use the server management scripts to configure servers, the server runtime environment, Web containers, performance monitoring, and logs. We can also use the scripts to administer the servers.
- Automating administrative architecture setup library
The scripting library provides Jython script procedures to assist in automating the environment. Use the server, node, and cluster management scripts to configure servers, nodes, node groups, and clusters in the application server environment.
- Automating application configurations
The scripting library provides Jython script procedures to assist in automating the environment. Use the application management scripts to install, uninstall, export, start, stop, and manage applications in the environment.
- Automating business-level application configurations
The scripting library provides Jython script procedures to assist in automating the environment. Use the application management scripts to install, uninstall, export, start, stop, and manage business-level applications in the environment.
- Automating data access resource configuration
The scripting library provides Jython script procedures to assist in automating the environment. Use the resource management scripts to configure and manage the Java Database Connectivity (JDBC) configurations.
- Automating messaging resource configurations
The scripting library provides Jython script procedures to assist in automating the environment. Use the resource management scripts to configure and manage the Java Messaging Service (JMS) configurations.
- Automating authorization group configurations
The scripting library provides Jython script procedures to assist in automating the environment. Use the authorization groups scripts create, configure, remove and query the authorization group configuration.
- Automating resource configurations
The scripting library provides Jython script procedures to assist in automating the environment. Use the scripts in the AdminResources script library to configure mail, URL, and resource settings.
- Displaying script library help information
The script library provides Jython script procedures to assist in automating the environment. The script library includes help commands to list each available script library, display information for specific script libraries, and to display information for specific script procedures.
- Saving changes to the script library
The script library provides Jython script procedures to assist in automating the environment. We can save changes to the master configuration repository, disable the automatic saving of configuration changes, or discard configuration changes.
- Directory conventions
References in product information to app_server_root, profile_root, and other directories imply specific default directory locations. Become familiar with the conventions in use for WebSphere Application Server.
Server settings configuration scripts Server configuration scripts Server query scripts Server administration scripts Cluster configuration scripts Cluster query scripts Cluster administration scripts Node administration scripts Node group configuration scripts Application installation and uninstallation scripts Application query scripts Application update scripts Application export scripts Application deployment configuration scripts Application administration scripts J2C query scripts J2C configuration scripts JMS configuration scripts JMS query scripts JDBC configuration scripts JDBC query scripts Resource configuration scripts Authorization group configuration scripts Business-level application configuration scripts Utility scripts