WAS v8.5 > Script the application serving environment (wsadmin) > Welcome to scripting for web services

Start the wsadmin scripting client using wsadmin.sh

We can use wsadmin to configure and administer application servers, application deployment, and server runtime operations.

The wsadmin tool provides the ability to automate configuration tasks for the environment by running scripts. However, there are some limitations for using wsadmin, including:

The wsadmin launcher supports several scripting objects, including the AdminConfig, AdminControl, AdminApp, AdminTask, and Help objects. Scripts use these objects for application management, configuration, operational control, and for communication with MBeans that run in product processes. Start the wsadmin scripting client before you perform any other task using scripting.

The application management design does not allow us to install an EE specification level EAR or module that is at a higher level than the client. Client code that runs in wsadmin reads the EAR file and uses introspection of the content to generate the deployment configuration options that are applicable to that application. The client side code cannot process a specification level that is higher than what that client supports. gotcha

  1. Locate the command that starts the wsadmin scripting client.

    Choose one of the following:

    • Invoke the scripting process using a specific profile. The QShell command for invoking a scripting process is located in the profile_root/bin directory. The name of the QShell script is wsadmin. If we use this option, we do not need to specify the -profileName profile_name parameter.
    • Invoke the scripting process using the default profile. The wsadmin Qshell command is located in the app_server_root/bin directory. If we do not want to connect to the default profile, specify the -profileName profile_name parameter to indicate the profile to use.

  2. Review additional connection options for wsadmin.

    We can start the wsadmin scripting client in several different ways. To specify the method for running scripts, perform one of the following wsadmin tool options:

    Run scripting commands interactively

    Run wsadmin with an option other than -f or -c or without an option. The wsadmin tool starts and displays an interactive shell with a wsadmin prompt. From the wsadmin prompt, enter any Jacl or Jython command. We can also invoke commands using the AdminControl, AdminApp, AdminConfig, AdminTask, or Help wsadmin objects. To leave an interactive scripting session, use the quit or exit commands. These commands do not take any arguments.

    The following examples launch wsadmin:

    • Launch wsadmin using Jython:

        wsadmin.sh -lang jython

        wsadmin.bat -lang jython
    • Launch wsadmin using Jython when security is enabled:

        wsadmin.sh -lang jython -user user_name -password password

        wsadmin.bat -lang jython -user user_name -password password
    • Launch wsadmin using Jacl with no options:

        wsadmin.sh -lang jacl

        wsadmin.bat -lang jacl

    Run scripting commands as individual commands

    Run wsadmin with the -c option.

    If you invoke a command that includes a dollar sign character ($) using the wsadmin -c option, the command line attempts to substitute a variable. To avoid this problem, escape the dollar sign character with a backslash character (\). For example: wsadmin -c "\$AdminApp install ...".

    The following examples run commands individually:

    • Run the list command for the AdminApp object using Jython:

        wsadmin.sh -lang jython -c 'AdminApp.list()'

        wsadmin -lang jython -c "AdminApp.list()"

    • Run the list command for the AdminApp object using Jacl:

        wsadmin.sh -c "\$AdminApp list"
      or

        wsadmin.sh -c '$AdminApp list'

        wsadmin -c "$AdminApp list"

    Run scripting commands in a script

    Run wsadmin with the -f option, and place the commands to run into the file.

    The following examples run scripts:

    • Run the a1.py script using Jython:

        wsadmin.sh -lang jython -f al.py

        wsadmin -lang jython -f al.py

      where the a1.py file contains the following commands: 

      apps = AdminApp.list()
print apps

    Run scripting commands in a profile script

    A profile script is a script that runs before the main script, or before entering interactive mode. We can use profile scripts to set up a scripting environment that is customized for the user or the installation.

    By default, the following profile script files might be configured for the com.ibm.ws.scripting.profiles profiles property in the app_server_root/properties/wsadmin.properties file:

    • app_server_root/bin/securityProcs.jacl
    • app_server_root/bin/LTPA_LDAPSecurityProcs.jacl

    By default, these files are in ASCII. If we use the profile.encoding option to run EBCDIC encoded profile script files, change the encoding of the files to EBCDIC.

    To run scripting commands in a profile script, run wsadmin with the -profile option, and include the commands to run into the profile script.

    To customize the script environment, specify one or more profile scripts to run.

    Do not use parenthesis in node names when creating profiles.

    The following examples run profile scripts:

    • Run the a1prof.py script using Jython:

        wsadmin.sh -lang jython -profile alprof.py

        wsadmin.bat -lang jython -profile alprof.py

      where the a1prof.py file contains the following commands: 

      apps = AdminApp.list()
print "Applications currently installed:\n " + apps

    • Run the a1prof.py script using Jacl:

        wsadmin.sh -profile alprof.jacl

        wsadmin.bat -profile alprof.jacl

      where the a1prof.py file contains the following commands: 

      set apps [$AdminApp list]
puts "Applications currently installed:\n$apps"


Results

The wsadmin returns the following output when it establishes a connection to the server process:

Jython example output: 

Applications currently installed:
 DefaultApplication
ivtApp
query
WASX70311: For help, enter: "print Help.help()"
wsadmin>

Jacl example output: 

Applications currently installed:
 DefaultApplication
ivtApp
query
WASX70311: For help, enter: "$Help help"
wsadmin>


Reference:

wsadmin scripting tool


+

Search Tips   |   Advanced Search