IBM XIV STORAGE SYSTEM, User Manual

Page: 147 / 652

Parameters:
Name Type Description Mandatory Default
category String Category name. N N/A
search String Search string. N N/A
command String Command name. N N/A
format Enumeration Output format for
command help. N short.
This command prints the help as follows:
v
No parameters - Lists all the commands with their short descriptions, grouped
by categories.
v Category - Lists all the commands in the category, with their short descriptions.
v
Search - Lists the short descriptions of all the commands in which the search
string appears in their name or short description.
v
Command with short output (default for command) - Prints the command name
and short description.
v
Command with full output (default when used in XIV-internal mode) - Prints
the command name, short description, syntax, list of parameters and their
description, types and default values. If output is table, prints all possible table
columns.
Example:
help category=volume
Output:
Category Name Description
volume vol_by_id Prints the volume name given its SCSI
serial number
volume vol_copy Copies a source Volume onto a target Volume.
volume vol_create Creates a new volume.
volume vol_delete Deletes a Volume
volume vol_format Formats a Volume.
volume vol_list Lists all Volumes, or a specific one.
volume vol_lock Locks a Volume, so that it is read-only.
volume vol_rename Renames a Volume
volume vol_resize Resize a Volume
volume vol_unlock Unlocks a Volume, so that it is no longer read-only,
and can be written to.
Id Name Default Position
category Category 1
name Name 2
access_control Access Control N/A
syntax Syntax N/A
Chapter 9. System Management
141