Resource Type Properties
The following information describes the resource type properties that are defined by Sun Cluster. The property values are categorized as follows (after Category):
-
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.
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.
Property names are shown first, followed by a description.
- 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
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:
-
No
- 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 that are similar to the Init method.
- Category:
-
Conditional/Explicit
- Default:
-
None
- Tunable:
-
No
- Failover (boolean)
-
TRUE indicates that resources of this type cannot be configured in any group that can be online on multiple nodes at once.
- Category:
-
Optional
- Default:
-
FALSE
- Tunable:
-
No
- 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:
-
None
- Tunable:
-
No
- 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:
-
None
- Tunable:
-
No
- 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:
-
No
- 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.
- Category:
-
Can be configured by the cluster administrator
- Default:
-
All cluster nodes
- Tunable:
-
Yes
- 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:
-
No
- Is_shared_address (boolean)
-
TRUE indicates that this resource type is some version of the SharedAddress resource type that manages failover Internet Protocol (IP) addresses.
- Category:
-
Query-only
- Default:
-
No default
- Tunable:
-
No
- 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:
-
No
- 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:
-
No
- 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:
-
No
- Pkglist (string_array)
-
An optional list of packages that are included in the resource type installation.
- Category:
-
Conditional/Explicit
- Default:
-
No default
- Tunable:
-
No
- 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:
-
No
- 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:
-
No
- 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:
-
No
- 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:
-
No
- RT_description (string)
-
A brief description of the resource type.
- Category:
-
Conditional
- Default:
-
Empty string
- Tunable:
-
No
- RT_system (boolean)
-
Indicates, when set to TRUE on a resource type, that the permitted scrgadm(1M) operations on that resource type are restricted. A resource type whose RT_system value is set to TRUE is called a system resource type. Editing the RT_system property itself is never restricted, regardless of the current value of RT_system.
- Category:
-
Optional
- Default:
-
FALSE
- Tunable:
-
Yes
- 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:
-
Optional/Explicit or Required
- Default:
-
No default
- Tunable:
-
No
- 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:
-
No
- 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:
-
No
- 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:
-
No
- 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:
-
No
- 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:
-
No
- Vendor_ID (string)
-
See the Resource_type property.
- Category:
-
Conditional
- Default:
-
No default
- Tunable:
-
No
- © 2010, Oracle Corporation and/or its affiliates