Files Reference

rmccli General Information File

Purpose

Contains information global to the Resource Monitoring and Control (RMC) command-line interface (CLI).

Description

This man page provides global information for the Resource Monitoring and Control command-line interface, including data types, terminology and references to other related material.

Terminology

Common terminology used in the RMC CLI man pages:

Attribute

Attributes are either persistent or dynamic. A resource class is defined by a set of persistent and dynamic attributes. A resource is also defined by a set of persistent and dynamic attributes. Persistent attributes define the configuration of the resource class and resource. Dynamic attributes define a state or performance-related aspect of the resource class and resource. In the same resource class or resource, a given attribute name can be specified as either persistent or dynamic, but not both.

Resource

A resource is an instance of a resource class. Therefore, a resource contains instances of the persistent and dynamic attributes for the resource class. A resource of the class IBM.FileSystem contains the persistent and dynamic attributes that describe a particular file system.

Resource_class

A resource class is a collection of attributes that describe similar hardware or software entities. The IBM.FileSystem resource class, for example, consists of persistent and dynamic attributes that define existing file systems in a host. To see all of the resource classes defined in the system, issue the command lsrsrc without any flags or parameters. To see all of the IBM.FileSystem resources defined in the system, issue the command: lsrsrc IBM.FileSystem.

Selection_string

Specifies a selection string. All selection strings must be enclosed within either double or single quotation marks. If the selection string contains double quotation marks, enclose the entire selection string in single quotation marks. For example:

-s 'Name == "testing"'

-s 'Name ?= "test*"'

Only persistent attributes may be listed in a selection string. For information on how to specify selection strings, see "Using Expressions" in the chapter "Using the Monitoring Application" of the RSCT 2.2 Resource Monitoring and Control Guide and Reference.

Data display information

The flags that control the display function for the RMC CLI routines, in order of precedence, are:

1. -l for long display. This is the default display format.

   For example, the command:

   lsrsrc -s 'Name == "c175n05"' IBM.Foo Name NodeList SD Binary RH Int32Array

   produces output similar to:

   Persistent Attributes for Resource: IBM.Foo
   resource 1:
           Name       = "c175n05"
           NodeList   = {1}
           SD         = ["testing 1 2 3",1,{0,1,2}]
           Binary     = "0xaabbcc00 0xeeff"
           RH         = "0x0000 0x0000 0x00000000 0x00000000 0x00000000 0x00000000"
           Int32Array = {1,5,-10,1000000}

2. -t for tabular display.

   For example, the command:

   lsrsrc -s 'Name ?= "Page"' -t IBM.Condition Name EventExpression

   produces output similar to:

   Persistent Attributes for Resource: IBM.Condition
   
   Name                  EventExpression       
   "Page space out rate" "VMPgSpOutRate > 500" 
   "Page fault rate"     "VMPgFaultRate > 500" 
   "Page out rate"       "VMPgOutRate > 500"   
   "Page in rate"        "VMPgInRate > 500"    
   "Page space in rate"  "VMPgSpInRate > 500"  

3. -x for suppressing headers when printing.
4. -d for colon (:) delimited display.

   For example, the command:

   lsrsrc -xd -s 'Name == "c175n05"' IBM.Foo Name Int32 Uint32Array SD Binary 

   produces output similar to:

   c175n05:-100:{}:["hel  lo1",1,{0,1,2}]:"0xaabbcc00 0xeeff":

   Note the use of the -x flag along with the -d flag.

5. -D Delimiter for string-delimited display.

   For example, the command:

   lsrsrc -xD:: -s 'Name == "c175n05"' IBM.Foo Name Int32 Uint32Array SD Binary 

   produces output similar to:

   c175n05::-100::{}::["hel  lo1",1,{0,1,2}]::"0xaabbcc00 0xeeff"::

   Note the use of the -x flag along with the -D Delimiter flag.

When output of any list command (lsrsrc, lsrsrcdef) is displayed in the tabular output format, the printing column width may be truncated. If more characters need to be displayed (as in the case of strings) use the -l flag to display the entire field.

Data input formatting

Binary data may be input in the following formats:

• "0x######## 0x######## 0x####..."
• "0x###################..."
• 0x################...

Be careful when you specify strings as input data:

• Strings that contain no white space or non-alphanumeric characters may be supplied as input without enclosing quotation marks.
• Strings that contain white space or other alphanumeric characters must be enclosed in double quotation marks.
• Strings that contain single quotation marks (') must be enclosed by double quotation marks ("), as shown in this example: "this is a string with 'single quotations marks'"

Selection strings must be input in double quotation marks, unless the selection string itself contains double quotation marks, in which case the selection string must be enclosed in single quotation marks. For information on how to specify selection strings, see "Using Expressions" in the chapter "Using the Monitoring Application" of the RSCT 2.2 Resource Monitoring and Control Guide and Reference.

• Typical selection string input: "NodeNumber == 1".
• Selection string input where double quotation marks are part of the selection string: 'Name == "c175n05"'.

Structured data (SD) types must be enclosed in square brackets: [hello,1,{2,4,6,8}]

When supplying structured data (SD) as command-line input to the RMC commands, enclose the SD in single quotation marks: SD='[hello,1,{2,4,6,8}]'

Arrays of any type must be enclosed in braces {}:

• Array of integers: {-4, -3, -2, -1, 0, 1, 2, 3, 4}
• Array of strings: {abc, "do re mi", 123}
• Array of structured data: {[hello,1,{0,1,2,3}],[hello2,2,{2,4,6,8}]}

When supplying arrays of structured data or arrays containing strings enclosed in quotation marks as command-line input to the RMC commands, enclose the entire array in single quotation marks:

• Array of strings: mkrsrc IBM.Foo Name="c175n05" NodeList={1} StringArray='{"a string","a different string"}'
• Array of structured data: mkrsrc IBM.Foo Name="c175n05" NodeList={1} SDArray='{["string 1",1,{1,1}],["string 2",2,{1,2,3}]}'

For more examples, refer to the Resource Data Input file.

Data output formatting

String data is always displayed in either double or single quotation marks, as shown below:

• A description attribute that equals the string "This is a string that contains white space" is displayed using long format as:

  Description = "This is a string that contains white space"

• A description attribute value that equals an empty string "" is displayed in long format as:

  Description = "" 

• A description attribute value that equals a string that contains a new-line character at the end of the string is displayed in long format as:

  Description = "This string ends with a new - line character...
  	 "   

• A selection string containing double quotation marks is displayed in long format as:

  SelectionString = 'Name == "c175n05"'

• A name attribute value that equals the string "c175n05" is displayed in long format as:

  Name = "c175n05"

Binary data is displayed as follows:

"0x######## 0x######## 0x######## 0x###..."

Naming and numbering conventions

The following keywords are used throughout the RMC command man pages:

Attr

The name of a resource class or resource attribute.

Resource_class

The name of a resource class.

Command structure and use

The RMC commands may be grouped into categories representing the different operations that can be performed on resource classes and resources:

• Creating and removing: mkrsrc, rmrsrc
• Modifying: chrsrc, refrsrc
• Viewing definitions and data: lsrsrc, lsrsrcdef
• Viewing actions: lsactdef

The RMC commands can be run directly from the command line or called by user-written scripts. In addition, the RMC commands are used as the basis for higher-level commands, such as the Event Response Resource Manager (ERRM) command line interface.

Flags

-h

Writes the command's usage statement to standard output.

-T

Writes this command's trace messages to standard error. For your software-service organization's use only.

-V

Writes this command's verbose messages to standard output.

All RMC commands support a -V and -T flag. The -V flag is used to see additional information (verbose mode) regarding the command. Verbose messages are contained in message catalogs and are translated based on the locale in which you are running and other criteria.

Run a command with the -T flag only when the your software-service organization instructs you to turn on trace. Trace messages are not translated. The -T flag shows the calls and returns to and from the underlying Perl to C Extensions.

Related Information

The Resource Data Input file.

The RSCT 2.2 Resource Monitoring and Control Guide and Reference contains more information regarding RMC operations.