InfoCenter Home >
6: Administer applications >
6.6: Tools and resources quick reference >
6.6.0: About user assistance >
6.6.0.2: Command line administration >
6.6.0.2.2: WebSphere Control Program (wscp) >
6.6.0.2.2.2: Command syntax and usage >
6.6.0.2.2.2.10: Using the wscp help facility

6.6.0.2.2.2.10: Using the wscp help facility

You can access wscp online help in varying levels of detail. Either of the following commands displays a summary of syntax for the help facility.
C:\> wscp -c "Help"
wscp> Help

The following topics contain examples of how to obtain help:


Help on object types

To obtain help on an object type, use the following syntax:
object_type help  [operation [ -verbose ] ]

When no arguments are specified, this command displays a brief description of all valid operations for the object type. Depending on the argument specified, you can access help on the following:

  • The operation argument displays valid options for the specified operation.

  • The -verbose option provides details on the options for an operation.

For example, the following command requests help on the ApplicationServer object. The command displays the names and descriptions of all valid operations for that object type.

wscp> ApplicationServer help
The following actions are available for ApplicationServer
attributes	    Display the attributes of the object
containment	    Display the containment hierarchy for the object
create		    Create the specified object
defaults     Display or set attribute defaults
help		    Display this help message
list		    Display all the instances of this type
modify		    Modify the attributes of the specified object
operations	    List all the actions available on the object type
remove		    Remove the specified object
show		    Display the attributes of specified object
start		    Start the specified object
stop		    Stop the specified object

The following command displays help for the list operation of ApplicationServer object types:

wscp> ApplicationServer help list
ApplicationServer list [-constraint <attribute list>] [-recursive]

The following command displays verbose help for the list operation:

wscp> ApplicationServer help list -verbose
ApplicationServer list
The following options are available for list
[-constraint <attribute list>]	Display only objects
which satisfy the constraints
[-recursive]			Display subtype objects

The following command displays the valid options for the clone operation of ServerGroup objects:

wscp> ServerGroup help clone
ServerGroup clone <name> -cloneAttrs <attribute list> -node <name>

The following command displays verbose help for the clone operation:

wscp> ServerGroup help clone -verbose
ServerGroup clone <name> -cloneAttrs <attribute list> -node <name>
The following options are available for clone
-cloneAttrs <attribute list>    Attribute list for the clone
-node <name>                    Node name

Help on operations

To obtain help on an object type's operations, use the following syntax:
object_type operations

This command displays a list of all valid operations for the given object type.

The following examples display a list of all valid operations for the ServerGroup and EnterpriseApp object types:

wscp> ServerGroup operations
attributes clone containment create help list listClones modify operations remove removeClone show showAttrs start stop
wscp> EnterpriseApp operations
attributes containment create defaults help list modify operations remove show start stop install listmodules listnodes showdeploymentinfo

Help on attributes

To obtain help on an object type's attributes, use the following syntax:
object_type attributes [ -cloneOnly ]   [ -modelOnly ]  [ -optional ]
[ -readOnly ]  [ -readWrite ]  [ -repository ]  [ -required ]
[ -runtime ]   [ -server ]  [ -startup ]

When no options are specified, this command displays a list of all valid attributes for the given object type. Various options allow you to display a subset of attributes. The options are as follows:

  • -cloneOnly. Displays only those attributes associated with clones of the object type.

  • -optional. Displays only those attributes that do not require a value.

  • -readOnly. Displays only those attributes that can be read but not changed directly. An example of a read-only attribute is CurrentState.

  • -readWrite. Displays only those attributes that can be viewed and modified. A read/write attribute can be changed at any time, and the changes take effect immediately.

  • -repository. Displays only those attributes that are stored in the repository. (The values of some attributes are short-lived and therefore are not stored permanently, for example, a process ID.)

  • -required. Displays only those attributes for which values must be specified in order for an object to be created.

  • -runtime. Displays only those attributes that come into existence after an object has been started. Run-time attributes are read-only attributes not stored in the repository. Examples of run-time attributes are ProcessID and StartTime.

  • -server. Displays only those attributes that reside in a server (run-time attributes of a server, for example, the ProcessID attribute).

  • -startup. Displays only those attributes that can be changed while a server is running but do not take effect until the next time the object is started. Examples of startup attributes are Executable and Environment.

The following commands display all valid attributes of the Node and GenericServer object types:

wscp> Node attributes
Name FullName CurrentState DesiredState StartTime HostName HostSystemType ProcessId InstallRoot PathMap
wscp> GenericServer attributes
Name FullName CurrentState DesiredState StartTime ProcessId Environment SelectionPolicy Executable ExecutableActive CommandLineArgs CommandLineArgsActive EnvironmentActive UserId UserIdActive GroupId GroupIdActive WorkingDirectory WorkingDirectoryActive Umask UmaskActive Stdin StdinActive Stdout StdoutActive Stderr StderrActive MaxStartupAttempts ProcessPriority ProcessPriorityActive PingInterval PingTimeout PingInitialTimeout

The following command displays only required attributes of the DataSource and JDBCDriver object types:

wscp> DataSource attributes -required
Name
wscp> JDBCDriver attributes -required
Name ImplClass

The following command displays only those attributes of ApplicationServer objects that apply to server groups and clones.

wscp> ApplicationServer attributes -modelOnly
SelectionPolicy
wscp> ApplicationServer attributes -cloneOnly
Name FullName

See Printing an object's attributes for a custom Tcl procedure that provides a shortcut method of displaying various combinations of attributes for one or more objects.

Go to previous article: 6.6.0.2.2.2.9: Specifying object names Go to next article: 6.6.0.2.2.3: Advanced usage of wscp

 

 
Go to previous article: 6.6.0.2.2.2.9: Specifying object names Go to next article: 6.6.0.2.2.3: Advanced usage of wscp