Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

scha_resource_setstatus (8HA)

Name

scha_resource_setstatus - set resource status

Synopsis

scha_resource_setstatus -R resource -G group -s status [-m msg] 
     [-Z zonename]

Description

The scha_resource_setstatus command sets the Status and Status_msg properties of a resource that is managed by the Resource Group Manager (RGM). This command is intended to be used by the resource's monitor to indicate the resource's state as perceived by the monitor. It provides the same functionality as the scha_resource_setstatus(3HA) C function.

When you execute the scha_resource_setstatus(8HA) command, the Status and Status_msg properties of the resource are updated with the values that you specify. Oracle Solaris Cluster logs the change to the resource status in the cluster system log, which you can view with cluster administration tools.

You need solaris.cluster.resource.admin authorization to use this command. See rbac(7).

You must also be able to assume a role to which the Oracle Solaris Cluster Commands rights profile has been assigned to use this command. Authorized users can issue privileged Oracle Solaris 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 Oracle Solaris Cluster commands that are assigned to the Oracle Solaris Cluster Commands rights profile. A profile shell is launched when you run su(8) to assume a role. You can also use pfexec(1) to issue privileged Oracle Solaris Cluster commands.

Options

The following options are supported:

–G group

Specifies the resource group that contains the resource.

–m msg

Specifies the text string that you want to assign to the Status_msg property of the resource. If you do not specify this option, the value of the resource's Status_msg is set to NULL.

–R resource

Specifies the resource whose status is to be set.

–s status

Specifies the value of status: OK, DEGRADED, FAULTED, UNKNOWN, or OFFLINE.

–Z zonename

Specifies the name of the zone cluster in which a resource group is configured to run.

If the Global_zone property is set to TRUE, methods execute in the global zone even if the resource group that contains the resource is configured in a zone cluster. The –Z option sets the status for the non-global zone where the resource group runs rather than for the global zone where the method runs.

Use the –Z option only for resource types whose Global_zone property is set to TRUE. This option is not needed if the Global_zone property is set to FALSE. For more information about the Global_zone property, see the rt_properties(7) man page.

Examples

Example 1 Setting the Status of Resource R1 With a Status_msg

The following command sets the status of resource R1 in resource group RG2 to OK and sets the Status_msg to Resource R1 is OK:

scha_resource_setstatus -R R1 -G RG2 -s OK -m "Resource R1 is OK"
Example 2 Setting the Status of Resource R1 Without a Status_msg

The following command sets the status of R1 in resource group RG2 to DEGRADED and sets the Status_msg to NULL:

scha_resource_setstatus -R R1 -G RG2 -s DEGRADED
Example 3 Setting the Status of Resource R1 in Zone Zone1 With a Status_msg

The following example shows a resource type method or monitor that is implemented as a shell script. This shell script shows how to set the status of resource $resource in resource group $rg in zone $localzone to OK. This shell script also sets the Status_msg to “Resource R1 is OK”. In this case, the -Z option must be specified because the resource type property Global_zone is assumed to be set to TRUE.

resource=
rg=""
localzone=""
zflag=""
while getopts R:G:Z:
do
      case $c in
      R)   resource=$OPTARG;;
      G)   rg=$OPTARG;;
      Z)   zflag="-Z"
           localzone=$OPTARG;;
      esac
done
...
scha_resource_setstatus -R $resource -G $rg $zflag $localzone -s OK -m
    "Resource R1 is OK"

Exit Status

The following exit status codes are returned:

0

The command completed successfully.

nonzero

An error occurred.

Failure error codes are described in scha_calls(3HA).

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
ha-cluster/developer/api
Interface Stability
Stable

See Also

scha_calls(3HA), scha_resource_setstatus(3HA), attributes(7), rbac(7), rt_properties(7), scha_cmds(8HA)