Commands for the AdminTask object

Use the AdminTask object to run administrative commands with the wsadmin tool.

Administrative commands are discovered dynamically when you start the wsadmin tool. The administrative commands that are available for you to use, and what you can do with them, depends on the edition of WebSphere Application Server that you have.

You can start the scripting client without having a server running by using the -conntype NONE option with the wsadmin tool. The AdminTask administrative commands are available in both connected and local modes. If a server is currently running, it is not recommended to run the AdminTask commands 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 can corrupt the configuration.

Configuration note: With the Jacl scripting language, the subst command enables you to substitute a previously set value for a variable in the command. For example:
set nodeparm "node1"
$AdminTask setJVMMaxHeapSize [subst {-serverName server1 -nodeName $nodeparm -maximumHeapSize 100}]
The following AdminTask commands are available but do not belong to a group:

createServerType

Use the createServerType command to define a server type.

Target object

None.

Required parameters

-version
(String, required)
-serverType
(String, required)
-createTemplateCommand
(String, required)
-createCommand
(String, required)
-defaultTemplateName
The default value is: default. (String, optional)
-configValidator
(String, optional)

Optional parameters

None.

Sample output

The command returns the object name of the server type that was created.

Examples

Batch mode example usage:

Interactive mode example usage:

createTCPEndPoint

The createTCPEndPoint command creates a new endpoint that you can associate with a TCP inbound channel.

Target object

Parent instance of the TransportChannelService that contains the TCPInboundChannel. (ObjectName, required)

Required parameters

-name
Name for the new NamedEndPoint. (String, required)
- host
Host for the new NamedEndPoint. (String, required)
- port
Port for the new NamedEndPoint. (String, required)

Optional parameters

None.

Sample output

The command returns the object name of the endpoint that was created.

Examples

Batch mode example usage:

Interactive mode example usage:

getTCPEndPoint

The getTCPEndPoint command obtains the named end point that is associated with either a TCP inbound channel or a chain that contains a TCP inbound channel.

Target object

TCPInboundChannel, or containing chain, instance that is associated with a NamedEndPoint. (ObjectName, required)

Required parameters

None.

Optional parameters

None.

Sample output

The command returns the object name of an existing named end point that is associated with the TCP inbound channel instance or a channel chain.

Examples

Batch mode example usage:

Interactive mode example usage:

help

The help command provides a summary of the help commands and ways to invoke an administrative command.

Target object

None.

Required parameters

- commands
The help command provides a list of available administrative commands if you use the -commands parameter. (String, optional)
- commandGroups
The help command provides a list of administrative command groups if you use the -commandGroups parameter. (String, optional)
- commandName
The help command provides help information for a given administrative command. (String, optional)
- stepName
The help command provides help information for a given step of an administrative command. (String, optional)

Optional parameters

None.

Sample output

The command returns general command information for the AdminTask object.

Examples

Batch mode example usage:

listSSLRepertoires

The listSSLRepertoires command lists all of the Secure Sockets Layer (SSL) configuration instances that you can associate with an SSL inbound channel.If you create a new SSL alias using the administrative console, the alias name is automatically created in the node_name/alias_name format. However, if you create a new SSL alias using the wsadmin tool, you must create the SSL alias and specify both the node name and alias name in the node_name/alias_name format.

Target object

SSLInboundChannel instance for which the SSLConfig candidates are listed.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a list of eligible SSL configuration object names.

Examples

Batch mode example usage:

Interactive mode example usage:

listTCPEndPoints

The listTCPEndPoints command lists all the named end points that can be associated with a TCP inbound channel.

Target object

TCP Inbound Channel instance for which named end points candidates are listed. (ObjectName, required)

Required parameters

None.

Optional parameters

- excludeDistinguished
Shows only non-distinguished named end points. This parameter does not require a value. (Boolean, optional)
- unusedOnly
Shows the named end points not in use by other TCP inbound channel instances. This parameter does not require a value. (Boolean, optional)

Sample output

The command returns a list of object names for the eligible named end points.

Examples

Batch mode example usage:

Interactive mode example usage:

listTCPThreadPools

The listTCPThreadPools command lists all of the thread pools that can be associated with a TCP inbound channel or TCP outbound channel.

Target object

TCPInboundChannel or TCPOutboundChannel instance for which ThreadPool candidates are listed. (ObjectName, required)

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a list of eligible thread pool object names.

Examples

Batch mode example usage:

Interactive mode example usage:

updateAppOnCluster

The updateAppOnCluster command can be used to synchronize nodes and restart cluster members for an application update that is deployed to a cluster. After an application update, this command can be used to synchronize the nodes without stopping all the cluster members on all the nodes at one time. This command synchronizes one node at a time. Each node is synchronized by stopping the cluster members on which the application is targeted, performing a node synchronization operation, and restarting the cluster members.

This command might take more time than the default connector timeout period, depending on the number of nodes that the target cluster spans. Be sure to set proper timeout values in the soap.client.props file in the profile_root/properties directory, when a SOAP connector is used, and in the sas.client.props file, when a RMI connector is used.

This command is not supported in local mode.

Target object

None.

Required parameters

-ApplicationNames
The names of the applications that are updated.
-timeout
The timeout value in seconds for each node synchronization. The default is 300 seconds.

Optional parameters

None.

Sample output

The command does not return output.

Examples

Batch mode example usage:

Interactive mode example usage:

Service integration commands

The service integration functionality within the product provides a highly-flexible messaging system that supports a service-oriented architecture with a wide spectrum of quality of service options, supported protocols, and messaging patterns. It supports both message-oriented and service-oriented applications.

A variety of administrative commands are available for service integration, such as bus administrative commands, messaging engine administrative commands, mediation administrative commands, and so on. For information on the service integration commands, click on the administering applications section of the information center navigation, then click on Administering WebSphere applications, and then finally click on Service integration.




Related tasks
Using the AdminTask object for scripted administration
Related reference
NodeGroupCommands command group for the AdminTask object
ManagedObjectMetadata command group for the AdminTask object
JCAManagement command group for the AdminTask object
ServerManagement command group for the AdminTask object
ChannelFrameworkManagement command group for the AdminTask object
CoreGroupManagement command group for the AdminTask object
CoreGroupBridgeManagement command group for the AdminTask object
UnmanagedNodeCommands command group for the AdminTask object
ConfigArchiveOperations command group for the AdminTask object
Reference topic    

Terms of Use | Feedback

Last updated: Aug 29, 2010 5:25:00 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=vela&product=was-base-dist&topic=rxml_admintask
File name: rxml_admintask.html