WAS v8.5 > Reference > Commands (wsadmin scripting)

Commands for AdminTask using wsadmin.sh

Use AdminTask to run administrative commands with wsadmin.

Administrative commands are loaded dynamically when we start wsadmin. 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 wsadmin. 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, we can corrupt the configuration.

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

The createTCPEndPoint command creates 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

Specifies the 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 that was created.

Examples

Batch mode example usage:

Interactive mode example usage:


getTCPEndPoint

The getTCPEndPoint command obtains 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

:

Interactive mode example usage:


help

The help command provides a summary of the help commands and ways to invoke an administrative command. We 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 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 AdminTask.

Examples

Batch mode example usage:

The following command examples return general help information for AdminTask:

The following command examples display each command for AdminTask:

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

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

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


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

Whether to show only non-distinguished named end points. This parameter does not require a value. (Boolean, optional)

-unusedOnly

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:

Interactive mode example usage:


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:

Interactive mode example usage:


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

Interactive mode example usage:


Related


Use the wsadmin scripting AdminTask object for scripted administration


Reference:

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


+

Search Tips   |   Advanced Search