[ Bottom of Page | Previous Page | Next Page | Contents | Index | Library Home | Legal | Search ]

Commands Reference, Volume 3, i - m

lsactdef Command

Purpose

Displays the action definitions of a resource or a resource class.

Syntax

To display the action definitions of a resource:

lsactdef [-p property] [-s i | o] [-e] [-a] [-l | -i | -t | -d | -D delimiter] [-x] [-h] [-TV] resource_class [action1 [action2...]]

To display the action definitions of a resource class:

lsactdef -c [-p property] [-s i | o] [-e] [-a] [-l | -i | -t | -d | -D delimiter] [-x] [-h] [-TV] resource_class [action1 [action2...]]

To display all resource class names:

lsactdef

Description

The lsactdef command displays a list of the action definitions of a resource or a resource class. By default, this command displays the action definitions of a resource. To see the action definitions of a resource class, specify the -c flag.

If you do not specify any actions on the command line, this command only displays actions that are defined as public. To override this default, use the -p flag or specify on the command line the names of the actions that have definitions you want to display.

To see the structured data definition that is required as input when this action is invoked, specify the -s i flag. To see the structured data definition linked with the output that results from invoking this action, specify the -s o flag.

By default, this command does not display action descriptions. To display action definitions and descriptions, specify the -e flag.

Flags

-a
Specifies that this command applies to all nodes in the cluster. The cluster scope is determined by the CT_MANAGEMENT_SCOPE environment variable. If it is not set, first the management domain scope is chosen if it exists, then the peer domain scope is chosen if it exists, and then local scope is chosen, until the scope is valid for the command. The command will run once for the first valid scope found. For example, if both a management and peer domain exist, lsactdef -a with CT_MANAGEMENT_SCOPE not set will list the management domain. In this case, to list the peer domain, set CT_MANAGEMENT_SCOPE to 2.
-c
Displays the action definitions for resource_class.
-d
Specifies delimiter-formatted output. The default delimiter is a colon (:). Use the -D flag if you want to change the default delimiter.
-D delimiter
Specifies delimiter-formatted output that uses the specified delimiter. Use this flag to specify a delimiter other than the default colon (:). An example is when the data to be displayed contains colons. Use this flag to specify a delimiter of one or more characters.
-e
Specifies expanded format. Displays descriptions along with the action definitions.
-i
Specifies input format. Generates a template of the Resource_Data_Input file. The output is displayed in long (stanza) format. The attribute's SD element data types are displayed as the value in the attr=value pairs. It is suggested that when you use this flag, the output of the lsactdef command be directed to a file. This flag overrides the -s o flag.
-l
Specifies "long" format -- one entry per line. This is the default display format. If the lsactdef command is issued with the -l flag, but without a resource class name, the -l flag is ignored when the command returns the list of defined resource class names.
-p property
Displays actions with the specified property. By default, only the definitions for public actions are displayed. To display all action definitions regardless of the action property, use the -p 0 flag.

Action properties:

0x0001
long_running
0x0002
public

A decimal or hexadecimal value can be specified for the property. To request the action definitions for all actions that have one or more properties, "OR" the properties of interest together and then specify the "OR"ed value with the -p flag. For example, to request the action definitions for all actions that are long_running or public, enter: 

-p 0x03
-s i | o
Displays the structured data definition for the action input or action response.
i
Displays the action input structured data definitions. This is the default.
o
Displays the action response (output) structured data definitions.
-t
Specifies table format. Each attribute is displayed in a separate column, with one resource per line.
-x
Suppresses header printing.
-h
Writes the command's usage statement to standard output.
-T
Writes the command's trace messages to standard error. For your software-service organization's use only.
-V
Writes the command's verbose messages to standard output.

Parameters

resource_class
Specifies the name of the resource class with the action definitions that you want to display. If resource_class is not specified, a list of all of the resource class names is displayed.
action1 [action2...]
Specifies one or more actions. If resource_class is specified, zero or more action names can be specified. If no actions are specified, all of the action definitions for resource_class are displayed. Enter specific action names to control which actions are displayed and in what order. Use blank spaces to separate action names.

Security

The user needs read permission for the resource_class specified in lsactdef to run lsactdef. Permissions are specified in the access control list (ACL) file on the contacted system.

Exit Status

0
The command has run 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.

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 located on the system to which the connection is established.
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's usage statement is written to standard output. All verbose messages are written to standard output.

Standard Error

All trace messages are written to standard error.

Examples

  1. To list the names of all of the resource classes, enter: 
    lsactdef
    The output will look like this: 
    class_name
"IBM.Association"     
"IBM.AuditLog"        
"IBM.AuditLogTemplate"
"IBM.Condition"       
"IBM.EventResponse"   
"IBM.Host"            
"IBM.Program"         
"IBM.Sensor"          
"IBM.ManagedNode"     
...
  2. To list the public resource action definitions for resource class IBM(R).AuditLog, enter: 
    lsactdef IBM.AuditLog
    The output will look like this: 
    Resource Action Definitions for
class_name: IBM.AuditLog
action 1:
        action_name    = "GetRecords"
        display_name   = ""
        description    = ""
        properties     = {"public"}
        confirm_prompt = ""
        action_id      = 0
        variety_list   = {{1..1}}
        variety_count  = 1
        timeout        = 0
action 2:
        action_name    = "DeleteRecords"
        display_name   = ""
        description    = ""
        properties     = {"public"}
        confirm_prompt = ""
        action_id      = 1
        variety_list   = {{1..1}}
        variety_count  = 1
        timeout        = 0
....
  3. To list the structured data definition required for invoking the action on resources in resource class IBM.AuditLog, action GetRecords, enter: 
    lsactdef -s i IBM.AuditLog GetRecords
    The output will look like this: 
    Resource Action Input for: IBM.AuditLog
action_name GetRecords:
sd_element 1:
        element_name      = "MatchCriteria"
	display_name      = ""
	description       = ""
        element_data_type = "char_ptr"
	element_index     = 0 
sd_element 2:
        element_name      = "IncludeDetail"
	display_name      = ""
	description       = ""
        element_data_type = "uint32"
        element_index     = 1

Location

/usr/sbin/rsct/bin/lsactdef
Contains the lsactdef command

Related Information

Commands: lsrsrcdef

Files: rmccli

[ Top of Page | Previous Page | Next Page | Contents | Index | Library Home | Legal | Search ]