WebSphere Application Server Network Deployment, Version 6.0.x   Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
             [TIP: Focusing the table of contents and search results]

Starting the wsadmin scripting client

You can use the wsadmin tool to manage a WebSphere Application Server installation, as well as configuration, application deployment, and server run-time operations.

About this task

The WebSphere Application Server wsadmin tool provides the ability to automate configuration tasks for your environment by running scripts. However, there are some limitations for using the wsadmin tool, including:
  • The wsadmin tool only supports the Jython and Jacl scripting languages.
  • The wsadmin tool can manage the installation, configuration, deployment, and runtime operations for application servers and deployment managers that have the same version or a higher version of WebSphere Application Server installed. The wsadmin tool can not connect to an application server or deployment manager that is running a product version which is older than the version of the wsadmin tool. For example, a Version 6.x wsadmin client can not connect to a Version 5.x application server or deployment manager. However, a Version 5.x wsadmin client can connect to a Version 6.x application server or deployment manager. This limitation exists because new functionality is added to the wsadmin tool in each product release. You can not use new command functionality on application servers running previous product versions.

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 Network Deployment processes.

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

Procedure

  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 you use this option, you do not need to specify the -profileName profilename parameter.
    • Invoke the scripting process using the default profile. The wsadmin Qshell command is located in the app_server_root/bin directory. If you do not want to connect to the default profile, you must specify the -profileName profilename parameter to indicate the profile that you want to use.
  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 Jython on Windows systems:
    wsadmin.bat -lang jython
    Using Jython on operating systems such as AIX or Linux:
    wsadmin.sh -lang jython

    By default security is enabled:

    wsadmin.sh -lang jython -user wsadmin 
    -password wsadmin
    Using Jacl on Windows systems:
    wsadmin.bat
    Using Jacl on operating systems such as AIX or Linux:
    wsadmin.sh

    If security is enabled:

    wsadmin.sh -user wsadmin -password wsadmin

    Example output:

    Jython 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>print AdminApp.list()
    DefaultApplication\nIBMUTC\nivtApp\nquery\nsampleEAR
    wsadmin>exit
    Jacl 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 Jython on operating systems such as AIX or Linux:
    wsadmin.sh -lang jython -c 'AdminApp.list()'
    Using Jacl on Windows systems:
    wsadmin -c "$AdminApp list"
    Using Jacl on operating systems such as AIX or Linux:
    wsadmin.sh -c "\$AdminApp list"
    or
    wsadmin.sh -c '$AdminApp list'
    Using Jython on Windows systems:
    wsadmin -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 Jython on Windows systems:
    wsadmin -lang jython -f  al.py
    Using Jython on operating systems such as AIX or Linux:
    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 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 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.

    Do not use parenthesis in node names when creating profiles.

    Using Jython on Windows systems:
    wsadmin.bat -lang jython -profile alprof.py
    Using Jython on operating systems such as AIX or Linux:
    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>
    Using Jacl on Windows systems:
    wsadmin.bat -profile alprof.jacl
    Using Jacl on operating systems such as AIX or Linux:
    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>



Related information
Wsadmin tool
Task topic    

Terms of Use | Feedback

Last updated: Mar 8, 2007 8:14:28 PM CST
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?topic=/com.ibm.websphere.nd.doc/info/ae/ae/txml_launchscript.html

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