Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

scha_resource_setstatus_zone (3HA)

Name

scha_resource_setstatus, scha_resource_setstatus_zone - set resource status functions

Synopsis

cc [flags…] –I /usr/cluster/include file –L /usr/cluster/lib 
     –l scha#include <scha.h>scha_err_t scha_resource_setstatus(
     const char *rname, const char *rgname, scha_rsstatus_t status, 
     const char *status_msg);
scha_err_t scha_resource_setstatus_zone(const char *rname, 
     const char *rgname, const char *zonename, scha_rsstatus_t 
     status, const char *status_msg);

Description

The scha_resource_setstatus () and scha_resource_setstatus_zone()functions set the Status and Status_msg properties of a resource that is managed by the Resource Group Manager (RGM). A resource's monitor uses these functions to indicate the resource's state as perceived by the monitor.

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

The rname argument names the resource whose status is to be set.

The rgname argument is the name of the resource group that contains the resource.

The zonename argument is the name of the zone cluster in which the 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 runs in a zone cluster.

The status argument is an enum value of type scha_rsstatus_t: SCHA_RSSTATUS_OK, SCHA_RSSTATUS_OFFLINE, SCHA_RSSTATUS_FAULTED, SCHA_RSSTATUS_DEGRADED, or SCHA_RSSTATUS_UNKNOWN.

The status-msg argument is the new value for the Status_msg property. The status-msg argument can be NULL.

A successful call to the scha_resource_setstatus() or scha_resource_setstatus_zone()function causes the Status and Status_msg properties of the resource to be updated with the supplied values. The update of the resource status is logged in the cluster system log and is accessible by cluster administration tools.

Return Values

The scha_resource_setstatus() and scha_resource_setstatus_zone ()functions return the following values:

0

The function succeeded.

nonzero

The function failed.

Errors

SCHA_ERR_NOERR

The function succeeded.

See scha_calls(3HA) for a description of other error codes.

Examples

Example 1 Using the scha_resource_setstatus() Function
#include <scha.h>

scha_err_t err_code;
const char *rname = "example_R";
const char *rgname = "example_RG";

err_code = scha_resource_setstatus(rname, rgname,
           SCHA_RSSTATUS_OK, "No problems");

Files

/usr/cluster/include/scha.h

Include file

/usr/cluster/lib/libscha.so

Library

Attributes

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

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

See Also

scha_calls(3HA), scha_strerror(3HA), attributes(7), rt_properties(7), scha_resource_setstatus(8HA)