You can select from three levels of online help for administrative commands.
Start the wsadmin tool.
The top-level help provides general information for the AdminTask object and associated commands. The second-level help provides information about all of the available administrative commands and command groups. The third-level help provides specific help on a command group, a command, or a step. Command group-specific help provides descriptions for the command group that you specify and the commands that belong to the associated group. Command-specific help provides description for the specified command, and associated parameters and steps. Step-specific help provides a description for the specified step and the associated parameters. For command and step-specific help, required parameters are marked with an asterisk (*) in the help output.
$AdminTask help
print AdminTask.help()
WASX8001I: The AdminTask object enables the execution of available admin
commands. AdminTask commands operate in two modes:
the default mode is one which AdminTask communicates with the WebSphere
server to accomplish its task. A local mode is also available, in which
no server communication takes place. The local mode of operation is
invoked by bringing up the scripting client using the command line
"-conntype NONE" option or setting the
"com.ibm.ws.scripting.connectiontype=NONE" property in
wsadmin.properties file.
The number of admin commands varies and depends on your WebSphere install.
Use the following help commands to obtain a list of supported commands
and their parameters:
help -commands Lists all the admin commands
help -commands <pattern> Lists admin commands matching with wildcard
"pattern"
help -commandGroups Lists all the admin command groups
help -commandGroups <pattern> Lists admin command groups matching with
wildcard "pattern"
help commandName Displays detailed information for the
specified command
help commandName stepName Displays detailed information for the specified
step belonging to the specified command
help commandGroupName Displays detailed information for the specified
command group
There are various flavors to invoke an admin command:
commandName Invokes an admin command that does not require
any argument.
commandName targetObject Invokes an admin command with the specified
target object string, for example, the
configuration object name of a resource
adapter. The expected target object varies
with the admin command invoked. Use help
command to get information on the target
object of an admin command.
commandName options Invokes an admin command with the specified
option strings. This invocation syntax is
used to invoke an admin command that does
not require a target object. It is also
used to enter interactive mode if
"-interactive" mode is included in the
options string.
commandName targetObject options Invokes an admin command with the specified
target object and options strings. If
"-interactive" is included in the options string,
then interactive mode is entered. The target
object and options strings vary depending on the
admin command invoked. Use help command to get
information on the target object and options.
$AdminTask help -commandGroups
print AdminTask.help('-commandGroups')
WASX8005I: Available admin command groups:
AdminAgentNode - Admin Agent Managed Node related tasks
AdminAgentSecurityCommands - Commands used to configure security related items during Admin Agent registration.
AdminReports - Admin configuration reports
AdminSDKCmds - Admin commands related to pluggable SDKs
AdministrativeJobs - This command group contains all the job management commands
.
AppManagementCommands - Application management commands.
...
$AdminTask help -commands
print AdminTask.help('-commands')
WASX8004I: Available administrative commands:
copyResourceAdapter - copy the specified J2C resource adapter to the specified scope
createCluster - Creates a new application server cluster.
createClusterMember - Creates a new member of an application server cluster.
createJ2CConnectionFactory - Create a J2C connection factory
deleteCluster - Delete the configuration of an application server cluster.
deleteClusterMember - Deletes a member from an application server cluster.
listConnectionFactoryInterfaces - list all of the
defined connection factory interfaces on the
specified J2C resource adapter.
listJ2CConnectionFactories - List J2C connection factories that have a specified
connection factory interface defined in the specified J2C resouce adapter
createJ2CAdminObject - Create a J2C administrative object.
listAdminObjectInterfaces - List all the defined administrative object interfaces
on the specified J2C resource adapter.
interface on the specified J2C resource adapter.
listJ2CAdminObjects - List the J2C administrative objects that have a specified
administrative object interface defined in the specified J2C resource adapter.
createJ2CActivationSpec - Create a J2C activation specification.
listMessageListenerTypes - list all of the defined messageListener
type on the specified J2C resource adapter.
listJ2CActivationSpecs - List the J2C activation specifications that have a
specified message listener type defined in the specified J2C resource adapter.
$AdminTask help JCAManagement
print AdminTask.help('JCAManagement')
WASX8007I: Detailed help for command group: JCAManagement
Description: A group of administrative commands that help to
configure Java 2 Connector Architecture (J2C)-related resources.
Commands:
createJ2CConnectionFactory - Create a J2C connection factory
listConnectionFactoryInterfaces - list all of the defined connection
factory interfaces on the specified J2C resource adapter.
listJ2CConnectionFactories - List J2C connection factories that have
a specified connection factory interface defined in the
specified J2C resouce adapter.
createJ2CAdminObject - Create a J2C administrative object.
listAdminObjectInterfaces - List all the defined administrative
object interfaces on the specified J2C resource adapter.
listJ2CAdminObjects - List the J2C administrative objects that have a
specified administrative object interface defined in the
specified J2C resource adapter.
createJ2CActivationSpec - Create a J2C activation specification.
listMessageListenerTypes - list all of the defined
message listener types on the specified J2C resource adapter.
listJ2CActivationSpecs - List the J2C activation specifications that
have a specified message listener type defined in the
specified J2C resource adapter.
copyResourceAdapter - copy the specified J2C resource
adapter to the specified scope.
$AdminTask help createJ2CConnectionFactory
print AdminTask.help('createJ2CConnectionFactory')
WASX8006I: Detailed help for command: createJ2CConnectionFactory
Description: Create a J2C connection factory
*Target object: The parent J2C resource adapter of the created J2C connection factory.
Arguments:
*connectionFactoryInterface - A connection factory interface that is defined in the deployment
description of the parent J2C resource adapter.
*name - The name of the J2C connection factory.
*jndiName - The JNDI name of the created J2C connection factory.
description - The description for the created J2C connection factory.
authDataAlias - the authentication data alias of the created J2C connection factory.
Steps:
None
-connectionFactoryInterface javax.resource.cci.ConnectionFactory -name newConnectionFactory
-jndiName CF/newConnectionFactory
See Administrative command invocation syntax using wsadmin scripting for more information about specifying argument options.The following example obtains help on a command step:
$AdminTask help createCluster clusterConfig
print AdminTask.help('createCluster', 'clusterConfig')
WASX8013I: Detailed help for step: clusterConfig
Description: Specifies the configuration of the new server cluster.
Collection: No
Arguments:
*clusterName - Name of server cluster.
preferLocal - Enables node-scoped routing optimization for the cluster.
Using Jacl:
-clusterConfig {{newCluster false}}
Using Jython:
-clusterConfig [[newCluster false]]
See Administrative command invocation syntax using wsadmin scripting for more information about specifying parameter options.You can use a regular Java expression pattern or a wildcard pattern to specify command name for AdminTask.help('–commands') and AdminConfig list, types, and listTemplates functions.
print AdminTask.help("-commands", "create.*")
print AdminTask.help("-commands", "create*")
print AdminTask.help("-commands", ".*SSLConfig.*")
print AdminTask.help("-commands", "*SSLConfig*")