The -overview option of the perfcli command displays information
about command modes and lists command format requirements.
Command modes
You can work with the administrative command-line interface (CLI) in one
of three modes:
- Single-shot mode
- If you want to run only a single command, specify the CLI program and
the command to run at the shell prompt, for example:
shell> perfcli settrace -devtype ess -dev ESS2105-123123-IBM -desc "New
Task" -sample 30 -interval 5 task_name return values
shell>
- Interactive mode
- If you want to run several commands, start the CLI program and then
specify the commands at the program prompt, for example:
shell> perfcli perfcli> setoutput -v on perfcli> setthresh -threshtype iorate -devtype ess -dev ESS2105-123123-
IBM
-status on
return values (verbose)
-
perfcli> exit
shell>
- Script mode
- If you want to run a set of commands that you defined in a file, start
the CLI program and specify a file that contains the commands, for example:
shell> perfcli -script ~/bin/containersetup
shell>
 | Note: The Multiple Device Manager (MDM) CLIs support and interpret
comments specified with a pound symbol (#) in the first column. |
Command output
Format options that you specify using the setoutput command
apply to all commands in the file. Output from successful commands routes
to stdout, and output from failed commands routes to stderr. If an error occurs
while one of the commands is running, the script exits at the point of failure
and returns to the system prompt.
Object naming guidelines
The requirements for valid user-defined object names are:
- Object names must contain at least one alphanumeric character. The name
must also start with an alphanumeric character.
- Object names cannot begin with a dash (-) and cannot consist of only a
dash (for example, objects cannot be named -).
- Object names cannot begin with an underscore (_) and cannot consist of
only an underscore (for example, objects cannot be named _).
- Objects cannot be named period (.) or colon (:).
- Object names cannot contain any blank spaces.
- User-defined object names can be 250 characters or fewer, unless otherwise
noted.
- User-defined objects should not be translated or otherwise modified from
what the user entered (they should remain case-sensitive).
User-defined descriptions
The requirements for valid user-defined descriptions are:
- Description strings must be enclosed in (matching) single or double quotation
marks, if the description contains spaces.
- If a description that is already enclosed in matching quotation marks
includes an asterisk, the asterisk must be escaped.
- User-defined descriptions can be a maximum of 256 characters. They cannot
contain any leading white space.
- User-defined descriptions should not be translated or otherwise modified
(they should remain case-sensitive).
Modifying command input
These commands modify command input:
- Use of "-f" forces destructive action, such as make a volume even
if the LUN already has a label; suppresses confirmation and error messages.
- Use of "-quiet" suppresses confirmation prompts and messages (answers "yes" to all confirmation prompts).
Standard format parameters
The standard format parameters set the output format of the list commands
(those commands that start with ls) in the administrative CLI.
These parameters can be used either in the list command syntax or in the setoutput command. The format settings remain in effect
for the duration of the session or until you reset the parameters either by
specifying these parameters in a list command or using the setoutput command.
- The -p parameter specifies whether to display one
page of text at a time or all text at once.
- The off parameter displays all text at one time.
This is the default value when the perfcli command is
run in single-shot mode.
- The on parameter displays one page of text at a
time. Pressing any key displays the next page. This is the default value when
the command is run in interactive mode.
- The -r number parameter
specifies the number of rows per page to display when the -p parameter is on. The default is 24 rows. You can specify a value from
1 to 100.
- The -fmt parameter specifies the format of the output.
You can specify one of the following values:
- The default parameter specifies that output should
be displayed in a tabular format using spaces as the delimiter between the
columns. This is the default value.
- The delim character parameter specifies that output
should be displayed in a tabular format using the specified character to separate
the columns. If you use a shell metacharacter as the delimiting character,
enclose the character in single or double quotation marks. A blank space is
not a valid character.
- The xml parameter specifies that output should
be displayed using XML format.
- The -hdr parameter specifies whether to display
the table header. Use the on parameter to display the
table header. This is the default value. Use off parameter
to hide the table header.
- The -v parameter specifies whether to enable verbose
mode. Use the off parameter to disable verbose mode.
This is the default value. Use the on parameter to enables
verbose mode.
Standard list parameters
The standard list parameters specify whether to display the default, long,
or short output for administrative CLI list commands. You can specify these
parameters in addition to the standard parameters available for the list commands.
If you do not specify a list parameter, the default listing displays all objects
and the most vital column information as in this example:
Name User Role Authorization
=====================================
JohnDoe Admin Current
MaryBlack Backup Not Current
JimSmith Operator Current
TomJones Monitor Not Current
Syntax diagrams
To read syntax diagrams, follow the path of the line. Read from left to
right, and top to bottom.
- The main path line begins on the left with double arrowheads (>>) and
ends on the right with two arrowheads facing each other (><).
- If a diagram is longer than one line, each line to be continued ends with
a single arrowhead (>) and the next line begins with a single arrowhead.
- A dash (-) indicates that you want to supply parameters from stdin rather
than entering parameters.
- An arrow returning to the left means you can repeat the item.
- A character or space within the arrow means you must separate repeated
items with that character or space.
- A stack of items followed by an arrow returning to the left means that
you can select more than one item or, in some cases, repeat a single item.
- Commands that contain lengthy groups or a section that is used more that
once in a command are shown as separate fragments following the main diagram.
The fragment name appears between vertical bars in the diagram. The expanded
fragment also appears between vertical bars after the heading with the same
fragment name.
- Italicized, lowercase elements denote variables.
Syntax diagrams use position to indicate required, optional, and default
values for keywords, variables, and operands:
- On the line (required element)
- Above the line (default element)
- Below the line (optional element)
- Default values are above the main line. If the default is a keyword, it
is shown only above the main line. You can specify this item or allow it to
default. In the following example, the keyword A is the default. You can override
it by choosing B or C. You can also specify the default value explicitly.
- If an operand has a default value, the operand appears both above and
below the main line. A value below the main line indicated that if you specify
the operand, you must also specify either the default value or another value
shown. If you do not specify an operand, the default value above the main
line is used.
- When one or more items are below the main line, all of the items are optional.
- When a keyword, variable, or operand is shown on the main line, you must
specify that item.
- When two or more items are in a stack and one of them is on the main line,
you must specify one item.
Confirmation prompts
When commands might lead to an irrecoverable operation, loss of data, memory
drain, long-running task, or impact to concurrent operations, you receive
an interactive confirmation prompt that asks if you are sure that you want
to continue with the specific action, such as, Are you sure you want
to xxx? Y/N. All confirmation prompts accept the following input: YES, yes, Y, y, or NO, no, N, n.
User assistance for commands
You can get user assistance for the commands that are available in the
administrative CLI using the helpcommand or the command-help parameters. The help command
enables you to display a list of available commands.
You can use the command-help parameters that are
supported by each command to display a detailed description of the specified
command. You can use the following help parameters:
-?
-h
-help
 | Note: When you use a help parameter,
all other parameters are ignored. |