@botname automation-resource

This command is used to operate on automation resource to show status, members, relations, requests or restart, start, stop, suspend, resume resources.

Syntax

Read syntax diagramSkip visual syntax diagram@ botnameautomation-resourcearliststatusresource_name--domain-name--dndomain_name--system-name--snsystem_name--compound-state--csokwarningerrorfatal--observed-state--osunknownavailableunavailablestoppingstarting--resource-type--rtaplapgmtrreflistmembermember_name--domain-name--dndomain_name--system-name--snsystem_nameresources-name--rnresource_namerelationtarget--domain-name--dndomain_name--system-name--snsystem_nameresources-name--rnresource_namerequestrequested_action_name--domain-name--dndomain_name--system-name--snsystem_nameresources-name--rnresource_namecancelrequestrequested_action_name--domain-name--dndomain_name--system-name--snsystem_nameresources-name--rnresource_namerestartresourceresource_name--domain-name--dn--system-name--snsystem_name--commentcomment--overridealldpyflgststrgsusno--prioritylowhighforce--removeavailabledegradedsysgoneunknownno*--scopeallonlychildren--typenormimmedforce--interruptyesnostartresourceresource_name--domain-name--dn--system-name--snsystem_name--commentcomment--overridealldpyflgststrgsusno--prioritylowhighforce--removeavailabledegradedsysgoneunknownno*--scopeallonly--typenormuserstopresourceresource_name--domain-name--dn--system-name--snsystem_name--commentcomment--overridealldpyflgststrgsusno--prioritylowhighforce--removeavailabledegradedsysgoneunknownno*--scopeallonlychildren--typenormimmedforce--interruptyesnosuspendresourceresource_name--domain-name--dn--system-name--snsystem_name--commentcomment--removesysgoneno*--scopeallonlyresumeresourceresource_name--domain-name--dndomain_name--system-name--snsystem_nameresetresourceresource_name--domain-name--dndomain_name--system-name--snsystem_name--limitnumber--json-format--jf

Usage

list
Shows the status of automation resources. If you do not specify any action, this action is the default action.
status
Shows the status or details of the automation resources. If you do not specify any object, this object is the default object. To narrow down returned results, you can specify the following positional argument.
resource_name
This argument is OPTIONAL. It specifies the name of the target resource that you want to show. Wildcard character * is supported. This positional argument resource_name follows a pattern in command as resource_name/resource_type/system_name, where system_name is optional here, for example, AM2/APG/AOBC and AM2/APG both work.
You can also specify the following options.
--domain-name|--dn domain_name
This option is REQUIRED. It specifies the domain name of target resource to narrow down the result.
--system-name|--sn system_name
This option is OPTIONAL. It specifies the system name of target resource to narrow down the result. If you specified the system name in the positional argument resource_name above, you don't have to specify this option again here, otherwise it will be ignored.
--compound-state|--cs ok|warning|error|fatal
This option is OPTIONAL. It specifies the compound state of the target resource to narrow down the result.
--observed-state|--os unknown|available|unavailable|stopping|starting
This option is OPTIONAL. It specifies the compound state of the target resource to narrow down the result.
--resource-type|--rt apl|apg|mtr|ref
This option is OPTIONAL. It specifies the resource type of target resource to narrow down the result. You can only choose among apl, apg, mtr, and ref. If you specified the resource type in the positional argument resource_name above, you don't have to specify this option again here, otherwise it will be ignored.
apl
Filters out resource whose type is application.
apg
Filters out resource whose type is application group.
mtr
Filters out resource whose type is monitor.
ref
Filters out resource whose type is reference.
list
Shows the member, relation or request of automation resources.
member
Shows all members of one automation resource. To narrow down returned results, you can specify the following positional argument.
member_name
This argument is OPTIONAL. It specifies the name of the target member that you want to show. Wildcard character * is supported. This positional argument member_name follows a pattern in command as member_name/resource_type/system_name, where system_name is optional here, for example, AM2/APG/AOBC and AM2/APG both work.
You can also specify the following options.
--resource-name|--rn resource_name
This option is REQUIRED. It specifies the application group name of target resource to narrow down the result. This option resource_name follows a pattern in command as resource_name/resource_type/system_name, where system_name is optional here, for example, AM2/APG/AOBC and AM2/APG both work.
--domain-name|--dn domain_name
This option is REQUIRED. It specifies the domain name of target resource to narrow down the result.
--system-name|--sn system_name
This option is OPTIONAL. It specifies the system name of target resource to narrow down the result. If you specified the system name before, you don't have to specify this option again here, otherwise it will be ignored.
relation
Shows all relations of one automation resource. To narrow down returned results, you can specify the following positional argument.
target
This argument is OPTIONAL. It specifies the name of the target relations that you want to show. Wildcard character * is supported. This positional argument target follows a pattern in command as target_name/resource_type/system_name, where system_name is optional here, for example, AM2/APG/AOBC and AM2/APG both work.

You can also specify the options. The options are the same as those of member. See options of member.

request
Shows all requests of one automation resource. To narrow down returned results, you can specify the following positional argument.
requested_action_name
This argument is OPTIONAL. It specifies the name of the requested action that you want to show. Wildcard character * is supported.

You can also specify the options. The options are the same as those of member. See options of member.

cancel
Cancel the automation resource.
request
Cancel all requests of one automation resource. To narrow down returned results, you can specify the following positional argument.
requested_action_name
This argument is OPTIONAL. It specifies the name of the requested action that you want to cancel. Wildcard character * is not supported.

You can also specify the options. The options are the same as those of member. See options of member.

restart/start/stop/suspend/resume/reset
Restart, start, stop, suspend, resume or reset the automation resource.
resource
Restart, start, stop, suspend, resume or reset the automation resource. To narrow down returned results, you can specify the following positional argument.
resource_name
This argument is REQUIRED. It specifies the name of the target resource that you want to show. This positional argument resource_name follows a pattern in command as resource_name/resource_type/system_name, where system_name is optional here, for example, AM2/APG/AOBC and AM2/APG both work.
You can also specify the following options. For detailed description about the supported values for each option, see INGREQ and INGSUSPD in the System Automation documentation.
--domain-name|--dn domain_name
This option is REQUIRED. It specifies the domain name of the target resource to narrow down the result.
--system-name|--sn system_name
This option is OPTIONAL. It specifies the system name of target resource to narrow down the result. If you specified the system name in the positional argument resource_name above, you don't have to specify this option again here, otherwise it will be ignored.
--comment comment
This option is OPTIONAL. It specifies descriptive information, for example, why the request was made.
--override all|dpy|flg|sts|trg|sus|no
This option is OPTIONAL. It specifies the overrides to be considered for the request.
--priority low|high|force
This option is OPTIONAL. It specifies the priority given to the request.
--remove available|degraded|sysgone|unknown|no|*
This option is OPTIONAL. It indicates the condition when the request is automatically removed, regardless of whether the request is satisfied or not. If the specified condition matches the observed status of the resource, the request is deleted.
--scope all|only|children
This option is OPTIONAL. Specifies whether the startup or shutdown affects a resource or its descendants, or both.
--type
This option is OPTIONAL. Specifies the type of the startup or shutdown. Each type must be defined in the policy database.
--interrupt yes|no
This option is OPTIONAL. Specifies whether or not a request to shut down a resource should interrupt the startup phase of the resource.

Examples

Table 1. Automation resources command examples
Action Object Command Explanation
list status @bnz automation-resource --domain-name “LPAR400J INGXSGSA” --system-name AOBC --compound-state error --resource-type apg Shows the status of the automation resource that is an application group in error state on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz automation-resource list status --domain-name “LPAR400J INGXSGSA” --system-name AOBC --compound-state error --resource-type apg Shows the status of the automation resource that is an application group in error state on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list status --dn “LPAR400J INGXSGSA” --sn AOBC Shows the status of the automation resource on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list status R#C16G1 --dn “LPAR400J INGXSGSA” --sn AOBC Shows the status of the automation resource R#C16G1 on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list status R#C16G1/APG --dn “LPAR400J INGXSGSA” --sn AOBC Shows the status of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list status R#C16G1/APG/AOBC --dn “LPAR400J INGXSGSA” Shows the status of the automation resource R#C16G1/APG/AOBC on the automation domain LPAR400J INGXSGSA.
@bnz ar list status R#C16G* --dn “LPAR400J INGXSGSA” Shows the status of the automation resource whose name starts with R#C16G on the automation domain LPAR400J INGXSGSA.
@bnz ar list status R#C16G*/APG --dn “LPAR400J INGXSGSA” --sn AOBC Shows the status of the automation resource whose name starts with R#C16G on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list status R#C16G*/APG/AOBC --dn “LPAR400J INGXSGSA” Shows the status of the automation resource whose name starts with R#C16G on the automation domain LPAR400J INGXSGSA.
@bnz ar list status R#C16G*/APG/AOBC --dn “LPAR400J INGXSGSA” --jf Shows the status of automation resource whose name starts with R#C16G on the automation domain LPAR400J INGXSGSA in JSON format.
member @bnz automation-resource list member --domain-name “LPAR400J INGXSGSA” --system-name AOBC --resource-name R#C16G1/APG Shows the member of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list member --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG Shows the member of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA.
@bnz ar list member AM2 --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG Shows the member AM2 of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA.
@bnz ar list member AM2/APL --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the member AM2/APL of the automation resource R#C16G1/APG/AOBC on the automation domain LPAR400J INGXSGSA.
@bnz ar list member AM2/APL --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC --jf Shows the member AM2/APL of the automation resource R#C16G1/APG/AOBC on the automation domain LPAR400J INGXSGSA in JSON format.
@bnz ar list member AM* --dn “LPAR400J INGXSGSA” --sn AOBC --rn R#C16G1/APG Shows the member of the automation resource R#C16G1/APG whose name starts with AM on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list member AM*/APL --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the member of the automation resource R#C16G1/APG/AOBC whose name starts with AM on the automation domain LPAR400J INGXSGSA.
relation @bnz automation-resource list relation --domain-name “LPAR400J INGXSGSA” --system-name AOBC --resource-name R#C16G1/APG Shows the relation of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list relation --dn “LPAR400J INGXSGSA” --sn AOBC --rn R#C16G1/APG Shows the relation of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list relation AM2 --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the relation of the automation resource R#C16G1/APG/AOBC whose target is AM2 on the automation domain LPAR400J INGXSGSA.
@bnz ar list relation AM2/APL --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the relation of the automation resource R#C16G1/APG/AOBC whose target is AM2/APL on the automation domain LPAR400J INGXSGSA.
@bnz ar list relation AM2/APL --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC --jf Shows the relation of the automation resource R#C16G1/APG/AOBC whose target is AM2/APL on the automation domain LPAR400J INGXSGSA in JSON format.
@bnz ar list relation AM* --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG Shows the relation of the automation resource R#C16G1/APG whose target name starts with AM on the automation domain LPAR400J INGXSGSA.
@bnz ar list relation AM*/APL --dn “LPAR400J INGXSGSA” --sn AOBC--rn R#C16G1/APG Shows the relation of the automation resource R#C16G1/APG whose target name starts with AM on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list relation AM*/APL --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the relation of the automation resource R#C16G1/APG/AOBC whose target name starts with AM on the automation domain LPAR400J INGXSGSA.
request @bnz automation-resource list request --domain-name “LPAR400J INGXSGSA” --system-name AOBC --resource-name R#C16G1/APG Shows the request of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list request --dn “LPAR400J INGXSGSA” --sn AOBC --rn R#C16G1/APG Shows the request of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar list request START --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the request of the automation resource R#C16G1/APG/AOBC whose requested action is START on the automation domain LPAR400J INGXSGSA.
@bnz ar list request START --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC --jf Shows the request of the automation resource R#C16G1/APG/AOBC whose requested action is START on the automation domain LPAR400J INGXSGSA in JSON format.
@bnz ar list request S* --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Shows the request of the automation resource R#C16G1/APG/AOBC whose requested action name starts with S on the automation domain LPAR400J INGXSGSA.
cancel request @bnz ar cancel request --domain-name “LPAR400J INGXSGSA” --system-name AOBC --resource-name R#C16G1/APG Cancels the request of the automation resource R#C16G1/APG on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar cancel request START --dn “LPAR400J INGXSGSA” --rn R#C16G1/APG/AOBC Cancels the request of the automation resource R#C16G1/APG/AOBC whose requested action is START on the automation domain LPAR400J INGXSGSA.
restart/stop resource @bnz automation-resource restart resource AM/APL --domain-name “LPAR400J INGXSGSA” --system-name AOBC --comment “restart by Annette” --interrupt yes Restarts the automaton resource AM/APL on the automation domain LPAR400J INGXSGSA and the system AOBC with specified options (comment: "restart by Annette", interrupt: "yes").
@bnz ar stop resource AM/APL/AOBC --dn “LPAR400J INGXSGSA” --priority high --type norm Stops the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA with specified options (priority: "high", type: "norm").
@bnz ar stop resource AM/APL/AOBC --dn “LPAR400J INGXSGSA” --p high --t norm --jf Shows the output in JSON format after stopping the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA with specified options (priority: "high", type: "norm").
start resource @bnz automation-resource start resource AM/APL --domain-name “LPAR400J INGXSGSA” --system-name AOBC Starts the automaton resource AM/APL on the automation domain LPAR400J INGXSGSA and the system AOBC.
@bnz ar start resource AM/APL --dn “LPAR400J INGXSGSA” --sn AOBC --comment “start by Annette” --override “all,dpy,flg” --remove no Starts the automaton resource AM/APL on the automation domain LPAR400J INGXSGSA and the system AOBC with specified options (comment: "start by Annette", override: "all,dpy,flg" , remove: "no").
@bnz ar start resource AM/APL --dn “LPAR400J INGXSGSA” --sn AOBC --c “start by Annette” --o “all,dpy,flg” --r no --jf Shows the output in JSON format after starting the automaton resource AM/APL on the automation domain LPAR400J INGXSGSA and the system AOBC with specified options (comment: "start by Annette", override: "all, dpy,flg" , remove: "no").
suspend resource @bnz automation-resource suspend resource AM/APL/AOBC --domain-name “LPAR400J INGXSGSA” Suspends the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA
@bnz ar suspend resource AM/APL/AOBC --dn “LPAR400J INGXSGSA” --remove sysgone --scope all Suspends the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA with specified options (remove: "sysgone", scope: "all").
@bnz ar suspend resource AM/APL/AOBC --dn “LPAR400J INGXSGSA” --r sysgone --s all --jf Shows the output in JSON format after suspending the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA with specified options (remove: "sysgone", scope: "all").
resume resource @bnz automation-resource resume resource AM/APL/AOBC --domain-name “LPAR400J INGXSGSA” Resumes the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA.
@bnz automation-resource resume resource AM/APL/AOBC --domain-name “LPAR400J INGXSGSA” --jf Shows the output in JSON format after resuming the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA.
reset resource @bnz automation-resource reset resource AM/APL/AOBC --domain-name “LPAR400J INGXSGSA” Resets the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA.
@bnz automation-resource reset resource AM/APL/AOBC --domain-name “LPAR400J INGXSGSA” --jf Shows the output in JSON format after resetting the automaton resource AM/APL/AOBC on the automation domain LPAR400J INGXSGSA.