Cross Reference: /ohac/man/man3ha/scds_get_rg_hostnames.3ha

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 2007 Sun Microsystems, Inc.
All rights reserved. Use is subject to license terms.

scds_get_rg_hostnames 3HA "1 Aug 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"

NAME

scds_get_rg_hostnames, scds_get_rg_hostnames_zone - get the network resources used in a resource group

SYNOPSIS

cc [flags.\|.\|.] -I /usr/cluster/include file
 -L /usr/cluster/lib  -l  dsdev
#include <rgm/libdsdev.h>

scha_err_t scds_get_rg_hostnames(char *resourcegroup_name,
scds_net_resource_list_t **netresource_list);

scha_err_t scds_get_rg_hostnames_zone(char *zone_name, char *resourcegroup_name, scds_net_resource_list_t **netresource_list);

DESCRIPTION

The scds_get_rg_hostnames() and scds_get_rg_hostnames_zone() functions retrieve a list of hostnames that are used by all the network resources in a resource group. The scds_get_rg_hostnames_zone() function enables you to retrieve a list within a particular zone. These functions return a pointer to the list in netresource_list. A resource group can contain no network resources or can contain resources that do not use network resources, so these functions can return a netresource_list parameter that is set to NULL.

You can pass the name of any resource group name in the system to scds_get_rg_hostnames() and scds_get_rg_hostnames_zone(). Use the hostnames that are returned by scds_get_rg_hostnames() and scds_get_rg_hostnames_zone() to contact applications that are running in the specified resource group.

Free the memory that is allocated and returned by this function with scds_free_net_list().

PARAMETERS

The following parameters are supported

.na resourcegroup_name .ad Name of the resource group for which data is to be retrieved

.na netresource_list .ad List of network resources that are used by the resource group

RETURN VALUES

The scds_get_rg_hostnames() and scds_get_rg_hostnames_zone() functions return the following values:

.na 0 .ad The function succeeded.

.na nonzero .ad The function failed.

ERRORS

.na SCHA_ERR_NOERR .ad Function succeeded.

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

FILES

.na /usr/cluster/include/rgm/libdsdev.h .ad Include file

.na /usr/cluster/lib/libdsdev.so .ad Library

ATTRIBUTES

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


ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWscdev
Interface Stability	Evolving

SEE ALSO

scds_free_net_list(3HA), scds_get_rs_hostnames(3HA), scha_calls(3HA), attributes(5)