Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)


Commands using wsadmin.sh

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

Administrative commands are loaded 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 the product that you use.

We can start the scripting client without having a server running by 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 you save a conflicting configuration, you 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 application server, you cannot update the configuration because the configuration for these server processes are copies of the master configuration, which resides in the dmgr. The copies are created on a node machine when a configuration synchronization occurs between the dmgr and the node agent. Make configuration changes to the server processes by connecting a scripting client to a dmgr.

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: 

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 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 endpoint. (String, required)

-host

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

Examples


Batch example...


Interactive example...



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


Interactive example...



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.


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

Sample output The command returns general command information .

Examples


Batch example...:

The following command examples return general help information for the AdminTask object:

The following command examples display each command for the AdminTask object:

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 that contains 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 example...:


Interactive example...



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


Interactive example...



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

Sample output The command does not return output.

Examples


Batch example...


Interactive example...


Use the wsadmin scripting AdminTask object for scripted administration


Related


AdminSDKCmds command group
Application management command group
AdministrationReports command group using wsadmin.sh
AuthorizationGroupCommands command group
JCAManagement command group
ChannelFrameworkManagement command group
ClusterConfigCommands command group
CoreGroupManagement command group
CoreGroupBridgeManagement command group
WSCertExpMonitorCommands command group
CertificateRequestCommands command group of the AdminTask object
ConfigArchiveOperations command group using wsadmin.sh
IdMgrConfig command group
IdMgrRepositoryConfig command group
IdMgrRealmConfig command group
JDBCProviderManagement command group for AdminTask object
keyManagerCommands command group
KeyStoreCommands command group
ManagedObjectMetadata command group
ManagementScopeCommands command group
NodeGroupCommands command group using wsadmin.sh
WSNotifierCommands command group
PersonalCertificateCommands command group
PolicySetManagement command group
PortManagement command group
Provider command group
DescriptivePropCommands command group
WSScheduleCommands command group of the AdminTask object
ServerManagement command group
ResourceManagement command group
TAMConfig command group
SIBAdminBusSecurityCommands command group
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 command group
SIBWebServices command group
SignerCertificateCommands command group
SpnegoTAICommands group (deprecated)
SSLConfigCommands command group
SSLConfigGroupCommands group
DynamicSSLConfigSelections command group
TrustManagerCommands command group
UnmanagedNodeCommands command group using wsadmin.sh
Utility command group of the AdminTask object
VariableConfiguration command group
WIMManagementCommands command group
WSGateway command group
WSNotificationCommands command group
KeySetGroupCommands command group
KeySetCommands command group
KeyReferenceCommands command group
WebServicesAdmin command group
JaspiManagement command group

+

Search Tips   |   Advanced Search