WebSphere Application Server - Express, Version 6.0.x     Operating Systems: AIX, HP-UX, Linux, Solaris, Windows

Starting the wsadmin scripting client

Why and when to perform this task

The WebSphere Application Server wsadmin tool provides the ability to run scripts. You can use the wsadmin tool to manage a WebSphere Application Server V6.0 installation, as well as configuration, application deployment, and server run-time operations. The WebSphere Application Server only supports the Jacl and Jython scripting languages.

The wsadmin launcher makes several WebSphere Application Server scripting objects available: AdminConfig, AdminControl, AdminApp, AdminTask, and Help. Scripts use these objects for application management, configuration, operational control, and for communication with MBeans that run in WebSphere Application Server processes.

You must start the wsadmin scripting client before you perform any other task using scripting.

Steps for this task

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

    The command for invoking a scripting process is located in the install_root/profiles/profile_name/bin directory. Use the wsadmin.bat file for a Windows system, and the wsadmin.sh file for a Linux or a UNIX system.

  2. Start the wsadmin scripting client. You 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:
    Option for starting the wsadmin scripting client: Explanation: Examples:
    Run scripting commands interactively

    Run wsadmin with an option other than -f or -c or without an option.

    An interactive shell is displayed with a wsadmin prompt. From the wsadmin prompt, enter any Jacl or Jython command. You 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.

    Using Jacl on Windows systems:
    wsadmin.bat
    Using Jacl on Unix systems:
    wsadmin.sh
    If security is enabled:
    wsadmin.sh -user wsadmin -password wsadmin
    Using Jython on Windows systems:
    wsadmin.bat -lang jython
    Using Jython on Unix systems:
    wsadmin.sh -lang jython
    By default security is enabled:
    wsadmin.sh -lang jython -user wsadmin -password wsadmin
    Example output:
    WASX7209I: Connected to process server1 on node myhost 
    using SOAP connector;  The type of process is: UnManagedProcess
    WASX7029I: For help, enter: "$Help help"
    wsadmin>$AdminApp list
    adminconsole
    DefaultApplication
    ivtApp
    wsadmin>exit
    Run scripting commands as individual commands

    Run the wsadmin tool with the -c option.

    Using Jacl on Windows systems:
    wsadmin -c "$AdminApp list"
    Using Jacl on Unix systems:
    wsadmin.sh -c "\$AdminApp list"
    or
    wsadmin.sh -c '$AdminApp list'
    Using Jython on Windows systems:
    wsadmin -lang jython -c "AdminApp.list()"
    Using Jython on Linux or Unix systems:
    wsadmin.sh -lang jython -c 'AdminApp.list()'
    Example output:
    WASX7209I: Connected to process "server1" on node myhost using 
    SOAP connector;  The type of process is: UnManagedProcess
    adminconsole
    DefaultApplication
    ivtApp
    Run scripting commands in a script

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

    Using Jacl on Windows systems:
    wsadmin -f al.jacl
    Using Jacl on Unix systems:
    wsadmin.sh -f al.jacl
    where the al.jacl file contains the following commands:
    set apps [$AdminApp list]
    puts $apps
    Using Jython on Windows systems:
    wsadmin -lang jython -f  al.py
    Using Jython on Unix systems:
    wsadmin.sh -lang jython -f  al.py
    where the al.py file contains the following commands:
    apps = AdminApp.list()
    print apps
    Example output:
    WASX7209I: Connected to process "server1" on node myhost 
    using SOAP connector;  The  type of process is: UnManagedProcess
     adminconsole
     DefaultApplication
     ivtApp
    
    Run scripting commands in a profile script

    A profile script is a script that runs before the main script, or before entering interactive mode. You 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 install_root/properties/wsadmin.properties file:
    install_root/bin/securityProcs.jacl
    install_root/bin/LTPA_LDAPSecurityProcs.jacl

    By default, these files are in ASCII. If you 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 the wsadmin tool with the -profile option, and include the commands that you want to run into the profile script.

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

    Using Jacl on Windows systems:
    wsadmin.bat -profile alprof.jacl
    Using Jacl on Linux or Unix systems:
    wsadmin.sh -profile alprof.jacl
    where the alprof.jacl file contains the following commands:
    set apps [$AdminApp list]
    puts "Applications currently installed:\n$apps"
    Example output:
    WASX7209I: Connected to process "server1" on node myhost 
    using SOAP connector;  The type of process is: UnManagedProcess
    Applications currently installed:
     adminconsole
     DefaultApplication
     ivtApp
     WASX7029I: For help, enter: "$Help help"
     wsadmin>
    Using Jython on Windows systems:
    wsadmin.bat -lang jython -profile alprof.py
    Using Jython on Linux or Unix systems:
    wsadmin.sh -lang jython -profile alprof.py
    where the alprof.py file contains the following commands:
    apps = AdminApp.list()
    print "Applications currently installed:\n " + apps
    Example output:
    WASX7209I: Connected to process "server1" on node myhost 
    using SOAP connector;  The type of process is: UnManagedProcess
    Applications currently installed:
     adminconsole
     DefaultApplication
     ivtApp
     WASX7029I: For help, enter: "Help.help()"
     wsadmin>



Related reference
Wsadmin tool

Task topic    

Terms of Use | Feedback

Last updated: Jun 8, 2005 12:45:23 PM EDT
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/txml_launchscript.html

© Copyright IBM Corporation 2002, 2005. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)