Sun Cluster 3.1 Data Services Developer's Guide

Resource Type Properties

The following table describes the resource type properties defined by Sun Cluster. The property values are categorized as follows (in the Category column):

Required — The property requires an explicit value in the Resource Type Registration (RTR) file or the object to which it belongs cannot be created. A blank or the empty string is not allowed as a value.
Conditional — To exist, the property must be declared in the RTR file; otherwise, the RGM does not create it and it is not available to administrative utilities. A blank or the empty string is allowed. If the property is declared in the RTR file but no value is specified, the RGM supplies a default value.
Conditional/Explicit — To exist, the property must be declared in the RTR file with an explicit value; otherwise, the RGM does not create it and it is not available to administrative utilities. A blank or the empty string is not allowed.
Optional — The property can be declared in the RTR file; if it isn't, the RGM creates it and supplies a default value. If the property is declared in the RTR file but no value is specified, the RGM supplies the same default value as if the property were not declared in the RTR file.

Resource type properties are not updatable by administrative utilities with the exception of Installed_nodes, which cannot be declared in the RTR file and must be set by the administrator.

Table A–1 Resource Type Properties

Property Name

Description

Updatable

Category

API_version (integer)

The version of the resource management API used by this resource type implementation.

The default for SC 3.1 is 2.

Optional

Boot (string)

An optional callback method: the path to the program that the RGM invokes on a node, which joins or rejoins the cluster when a resource of this type is already managed. This method is expected to do initialization actions for resources of this type similar to the Init method.

Conditional/Explicit

Failover (Boolean)

True indicates that resources of this type cannot be configured in any group that can be online on multiple nodes at once. The default is False.

Optional

Fini (string)

An optional callback method: the path to the program that the RGM invokes when a resource of this type is removed from RGM management.

Conditional/Explicit

Init (string)

An optional callback method: the path to the program that the RGM invokes when a resource of this type becomes managed by the RGM.

Conditional/Explicit

Init_nodes (enum)

The values can be RG_primaries (just the nodes that can master the resource) or RT_installed_nodes (all nodes on which the resource type is installed). Indicates the nodes on which the RGM is to call the Init, Fini, Boot and Validate methods.

The default value is RG_primaries.

Optional

Installed_nodes (string array)

A list of the cluster node names on which the resource type is allowed to be run. The RGM automatically creates this property. The cluster administrator can set the value. You cannot declare this property in the RTR file.

The default is all cluster nodes.

Configurable by cluster administrator

Monitor_check (string)

An optional callback method: the path to the program that the RGM invokes before doing a monitor-requested failover of a resource of this type.

Conditional/Explicit

Monitor_start (string)

An optional callback method: the path to the program that the RGM invokes to start a fault monitor for a resource of this type.

Conditional/Explicit

Monitor_stop (string)

A callback method that is required if Monitor_start is set: the path to the program that the RGM invokes to stop a fault monitor for a resource of this type.

Conditional/Explicit

Num_resource_restarts: on each cluster node (integer)

This property is set by the RGM to the number of scha_control RESTART calls that have been made for this resource on this node within the past n seconds, where n is the value of the Retry_interval property of the resource. If a resource type does not declare the Retry_interval property, then the Num_resource_restarts property is not available for resources of that type.

Query-only

Pkglist (string array)

An optional list of packages that are included in the resource type installation.

Conditional/Explicit

Postnet_stop (string)

An optional callback method: the path to the program that the RGM invokes after calling the Stop method of any network-address resources (Network_resources_used) that a resource of this type is dependent on. This method is expected to do STOP actions that must be done after the network interfaces are configured down.

Conditional/Explicit

Prenet_start (string)

An optional callback method: the path to the program that the RGM invokes before calling the Start method of any network-address resources (Network_resources_used) that a resource of this type is dependent on. This method is expected to do START actions that must be done before network interfaces are configured up.

Conditional/Explicit

RT_basedir (string)

The directory path that is used to complete relative paths for callback methods. This path is expected to be set to the installation location for the resource type packages. It must be a complete path, that is, it must start with a forward slash (/). This property is not required if all the method path names are absolute.

Required (unless all method path names are absolute)

RT_description (string)

A brief description of the resource type.

The default is the empty string.

Conditional

Resource_type (string)

The name of the resource type. .

To view the names of the currently registered resource types, use:

scrgadm -p

Starting in Sun Cluster 3.1, a resource type name is of the form

vendor_id.resource_type:version

The three components of the resource type name are properties specified in the RTR file as Vendor_id, Resource_type, and RT_version; the scrgadm command inserts the period and colon delimiters. The RT_version suffix of the resource type name is the same value as the RT_version property

To ensure that the Vendor_id is unique, the recommended approach is to use the stock symbol for the company creating the resource type.

Resource type names created prior to Sun Cluster 3.1 continue to be of the form:

vendor_id.resource_type

The default is the empty string.

Required

RT_version (string)

Starting with Sun Cluster 3.1, a required version string of this resource type implementation. The RT_version is the suffix component of the full resource type name.

Conditional/Explicit

Single_instance (Boolean)

If True, indicates that only one resource of this type can exist in the cluster. Hence, the RGM allows only one resource of this type to run cluster-wide at one time.

The default value is False.

Optional

Start (string)

A callback method: the path to the program that the RGM invokes to start a resource of this type.

Required (unless the RTR file declares a Prenet_start method)

Stop (string)

A callback method: the path to the program that the RGM invokes to stop a resource of this type.

Required (unless the RTR file declares a Postnet_stop method)

Update (string)

An optional callback method: the path to the program that the RGM invokes when properties of a running resource of this type are changed.

Conditional/Explicit

Validate (string)

An optional callback method: the path to the program that will be invoked to check values for properties of resources of this type.

Conditional/Explicit

Vendor_ID (string)

See the Resource_type property.

Conditional