Commands for the AdminTask object using wsadmin.sh

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

Administrative commands are loaded dynamically when we start the wsadmin tool. The administrative commands available for you to use, and what we can do with them, depends on the edition of the product that we use.

We can start the scripting client without having a server running 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 we save a conflicting configuration, we 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, we 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 us 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}]

AdminTask commands...

• AdminSDKCmds
• Application management
• AdministrationReports
• AuthorizationGroupCommands
• JCAManagement
• ChannelFrameworkManagement
• ClusterConfigCommands
• CoreGroupManagement
• CoreGroupBridgeManagement
• WSCertExpMonitorCommands
• CertificateRequestCommands
• ConfigArchiveOperations
• IdMgrConfig
• IdMgrRepositoryConfig
• IdMgrRealmConfig
• JavaEEDefaultResources
• JDBCProviderManagement
• keyManagerCommands
• KeyStoreCommands
• ManagedObjectMetadata
• ManagementScopeCommands
• NodeGroupCommands
• WSNotifierCommands
• PersonalCertificateCommands
• PolicySetManagement
• PortManagement
• Provider
• DescriptivePropCommands
• WSScheduleCommands
• ServerManagement
• ResourceManagement
• TAMConfig
• SIBAdminBusSecurityCommands
• SIBAdminCommands: Bus administrative commands
• SIBAdminCommands: Bus link administrative commands
• SIBAdminCommands: Destination administrative commands
• SIBAdminCommands: Foreign bus administrative commands
• SIBAdminCommands: Mediation administrative commands
• SIBAdminCommands: Messaging engine administrative commands
• SIBAdminCommands: IBM MQ link administrative commands
• SIBAdminCommands: IBM MQ server administrative commands
• SIBJMSAdminCommands
• SIBWebServices
• SignerCertificateCommands
• SpnegoTAICommands (deprecated)
• SSLConfigCommands
• SSLConfigGroupCommands
• DynamicSSLConfigSelections
• TrustManagerCommands
• UnmanagedNodeCommands
• Utility command group of the AdminTask object
• VariableConfiguration
• WIMManagementCommands
• WSGateway
• WSNotificationCommands
• KeySetGroupCommands
• KeySetCommands
• KeyReferenceCommands
• WebServicesAdmin
• JaspiManagement

The following AdminTask commands are available but do not belong to a group:

• createTCPEndPoint
• getTCPEndPoint
• help
• listTCPEndPoints
• listTCPThreadPools
• updateAppOnCluster

createTCPEndPoint

Create a new endpoint that we can associate with a TCP inbound channel.

Target object: Parent instance of the TransportChannelService containing the TCPInboundChannel. (ObjectName, required)

Required parameters:

-name

Name for the new endpoint. (String, required)

-host

Host for the new endpoint. (String, required)

-port

Port for the new endpoint. (String, required)

Optional parameters: None.

Sample output

The command returns the object name of the endpoint created.

Examples

Batch mode example usage:

• Use 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}
  

• Use 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]')
  

• Use 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:

• Use Jacl:

  $AdminTask createTCPEndPoint {-interactive}
  

• Use Jython:

  AdminTask.createTCPEndPoint('-interactive')
  

getTCPEndPoint

Obtain the named end point associated with either a TCP inbound channel or a chain containing a TCP inbound channel.

Target object: TCPInboundChannel, or containing chain, instance 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 associated with the TCP inbound channel instance or a channel chain.

Examples

Batch mode example usage:

• Use 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)
  

• Use 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)')
  

• Use 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:

• Use Jacl:

  $AdminTask getTCPEndPoint {-interactive}
  

• Use Jython:

  print AdminTask.getTCPEndPoint('-interactive')
  

help

Provide a summary of the help commands and ways to invoke an administrative command. 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 we use the -commands parameter. (String, optional)

-commandGroups

The help command provides a list of administrative command groups if we 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:

• Jacl:

  $AdminTask help
  

• Use Jython:

  print AdminTask.help()
  

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

• Use Jacl:

  $AdminTask help -commands
  

• Use Jython:

  print AdminTask.help('-commands')
  

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

• Use Jacl:

  $AdminTask help createJ2CConnectionFactory
  

• Use Jython:

  print AdminTask.help('createJ2CConnectionFactory')
  

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

• Use Jacl:

  $AdminTask help -commands *create*
  

• Use Jython:

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

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

• Use Jacl:

  $AdminTask help -commands <pattern>
  

• Use Jython:

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

listTCPEndPoints

List 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:

• Use 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}
  

• Use 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]')
  

• Use 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:

• Use Jacl:

  $AdminTask listTCPEndPoints {-interactive}
  

• Use Jython:

  print AdminTask.listTCPEndPoints('-interactive')
  

listTCPThreadPools

List 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:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask listTCPThreadPools {-interactive}
  

• Use Jython:

  print AdminTask.listTCPThreadPools('-interactive')
  

updateAppOnCluster

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

Names of the applications that are updated. (String, required)

Optional parameters:

-timeout

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:

• Use Jacl:

  $AdminTask updateAppOnCluster {-ApplicationNames app1}
  

  $AdminTask updateAppOnCluster {-ApplicationNames app1 -timeout 600}
  

• Use Jython string:

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

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

• Use Jython list:

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

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateAppOnCluster -interactive
  

• Use Jython:

  AdminTask.updateAppOnCluster('-interactive')
  

wsadmin AdminTask