Server or storage agent help

Edit online

The server and storage agent both include a help facility. The help facility provides descriptions and syntax for server commands and a full description of server messages.

Accessing server or storage agent help for commands

Issue the HELP command to access help for the server or storage agent.

To display command-line help for server commands that have unique names, you can type help commandName, where commandName is the name of the server command for which you want information. For example, to display help for the REGISTER NODE command, type help register node. Command syntax and parameter descriptions are displayed in the output.

You can also type help followed by the topic number for the command. Topic numbers are listed in the table of contents for command-line help, for example:
3.0 Administrative commands
  3.46 REGISTER
     3.46.1 REGISTER ADMIN (Register an administrator)
     3.46.2 REGISTER LICENSE (Register a new license)
     3.46.3 REGISTER NODE (Register a node)
To display help about the REGISTER NODE command, type:
help 3.46.3

Use topic numbers to display command-line help for subcommands. DEFINE DEVCLASS is an example of a command that has subcommands. For example, you can specify the DEFINE DEVCLASS command for 3590 device classes and for 3592 device classes:

3.0 Administrative commands
  ...
  3.13.10 DEFINE DEVCLASS (Define a device class)
      3.13.10.1 DEFINE DEVCLASS (Define a 3590 device class)
      3.13.10.2 DEFINE DEVCLASS (Define a 3592 device class)
      ...
To display help for the DEFINE DEVCLASS command for 3590 device classes, type:
help 3.13.10.1

Accessing help for messages

Issue the help command to access help for messages.

Issue the following command for help on a server message: HELP message number, where message number is the message for which you want information. If you specify the message number without including the message prefix, for example HELP 4296, it assumes the message prefix ANR and reports the help information for ANR4296W. If the message number is specified with the prefix, for example HELP ANR4296, it reports the help information for that message. Issue HELP ANR4296 to view the following example output for that message:
ANR4296W A reclamation operation was started on offsite copy storage pool volumes. This
operation mightresult in data movement charges from your cloud storage provider.
Explanation: This operation reclaims data by using a cloud-container storage pool that is based
in the public cloud.When data is moved from a public cloud to an on-premises location, your
organization might incur datamovement charges from the cloud storage provider during reclamation
processing.
System Action: Server operation continues.
User Response: To help minimize data movement charges, you can disable reclamation for offsite
volumes on the copystorage pool. Issue the UPDATE STGPOOL command and specify the OFFSITERECLAIMLIMIT=0
parameter setting.

Command-line interface help for the client

The command-line client interface includes a help facility that provides descriptions and syntax for client commands and options and a full description of client messages.

Help information for the graphical user interface (GUI) and web GUI clients is available through the Help menu item.