You are here: PS Series CLI Reference > Introduction to the CLI > Getting Help on the CLI

Getting Help on the CLI

To obtain help on a CLI command, type help and the command. You can also enter a command and then type a space (required) and a question mark (?), which displays all possibilities for what you can enter next on the command line.

The following examples show both ways of getting help.

> help alerts

alerts - Displays and manages event notification methods.

select - Selects an event notification method.

show   - Displays the event notification methods and priorities, if any.

> volume rename ?

<currentname>      - Current volume name.

> member select ?

<name>             - Name of the member to select.

> member select ps12 ?

cancel-operation - Cancels an in-progress operation.

controller-safe - Enables or disables controller-safe mode for the

                       selected member. If enabled, operates in write-

                       through mode to ensure data integrity.

def-gateway - Sets a default gateway for the member.

delay-data-move - Enables or disables (default) a delay before using

                       member storage until initial RAID verification

                       completes and batteries are fully charged.

description - Sets a description for the member.

disk - Displays information about one or more disks or

                       adds disks.

eth - Selects a network interface to configure, modify,

                       or display.

locate - Enables or disables blinking of LEDs on front and

                       back panel. Used to locate the member.

low-battery-safe - Enables or disables low-battery-safe mode for the

                       selected member.

pool - Assigns member to a pool.

raid-policy - Configures the RAID set.

show - Displays detailed information about a member or a

                       specific component.

<cr>

CLI help messages have two components, as shown in the following example.

> member select ?

<name>           - Name of the member to select.

If the component to the left is in angle brackets (<>), it indicates that you must replace the variable. If the component to the left is not in angle brackets, it indicates that you must specify the parameter itself (and possibly a variable).