scha_resourcegroup_get(1HA) (Sun Cluster Reference Manual for Solaris OS)

Sun Cluster Reference Manual for Solaris OS

scha_resourcegroup_get(1HA)

NAME

scha_resourcegroup_get– access resource group information

SYNOPSIS

scha_resourcegroup_get

-O

optag

-G

group

args

DESCRIPTION

The scha_resourcegroup_get command accesses information about a resource group that is under the control of the Resource Group Manager (RGM) cluster facility.

This command is intended to be used in shell script implementations of the callback methods for resource types. These resource types represent services that are controlled by the cluster's RGM. This command provides the same information as the scha_resourcegroup_get(3HA) C function.

Information is generated by the command to standard output (stdout) in formatted strings as described in scha_cmds(1HA). The output is a string or several strings on separate lines. The output can be stored in shell variables and parsed using shell facilities or awk(1) for further use by the script.

You need solaris.cluster.resource.read role-based access control (RBAC) authorization to use this command. See rbac(5).

You must also be able to assume a role to which the Sun Cluster Commands rights profile has been assigned to use this command. Authorized users can issue privileged Sun Cluster commands on the command line from the pfsh(1), pfcsh(1), or pfksh(1) profile shell. A profile shell is a special kind of shell that enables you to access privileged Sun Cluster commands that are assigned to the Sun Cluster Commands rights profile. A profile shell is launched when you run su(1M) to assume a role. You can also use pfexec(1) to issue privileged Sun Cluster commands.

OPTIONS

The following options are supported:

-G group

Name of the resource group.

-O optag

Specifies the information that is to be accessed. Depending on the optag that you specify, you might need to include an additional operand to indicate the node or zone for which information is to be retrieved.

Note –

optag values, such as DESIRED_PRIMARIES and FAILBACK, are not case sensitive. You can use any combination of uppercase and lowercase letters when you specify optag options.

The following optag values retrieve the corresponding resource group properties. The value of the named property of the resource group is generated. The RG_STATE property refers to the value on the particular node or zone where the command is executed.

AUTO_START_ON_NEW_CLUSTER
DESIRED_PRIMARIES
FAILBACK
GLOBAL_RESOURCES_USED
IMPLICIT_NETWORK_DEPENDENCIES
MAXIMUM_PRIMARIES
NODELIST
PATHPREFIX
PINGPONG_INTERVAL
RESOURCE_LIST
RG_AFFINITIES
RG_DEPENDENCIES
RG_DESCRIPTION
RG_IS_FROZEN
RG_MODE
RG_PROJECT_NAME
RG_SLM_TYPE
RG_SLM_PSET_TYPE
RG_SLM_CPU
RG_SLM_CPU_MIN
RG_STATE
RG_STATE_NODE
RG_SYSTEM
SUSPEND_AUTOMATIC_RECOVERY

Note –

RG_STATE_NODE requires an unflagged argument that specifies a node or zone. This optag value generates the value of the resource group's RG_STATE property for the specified node or zone. If the unflagged argument specifies a non-global zone, the format is nodename:zonename.

EXAMPLES

Example 1 A Sample Script Using `scha_resourcegroup_get`

The following script is passed a -G argument, which provides the required resource group name. Next, the scha_resourcegroup_get command is used to get the list of resources in the resource group.

#!/bin/sh

while getopts G: opt
do
     case $opt in
          G)      group="$OPTARG";;
     esac
done

resource_list=`scha_resourcegroup_get -O Resource_list -G $group`

for resource in $resource_list
do
     printf "Group: %s contains resource: %s\n" "$group" "$resource"
done

EXIT STATUS

The following exit status codes are returned:

0

The command completed successfully.

nonzero

An error occurred.

Failure error codes are described scha_calls(3HA).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWscdev
Interface Stability	Stable