InfoCenter Home > 6.6.0.2.2.2.10: Using the wscp help facilityYou 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 typesTo 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:
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 operationsTo 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 attributesTo 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:
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. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|