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.
set nodeparm "node1" $AdminTask setJVMMaxHeapSize [subst {-serverName server1 -nodeName $nodeparm -maximumHeapSize 100}]
Use the createServerType command to define a server type.
Target object
None.Required parameters
Optional parameters
None.Sample output
The command returns the object name of the server type that was created.Examples
Batch mode example usage:
$AdminTask createServerType {-version version -serverType serverType -createTemplateCommand name -createCommand name}
AdminTask.createServerType('[-version version -serverType serverType -createTemplateCommand name -createCommand name]')
Interactive mode example usage:
$AdminTask createServerType {-interactive}
AdminTask.createServerType ('[-interactive]')
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
Optional parameters
None.Sample output
The command returns the object name of the endpoint that was created.Examples
Batch mode example usage:
$AdminTask createTCPEndPoint (cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers /dmgr|server.xml#TransportChannelService_1) {-name Sample_End_Pt_Name -host rohitbuild.raleigh.ibm.com -port 8978}
AdminTask.createTCPEndPoint('cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers /dmgr|server.xml#TransportChannelService_1', '[-name Sample_End_Pt_Name -host rohitbuild.raleigh.ibm.com -port 8978]')
Interactive mode example usage:
$AdminTask createTCPEndPoint {-interactive}
AdminTask.createTCPEndPoint ('[-interactive]')
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:
$AdminTask getTCPEndPoint TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)
$AdminTask getTCPEndPoint DCS(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#Chain_3)
print AdminTask.getTCPEndPoint('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)')
print AdminTask.getTCPEndPoint('DCS(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#Chain_3)')
Interactive mode example usage:
$AdminTask getTCPEndPoint {-interactive}
print AdminTask.getTCPEndPoint ('[-interactive]')
The help command provides a summary of the help commands and ways to invoke an administrative command.
Target object
None.Required parameters
Optional parameters
None.Sample output
The command returns general command information for the AdminTask object.Examples
Batch mode example usage:
$AdminTask help
print AdminTask.help()
$AdminTask help -commands
print AdminTask.help('-commands')
$AdminTask help createJ2CConnectionFactory
print AdminTask.help('createJ2CConnectionFactory')
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:
$AdminTask listSSLRepertoires SSL_3(cells/rohitbuildCell01/ nodes/rohitbuildNode01/servers/server2|server.xml#SSLInboundChannel_1093445762330)
print AdminTask.listSSLRepertoires('SSL_3(cells/rohitbuildCell01/nodes/ rohitbuildNode01/servers/server2|server.xml#SSLInboundChannel_1093445762330)')
Interactive mode example usage:
$AdminTask listSSLRepertoires {-interactive}
print AdminTask.listSSLRepertoires ('[-interactive]')
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
Sample output
The command returns a list of object names for the eligible named end points.Examples
Batch mode example usage:
$AdminTask listTCPEndPoints TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)
$AdminTask listTCPEndPoints TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1) {-excludeDistinguished}
$AdminTask listTCPEndPoints TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1) {-excludeDistinguished -unusedOnly}
print AdminTask.listTCPEndPoints('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished]')
print AdminTask.listTCPEndPoints('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished]')
print AdminTask.listTCPEndPoints('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished -unusedOnly]')
Interactive mode example usage:
print AdminTask.listTCPEndPoints ('[-interactive]')
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:
$AdminTask listTCPThreadPools TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)
print AdminTask.listTCPThreadPools('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)')
Interactive mode example usage:
print AdminTask.listTCPThreadPools ('[-interactive]')
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
Optional parameters
None.Sample output
The command does not return output.Examples
Batch mode example usage:
$AdminTask updateAppOnCluster {-ApplicationNames app1}
$AdminTask updateAppOnCluster {-ApplicationNames app1 -timeout 600}
AdminTask.updateAppOnCluster('[-ApplicationNames app1]')
AdminTask.updateAppOnCluster('[-ApplicationNames app1 -timeout 600]')
Interactive mode example usage:
$AdminTask updateAppOnCluster -interactive
AdminTask.updateAppOnCluster('[-interactive]')
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.