Use AdminTask for scripted administration



Search Tips   |   Advanced Search


Use AdminTask to access a set of admin commands that provide an alternative way to access the configuration commands and the running object management commands.

The admin 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 admin commands depends on the edition of WAS that you installed. Use AdminTask commands to access these commands.

Administrative commands are grouped based on their function. You can use admin command groups to find related commands. For example, the admin commands that are related to server management are grouped into a server management command group. The admin commands that are related to the security management are grouped into a security management command group. An admin command can be associated with multiple command groups because it can be useful for multiple areas of system management. Both administrative commands and admin command groups are uniquely identified by their name.

Two run modes are always available for each administrative command, namely the batch and interactive mode. When you use an admin command in interactive mode, you go through a series of steps to collect the input interactively. This process provides users a text-based wizard and a similar user experience to the wizard in the admin console. We can also use the help command to obtain help for any administrative command and AdminTask.

The admin 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 we save a conflicting configuration, you could corrupt the configuration.

In a dmgr environment, configuration updates are available only if a scripting client is connected to a dmgr. When connected to a node agent or a managed application server, 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 dmgr. The copies are created on a node machine when a configuration synchronization occurs between the dmgr and the node agent. Make configuration changes to the server processes by connecting a scripting client to a dmgr. 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. You do not have to specify option parameters. This applies to all commands for AdminTask.

For example:

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

To determinethe names of the step parameters, use the following command:'command_name', 'step_name')...:'createCluster', 'clusterConfig')



Administrative command invocation syntax
Obtaining online help using scripting
Invoking an admin command in batch mode
Invoking an admin command in interactive mode
Data types for AdminTask
Commands for AdminTask