General-Purpose Functions

The functions in this section provide a broad range of functionality.

These functions enable you to perform the following operations:

• Initialize the DSDL environment

• Retrieve resource type, resource, and resource group names, and extension property values

• Fail over and restart a resource group, and restart a resource

• Convert error strings to error messages

• Execute a command under a timeout

Initialization Functions

The following functions initialize the calling method:

• scds_initialize(3HA) – Allocates resources and initializes the DSDL environment.

• scds_close(3HA) – Frees resources that are allocated by scds_initialize().

Retrieval Functions

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

• scds_get_current_method_name(3HA) – Retrieves the last element of the path name by which a data service method was called.

• scds_get_zone_name(3HA) – Retrieves the name of the zone on whose behalf a method is running.

• scds_get_resource_type_name(3HA) – Retrieves the name of the resource type for the calling program.

• scds_get_resource_name(3HA) – Retrieves the name of the resource for the calling program.

• scds_get_resource_group_name(3HA) – Retrieves the name of the resource group for the calling program.

• scds_get_ext_property(3HA) – Retrieves the value of the specified extension property.

• scds_free_ext_property(3HA) – Frees the memory that is allocated by scds_get_ext_property().

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:

• scds_failover_rg(3HA) – Fails over a resource group.

• scds_restart_rg(3HA) – Restarts a resource group.

• scds_restart_resource(3HA) – Restarts a resource.

Execution Functions

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

• scds_timerun(3HA) – Executes a command under a timeout value.

• scds_error_string(3HA) and scds_error_string_i18n(3HA) – Translates an error code to an error string. Strings that are returned by scds_error_string() are displayed in English. Strings that are returned by scds_error_string_i18n() are displayed in the native language that is specified by the LC_MESSAGES locale category.

• scds_svc_wait(3HA) - Waits for the specified timeout period for a monitored process to die.