Chapter 11

Data Service Development Library Reference

This chapter lists and briefly describes the Data Service Development Library (DSDL) API functions. See the individual 3HA man pages for a complete description of each DSDL function. The DSDL defines a C interface only. There is no scriptable DSDL interface.

The DSDL provides functions in the following categories.

DSDL Functions

The following subsections provide a brief overview to each category of DSDL functions. However, the individual 3HA man pages are the definitive reference for DSDL functions.

General Purpose Functions

The functions in this section provide a broad range of functionality. These functions enable you to

Initialize the DSDL environment
Retrieve resource, resource type, and resource group names, and extension property values
Failover and restart a resource group and restart a resource
Convert error strings to error messages
Execute a command under a timeout

The following functions initialize the calling method.

scds_initialize - allocate resources and initialize the DSDL environment.
scds_close - free resources allocated by scds_initialize.

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

scds_get_resource_name - retrieve the name of the resource for the calling program.
scds_get_resource_type_name - retrieve the name of the resource type for the calling program.
scds_get_resource_group_name - retrieve the name of the resource group for the calling program.
scds_get_ext_property - retrieve the value of the specified extension property.
scds_free_ext_property - free the memory allocated by scds_get_ext_property.

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

scds_hasp_check - retrieves status information about SUNW.HAStoragePlus resources used by a resource. This information is obtained from the state (online or otherwise) of all SUNW.HAStoragePlus resources that the resource depends upon using the Resource_dependencies or Resource_dependencies_weak system properties defined for the resource.

See SUNW.HAStoragePlus(5) for more information about SUNW.HAStoragePlus.

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

scds_failover_rg - fail over a resource group.
scds_restart_rg - restart a resource group.
scds_restart_resource - restart a resource.

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

scds_timerun - execute a command under a timeout value.
scds_error_string - translate an error code to an error string.


	Chapter 11 Data Service Development Library Reference This chapter lists and briefly describes the Data Service Development Library (DSDL) API functions. See the individual 3HA man pages for a complete description of each DSDL function. The DSDL defines a C interface only. There is no scriptable DSDL interface. The DSDL provides functions in the following categories. General Purpose Functions Property Functions Network Resource-Access Functions PMF Functions Fault Monitor Functions Utility Functions DSDL Functions The following subsections provide a brief overview to each category of DSDL functions. However, the individual 3HA man pages are the definitive reference for DSDL functions. General Purpose Functions The functions in this section provide a broad range of functionality. These functions enable you to Initialize the DSDL environment Retrieve resource, resource type, and resource group names, and extension property values Failover and restart a resource group and restart a resource Convert error strings to error messages Execute a command under a timeout The following functions initialize the calling method. `scds_initialize` - allocate resources and initialize the DSDL environment. `scds_close` - free resources allocated by `scds_initialize`. The following functions retrieve information about resources, resource types, resource groups, and extension properties. `scds_get_resource_name` - retrieve the name of the resource for the calling program. `scds_get_resource_type_name` - retrieve the name of the resource type for the calling program. `scds_get_resource_group_name` - retrieve the name of the resource group for the calling program. `scds_get_ext_property` - retrieve the value of the specified extension property. `scds_free_ext_property` - free the memory allocated by `scds_get_ext_property`. The following function retrieves status information about the SUNW.HAStoragePlus resources used by a resource. `scds_hasp_check` - retrieves status information about `SUNW.HAStoragePlus` resources used by a resource. This information is obtained from the state (online or otherwise) of all `SUNW.HAStoragePlus` resources that the resource depends upon using the `Resource_dependencies` or `Resource_dependencies_weak` system properties defined for the resource. See `SUNW.HAStoragePlus`(5) for more information about `SUNW.HAStoragePlus`. The following functions fail over or restart a resource or resource group. `scds_failover_rg` - fail over a resource group. `scds_restart_rg` - restart a resource group. `scds_restart_resource` - restart a resource. The following two functions execute a command under a timeout and convert an error code to an error message. `scds_timerun` - execute a command under a timeout value. `scds_error_string` - translate an error code to an error string.