Commands for the AdminTask object using wsadmin scripting

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

Administrative commands are loaded 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 the product that you use.

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.

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, you cannot 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. To change a configuration, do not run a scripting client in local mode on a node machine because this is not supported.

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:

createTCPEndPoint
getTCPEndPoint
help
listTCPEndPoints
listTCPThreadPools
updateAppOnCluster

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: Specifies the name for the new endpoint. (String, required)
-host: Specifies the host for the new endpoint. (String, required)
-port: Specifies the port for the new endpoint. (String, required)

Optional parameters

None.

Sample output

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask createTCPEndPoint (cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1)
  {-name Sample_End_Pt_Name -host mybuild.location.ibm.com -port 8978}

Using Jython string:

AdminTask.createTCPEndPoint('cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1',
  '[-name Sample_End_Pt_Name -host mybuild.location.ibm.com -port 8978]')

Using Jython list:

AdminTask.createTCPEndPoint('cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1', 
 ['-name', 'Sample_End_Pt_Name', '-host', 'mybuild.location.ibm.com', '-port', '8978'])

Interactive mode example usage:

Using Jacl:

$AdminTask createTCPEndPoint {-interactive}

Using Jython:

AdminTask.createTCPEndPoint('-interactive')

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:

Using Jacl:

$AdminTask getTCPEndPoint TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01
/servers/dmgr|server.xml#TCPInboundChannel_1)

$AdminTask getTCPEndPoint DCS(cells/mybuildCell01/nodes/mybuildCellManager01
/servers/dmgr|server.xml#Chain_3)

Using Jython string:

print AdminTask.getTCPEndPoint('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01
/servers/dmgr|server.xml#TCPInboundChannel_1)')

print AdminTask.getTCPEndPoint('DCS(cells/mybuildCell01/nodes/mybuildCellManager01
/servers/dmgr|server.xml#Chain_3)')

Using Jython list:

print AdminTask.getTCPEndPoint('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01
/servers/dmgr|server.xml#TCPInboundChannel_1)')

print AdminTask.getTCPEndPoint('DCS(cells/mybuildCell01/nodes/mybuildCellManager01
/servers/dmgr|server.xml#Chain_3)')

Interactive mode example usage:

Using Jacl:

$AdminTask getTCPEndPoint {-interactive}

Using Jython:

print AdminTask.getTCPEndPoint('-interactive')

help

The help command provides a summary of the help commands and ways to invoke an administrative command. You can use wildcard characters (*) or Java regular expressions (.*) in the command syntax to customize the search query.

Target object

None.

Optional 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)

Sample output

The command returns general command information for the AdminTask object.

Examples

Batch mode example usage:

The following command examples return general help information for the AdminTask object:

Using Jacl:
```
$AdminTask help
```
Using Jython:
```
print AdminTask.help()
```

The following command examples display each command for the AdminTask object:

Using Jacl:
```
$AdminTask help -commands
```
Using Jython:
```
print AdminTask.help('-commands')
```

The following command examples return detailed command information for the createJ2CConnectionFactory command for the AdminTask object:

Using Jacl:

$AdminTask help createJ2CConnectionFactory

Using Jython:

print AdminTask.help('createJ2CConnectionFactory')

The following examples demonstrate the use of the wildcard character (*) to return each command that contains the create string:

Using Jacl:
```
$AdminTask help -commands *create*
```

Using Jython:

print AdminTask.help('-commands *create*')

The following examples demonstrate the syntax to use regular Java expressions (.*):

Using Jacl:
```
$AdminTask help -commands <pattern>
```

Using Jython:

print AdminTask.help('-commands <pattern>')

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: Specifies whether to show only non-distinguished named end points. This parameter does not require a value. (Boolean, optional)
-unusedOnly: Specifies whether to show 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:

Using Jacl:

$AdminTask listTCPEndPoints TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)

$AdminTask listTCPEndPoints TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)
  {-excludeDistinguished}

$AdminTask listTCPEndPoints TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)
   {-excludeDistinguished -unusedOnly}

Using Jython string:

print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)',
   '[-excludeDistinguished]')

print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', 
   '[-excludeDistinguished]')

print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)',
   '[-excludeDistinguished -unusedOnly]')

Using Jython list:

print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)',
  ['-excludeDistinguished'])

print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)',
   ['-excludeDistinguished'])

print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)',
  ['-excludeDistinguished', '-unusedOnly'])

Interactive mode example usage:

Using Jacl:

$AdminTask listTCPEndPoints {-interactive}

Using Jython:

print AdminTask.listTCPEndPoints('-interactive')

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:

Using Jacl:

$AdminTask listTCPThreadPools TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)

Using Jython string:

print AdminTask.listTCPThreadPools('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)')

Using Jython list:

print AdminTask.listTCPThreadPools('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)')

Interactive mode example usage:

Using Jacl:

$AdminTask listTCPThreadPools {-interactive}

Using Jython:

print AdminTask.listTCPThreadPools('-interactive')

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; in the sas.client.props file, when a JSR160RMI connector or an RMI connector is used; and in the ipc.client.props file when an IPC connector is used.

This command is not supported in local mode.

Target object

None.

Required parameters

-ApplicationNames: Specifies the names of the applications that are updated. (String, required)

Optional parameters

-timeout: Specifies the timeout value in seconds for each node synchronization. The default is 300 seconds. (Integer, optional)

Sample output

The command does not return output.

Examples

Batch mode example usage:

Using Jacl:

$AdminTask updateAppOnCluster {-ApplicationNames app1}

$AdminTask updateAppOnCluster {-ApplicationNames app1 -timeout 600}

Using Jython string:

AdminTask.updateAppOnCluster('[-ApplicationNames app1]')

AdminTask.updateAppOnCluster('[-ApplicationNames app1 -timeout 600]')

Using Jython list:

AdminTask.updateAppOnCluster(['-ApplicationNames', 'app1'])

AdminTask.updateAppOnCluster(['-ApplicationNames', 'app1', '-timeout', '600'])

Interactive mode example usage:

Using Jacl:

$AdminTask updateAppOnCluster -interactive

Using Jython:

AdminTask.updateAppOnCluster('-interactive')