Sun Cluster Data Services Developer's Guide for Solaris OS

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 the property is not, 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 cannot be updated 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

Can Be Updated?

Category

Allow_hosts (string array)

Controls the set of clients that are allowed to register with the cl_apid daemon to receive cluster reconfiguration events. The general form of this property is ipaddress/masklength, which defines a subnet from which the clients are allowed to register. For example, the setting 129.99.77.0/24 allows clients on the subnet 129.99.77 to register for events. As another example, 192.9.84.231/32 allows only the client 192.9.84.231 to register for events. This property provides security to the CRNP. The cl_apid daemon is described in SUNW.Event(5).

In addition, the following special keywords are recognized. LOCAL refers to all clients that are located in directly connected subnets of the cluster. ALL allows all clients to register. Note that if a client matches an entry in both the Allow_hosts and the Deny_hosts property, that client is prevented from registering with the implementation.

The default is LOCAL.

Optional

API_version (integer)

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

The default for Sun Cluster 3.1 4/04 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

Client_retry_count (integer)

Controls the number of attempts made by the cl_apid daemon while communicating with external clients. If a client fails to respond within Client_retry_count attempts, the client times out. The client is subsequently removed from the list of registered clients that are eligible to receive cluster reconfiguration events. The client must re-register in order to start receiving events again. See the description of the Client_retry_interval property to learn more about how often these retries are made by the implementation. The cl_apid daemon is described in SUNW.Event(5).

The default is 3.

Optional

Client_retry_interval (integer)

Defines the time period (in seconds) used by the cl_apid daemon while communicating with unresponsive external clients. Up to Client_retry_count attempts are made during this interval to contact the client. The cl_apid daemon is described in SUNW.Event(5).

The default is 1800.

Optional

Client_timeout (integer)

The time-out value (in seconds) that is used by the cl_apid daemon while communicating with external clients. However, the cl_apid daemon continues to attempt to contact the client for a tunable number of times. See the descriptions of the Client_retry_count and Client_retry_interval properties to learn more about the means that you can use to tune this property. The cl_apid daemon is described in SUNW.Event(5).

The default is 60.

Optional

Deny_hosts (string array)

Controls the set of clients that are prevented from registering to receive cluster reconfiguration events. To determine access, the settings of this property take precedence over those in the Allow_hosts list. The format of this property is the same as the format that is defined in the Allow_hosts property. This property provides security to the CRNP.

The default is NULL.

Optional

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.

Can be configured by the cluster administrator

Max_clients (integer)

Controls the maximum number of clients that can register with the cl_apid daemon to receive notification of cluster events. Attempts by additional clients to register for events are rejected by your application. Since each client registration uses resources on the cluster, tuning this property allows users to control resource usage on the cluster by external clients. The cl_apid daemon is described in SUNW.Event(5).

The default is 1000.

Optional

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) on which a resource of this type depends. 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

Resource_type (string)

The name of the resource type. To view the names of the currently registered resource types, use:

scrgadm -p

In Sun Cluster 3.1 and later releases, a resource type name includes the version, which is mandatory:

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 use the syntax:

vendor_id.resource_type

The default is the empty string.

Required

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

RT_version (string)

Starting in 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. The RT_version property, which was optional in Sun Cluster 3.0, is mandatory starting in Sun Cluster 3.1.

Conditional/ Explicit

Single_instance (Boolean)

If True, indicates that only one resource of this type can exist in the cluster. 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