wsadmin AdminTask object for scripted administration
Use the AdminTask object to access a set of administrative commands that provide an alternative way to access the configuration commands and the running object management commands.
The administrative commands run simple and complex commands. They provide more user friendly and task-oriented commands. The administrative commands are discovered dynamically when you start a scripting client. The set of available administrative commands depends on the edition of WebSphere Application Server that we installed. Use the AdminTask object commands to access these commands.
Administrative commands are grouped based on their function. Use administrative command groups to find related commands. For example, the administrative commands related to server management are grouped into a server management command group. The administrative commands related to the security management are grouped into a security management command group. An administrative command can be associated with multiple command groups because it can be useful for multiple areas of system management. Both administrative commands and administrative command groups are uniquely identified by their name.
Two run modes are always available for each administrative command, namely the batch and interactive modes. When we use an administrative command in interactive mode, you go through a series of steps to collect your input interactively. This process provides users a text-based wizard and a similar user experience to the wizard in the administrative console. We can also use the help command to obtain help for any administrative command and the AdminTask object.
The administrative commands do not replace any existing configuration commands or running object management commands but provide a way to access these commands and organize the inputs. The administrative commands can be available in connected or local mode. The set of available administrative commands is determined when you start a scripting client in connected or local mode. If a server is running, it is not recommended that we run the scripting client in local mode because any configuration changes made in local mode are not reflected in the running server configuration and vice versa. If we save a conflicting configuration, we could corrupt the configuration.
In a deployment manager environment, configuration updates are available only if a scripting client is connected to a deployment manager. When connected to a node agent or a managed application server, we will not be able to update the configuration because the configuration for these server processes are copies of the master configuration which resides in the deployment manager. The copies are created on a node machine when a configuration synchronization occurs between the deployment manager and the node agent. Make configuration changes to the server processes by connecting a scripting client to a deployment manager. For this reason, to change a configuration, do not run a scripting client in local mode on a node machine. It is not a supported configuration.
Use parameter name and parameter value pairs to specify the parameters of a step in any order. We do not have to specify option parameters. This applies to all commands for the AdminTask object. For example:
AdminTask.createCluster('[-clusterConfig [-clusterName cluster1 -preferLocal true]]')
To determine the names of the step parameters. AdminTask.help('command_name', 'step_name'):
AdminTask.help('createCluster', 'clusterConfig')
Tasks
- Invoking an administrative command in batch mode
- Invoking an administrative command in interactive mode
- Obtain online help
Subtopics
Administrative command invocation syntax Commands for the AdminTask object