rgmbrreq

Name

rgmbrreq - Requests for a managed resource to be started, stopped, or canceled.

The command rgmbrreq - belongs to a group of commands (rgreq, rgmbrreq, and lsrgreq) which allow an operator to introduce persistent requests into System Automation for Multiplatforms. Using this set of commands the operator can start, stop, cancel, or move resource groups and managed resources.

Synopsis

rgmbrreq [-h] [-p priority] -o action [-S source] [-u userID] [-c comments] [-T] [-V] Resource_class:Resource[:Node][,Resource[:Node][,...]][Resource_class:Resource[:Node]
[,Resource[:Node][,...]][...]]

rgmbrreq [-h] [-p priority] -o action -s [-S source] [-u userID] [-c comments] [-T] [-V]Resource_class:"Selection_String" [Resource_class:"Selection_String" [...]]

Description

By using the rgmbrreq command, the operator or any originator (source) asks for the managed resource to be started, stopped, canceled, locked, or unlocked. Start and Stop requests last until explicitly removed or canceled by the operator. A request that comes from the same source replaces a former request from that source - that is, it cancels the previous request automatically. A move request is not allowed for a managed resource. A stop or a start request can be canceled by the same source that enabled it.

Lock requests freeze resources in their current state and prevent them from being automated. Lock requests are persistent. To unlock a resource and to remove the lock request, an unlock request is required.

Options

-h

Help. Writes the command's usage statement to standard output.

-p priority

Determines how important the request is regarding other requests within the resource structure. The priority allows System Automation for Multiplatforms to solve conflicting requests for the same resource.

low: Low priority, default value.
high: High priority.
force: Takes precedence over requests posted with high priority.

-o action

The actual action request.

start: Sets a request to start the resource. The resource starts if the policy allows it and if no request with a higher priority that prevents the resource from being started exists.
stop: Sets a request to stop the resource. The resource stops if the policy allows it and if no request with a higher priority that prevents the resource from being stopped exists.
cancel: Cancels a previously entered request. The request is identified by the source of the request (-S parameter) and the resource name.
lock: Locks a resource. When the resource is locked, it is frozen in its current state and no longer automated.
unlock: Unlocks a resource.

-s

Specifies that a selection string is used.

-S source

Identifies the originator of the request.

Operator
ExtSched
Automation

Any other value is allowed, but gets the lowest priority. If the source is not specified, "Operator" is used as default source. When the request is canceld, the same source string must be specified. Each source can have only one active request of each type against each resource. If the source makes a second request directly against the resource, it replaces their first request. The source option allows the installation to identify the different organizational units and the roles they are playing. Another usage is to distinguish between who made or where the request came from, for example from the operator versus an automation shell script.

-u userID

The user or operator ID of the originator of the request, which can be any string. If the string contains blanks, it must be enclosed in quotation marks.

-c comments

A string that represents a remark that might be related to the request. If the string contains blanks, it must be enclosed in quotation marks. The character semicolon ";" is not allowed in comments.

-T

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

-V

Verbose. Writes the command's verbose messages to standard output.

Parameters

Resource_class:"selection_string"

The -s option determines this operand. Each selection string must be preceded by a resource class. Resource_class indicates the name of the resource class the selection_string is applied to. The selection_string and its Resource_class must be separated by colon or ":"delimiter. The specified selection string is applied to its corresponding Resource_class attributes to determine which member resources are to be removed from the Resource_group. The selection string must be enclosed within 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 IBM.Application:`Name=="testing"`
-s IBM.Application:`Name ?="test"`
-s IBM.Application:`Name like "%"` (For all resources)

Resource_class:Resource[:Node]

The member resources specifies one or more member resources that are to be acted on. Resources belonging to different resource classes can also be specified by using this syntax. However, member resources that belong to different classes must be separated by spaces. A member resource is identified by the resource's class (Resource_class), the resource's name (Resource_name), and optionally the node (Node) the resource is on. The Resource_class, Resource, and Node must be separated by a colon. Resource_class is the name of the resource class the member resource belongs to. Resource is the name of the actual member resource in its class. The node must be included when trying to act on a fixed member resource. The node and its resource must be separated by the colon or ":" delimiter. Multiple resources that belong to the same resource class can also be specified and are separated by a comma:Resource_class:Resource[:Node][,Resource[:Node][,...]] The member resources must exist in the resource group for the requested action to take place.

Exit Status

0: The command ran 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.
6: Resource specified was not found.

Security

This command requires root authority, or a user ID with appropriate permissions. For more information, see Setting up non-root user Ids for the command line interface.

Files

/usr/sbin/rsct/bin/rgmbrreq: Location of the rgmbrreq command.