WAS v8.5 > Script the application serving environment (wsadmin) > Use the script library to automate the application serving environment using wsadmin.shAutomating server administration using wsadmin.sh
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 your servers.
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. We can launch wsadmin, 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, and further organized by version. For example, the app_server_root/scriptLibraries/application/V70 subdirectory contains procedures that perform application management tasks that are applicable to v7.0 and later of the product.
The AdminServerManagement procedures in scripting library are located in the app_server_root/scriptLibraries/servers/V70 subdirectory. Each script from the directory automatically loads when we launch wsadmin. To automatically load our own Jython scripts (*.py) when wsadmin starts, create a new subdirectory and save existing automation scripts under the app_server_root/scriptLibraries directory.
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.
We can use the AdminServerManagement.py scripts to perform multiple combinations of administration functions. This topic provides one sample combination of procedures. Use the following steps to create an application server, connect the application server to the AdminService interface, configure JVM settings, add the application server to a cluster, and propagate the changes to the node.
- Optional: Launch wsadmin.
Use this step to launch wsadmin and connect to a server, job manager, or administrative agent profile, or run the tool in local mode. If you 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 the Jython scripting language:
wsadmin -conntype none -lang jython
When wsadmin launches, the system loads all scripts from the scripting library.
- Create an application server.
Run the createApplicationServer script procedure from the AdminServerManagement script library, as the following example demonstrates:
bin>wsadmin -lang jython -c "AdminServerManagement.createApplicationServer("myNode", "myServer", "default")"
We can also use interactive mode to run the script procedure, as the following example demonstrates:
wsadmin>AdminServerManagement.createApplicationServer("myNode", "myServer", "default")
- Connect the application server of interest to the AdminService interface.
The AdminService interface is the server interface to the application server administration functions. To connect the application server to the AdminService interface, run the configureAdminService script procedure from the AdminServerManagement script library, specifying the node name, server name, and connector type arguments, as the following example demonstrates:
bin>wsadmin -lang jython -c "AdminServerManagement.configureAdminService("myNode", "myServer", "IPC", "JSR160RMI")We can also use interactive mode to run the script procedure, as the following example demonstrates:
wsadmin>AdminServerManagement.configureAdminService("myNode", "myServer", "IPC", "JSR160RMI")
- Configure the JVM.
As part of configuring an application server, you might define settings that enhance the way your operating system uses of the JVM. The JVM is an interpretive computing engine responsible for running the byte codes in a compiled Java program. The JVM translates the Java byte codes into the native instructions of the host machine. The application server, being a Java process, requires a JVM in order to run, and to support the Java applications running on it.
Run the configureJavaVirtualMachine script procedure from the AdminServerManagement script library, specifying the node name, server name, whether to run the JVM in debug mode, and any debug arguments to pass to the JVM process. We can optionally specify additional configuration attributes with an attribute list. Use the following example to configure the JVM:
bin>wsadmin -lang jython -c "AdminServerManagement.configureJavaVirtualMachine("myNode", "myServer", "true", "mydebug", [["internalClassAccessMode", "RESTRICT"], ["disableJIT", "false"], ["verboseModeJNI", "false"]])"We can also use interactive mode to run the script procedure, as the following example demonstrates:
wsadmin>AdminServerManagement.configureJavaVirtualMachine("myNode", "myServer", "true", "mydebug", [["internalClassAccessMode", "RESTRICT"], ["disableJIT", "false"], ["verboseModeJNI", "false"]])- Create a cluster, and add the application server as a cluster member.
Run the createClusterWithFirstMember script procedure from the AdminClusterManagement script library, as the following example demonstrates:
bin>wsadmin -lang jython -c "AdminClusterManagement.createClusterWithFirstMember("myCluster", "APPLICATION_SERVER", "myNode", "myServer")"wsadmin>AdminClusterManagement.createClusterWithFirstMember("myCluster", "APPLICATION_SERVER", "myNode", "myServer")
Results
The wsadmin script libraries return the same output as the associated wsadmin commands. For example, the AdminServerManagement.listServers() script returns a list of available servers. The AdminClusterManagement.checkIfClusterExists() script 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")
Create custom scripts to automate the environment by combining script procedures from the scripting library. Save custom scripts to a new subdirectory of the app_server_root/scriptLibraries directory.
Subtopics
- Server settings configuration scripts
The scripting library provides script procedures to automate the application server configurations. Use the application server scripts to configure class loaders, Java Virtual Machine (JVM) settings, EJB containers, performance monitoring, dynamic cache, and so on. We can run each script individually, or combine procedures to create custom automation scripts for the environment.- Server configuration scripts
The scripting library provides script procedures to automate the application server configurations. Use the application server scripts to create application servers, web servers, and generic servers. We can run each script individually, or combine procedures to create custom automation scripts for the environment.- Server query scripts
The scripting library provides script procedures to automate your server configurations. This topic provides usage information for scripts that query the application server configuration. We can run each script individually, or combine procedures to create custom automation scripts for the environment.- Server administration scripts
The scripting library provides script procedures to automate the application server configurations. Use the application server scripts to delete, start, and stop servers. We can run each script individually or combine procedures to create custom automation scripts for the environment.- Server settings configuration scripts
The scripting library provides script procedures to automate the application server configurations. Use the application server scripts to configure class loaders, Java Virtual Machine (JVM) settings, EJB containers, performance monitoring, dynamic cache, and so on. We can run each script individually, or combine procedures to create custom automation scripts for the environment.- Server configuration scripts
The scripting library provides script procedures to automate the application server configurations. Use the application server scripts to create application servers, web servers, and generic servers. We can run each script individually, or combine procedures to create custom automation scripts for the environment.- Server query scripts
The scripting library provides script procedures to automate your server configurations. This topic provides usage information for scripts that query the application server configuration. We can run each script individually, or combine procedures to create custom automation scripts for the environment.- Server administration scripts
The scripting library provides script procedures to automate the application server configurations. Use the application server scripts to delete, start, and stop servers. We can run each script individually or combine procedures to create custom automation scripts for the environment.
Related
Use the script library to automate the application serving environment using wsadmin.sh