Property Variables

You can retrieve the values of selected Sun Cluster resource, resource type, and resource group properties from the RGM framework by using property variables. Agent Builder scans your start, probe, or stop script for property variables and substitutes these variables with their values before Agent Builder launches the script.

Property variables are not supported for use with Korn shell-based services.

List of Property Variables

The following list includes the property variables that you can use with your scripts. Sun Cluster resource, resource type, and resource group properties are described in Appendix A, Standard Properties.

The following list includes resource property variables:

• HOSTNAMES

• RS_CHEAP_PROBE_INTERVAL

• RS_MONITOR_START_TIMEOUT

• RS_MONITOR_STOP_TIMEOUT

• RS_NAME

• RS_NUM_RESTARTS

• RS_RESOURCE_DEPENDENCIES

• RS_RESOURCE_DEPENDENCIES_WEAK

• RS_RETRY_COUNT

• RS_RETRY_INTERVAL

• RS_SCALABLE

• RS_START_TIMEOUT

• RS_STOP_TIMEOUT

• RS_THOROUGH_PROBE_INTERVAL

• SCHA_STATUS

The following list includes resource type property variables:

• RT_API_VERSION

• RT_BASEDIR

• RT_FAILOVER

• RT_INSTALLED_NODES

• RT_NAME

• RT_RT_VERSION

• RT_SINGLE_INSTANCE

The following list includes resource group property variables:

• RG_DESIRED_PRIMARIES

• RG_GLOBAL_RESOURCES_USED

• RG_IMPLICIT_NETWORK_DEPENDENCIES

• RG_MAXIMUM_PRIMARIES

• RG_NAME

• RG_NODELIST

• RG_NUM_RESTARTS

• RG_PATHPREFIX

• RG_PINGPONG_INTERVAL

• RG_RESOURCE_LIST

Syntax of Property Variables

You include a percent sign (%) before a property name to indicate a property variable, as shown in this example.

# /opt/network_aware/echo_server -t %RS_STOP_TIMEOUT -n %RG_NODELIST

Given the preceding example, Agent Builder might interpret these property variables and launch the echo_server script with the following values.

# /opt/network_aware/echo_server -t 300 -n phys-node-1,phys-node-2,phys-node-3

How Agent Builder Substitutes Property Variables

The following list describes how Agent Builder interprets the types of property variables:

• An integer is substituted with its actual value (300, for example).

• A Boolean value is substituted with the string TRUE or FALSE.

• A string is substituted with the actual string (phys-node-1, for example).

• A list of strings is substituted with all members in the list, each separated by a comma (phys-node-1,phys-node-2,phys-node-3, for example).

• A list of integers is substituted with all members in the list, each separated by a comma (1,2,3, for example).

• An enumerated type is substituted with its value, in string form.