Commands

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

Administrative commands are loaded dynamically when you start wsadmin.sh.

We can start the scripting client without having a server running using the -conntype NONE option with wsadmin.sh. 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 you to substitute a previously set value for a variable in the command. For example:

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

Optional parameters None.

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

Examples

Batch mode example:

Interactive mode:


getTCPEndPoint

The getTCPEndPoint command obtains the named end point that is associated with either a TCP inbound channel or a chain containing 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:

Interactive mode:


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

Sample output The command returns general command information .

Examples

Batch mode example:

The following command examples return general help information :

The following command examples display each command :

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

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

Interactive mode:


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:

Interactive mode:


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

Interactive mode:


Related tasks

  • Use the wsadmin scripting AdminTask object for scripted administration
  • AdminSDKCmds
  • Application management
  • AdministrationReports
  • AuthorizationGroupCommands
  • JCAManagement
  • ChannelFrameworkManagement
  • ClusterConfigCommands
  • CoreGroupManagement
  • CoreGroupBridgeManagement
  • WSCertExpMonitorCommands
  • CertificateRequestCommands
  • ConfigArchiveOperations
  • IdMgrConfig
  • IdMgrRepositoryConfig
  • IdMgrRealmConfig
  • JDBCProviderManagement command group for AdminTask object
  • 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: WebSphere MQ link administrative commands
  • SIBAdminCommands: WebSphere MQ server administrative commands
  • SIBJMSAdminCommands
  • SIBWebServices
  • SignerCertificateCommands
  • SpnegoTAICommands group (deprecated)
  • SSLConfigCommands
  • SSLConfigGroupCommands group
  • DynamicSSLConfigSelections
  • TrustManagerCommands
  • UnmanagedNodeCommands
  • Utility
  • VariableConfiguration
  • WIMManagementCommands
  • WSGateway
  • WSNotificationCommands
  • KeySetGroupCommands
  • KeySetCommands
  • KeyReferenceCommands
  • WebServicesAdmin
  • JaspiManagement