[ Bottom of Page | Previous Page | Next Page | Contents | Index | Library Home |
Legal |
Search ]
Commands Reference, Volume 3
lsactdef Command
Purpose
Lists (displays) action definitions of a resource or resource class.
Syntax
lsactdef [-h] [-c] [-p property] [-s i | o] [-e] [-l | -i | -t | -d | -D delimiter] [-x] [-TV] [resource_class [action...]]
Description
The lsactdef command lists the action definitions of a resource
or resource class. Use lsactdef with no parameters specified to get
a list of all resource class names.
By default, the resource action definitions are displayed. To see the resource
class action definitions, specify the -c flag.
By default, when no actions are specified on the command line, only actions
that are defined as public are displayed. To override this default, use the -p flag or specify
on the command line the names of the actions whose definition you wish 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, for the actions that contain descriptions, the descriptions
are not displayed. Specify the -e flag to display the descriptions. Because the translation
of these descriptions may take some time and because some of the descriptions
are very long, the default is not to display these descriptions.
Flags
- -c
- Displays the resource class action definitions. By default the resource
action definitions are displayed.
- -d
- Specifies delimiter-formatted output. The default delimiter is a colon
(:). Use the -D flag if you wish 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
- Expands the descriptions. By default the definitions are displayed without
the textual descriptions because they can be lengthy. Specify this flag to see both the definitions and descriptions.
- -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 formatted output, 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 "ORed" 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 tabular formatted output. Each attribute is displayed in a
separate column, one resource per line.
- -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.
- -x
- Suppresses header printing.
Parameters
- action
- If a resource_class parameter is specified, zero or more action
names may be specified. If no action parameter is specified, the
definitions for all of the actions for the resource_class are listed.
Specific action names may be entered to control which actions are displayed
and in what order. Actions must be separated by spaces.
- resource_class
- Specifies the name of the resource class with the action definitions
that you want to display. If no resource_class parameter is specified,
a list of all of the resource class names is displayed.
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. See the RSCT Guide and Reference for information about the ACL file and
how to modify it.
Exit Status
- 0
- Command has run successfully.
- 1
- Error occurred with RMC.
- 2
- Error occurred with CLI script.
- 3
- Incorrect flag on command line.
- 4
- Incorrect parameter on command line.
- 5
- Error occurred with RMC that was based on faulty 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
- To list the names of all of the resource classes, enter:
lsactdef
Output is similar to:
class_name
"IBM.Association"
"IBM.AuditLog"
"IBM.AuditLogTemplate"
"IBM.Condition"
"IBM.EventResponse"
"IBM.Host"
"IBM.Program"
"IBM.Sensor"
"IBM.ManagedNode"
...
- To list the public resource action definitions for resource class IBM.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
....
- 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_index = 0
element_name = "MatchCriteria"
description = ""
element_data_type = "char_ptr"
display_name = ""
SD element 2:
element_index = 1
element_name = "IncludeDetail"
description = ""
element_data_type = "uint32"
display_name = ""
Location
- /usr/sbin/rsct/bin/lsactdef
- Contains the lsactdef command
Related Information
Commands: lsrsrcdef
Files: rmccli
Books: see the RSCT Guide and Reference for information about RMC operations
[ Top of Page | Previous Page | Next Page | Contents | Index | Library Home |
Legal |
Search ]