rgreq

Name

rgreq - Requests for a resource group to be started, stopped, canceled, locked, unlocked, or moved.

The rgreq command 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, lock, unlock, or move resource groups and managed resources.

Synopsis

rgreq [-h] [-p priority] -o action [-S source] [-n node1,....noden] [-u userID] [-c comments] [-T] [-V] Resource_group

Description

The rgreq command is used to send requests against resource groups that are automated by System Automation for Multiplatforms. By sending a request, the originator or source of the request, for example, an operator or the decision engine of System Automation for Multiplatforms, asks that a resource group is started, stopped, canceled, locked, unlocked, or moved.

Start and Stop requests are retained until they are explicitly removed or canceled; lock requests are retained until the resource is explicitly unlocked again.

Typically, two requests that are sent by the same originator replace each other. The new request automatically cancels the older one. Requests are considered to have the same originator if their Source attributes have the same value. Start and Stop requests cancel each other, but Move requests do not.

Since Move and Start or Stop request are of different types, both a Move request and a Start or a Stop request from the same source against the same resource can be allowed. For example, request a resource group to start, then to move the resource. When the resource group is moved, the Start request can be still be in place. A Move request is automatically removed when the move action is carried out or canceled by the Recovery RM (IBM.RecoveryRM), or when the move request is canceled by using a movecancel request. Stop and Start requests can be canceled at any time. However, the cancel requests must come from the same source as the original Start and Stop requests.

Lock requests freeze resource groups in their current state and prevent them from being automated. Lock requests are persistent, to unlock a resource group 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 level

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. priority level can have one of the following values:

low: Low priority. This is the default.
high: High priority. Takes precedence over request posted with low priority.
force: Takes precedence over request posted with high or low priority.

-o action

Specifies the actual action request. It can be one of the following actions:

start: Sets a request to start the resource group. The resource group starts if the policy allows it and if no request with a higher priority that prevents the resource group from being started exists.
stop: Sets a request to stop the resource group. The resource group stops if the policy allows it and if no request with a higher priority that prevents the resource group from being stopped exists.
move: Moves the resource group and its members to a different node in the cluster. The process involves stopping an active set of resources and starting them on different node(s) in a coordinated fashion.
cancel: Cancels a previously entered request. The request is identified by the source of the request (-S parameter) and the resource name. Start and stop requests can only be canceled byusing cancel requests. Move requests are canceled by using movecancel requests. Lock requests are canceled by using unlock requests.
movecancel: Cancels a previously entered move request. The request is identified by the name of the resource group.
lock: Locks a resource group. When the group is locked, it is frozen in its current state and no longer automated.
unlock: Unlocks a resource group.

-S source

Identifies the originator of the request.

Operator
ExtSched
Automation

Other originators are allowed, but gets the lowest priority. If the source attribute is not specified, then it defaults to Operator. When the request is cancled, the same source string must be specified. There are two types of request. Start and Stop requests are of one type, and the Move request is of another type. 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 distinguish where the request came from, for example from the operator versus an automation shell script.

-n node1,..noden

The originating nodes. This option can be applied only for a move action. It identifies the nodes to move the resource group or its underlying resources from. This option is required for an anticollocated resource group.

-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_group: The name of the resource group. The resource goup is the entry point at which the request is introduced into the resource structure and from which it propagates outwards.

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/rgreq: Location of the rgreq command.