Automating resource configurations using the scripting library.


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

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.

The resource management procedures in scripting library are located in...

WAS_HOME/scriptLibraries/resource/V70 sub

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

Use the AdminResources.py scripts to perform multiple combinations of administration functions. This page provides one sample combination of procedures. See the documentation for the resource configuration scripts for additional scripts, argument descriptions, and syntax examples.

The example script in this topic 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. Set the own mail providers and sessions to customize how Java Mail is handled.

 

  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:

      wsadmin -lang jython
      

    • Enter the following command from the bin directory to launch wsadmin in local mode and using Jython:

      wsadmin -conntype none -lang jython
      

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

  2. Create a mail provider. Run the createMailProvider script from the AdminResources script library, specifying the node name, server name, and new mail provider name...

    wsadmin -lang jython -c "AdminResources.createMailProvider(myNode, myServer, newMailProvider)"
    

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

    wsadmin>AdminResources.createMailProvider(nodeName, serverName, mailProviderName)
    

  3. 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...

    wsadmin -lang jython -c "AdminResources.configMailProvider(myNode, myServer, newMailProvider, "", "", "SOAP", "", "", "", "", "", "")"
    
    

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

    wsadmin>AdminResources.configMailProvider(myNode, myServer, newMailProvider, "", "", "SOAP", "", "", "", "", "", "")
    

  4. 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...

    wsadmin -lang jython -c "AdminResources.createMailSession("myNode", "myServer", "newMailProvider", "myMailSession", "myMailSession/jndi")"

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

    wsadmin>AdminResources.createMailSession("myNode", "myServer", "newMailProvider", "myMailSession", "myMailSession/jndi")

  5. Save the configuration changes...

    AdminConfig.save()
    

  6. 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 the environment by combining script procedures from the scripting library. Save custom scripts to a new subdirectory of the WAS_HOME/scriptLibraries directory.


Resource configuration scripts

 

Related tasks


Use the script library to automate the application serving environment