Overview of the perfcli command MDM commands -overview -overviewOverview of the repcli command

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: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:

User-defined descriptions

The requirements for valid user-defined descriptions are:

Modifying command input

These commands modify command input:

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.

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.

Syntax diagrams use position to indicate required, optional, and default values for keywords, variables, and operands:

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:Note: When you use a help parameter, all other parameters are ignored.

(C) Copyright International Business Machines Corporation 2004