Home | History | Annotate | Download | only in man3ha
 te
 CDDL HEADER START

 The contents of this file are subject to the terms of the
 Common Development and Distribution License (the "License"). 
 You may not use this file except in compliance with the License.

 You can obtain a copy of the license at CDDL.txt
 or http://www.opensolaris.org/os/licensing.
 See the License for the specific language governing permissions
 and limitations under the License.

 When distributing Covered Code, include this CDDL HEADER in each
 file and include the License file at CDDL.txt.
 If applicable, add the following below this CDDL HEADER, with the
 fields enclosed by brackets "[]" replaced with your own identifying
 information: Portions Copyright [yyyy] [name of copyright owner]

 CDDL HEADER END
 Copyright 2008 Sun Microsystems, Inc.
 All rights reserved. Use is subject to license terms.
 scha_resource_setstatus 3HA "11 Sep 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"
 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(5) 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 non-global zone 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 non-global zone.


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:


.na
0
.ad


The function succeeded.





.na
nonzero
.ad


The function failed.




 ERRORS

.na
SCHA_ERR_NOERR
.ad


The function succeeded.





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

 EXAMPLES

Example 1 Using the scha_resource_setstatus_zone() Function

#include <scha.h>

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

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




 FILES

.na
/usr/cluster/include/scha.h
.ad


Include file





.na
/usr/cluster/lib/libscha.so
.ad


Library




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWscdev
Interface StabilityEvolving



 SEE ALSO

scha_resource_setstatus(1HA), scha_calls(3HA), scha_strerror(3HA), attributes(5), rt_properties(5)