Commands for the AdminTask object

 

+

Search Tips   |   Advanced Search

 

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 WAS 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.

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 appserver, 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.

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

• configureTAM
• createGenericServerTemplate
• createServerTemplate
• createServerType
• createTCPEndPoint
• getTCPEndPoint
• help
• listSSLRepertoires
• listTAMSettings
• listTCPEndPoints
• listTCPThreadPools
• reconfigureTAM
• setResourceProperty
• showResourceProperties
• unconfigureTAM
• updateAppOnCluster

 

configureTAM

Manually configure the Tivoli Access Manager.

Target object None.

Examples

Interactive mode example usage:

• Use Jacl:

  $AdminTask configureTAM {-interactive}

• Use Jython string:

  AdminTask.configureTAM ('[-interactive]')

• Use Jython list:

  AdminTask.configureTAM (['-interactive'])

 

createGenericServerTemplate

Create a server template based on a server configuration.

Target object None.

Required parameters and return values

-serverName

Name of the server of interest. (String, required)

-nodeName

Name of the node of interest. (String, required)

-templateName

Name of the template to create. (String, required)

-description

Provides a description for the template to be created. (String, optional)

-templateLocation

Location to store the template. If this parameter is not specified, the system will use the default location. (String, optional)

Examples

Interactive mode example usage:

• Use Jacl:

  $AdminTask createGenericServerTemplate {-interactive}

• Use Jython string:

  AdminTask.createGenericServerTemplate ('[-interactive]')

• Use Jython list:

  AdminTask.createGenericServerTemplate (['-interactive'])

 

createServerTemplate

Create a server using a template.

Target object None.

Required parameters and return values

-serverName

Name of the server of interest. (String, required)

-nodeName

Name of the node of interest. (String, required)

-templateName

Name of the template to create. (String, required)

-description

Provides a description for the template. (String, optional)

-templateLocation

Location to store the template. If this parameter is not specified, the system will use the default location. (String, optional)

• Returns: The identification of the template that you created, javax.management.ObjectName.

Examples

Interactive mode example usage:

• Use Jacl:

  $AdminTask createServerTemplate {-interactive}

• Use Jython string:

  AdminTask.createServerTemplate('[-interactive]')

• Use Jython list:

  AdminTask.createServerTemplate(['-interactive'])

 

createServerType

Define a server type.

Target object None.

Required parameters and return values

-version

(String, required)

-serverType

(String, required)

-createTemplateCommand

(String, required)

-createCommand

(String, required)

-defaultTemplateName

The default value is: default. (String, optional)

-configValidator

(String, optional)

• Returns: The identification of the server type that you created, javax.management.ObjectName.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createServerType {-version version -serverType serverType -createTemplateCommand name -createCommand name}

• Use Jython string:

  AdminTask.createServerType('[-version version -serverType serverType -createTemplateCommand name -createCommand name]')

• Use Jython list:

  AdminTask.createServerType(['-version', 'version', '-serverType', 'serverType','-createTemplateCommand', 'name', '-createCommand', 'name'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask createServerType {-interactive}

• Use Jython string:

  AdminTask.createServerType ('[-interactive]')

• Use Jython list:

  AdminTask.createServerType (['-interactive'])

 

createTCPEndPoint

The createTCPEndPoint command creates a new named end point that you can associate with a TCP inbound channel.

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

Required parameters and return values

-name

Name for the new NamedEndPoint. (String, required)

- host

Host for the new NamedEndPoint. (String, required)

- port

Port for the new NamedEndPoint. (String, required)

• Returns: Object name of the created NamedEndPoint.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createTCPEndPoint (cells/cell/nodes/node/servers/dmgr|server.xml#TransportChannelService_1) {-name EndpointName -host hostname.com -port 8978}

• Use Jython string:

  AdminTask.createTCPEndPoint('cells/cell/nodes/node/servers /dmgr|server.xml#TransportChannelService_1', '[-name EndpointName -host hostname.com -port 8978]')

• Use Jython list:

  AdminTask.createTCPEndPoint('cells/cell/nodes/node/servers /dmgr|server.xml#TransportChannelService_1', ['-name', 'EndpointName', '-host', 'hostname.com', '-port', '8978'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask createTCPEndPoint {-interactive}

• Use Jython string:

  AdminTask.createTCPEndPoint ('[-interactive]')

• Use Jython list:

  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 and return values

• Parameters: None.

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

• Use Jacl:

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

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

• Use Jython string:

  AdminTask.getTCPEndPoint('TCP_1(cells/cell/nodes/node/servers/dmgr|server.xml#TCPInboundChannel_1)')

  AdminTask.getTCPEndPoint('DCS(cells/cell/nodes/node/servers/dmgr|server.xml#Chain_3)')

• Use Jython list:

  AdminTask.getTCPEndPoint('TCP_1(cells/cell/nodes/node/servers/dmgr|server.xml#TCPInboundChannel_1)')

  AdminTask.getTCPEndPoint('DCS(cells/cell/nodes/node/servers/dmgr|server.xml#Chain_3)')

Interactive mode example usage:

• Use Jacl:

  $AdminTask getTCPEndPoint {-interactive}

• Use Jython string:

  AdminTask.getTCPEndPoint ('[-interactive]')

• Use Jython list:

  AdminTask.getTCPEndPoint (['-interactive'])

 

help

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

Target object None.

Required parameters and return values

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

• Returns: General command information.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask help

• Use Jython string:

  print AdminTask.help()

• Use Jython list:

  print AdminTask.help()

• Use Jacl:

  $AdminTask help -commands

• Use Jython string:

  AdminTask.help('-commands')

• Use Jython list:

  AdminTask.help('-commands')

• Use Jacl:

  $AdminTask help createJ2CConnectionFactory

• Use Jython string:

  AdminTask.help('createJ2CConnectionFactory')

• Use Jython list:

  AdminTask.help('createJ2CConnectionFactory')

 

listSSLRepertoires

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

Target object SSLInboundChannel instance for which the SSLConfig candidates are listed.

Required parameters and return values

• Parameters: None

• Returns: A list of eligible SSL configuration object names.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listSSLRepertoires SSL_3(cells/cell/nodes/node/servers/server2|server.xml#SSLInboundChannel_1093445762330)

• Use Jython string:

  AdminTask.listSSLRepertoires('SSL_3(cells/cell/nodes/node/servers/server2|server.xml#SSLInboundChannel_1093445762330)')

• Use Jython list:

  AdminTask.listSSLRepertoires('SSL_3(cells/cell/nodes/node/servers/server2|server.xml#SSLInboundChannel_1093445762330)')

Interactive mode example usage:

• Use Jacl:

  $AdminTask listSSLRepertoires {-interactive}

• Use Jython string:

  AdminTask.listSSLRepertoires ('[-interactive]')

• Use Jython list:

  AdminTask.listSSLRepertoires (['-interactive'])

 

listTAMSettings

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

Target object None.

Examples Interactive mode example usage:

• Use Jacl:

  $AdminTask listTAMSettings {-interactive}

• Use Jython string:

  AdminTask.listTAMSettings ('[-interactive]')

• Use Jython list:

  AdminTask.listTAMSettings (['-interactive'])

 

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 and return values

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

• Returns: A list of object names for the eligible named end points.

Examples

Batch mode example usage:

• Use Jacl:

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

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

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

• Use Jython string:

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

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

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

• Use Jython list:

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

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

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask listTCPEndPoints {-interactive}

• Use Jython string:

  AdminTask.listTCPEndPoints ('[-interactive]')

• Use Jython list:

  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 and return values

• Parameters: None

• Returns: A list of eligible thread pool object names.

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

  AdminTask.listTCPThreadPools('TCP_1(cells/cell/nodes/node/servers/dmgr|server.xml#TCPInboundChannel_1)')

• Use Jython list:

  AdminTask.listTCPThreadPools('TCP_1(cells/cell/nodes/node/servers/dmgr|server.xml#TCPInboundChannel_1)')

Interactive mode example usage:

• Use Jacl:

  $AdminTask listTCPThreadPools {-interactive}

• Use Jython string:

  AdminTask.listTCPThreadPools ('[-interactive]')

• Use Jython list:

  AdminTask.listTCPThreadPools (['-interactive'])

 

reconfigureTAM

The reconfigureTAM command reconfigures the Java Authorization Contract for Containers (JACC) Tivoli Access Manager settings.

Examples

Interactive mode example usage:

• Use Jacl:

  $AdminTask reconfigureTAM {-interactive}

• Use Jython string:

  AdminTask.reconfigureTAM ('[-interactive]')

• Use Jython list:

  AdminTask.reconfigureTAM (['-interactive'])

 

setResourceProperty

Set the value of a specified property defined on a resource provider such as JDBCProvider or a connection factory such as DataSource or JMSConnectionFactory. If the property with specified key is defined already, then this command overrides the value. If no property with a specified key is defined, this command will add the property with specified key and value.

Target object The configuration object ID of a resource provider or a connection factory.

Required parameters and return values

- propertyName

The name of the property. (String, required)

- propertyValue

The value of a property. (String, required)

- propertyType

The type of the property. The default value is java.lang.String. (String, optional)

- propertyDescription

The description of the defined property. (String, optional)

• Returns: None.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setResourceProperty {-propertyName test.property -propertyValue testValue}

• Use Jython string:

  AdminTask.setResourceProperty('[-propertyName test.property -propertyValue testValue]')

• Use Jython list:

  AdminTask.setResourceProperty(['-propertyName', 'test.property', '-propertyValue', 'testValue'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setResourceProperty {-interactive}

• Use Jython string:

  AdminTask.setResourceProperty ('[-interactive]')

• Use Jython list:

  AdminTask.setResourceProperty (['-interactive'])

 

showResourceProperties

List all of the property values that are defined on a resource provider such as JDBC provider or a connection factory such as data source or JMS connection factory.

Target object The configuration object ID of a resource provider or a connection factory.

Required parameters and return values

- propertyName

The name of the property. If you specify the property name, the value of the specified property name is returned. If you do not specify the property name, all property values will be listed. Each element in the list is a property name value pair. (String, optional)

• Returns: The property values that are defined on the resource provider or the connection factory specified.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask showResourceProperties {-propertyName test.property}

• Use Jython string:

  AdminTask.showResourceProperties('[-propertyName test.property]')

• Use Jython list:

  AdminTask.showResourceProperties(['-propertyName', 'test.property'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask showResourceProperties {-interactive}

• Use Jython string:

  AdminTask.showResourceProperties('[-interactive]')

• Use Jython list:

  AdminTask.showResourceProperties(['-interactive'])

 

unconfigureTAM

The unconfigureTAM command removes configuration data for the Java Authorization Contract for Containers (JACC) Tivoli Access Manager.

Examples

Interactive mode example usage:

• Use Jacl:

  $AdminTask unconfigureTAM {-interactive}

• Use Jython string:

  AdminTask.unconfigureTAM ('[-interactive]')

• Use Jython list:

  AdminTask.unconfigureTAM (['-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, 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 and return values

-ApplicationNames

The names of the applications that are updated.

-timeout

The timeout value in seconds for each node synchronization. The default is 300 seconds.

• Returns: None.

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

  AdminTask.updateAppOnCluster('[-interactive]')

• Use Jython list:

  AdminTask.updateAppOnCluster(['-interactive'])

 

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

Use the AdminTask object for scripted administration

 

Related Reference

IdMgrConfig command group for the AdminTask object
IdMgrRepositoryConfig command group for the AdminTask object
IdMgrRealmConfig command group for the AdminTask object
WIMManagementCommands command group for the AdminTask object
KeyStoreCommands command group for the AdminTask object
SSLConfigCommands command group for the AdminTask object
DescriptivePropCommands command group for the AdminTask object
TrustManagerCommands command group for the AdminTask object
keyManagerCommands command group for the AdminTask object
SSLConfigGroupCommands group for the AdminTask object
DynamicSSLConfigSelections command group for the AdminTask object
ManagementScopeCommands command group for the AdminTask object
Provider command group for the AdminTask object
WSScheduleCommands command group of the AdminTask object
WSNotifierCommands command group for the AdminTask object
WSCertExpMonitorCommands command group for the AdminTask object
KeySetGroupCommands command group for the AdminTask object
KeySetCommands command group for the AdminTask object
KeyReferenceCommands command group for the AdminTask object
CertificateRequestCommands command group of the AdminTask object
SignerCertificateCommands command group for the AdminTask object
PersonalCertificateCommands command group for the AdminTask object
SpnegoTAICommands group for the AdminTask object
NodeGroupCommands command group for the AdminTask object
AuthorizationGroupCommands command group for the AdminTask object
WSGateway command group for the AdminTask object
Utility command group of 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
ClusterConfigCommands command group for the AdminTask object
CoreGroupManagement command group for the AdminTask object
CoreGroupBridgeManagement command group for the AdminTask object
JDBCProviderManagement command group for the AdminTask object
UnmanagedNodeCommands command group for the AdminTask object
ConfigArchiveOperations command group for the AdminTask object
PortManagement command group for the AdminTask object
VariableConfiguration command group for the AdminTask object
AdministrationReports command group for the AdminTask object