Commands for the AdminTask object

Operating Systems: i5/OS
Personalize the table of contents and search results

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.

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

Use the configureTAM command to manually configure the Tivoli Access Manager.

Target object None.

Required parameters None.

Optional parameters None.

Examples

Interactive mode example usage:

Using Jacl:
```
$AdminTask configureTAM {-interactive}
```

Using Jython string:

AdminTask.configureTAM ('[-interactive]')

Using Jython list:

AdminTask.configureTAM (['-interactive'])

createGenericServerTemplate

Use the createGenericServerTemplate command to create a server template based on a server configuration.

Target object None.

Required parameters

-serverName

Specifies the name of the server of interest. (String, required)

-nodeName

Specifies the name of the node of interest. (String, required)

-templateName

Specifies the name of the template to create. (String, required)

-description

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

-templateLocation

Specifies a configuration Id that represents the location of the template. If this parameter is not specified, the system uses the default location. (String, optional)The following example displays the format of the configuration Id, where the display name is optional:

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id

The configuration Id can be one of the following values:

To create a Web server template:
templates\servertypes\WEB_SERVER|servertype-metadata.xml
To create an application server template:
templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml
To create a generic server template:
templates\servertypes\GENERIC_SERVER|servertype-metadata.xml
To create a proxy server template:
templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Optional parameters None.

Examples

Interactive mode example usage:

Using Jacl:

$AdminTask createGenericServerTemplate {-interactive}

Using Jython string:

AdminTask.createGenericServerTemplate('[-interactive]')

Using Jython list:

AdminTask.createGenericServerTemplate(['-interactive'])

createServerTemplate

Use the createServerTemplate command to create a server using a template.

Target object None.

Required parameters

-serverName

Specifies the name of the server of interest. (String, required)

-nodeName

Specifies the name of the node of interest. (String, required)

-templateName

Specifies the name of the template to create. (String, required)

-description

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

-templateLocation

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id

The configuration Id can be one of the following values:

To create a Web server template:
templates\servertypes\WEB_SERVER|servertype-metadata.xml
To create an application server template:
templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml
To create a generic server template:
templates\servertypes\GENERIC_SERVER|servertype-metadata.xml
To create a proxy server template:
templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Optional parameters None.

Sample output The command returns the object name of the template that was created.

Examples

Interactive mode example usage:

Using Jacl:

$AdminTask createServerTemplate {-interactive}

Using Jython string:

AdminTask.createServerTemplate('[-interactive]')

Using Jython list:

AdminTask.createServerTemplate(['-interactive'])

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:

Using Jacl:

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

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask createServerType {-interactive}

Using Jython string:

AdminTask.createServerType ('[-interactive]')

Using Jython list:

AdminTask.createServerType (['-interactive'])

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:

Using Jacl:

$AdminTask createTCPEndPoint (cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers
/dmgr|server.xml#TransportChannelService_1) {-name Sample_End_Pt_Name -host 
rohitbuild.raleigh.ibm.com -port 8978}

Using Jython string:

AdminTask.createTCPEndPoint('cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers
/dmgr|server.xml#TransportChannelService_1', '[-name Sample_End_Pt_Name -host 
rohitbuild.raleigh.ibm.com -port 8978]')

Using Jython list:

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:

Using Jacl:

$AdminTask createTCPEndPoint {-interactive}

Using Jython string:

AdminTask.createTCPEndPoint ('[-interactive]')

Using 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 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/rohitbuildCell01/nodes/rohitbuildCellManager01
/servers/dmgr|server.xml#TCPInboundChannel_1)

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

Using Jython string:

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

Using Jython list:

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:

Using Jacl:

$AdminTask getTCPEndPoint {-interactive}

Using Jython string:

print AdminTask.getTCPEndPoint ('[-interactive]')

Using Jython list:

print 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

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

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

Using Jacl:

$AdminTask help createJ2CConnectionFactory

Using Jython string:

print AdminTask.help('createJ2CConnectionFactory')

Using Jython list:

print AdminTask.help('createJ2CConnectionFactory')

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

Using Jacl:

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

Using Jython string:

print AdminTask.listSSLRepertoires('SSL_3(cells/rohitbuildCell01/nodes/
rohitbuildNode01/servers/server2|server.xml#SSLInboundChannel_1093445762330)')

Using Jython list:

print AdminTask.listSSLRepertoires('SSL_3(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers
/server2|server.xml#SSLInboundChannel_1093445762330)')

Interactive mode example usage:

Using Jacl:

$AdminTask listSSLRepertoires {-interactive}

Using Jython string:

print AdminTask.listSSLRepertoires ('[-interactive]')

Using Jython list:

print AdminTask.listSSLRepertoires (['-interactive'])

listTAMSettings

Target object None.

Required parameters None.

Optional parameters None.

Examples Interactive mode example usage:

Using Jacl:

$AdminTask listTAMSettings {-interactive}

Using Jython string:

print AdminTask.listTAMSettings ('[-interactive]')

Using Jython list:

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

Using Jacl:

$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}

Using Jython string:

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

Using Jython list:

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:

Using Jacl:

$AdminTask listTCPEndPoints {-interactive}

Using Jython string:

print AdminTask.listTCPEndPoints ('[-interactive]')

Using Jython list:

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/rohitbuildCell01/nodes/rohitbuildCellManager01
/servers/dmgr|server.xml#TCPInboundChannel_1)

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask listTCPThreadPools 
{-interactive}

Using Jython string:

print AdminTask.listTCPThreadPools ('[-interactive]')

Using Jython list:

print AdminTask.listTCPThreadPools (['-interactive'])

reconfigureTAM

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

Target object None.

Required parameters None.

Optional parameters None.

Examples

Interactive mode example usage:

Using Jacl:

$AdminTask reconfigureTAM {-interactive}

Using Jython string:

AdminTask.reconfigureTAM ('[-interactive]')

Using Jython list:

AdminTask.reconfigureTAM (['-interactive'])

setResourceProperty

Use the setResourceProperty command to 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

- propertyName: The name of the property. (String, required)
- propertyValue: The value of a property. (String, required)

Optional parameters

- propertyType: The type of the property. The default value is java.lang.String. (String, optional)
- propertyDescription: The description of the defined property. (String, optional)

Sample output The command does not return output.

Examples

Batch mode example usage:

Using Jacl:

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

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask setResourceProperty {-interactive}

Using Jython string:

AdminTask.setResourceProperty ('[-interactive]')

Using Jython list:

AdminTask.setResourceProperty (['-interactive'])

showResourceProperties

Use the showResourceProperties command to 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 None.

Optional parameters

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

Sample output The command returns the property values that are defined on the resource provider or the connection factory that you specified.

Examples

Batch mode example usage:

Using Jacl:

$AdminTask showResourceProperties {-propertyName test.property}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask showResourceProperties {-interactive}

Using Jython string:

print AdminTask.showResourceProperties('[-interactive]')

Using Jython list:

print AdminTask.showResourceProperties(['-interactive'])

unconfigureTAM

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

Required parameters None.

Optional parameters None.

Examples

Interactive mode example usage:

Using Jacl:

$AdminTask unconfigureTAM {-interactive}

Using Jython string:

AdminTask.unconfigureTAM ('[-interactive]')

Using 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

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

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

AdminTask.updateAppOnCluster('[-interactive]')

Using 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 Reference