IBM DS6000 Computer Drive User Manual


 
34 IBM System Storage DS6000 Series: Copy Services with IBM System z
4.9 User assistance
The DS CLI is designed to include several forms of user assistance. The main form of user
assistance is accessed from the help command, such as:
help
Lists all available DS CLI commands.
help -s
Lists all DS CLI commands with a brief description of each.
help -l
Lists all DS CLI commands with syntax information.
If you are interested in more details about a specific DS CLI command, you can use -l (long)
or -s (short) against a specific command. In Example 4-4, the -s parameter is used to obtain
a short description of the purpose of the mkflash command.
Example 4-4 Use of the help -s command
dscli> help -s mkflash
mkflash The mkflash command initiates a point-in-time copy from source volumes to target
volumes.
In Example 4-5, the -l parameter is used to obtain a list of all parameters that can be used
with the mkflash command.
Example 4-5 Use of the help -l command
dscli> help -l mkflash
mkflash [ { -help|-h|-? } ] [-dev storage_image_ID] [-tgtpprc] [-tgtoffline] [-t
gtinhibit] [-freeze] [-record] [-persist] [-nocp] [-wait] [-seqnum Flash_Sequenc
e_Num] SourceVolumeID:TargetVolumeID ... | -
Man pages
A man page is available for every DS CLI command. Man pages are most commonly seen in
UNIX-based operating systems to give information about command capabilities. This
information can be displayed by issuing the relevant command followed by -h, -help, or -?,
for example:
dscli> mkflash -help
or
dscli> help mkflash
4 Server error The DS CLI server had an error.
5 Authentication error Password or user ID details are incorrect.
6 Application error The DS CLI application had an error.
Return code Category Description