rt_properties(5)

NAME | DESCRIPTION | SEE ALSO

NAME

rt_properties– resource type properties

DESCRIPTION

The following information describes the resource type properties that are defined by Sun Cluster. These descriptions have been developed for data service developers. For information about a particular data service, see that data service man page.

Resource Type Property Values

Required

The property requires an explicit value in the Resource Type Registration (RTR) file. Otherwise, the object to which the property 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 the property and the property 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 the property and the property 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 declared in the RTR file, 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.

Query-only

The property cannot be set directly by an administrative utility. These properties are not set in the RTR file.

---

Note –

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

---

Resource Type Properties and Descriptions

A resource type is defined by a resource type registration file that specifies standard and extension property values for the resource type.

---

Note –

Resource type property names, such as API_version and Boot, are not case sensitive. You can use any combination of uppercase and lowercase letters when you specify property names.

---

API_version (integer)

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

The following information summarizes the maximum API_version that is supported by each release of Sun Cluster.

Before and up to 3.1

2

3.1 10/03

3

3.1 4/04

4

3.1 9/04

5

3.1 3/05

6

Declaring a value for API_version that is greater than 2 in the RTR file prevents that resource type from being installed on a version of Sun Cluster that supports a lower maximum version. For example, if you declare API_version=5 for a resource type, that resource type cannot be installed on any version of Sun Cluster that was released before 3.1 9/04.

Category

Optional

Default

2

Tunable

Never

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 initialize resources of this type similar to the Init method.

Category

Conditional/Explicit

Default

None

Tunable

Never

Failover (boolean)

TRUE indicates that resources of this type cannot be configured in any group that can be online on multiple nodes at once.

You use this resource type property in combination with the Scalable resource property, as follows:

If FAILOVER is	If Scalable is	Description
TRUE	TRUE	Do not specify this illogical combination.
TRUE	FALSE	Specify this combination for a failover service.
FALSE	TRUE	Specify this combination for a scalable service that uses a SharedAddress resource for network load balancing. The Sun Cluster Concepts Guide describes SharedAddress in more detail.
FALSE	FALSE	Although it is an unusual combination, you can use this combination to select a multi-master service that does not use network load balancing.

The description for Scalable in r_properties(5) and “Key Concepts – Administration and Application Development” in Sun Cluster Concepts Guide for Solaris OS contain additional information.

Category

Optional

Default

FALSE

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

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.

Category

Optional

Default

RG_primaries

Tunable

Never

Installed_nodes (string_array)

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

Category

Can be configured by the cluster administrator

Default

All cluster nodes

Tunable

Any time

Is_logical_hostname (boolean)

TRUE indicates that this resource type is some version of the LogicalHostname resource type that manages failover Internet Protocol (IP) addresses.

Category

Query-only

Default

No default

Tunable

Never

Is_shared_address (boolean)

TRUE indicates that this resource type is some version of the SharedAddress resource type that manages failover IP (Internet Protocol) addresses.

Category

Query-only

Default

No default

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

Pkglist (string_array)

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

Category

Conditional/Explicit

Default

No default

Tunable

Never

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 on which a resource of this type depends. After the network interfaces are configured down, this method must perform Stop actions.

Category

Conditional/Explicit

Default

No default

Tunable

Never

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 on which a resource of this type depends. This method is expected to perform Start actions that must be performed before network interfaces are configured.

Category

Conditional/Explicit

Default

No default

Tunable

Never

Resource_list (string_array)

The list of all resources of the resource type. The administrator does not set this property directly. Rather, the RGM updates this property when the administrator adds or removes a resource of this type to or from any resource group.

Category

Query-only

Default

Empty list

Tunable

Never

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 that are 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 that were created before Sun Cluster 3.1 continue to use the syntax:

vendor_id.resource_type

Category

Required

Default

Empty string

Tunable

Never

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. The path must be a complete path, that is, the path must start with a forward slash (/). This property is not required if all the method path names are absolute.

Category

Required unless all method path names are absolute

Default

No default

Tunable

Never

RT_description (string)

A brief description of the resource type.

Category

Conditional

Default

Empty string

Tunable

Never

RT_system (boolean)

If the RT_system property is TRUE for a resource type, you cannot delete the resource type (scrgadm -r -t resource_type_name). This property is intended to help prevent accidental deletion of resource types, such as LogicalHostname, that are used to support the cluster infrastructure. However, you can apply the RT_system property to any resource type.

To delete a resource type whose RT_system property is set to TRUE, you must first set the property to FALSE. Use care when you delete a resource type whose resources support cluster services.

Category

Optional

Default

FALSE

Tunable

Any time

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 in Sun Cluster 3.1 and later releases.

Category

Conditional/Explicit or Required

Default

No default

Tunable

Never

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.

Category

Optional

Default

FALSE

Tunable

Never

Start (string)

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

Category

Required unless the RTR file declares a Prenet_start method

Default

No default

Tunable

Never

Stop (string)

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

Category

Required unless the RTR file declares a Postnet_stop method

Default

No default

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

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.

Category

Conditional/Explicit

Default

No default

Tunable

Never

Vendor_ID (string)

See the Resource_type property.

Category

Conditional

Default

No default

Tunable

Never

SEE ALSO

scrgadm(1M), rt_reg(4), property_attributes(5), r_properties(5), rg_properties(5)

Sun Cluster 3.1  Last Revised 27 Oct 2004

NAME | DESCRIPTION | SEE ALSO