Get started with wsadmin scripting
The WebSphere Application Server wsadmin tool provides the ability to run scripts. The wsadmin tool supports a full range of product administrative activities.
The wsadmin tool does not apply to the Liberty profile.
The wsadmin tool supports two scripting languages: Jacl and Jython. Five objects are available when you use scripts:
AdminControl Run operational commands. AdminConfig Run configurational commands to create or modify WebSphere Application Server configurational elements. AdminApp Administer applications. AdminTask Run administrative commands. Help Obtain general help.
The scripts use these objects to communicate with MBeans that run in WebSphere Application Server processes. MBeans are Java objects that represent JMX resources. JMX is an optional package addition to Java 2 Platform Standard Edition (J2SE). JMX is a technology that provides a simple and standard way to manage Java objects.
Important: Some wsadmin scripts, including the AdminApp install, AdminApp update, and some AdminTask commands, require that the user ID under which the server is running must have read permission to the files created by the user running wsadmin scripting. For example, if the application server is running under user1, but you are running wsadmin scripting under user2, you might encounter exceptions involving a temporary directory. When user2 runs wsadmin scripting to deploy an application, a temporary directory for the EAR file is created. However, when the application server attempts to read and unzip the EAR file as user1, the process fails. It is not recommended set the umask value of the user running wsadmin scripting to 022 or 023 to work around this issue. This approach makes all of the files created by the user readable by other users. To resolve this issue, consider the following approaches based on the administrative policies:
- Run wsadmin scripting with the same user ID as the user that runs the deployment manager or application server. A root user can switch the user ID to complete these actions.
- Set the group ID of the user running the deployment manager or application server to be the same group ID as the user running wsadmin scripting. Also, set the umask value of the user running the wsadmin scripting to be at least a umask 027 value so that files created by the wsadmin scripting can be read by members of the group.
- Run wsadmin scripting from a different machine. This approach forces files to be transferred and bypasses the file copy permission issue.
To perform a task , first perform the following steps:
- Choose a scripting language. The wsadmin tool only supports Jacl and Jython scripting languages. Jacl is the language specified by default. To use the Jython scripting language, use the -lang option or specify it in the wsadmin.properties file.
- Start the wsadmin scripting client interactively, as an individual command, in a script, or in a profile.
What to do next
Before you perform any task , make sure that you are familiar with the following concepts:
- JMX
- WebSphere Application Server configuration model
- wsadmin tool
- Jacl syntax or Jython syntax
- Scripting objects
Optionally, we can customize the scripting environment. For more information, see Administrative properties for .
After you become familiar with the scripting concepts, choose a scripting language, and start the scripting client, you are ready to perform tasks .
Subtopics
- What is new for scripted administration (wsadmin)
This topic highlights what is new or changed for users who are going to customize, administer, monitor, and tune production server environments .
- Overview and new features for scripting the application serving environment
Use the links provided in this topic to learn about the administrative features.
Related concepts
Use wsadmin scripting with JMX WebSphere Application Server configuration model Use wsadmin scripting with Jacl Use wsadmin scripting with Jython
Related tasks
Use the wsadmin scripting objects Start the wsadmin scripting client Restricting remote access Use wsadmin scripting
wsadmin scripting tool Administrative properties for Scripting and command line reference material
Related information:
IBM Jacl to Jython Conversion Assistant
WebSphere Application Server Administration Using Jython