Use the AdminTask object for scripted administration

 

+

Search Tips   |   Advanced Search

 

Overview

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 set of available administrative commands depends on the edition of WAS that you installed.

Administrative commands are grouped based on their function. You can use administrative command groups to find related commands. For example, the administrative commands that are related to server management are grouped into a server management command group. The administrative commands that are 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...

• batch
• interactive

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 you 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 you save a conflicting configuration, you 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 appserver, you 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.

In V6.1, you can use parameter name and parameter value pairs instead of using parameter value one-to-one mapping as in V6.x. This way, you can specify the parameters of a step in any order and you do not have to specify option parameters. This applies to all commands for the AdminTask object.

V6.x syntax...

$AdminTask commandName {-stepName {{param1Value param2Value param3Value ...}}}

Syntax for V6.1:

$AdminTask commandName {-stepName {-param1Name param1Value -param3Name param3Value -param2Name param2Value ...}}

Example using Jacl in V6.x:

$AdminTask createCluster {-clusterConfig {{cluster1 true}}}

Example using Jython in V6.x:

AdminTask.createCluster ('[-clusterConfig [[cluster1 true]]]')

Example using Jacl in V6.1:

$AdminTask createCluster {-clusterConfig {-clusterName cluster1 -preferLocal true}}

Example using Jython in V6.1:

AdminTask.createCluster('[-clusterConfig [-clusterName cluster1 -preferLocal true]]')

To find out the names of the step parameters...

$AdminTask help command_name step_name

For example using Jacl:

$AdminTask help createCluster clusterConfig

For example using Jython:

AdminTask.help('createCluster', 'clusterConfig')

 

Procedure

1. Invoke an administrative command in batch mode
2. Invoke an administrative command in interactive mode
3. Obtain online help using scripting

---

 

Related Reference

Administrative command invocation syntax
Commands for the AdminTask object