The -overview option of the repcli displays information about command modes, lists
command format requirements, and provides other command information..
Command modes
You can work with the Administrative CLI in one of three modes:
- Single-shot mode
- If you only want to run a single command, specify the CLI program and
command to execute at the shell prompt, for example:
shell> repcli startsess -session_name session1 shell>
- Interactive mode
- If you want to run several commands, start the CLI program and commands
to execute at the shell prompt, for example:
shell> repcli chsess session1 -desc "new description" -approve man>
startsess -session_name session1 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> repcli -script ~/bin/containersetup
shell>
 | Note: The MDM CLIs support and interpret comments specified
with a pound symbol (#) in the first column. |
Command output
Format options specified using the setoutput command will apply to all
commands in the file. Output from successful commands routes to stdout, and
output from the failed command routes to stderr. If an error occurs during
execution of one of the commands in the file, the script will exit at the
point of failure and return 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 (i.e., objects cannot be named -).
- Object names cannot begin with an underbar (_) and cannot consist of only
an underbar (i.e., objects cannot be named _).
- Objects cannot be named Period (.) or Colon (:).
- Object names cannot contain any white space.
- 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 they contain space(s).
- If a description, which is already enclosed in matching quotation marks,
includes an asterisk, the asterisk must be escaped.
- User-defined descriptions can be 256 characters or fewer. They cannot
contain any leading white space.
- User-defined descriptions should not be translated or otherwise modified
from what the user entered (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 listing (ls)
commands in the Administrative CLI. These parameters can be used either in
the listing 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 listing command (those commands
that start with ls) or using the setoutput command.
- -p specifies whether to display one page of text
at a time or all text at once.
- off displays all text at one time. This is the
default value when the repcli command is run in single-shot mode.
- on displays one page of text at time. Pressing any
key displays the next page. This is the default value when the command is
run in interactive mode.
- -r number 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.
- -fmt specifies the format of the output. You
can specify one of the following values:
- default specifies to display output in a tabular
format using spaces as the delimiter between the columns. This is the default
value.
- delim character specifies to display output 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.
- xml specifies to display output using XML format
- -hdr specifies whether to display the table header.
Use on to display the table header. This is the default
value. Use off to hide the table header.
- -v specifies whether to enable verbose mode.
Use off to disable verbose mode. This is the default
value. Use on to enables verbose mode.
Standard listing parameters
The standard listing parameters specify whether to display the default,
long, or short output for Administrative CLI listing commands. You can specify
these parameters in addition to the standard parameters available for the
listing commands. If you do not specify a listing parameter, the default
listing displays all objects and the most vital column information, for example:
Name User Role Authorization
=====================================
JohnDoe Admin Current
MaryBlack Backup Not Current
JimSmith Operator Current
TomJones Monitor Not Current
Syntax diagram conventions
To read syntax diagrams, follow the path of the line. Read from left to
right, and top to bottom.
- The >>-- symbol indicates the beginning of the syntax diagram.
- The --> symbol at the end of a line indicates that the syntax diagram
continues on the next line.
- The >-- symbol at the beginning of a line indicates that the syntax diagram
continues from the previous line.
- The -->< symbol indicates the end of the syntax diagram.
- 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
appears 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 appears 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 may lead to an irrecoverable operation, loss of data, memory
drain, long-running task, or impact to concurrent operations, users receive
an interactive confirmation prompt that asks if they are sure they 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 help command or the command-help parameters.
The help command allows you to display a list of available commands.
You can use the command-help parameters supported by each command to display
a detailed description of the specified command. The following help parameters
are supported:
-?
-h
-help
 | Note: When you use a help parameter, all other parameters
are ignored. |