Automating resource configurations using wsadmin scripting

The scripting library provides Jython script procedures to assist in automating your environment. Use the scripts in the AdminResources script library to configure mail, URL, and resource settings.

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.

The resource management procedures in scripting library are located in a app_server_root/scriptLibraries/resources/ 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 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.

You can use the AdminResources.py scripts to perform multiple combinations of administration functions. See the documentation for the resource configuration scripts for additional scripts, argument descriptions, and syntax examples.

The example script configures a custom mail provider and session. A mail provider encapsulates a collection of protocol providers like SMTP, IMAP and POP3, while mail sessions authenticate users and controls users' access to messaging systems. Configure your own mail providers and sessions to customize how JavaMail is handled.

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 to run scripts.
- Enter the following command from the bin directory to launch the wsadmin tool and connect to a server:
```
wsadmin -lang jython
```
- Enter the following command from the bin directory to launch the wsadmin tool in local mode and using the Jython scripting language:
```
wsadmin -conntype none -lang jython
```
When the wsadmin tool launches, the system loads all scripts from the scripting library.
Create a mail provider.
Run the createMailProvider script from the AdminResources script library, specifying the node name, server name, and new mail provider name, as the following example demonstrates:
```
wsadmin -lang jython -c "AdminResources.createMailProvider(myNode, myServer, newMailProvider)"
```
You can also use interactive mode to run the script procedure, as the following example demonstrates:
```
wsadmin>AdminResources.createMailProvider(nodeName, serverName, mailProviderName)
```
Define the protocol provider for the mail provider.
You can also configure custom properties, classes, JNDI name, and other mail settings with this script. See the documentation for the resource configuration scripts for argument descriptions and syntax examples. Run the configMailProvider script from the AdminResources script library to define the protocol provider, as the following example demonstrates:
```
wsadmin -lang jython -c "AdminResources.configMailProvider(myNode, myServer, newMailProvider, "", "", "SOAP", "", "", "", "", "", "")"
```
You can also use interactive mode to run the script procedure, as the following example demonstrates:
```
wsadmin>AdminResources.configMailProvider(myNode, myServer, newMailProvider, "", "", "SOAP", "", "", "", "", "", "")
```
Create the mail session.
Run the createMailSession script from the AdminResources script library, specifying the node name, server name, mail provider name, mail session name, and Java™ Naming and Directory Interface (JNDI) name arguments, as the following example demonstrates:
```
wsadmin -lang jython -c "AdminResources.createMailSession("myNode", "myServer", "newMailProvider", "myMailSession", "myMailSession/jndi")"
```
You can also use interactive mode to run the script procedure, as the following example demonstrates:
```
wsadmin>AdminResources.createMailSession("myNode", "myServer", "newMailProvider", "myMailSession", "myMailSession/jndi")
```
Save the configuration changes.
Use the following command example to save your configuration changes:
```
AdminConfig.save()
```
Synchronize the node.
To propagate the configuration changes to the node, run the syncNode script procedure from the AdminNodeManagement script library, specifying the node of interest, as the following example demonstrates:
```
wsadmin -lang jython -c "AdminNodeManagement.syncNode("myNode")"
```
You can also use interactive mode to run the script procedure, as the following example displays:
```
wsadmin>AdminNodeManagement.syncNode("myNode")
```

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.