The scripting library provides Jython script procedures
to assist in automating your environment. Use the server, node, and
cluster management scripts to configure servers, nodes, node groups,
and clusters in your application server environment.
Before you begin
Before you can complete this task, you must install an
application server in your environment.
About this task
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 the wsadmin tool. You can launch the wsadmin tool, 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 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.
Use
the scripts in the following directories to configure your administrative
architecture:
- The server and cluster management procedures are located in the app_server_root/scriptLibraries/servers/V70 subdirectory.
- The node and node group management procedures are located in the app_server_root/scriptLibraries/system/V70 subdirectory.
Each script from the directory automatically loads when
you launch the wsadmin tool. To automatically load your own Jython
scripts (
*.py) when the wsadmin tool starts,
create a new subdirectory, and save existing automation scripts in
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.
bprac
This topic provides one sample combination
of procedures. Use the following steps to create a node group and
add three nodes to the group:
Procedure
- Optional: Launch the wsadmin tool.
Use
this step to launch the wsadmin tool and connect to a server, job
manager, or administrative agent profile, or run the tool in local
mode. If you launch the wsadmin tool, use the interactive mode examples
in this topic to run scripts.
When the wsadmin tool launches, the system
loads all scripts from the scripting library.
- Display the nodes in your 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
- Create a node group.
Run the createNodeGroup
script procedure from the AdminNodeGroupManagement script library,
specifying the name to assign to the new node group, as the following
example demonstrates:
bin>wsadmin -lang jython -c "AdminNodeGroupManagement.createNodeGroup("NodeGroup1")"
You can also use interactive mode to run the script
procedure, as the following example demonstrates:
wsadmin>AdminNodeGroupManagement.createNodeGroup("myNodeGroup")
- Add nodes to the node group.
Run the addNodeGroupMember
script procedure from the AdminNodeGroupManagement 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 "AdminNodeGroupManagement.addNodeGroupMember("Node1", "NodeGroup1")"
wsadmin -lang jython -c "AdminNodeGroupManagement.addNodeGroupMember("Node2", "NodeGroup1")"
wsadmin -lang jython -c "AdminNodeGroupManagement.addNodeGroupMember("Node3", "NodeGroup1")"
You
can also use interactive mode to run the script procedure, as the
following example demonstrates:
wsadmin>AdminNodeGroupManagement.addNodeGroupMember("Node1", "NodeGroup1")
wsadmin>AdminNodeGroupManagement.addNodeGroupMember("Node2", "NodeGroup1")
wsadmin>AdminNodeGroupManagement.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 your environment by
combining script procedures from the scripting library. Save custom
scripts to a new subdirectory of the app_server_root/scriptLibraries directory.