JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Solaris Cluster Reference Manual
search filter icon
search icon

Document Information

Preface

Introduction

OSC33 1

OSC33 1cl

OSC33 1ha

OSC33 1m

OSC33 3ha

scds_calls(3HA)

scds_close(3HA)

scds_error_string(3HA)

scds_error_string_i18n(3HA)

scds_failover_rg(3HA)

scds_fm_action(3HA)

scds_fm_net_connect(3HA)

scds_fm_net_disconnect(3HA)

scds_fm_print_probes(3HA)

scds_fm_sleep(3HA)

scds_fm_tcp_connect(3HA)

scds_fm_tcp_disconnect(3HA)

scds_fm_tcp_read(3HA)

scds_fm_tcp_write(3HA)

scds_free_ext_property(3HA)

scds_free_netaddr_list(3HA)

scds_free_net_list(3HA)

scds_free_port_list(3HA)

scds_get_current_method_name(3HA)

scds_get_ext_property(3HA)

scds_get_netaddr_list(3HA)

scds_get_port_list(3HA)

scds_get_resource_group_name(3HA)

scds_get_resource_name(3HA)

scds_get_resource_type_name(3HA)

scds_get_rg_hostnames(3HA)

scds_get_rg_hostnames_zone(3HA)

scds_get_rs_hostnames(3HA)

scds_get_zone_name(3HA)

scds_hasp_check(3HA)

scds_initialize(3HA)

scds_pmf_get_status(3HA)

scds_pmf_restart_fm(3HA)

scds_pmf_signal(3HA)

scds_pmf_start(3HA)

scds_pmf_start_env(3HA)

scds_pmf_stop(3HA)

scds_pmf_stop_monitoring(3HA)

scds_print_netaddr_list(3HA)

scds_print_net_list(3HA)

scds_print_port_list(3HA)

scds_property_functions(3HA)

scds_restart_resource(3HA)

scds_restart_rg(3HA)

scds_simple_net_probe(3HA)

scds_simple_probe(3HA)

scds_svc_wait(3HA)

scds_syslog(3HA)

scds_syslog_debug(3HA)

scds_timerun(3HA)

scha_calls(3HA)

scha_cluster_close(3HA)

scha_cluster_get(3HA)

scha_cluster_getlogfacility(3HA)

scha_cluster_getnodename(3HA)

scha_cluster_getzone(3HA)

scha_cluster_open(3HA)

scha_control(3HA)

scha_control_zone(3HA)

scha_resource_close(3HA)

scha_resource_get(3HA)

scha_resourcegroup_close(3HA)

scha_resourcegroup_get(3HA)

scha_resourcegroup_open(3HA)

scha_resource_open(3HA)

scha_resource_setstatus(3HA)

scha_resource_setstatus_zone(3HA)

scha_resourcetype_close(3HA)

scha_resourcetype_get(3HA)

scha_resourcetype_open(3HA)

scha_strerror(3HA)

scha_strerror_i18n(3HA)

OSC33 4

OSC33 5

OSC33 5cl

OSC33 7

OSC33 7p

Index

scds_calls

- Oracle Solaris Cluster Data Services Development Library (DSDL) functions

Synopsis

cc [flags…] -I /usr/cluster/include file -L /usr/cluster/lib -l dsdev

#include <rgm/libdsdev.h>

Description

The Data Services Development Library (DSDL) is a set of higher-level library functions that encapsulate and extend the functionality of the scha library functions. The scha library functions are described in the scha_calls(3HA) man page.

DSDL functions are implemented in the libdsdev.so library.

DSDL functions are generally divided into the following categories.

Initialization Functions

The following functions initialize the calling method:

Retrieval Functions

The following functions retrieve information about zones, resource types, resources, resource groups, and extension properties:

The following function retrieves status information about the SUNW.HAStoragePlus resources that are used by a resource:

scds_hasp_check(3HA) – Retrieves status information about SUNW.HAStoragePlus resources that are used by a resource. This information is obtained from the state (online or otherwise) of all SUNW.HAStoragePlus resources on which the resource depends by using the Resource_dependencies or Resource_dependencies_weak system properties that are defined for the resource. See the SUNW.HAStoragePlus(5) man page for more information.

Failover and Restart Functions

The following functions fail over or restart a resource or resource group:

Execution Functions

The following functions execute a command under a timeout and convert an error code to an error message:

Property Functions

These functions provide convenience APIs for accessing specific properties of the relevant resource type, resource, and resource group, including some commonly used extension properties. The DSDL provides the scds_initialize() function to parse the command-line arguments. The library caches the various properties of the relevant resource type, resource, and resource group.

The scds_property_functions(3HA) man page describes these functions, which include the following:

Network Resource Access Functions

You use these functions to manage network resources.

The following functions handle host names:

The following functions handle port lists:

The following functions handle network addresses:

The following functions enable TCP-based monitoring. Typically, a fault monitor uses these functions to establish a simple socket connection to a service, read and write data to the service to ascertain its status, and disconnect from the service.

This set of functions includes the following functions:

PMF Functions

These functions encapsulate the Process Monitor Facility (PMF) functionality. The DSDL model for monitoring through the PMF creates and uses implicit tag values for pmfadm. See the pmfadm(1M) man page for more information.

The PMF facility also uses implicit values for the Restart_interval, Retry_count, and action_script (the -t, -n, and -a options to pmfadm). Most important, the DSDL ties the process failure history, as determined by the PMF, into the application failure history as detected by the fault monitor to compute the restart or failover decision.

The set includes the following functions:

Fault Monitor Functions

These functions provide a predetermined model of fault monitoring by keeping the failure history and evaluating it in conjunction with the Retry_count and Retry_interval properties.

This set includes the following functions:

Utility Functions

The following functions enable you to write messages and debugging messages to the system log:

Files

/usr/cluster/include/scds.h

Include file

/usr/cluster/lib/libdsdev.so

Library

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
SUNWscdev
Interface Stability
Evolving

See Also

pmfadm(1M), scds_close(3HA), scds_error_string(3HA), scds_error_string_i18n(3HA), scds_failover_rg(3HA), scds_fm_action(3HA), scds_fm_net_connect(3HA), scds_fm_net_disconnect(3HA), scds_fm_print_probes(3HA), scds_fm_sleep(3HA), scds_fm_tcp_connect(3HA), scds_fm_tcp_disconnect(3HA), scds_fm_tcp_read(3HA), scds_fm_tcp_write(3HA), scds_free_ext_property(3HA), scds_free_net_list(3HA), scds_free_netaddr_list(3HA), scds_free_port_list(3HA), scds_get_ext_property(3HA), scds_get_netaddr_list(3HA), scds_get_port_list(3HA), scds_get_resource_group_name(3HA), scds_get_resource_name(3HA), scds_get_resource_type_name(3HA), scds_get_rg_hostnames(3HA), scds_get_rs_hostnames(3HA), scds_get_zone_name(3HA), scds_hasp_check(3HA), scds_initialize(3HA), scds_pmf_get_status(3HA), scds_pmf_restart_fm(3HA), scds_pmf_signal(3HA), scds_pmf_start(3HA), scds_pmf_stop(3HA), scds_pmf_stop_monitoring(3HA), scds_print_net_list(3HA), scds_print_netaddr_list(3HA), scds_print_port_list(3HA), scds_property_functions(3HA), scds_restart_resource(3HA), scds_restart_rg(3HA), scds_simple_net_probe(3HA), scds_simple_probe(3HA), scds_svc_wait(3HA), scds_syslog(3HA), scds_syslog_debug(3HA), bscds_timerun(3HA), scha_calls(3HA), SUNW.HAStoragePlus(5), attributes(5)