Resource Type Properties
Table A-1 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.0 is 2. |
N |
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. |
N |
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. |
N |
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. |
N |
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. |
N |
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. |
N |
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. |
Y |
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. |
N |
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. |
N |
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. |
N |
Conditional/Explicit |
|
Pkglist (string array) |
An optional list of packages that are included in the resource type installation. |
N |
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. |
N |
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. |
N |
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. |
N |
Required (unless all method path names are absolute) |
|
RT_description (string) |
A brief description of the resource type.
The default is the empty string. |
N |
Conditional |
|
Resource_type (string) |
The name of the resource type. Must be unique in the cluster installation. You must declare this property as the first entry in the RTR file; otherwise, registration of the resource type fails.
In addition, you can specify Vendor_id to identify the resource type. Vendor_id serves as a prefix that is separated from a resource type name by a ".", for example, SUNW.http. You can completely identify the resource type with Resource_type and Vendor_id or omit Vendor_id. For example, both SUNW.http and http are valid. If you specify the Vendor_id, use the stock symbol for the company that defines the resource type. If two resource-types in the cluster differ only in the Vendor_id prefix, the use of the abbreviated name fails.
The default is the empty string. |
N |
Required |
|
RT_version (string) |
An optional version string of this resource type implementation. |
N |
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. |
N |
Optional |
|
START (string) |
A callback method: the path to the program that the RGM invokes to start a resource of this type. |
N |
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. |
N |
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. |
N |
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. |
N |
Conditional/Explicit |
|
Vendor_ID (string) |
See the Resource_type property. |
N |
Conditional |
- © 2010, Oracle Corporation and/or its affiliates