rmccli information file

Purpose

Provides general information about resource monitoring and control (RMC) and related commands.

Description

The general information about RMC and related commands, including data types, terminology, and references to related information follows.

Command structure and use

The RMC commands might be grouped into categories that represent the different operations that can be run on resource classes and resources:

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

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) commands.

Data display information

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

–l for long display. This flag is the default display format.

For example, the command:

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

produces the following output:

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}

–t for tabular display.

For example, the command:

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

produces the following output:

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"

–x for suppressing headers when printing.
–d for colon (:) delimited display.
For example, the command:
```
lsrsrc -xd -s 'Name == "c175n05"' IBM.Foo Name Int32 Uint32Array SD Binary 
```
produces the following output:
```
c175n05:-100:{}:["hel  lo1",1,{0,1,2}]:"0xaabbcc00 0xeeff":
```
Note the use of the –x flag along with the –d flag.
–Ddelimiter for string-delimited display.
For example, the command:
```
lsrsrc -xD:: -s 'Name == "c175n05"' IBM.Foo Name Int32 Uint32Array SD Binary 
```
produces the following output:
```
c175n05::-100::{}::["hel  lo1",1,{0,1,2}]::"0xaabbcc00 0xeeff"::
```
Note the use of the –x flag along with the –DDelimiter flag.

When output of any list command lsrsrc lsrsrcdef is displayed in the tabular output format, the printing column width might 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 for attributes of binary type can be entered in the following formats:

"0xnnnnnnnn 0x nnnnnnnn 0x nnnn..."
"0xnnnnnnnnnnnnnnnnnnn..."
0x nnnnnnnnnnnnnnnn...

Integer data for attributes of one of the integer types can be entered as:

A decimal constant that begins with a non-zero digit (Int32=45, for example)
An octal constant that begins with a prefix of 0, which is optionally followed by a combination of decimal numbers in the range 0 to 7 (Int32=055, for example)
A hexadecimal constant that begins with a prefix of 0x or 0X followed a combination of decimal numbers in the range a to f and A to F (Int32=0x2d, for example)

Be careful when you specify strings as input data. Strings that contain:

No white space or non-alphanumeric characters can be entered as input without enclosing quotation marks
White space or other alphanumeric characters must be enclosed in quotation marks
Single quotation marks (') must be enclosed by double quotation marks ("), as shown in this example: "this is a string with 'single quotation marks'"

Selection strings must be enclosed 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 about how to specify selection strings, see the Administering RSCT Guide.

Sample 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 structured data (SD) is supplied 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}]}

Arrays of any type with more than one element must be enclosed in quotation marks. For example:

mkrsrc IBM®.Foo Name=testing NodeList={1} Uint32Array='{1,2,3}'
mkrsrc IBM.Foo Name=testing NodeList='{1}' Uint32_array='{1,2,3}'

Arrays of strings and arrays of structured data must always be enclosed in quotation marks.

When arrays of structured data or arrays that contain strings enclosed in quotation marks are supplied 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, see the resource_data_input.

Data output formatting

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

A description attribute that equals the string "This is a string that contains white space" is displayed in the 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 that contains 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 nnnnnnnn 0x nnnnnnnn 0x nnnnnnnn 0x nnnnnnnn"

Naming conventions

The following variable names are used throughout the RMC command man pages:

Variable	Description
`attr`	The name of a resource class or a resource attribute
`resource_class`	The name of a resource class

Node groups

If Cluster Systems Management (CSM) is installed on your system, you can use CSM defined node groups as node name values to refer to more than one node. For information about working with CSM node groups and by using the CSM nodegrp command, see the CSM: Administration Guide and the CSM: Command and Technical Reference.

Terminology

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 a performance-related aspect of the resource class and resource. In the same resource class or resource, an attribute name can be specified as either persistent or dynamic, but not both.

resource

An entity in the system that provides a set of services. Examples of hardware entities are processors, disk drives, memory, and adapters. Examples of software entities are database applications, processes, and file systems. Each resource in the system has one or more attributes that define the state of the resource.

resource class

A broad category of system resource, for example: node, file system, adapter. Each resource class has a container that holds the functions, information, dynamic attributes, and conditions that apply to that resource class. For example, the /tmp space used condition applies to a file system resource class.

resource manager

A process that maps resource and resource-class abstractions into calls and commands for one or more specific types of resources. A resource manager can be a stand-alone daemon, or it can be integrated into an application or a subsystem directly.

To see all of the resource classes that are defined in the system, run the lsrsrc command without any flags or parameters. To see all of the resources that are defined in the system for the IBM.FileSystem resource class, enter:

lsrsrc IBM.FileSystem

selection string

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 can be listed in a selection string.

Flags

-h: Writes the command usage statement to standard output.
-T: Writes the command trace messages to standard error. For your software service organization use only.
-V: Writes the command verbose messages (if there are any available) to standard output.

All RMC commands include a -T flag and a -V flag. Use the -T flag only when your software service organization instructs you to turn on tracing. Trace messages are not translated. Use the -V flag, which indicates "verbose" mode, to see more information about the command. Verbose messages (if there are any available) are contained in message catalogs and are translated based on the locale in which you are running and other criteria.

Environment variables

CT_CONTACT

When the CT_CONTACT environment variable is set to a host name or IP address, the command contacts the resource monitoring and control (RMC) daemon on the specified host. If the environment variable is not set, the command contacts the RMC daemon on the local system where the command is being run. The resource class or resources that are displayed or modified by the command are on the system to which the connection is established.

CT_IP_AUTHENT

When the CT_IP_AUTHENT environment variable exists, the RMC daemon uses IP-based network authentication to contact the RMC daemon on the system that is specified by the IP address to which the CT_CONTACT environment variable is set. The CT_IP_AUTHENT environment variable is valid, if the CT_CONTACT environment variable is set to an IP address; it does not rely on the domain name system (DNS) service.

CT_MANAGEMENT_SCOPE

Determines the management scope that is used for the session with the RMC daemon to monitor and control the resources and resource classes. The management scope determines the set of possible target nodes where the resources and resource classes can be monitored and controlled. The valid values are:

0: Specifies local scope.
1: Specifies local scope.
2: Specifies peer domain scope.
3: Specifies management domain scope.

If this environment variable is not set, local scope is used.

Standard output

When the -h flag is specified, this command usage statement is written to standard output. When the -V flag is specified, these command verbose messages (if there are any available) are written to standard output.

Standard error

All trace messages are written to standard error.

Exit status

0: The command ran successfully.
1: An error occurred with RMC.
2: An error occurred with the command-line interface (CLI) script.
3: An incorrect flag was specified on the command line.
4: An incorrect parameter was specified on the command line.
5: An error occurred with RMC that was based on incorrect command-line input.
6: No resources were found that match the specified selection string.

Security

Permissions are specified in the access control list (ACL) file on the contacted system.

Implementation specifics

This information is part of the rsct.core.rmc fileset for AIX® and rsct.core-3.1.0.0-0.platform.rpm package for Linux®, Solaris, and Windows, where platform is i386, ppc, ppc64, s390, or x86_64.

Location

/opt/rsct/man/rmccli: /opt/rsct/man/rmccli.7 - For Linux platform.