Automate application configurations using the scripting library
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.
The scripting library provides a set of procedures to automate the most common appserver administration functions. There are three ways to use the Jython script library.
- Run scripts from the Jython script library in interactive mode...
wsadmin>AdminServerManagement.createApplicationServer("myNode", "myServer", "default")- Use a text editor to combine several scripts from the Jython script library...
###
### My Custom Jython Script - CreateServers.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/CreateServers.py- Use the Jython scripting library code in...
APP_ROOT/scriptLibraries...as sample syntax to write custom scripts.
The application management procedures in scripting library are located in...
WAS_HOME/scriptLibraries/application/V70
Each script from the directory automatically loads when you launch wsadmin. To automatically load the own Jython scripts (*.py) when wsadmin starts, create a new subdirectory and save existing automation scripts under...
WAS_HOME/scriptLibraries
Best practice: To create custom scripts using the scripting library procedures, save the modified scripts to a new subdirectory to avoid overwriting the library. Do not edit the script procedures in the scripting library
Use the AdminApplication.py scripts to perform multiple combinations of administration functions.
Use the following steps to use the scripting library to install an application on a cluster and start the application:
- Launch wsadmin.
Use this step to launch wsadmin and connect to a server, or run the tool in local mode. If we launch wsadmin, use the interactive mode examples in this topic to run scripts.
- Enter the following command from the bin directory to launch wsadmin and connect to a server:
bin>wsadmin -lang jython- Enter the following command from the bin directory to launch wsadmin in local mode and using Jython:
bin>wsadmin -conntype none -lang jython
When wsadmin launches, the system loads all scripts from the scripting library.
- Create a cluster.
Run the createClusterWithoutMember script procedure from the AdminClusterManagement script library, and specify the required arguments...
bin>wsadmin -lang jython -c "AdminClusterManagement.createClusterWithoutMember('myCluster')"We can also use interactive mode to run the script procedure...
wsadmin>AdminClusterManagement.createClusterWithoutMember("myCluster")- Create a cluster member for the new cluster.
Run the createClusterMember script procedure from the AdminClusterManagement script library, and specify the required arguments...
bin>wsadmin -lang jython -c "AdminClusterManagement.createClusterMember('myCluster', 'myNode, 'myNewMember')"We can also use interactive mode to run the script procedure...
wsadmin>AdminClusterManagement.createClusterWithoutMember("myCluster", "myNode", "myNewMember")- Install the application on the newly created cluster.
Run the installAppWithClusterOption script procedure from the AdminApplication script library, and specify the required arguments...
bin>wsadmin -lang jython -c "AdminApplication.installAppWithClusterOption('myApplication','myApplicationEar.ear','myCluster')"We can also use interactive mode to run the script procedure...
wsadmin>AdminApplication.installAppWithClusterOption("myApplication", "myApplicationEar.ear", "myCluster")- Start the application on the cluster.
Run the startApplicationOnCluster script procedure from the AdminApplication script library and specify the required arguments...
bin>wsadmin -lang jython -c "AdminApplication.startApplicationOnCluster('myApplication','myCluster')"We can also use interactive mode to run the script procedure, as the following example displays:
wsadmin>AdminApplication.startApplicationOnCluster("myApplication", "myCluster")
Results
The wsadmin script libraries return the same output as the associated wsadmin commands. For example, the script...
AdminServerManagement.listServers()
...returns a list of available servers.
The script...
AdminClusterManagement.checkIfClusterExists()
...returns a value of true if the cluster exists, or false if the cluster does not exist. If the command does not return the expected output, the script libraries return a 1 value when the script successfully runs. If the script fails, the script libraries return a -1 value and an error message with the exception. By default, the system disables failonerror option. To enable this option, specify true as the last argument for the script procedure, as the following example displays:
wsadmin>AdminApplication.startApplicationOnCluster("myApplication","myCluster","true")
What to do next
Create custom scripts to automate the environment by combining script procedures from the scripting library. Save custom scripts to a new subdirectory of...
WAS_HOME/scriptLibraries
Application installation and uninstallation scripts
Application query scripts
Application update scripts
Application export scripts
Application deployment configuration scripts
Application administration scripts
Related tasks
Use the script library to automate the application serving environment