Commands for AdminTask


 

+

Search Tips   |   Advanced Search

 

Use AdminTask to run admin commands with wsadmin.

We can start the scripting client without having a server running by using the -conntype NONE option with wsadmin.

AdminTask is available in both connected and local modes (-conntype NONE).

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 dmgr environment, configuration updates are available only if a scripting client is connected to a dmgr. When connected to a node agent or a managed appserver, we cannot update the configuration because the configuration for these server processes are copies of the master configuration, which resides in the dmgr.

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

 

configureTAM

Manually configure the TAM.

Jacl...

$AdminTask configureTAM {-interactive}

Jython...

AdminTask.configureTAM('-interactive')

 

createTCPEndPoint

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

Target object is the parent instance of the TransportChannelService that contains 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)

The command returns the object name of the endpoint created.

Jacl...

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

Use Jython string:

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

Use Jython list:

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

Jacl...

$AdminTask createTCPEndPoint {-interactive}

Jython...

AdminTask.createTCPEndPoint('-interactive')

 

getTCPEndPoint

Obtain the named end point that is associated with either a TCP inbound channel or a chain that contains a TCP inbound channel.

Target object is the TCPInboundChannel, or containing chain, instance that is associated with a NamedEndPoint. (ObjectName, required)

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.

Jacl...

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

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

Use Jython string:

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

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

Use Jython list:

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

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

Jacl...

$AdminTask getTCPEndPoint {-interactive}

Jython...

print AdminTask.getTCPEndPoint('-interactive')

 

help

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.

Optional parameters

-commands List available administrative commands.
-commandGroups List admin command groups
-commandName Help information for a given administrative command
-stepName Help information for a given step of an admin command

The command returns general command information for AdminTask.

The following command examples return general help information for AdminTask:

Jacl...

$AdminTask help

Jython...

print AdminTask.help()

The following command examples return display each command for AdminTask:

Jacl...

$AdminTask help -commands

Jython...

print AdminTask.help('-commands')

The following command examples return detailed command information createJ2CConnectionFactory...

Jacl...

$AdminTask help createJ2CConnectionFactory

Jython...

print AdminTask.help('createJ2CConnectionFactory')

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

Jacl...

$AdminTask help -commands *create*

Jython...

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

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

Jacl...

$AdminTask help -commands <pattern>

Jython...

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

 

listTAMSettings

Note: listSSLRepertoires displays the current embedded TAM configuration settings.

Jacl...

$AdminTask listTAMSettings {-interactive}

Jython...

print AdminTask.listTAMSettings('-interactive')

 

listTCPEndPoints

List all the named end points that can be associated with a TCP inbound channel.

Target object is TCP Inbound Channel instance for which named end points candidates are listed. (ObjectName, required)

Optional parameters...

-excludeDistinguished Show only non-distinguished named end points.

This parameter does not require a value. (Boolean, optional)

-unusedOnly Show the named end points not in use by other TCP inbound channel instances.

This parameter does not require a value. (Boolean, optional)

The command returns a list of object names for the eligible named end points.

Batch mode example usage:

Jacl...

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

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

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

Use Jython string:

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

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

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

Use Jython list:

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

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

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

Jacl...

$AdminTask listTCPEndPoints {-interactive}

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 is TCPInboundChannel or TCPOutboundChannel instance for which ThreadPool candidates are listed. (ObjectName, required)

The command returns a list of eligible thread pool object names.

Jacl...

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

Use Jython string:

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

Use Jython list:

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

Jacl...

$AdminTask listTCPThreadPools {-interactive}

Jython...

print AdminTask.listTCPThreadPools('-interactive')

 

modifyTAM

Modify embedded TAM settings.

Required parameters

-adminPasswd TAM administrator password. (String, required)

Optional parameters

-adminUid TAM user name. (String, optional)
-nodeName Target node or nodes. Set the value as the * asterisk character to specify all nodes. (String, optional)

Jacl...

$AdminTask modifyTAM {-adminPasswd my11password}

Jython...

AdminTask.modifyTAM('-adminPasswd my11password')

Use Jython list:

AdminTask.modifyTAM(['-adminPasswd', 'my11password'])

Jacl...

$AdminTask modifyTAM {-interactive}

Jython...

AdminTask.modifyTAM('-interactive')

 

reconfigureTAM

Reconfigure the JACC TAM settings.

Jacl...

$AdminTask reconfigureTAM {-interactive}

Jython...

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 is the configuration object ID of a resource provider or a connection factory.

Required parameters

-propertyName Name of the property. (String, required)
-propertyValue Value of a property. (String, required)

Optional parameters

-propertyType Type of the property. The default value is java.lang.String. (String, optional)
-propertyDescription Description of the defined property. (String, optional)

The command does not return output.

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

Jacl...

$AdminTask setResourceProperty {-interactive}

Jython...

AdminTask.setResourceProperty('-interactive')

 

showResourceProperties

List all of the property values 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.

Optional parameters

-propertyName Name of the property. If specify the property name, the value of the specified property name is returned. If we 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)

The command returns the property values defined on the resource provider or the connection factory specified.

Jacl...

$AdminTask showResourceProperties {-propertyName test.property}

Use Jython string:

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

Use Jython list:

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

Jacl...

$AdminTask showResourceProperties {-interactive}

Jython...

print AdminTask.showResourceProperties('-interactive')

 

unconfigureTAM

Remove configuration data for the JACC TAM.

Jacl...

$AdminTask unconfigureTAM {-interactive}

Jython...

AdminTask.unconfigureTAM('-interactive')

 

updateAppOnCluster

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 sas.client.props, when a JSR160RMI connecor 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.

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)

The command does not return output.

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

Jacl...

$AdminTask updateAppOnCluster -interactive

Jython...

AdminTask.updateAppOnCluster('-interactive')





 

Related tasks


Use AdminTask for scripted administration

 

Related


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