Automating admin architecture setup using the scripting 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.

Before we can complete this task, install an application server 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 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:

  #
  # My Custom Jython Script - file.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 in the script library demonstrates best practices for writing wsadmin scripts. The script library code is located in...

  $WAS_HOME/scriptLibraries

  Within this directory, the scripts are organized into subdirectories according to functionality, and further organized by version. For example, the $WAS_HOME/scriptLibraries/application/V70 subdirectory contains procedures that perform application management tasks that are applicable to V7.0 and later of WAS ND.

Use the scripts in the following directories to configure the admin architecture:

• The server and cluster management procedures are located in...

  WAS_HOME/scriptLibraries/servers/V70 sub

• The node and node group management procedures are located in...

  WAS_HOME/scriptLibraries/system/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 in the WAS_HOME/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

This page provides one sample combination of procedures. Use the following steps to create a node group and add three nodes to the group:

 

1. 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 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 using Jython:

     wsadmin -conntype none -lang jython
     

   When wsadmin launches, the system loads all scripts from the scripting library.

2. Display the nodes in the environment. Run the listNodes script procedure from the AdminNodeManagement script library, as the following example demonstrates:

   bin>wsadmin -lang jython -c "AdminNodeManagement.listNodes()"
   

   You can also use interactive mode to run the script procedure, as the following example demonstrates:

   wsadmin>AdminNodeManagement.listNodes()
   

   For this example, the command returns the following output:

   Node1 Node2 Node3
   

3. Create a node group. Run the createNodeGroup script procedure from the AdminNodeManagement script library, specifying the name to assign to the new node group...

   bin>wsadmin -lang jython -c "AdminNodeManagement.createNodeGroup("NodeGroup1")"
   
   

   We can also use interactive mode to run the script procedure...

   wsadmin>AdminNodeManagement.createNodeGroup("myNodeGroup")
   

4. Add nodes to the node group. Run the addNodeGroupMember script procedure from the AdminNodeManagement script library to add the Node1, Node2, and Node3 nodes to the NodeGroup1 node group, specifying the node name and node group name, as the following examples demonstrate:

   wsadmin -lang jython -c "AdminNodeManagement.addNodeGroupMember("Node1", "NodeGroup1")" wsadmin -lang jython -c "AdminNodeManagement.addNodeGroupMember("Node2", "NodeGroup1")" wsadmin -lang jython -c "AdminNodeManagement.addNodeGroupMember("Node3", "NodeGroup1")"
   

   You can also use interactive mode to run the script procedure, as the following example demonstrates:

   wsadmin>AdminNodeManagement.addNodeGroupMember("Node1", "NodeGroup1") wsadmin>AdminNodeManagement.addNodeGroupMember("Node2", "NodeGroup1") wsadmin>AdminNodeManagement.addNodeGroupMember("Node3", "NodeGroup1")
   

 

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")

 

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 the WAS_HOME/scriptLibraries directory.

Node administration scripts
Node group configuration scripts
Cluster configuration scripts
Cluster query scripts
Cluster administration scripts

 

Related tasks

Use the script library to automate the application serving environment

 

Related

Server configuration scripts