Resource Properties
Table A-2 describes the resource properties defined by Sun Cluster. These descriptions have been developed for data service developers. For more information about a particular data service, see that data service's man page. Resource property values are categorized as follows.
-
Required - The administrator must specify a value when creating a resource with an administrative utility.
-
Optional - If the administrator does not specify a value when creating a resource group, the system supplies a default value.
-
Conditional - The RGM creates the property only if the property is declared in the RTR file. Otherwise, the property does not exist and is not available to system administrators. A conditional property declared in the RTR file is optional or required, depending on whether a default value is specified in the RTR file. For details, see the description of each conditional property.
-
Query-only - Cannot be set directly by an administrative tool.
Table A-2 also lists whether and when resource properties are tunable, as follows.
|
None or False |
Never. |
|
True or Anytime |
Any time. |
|
At_creation |
When the resource is added to a cluster. |
|
When_disabled |
When the resource is disabled. |
Table A-2 Resource Properties
|
Property Name |
Description |
|---|---|
|
Cheap_probe_interval (integer) |
The number of seconds between invocations of a quick fault probe of the resource. This property is only created by the RGM and available to the administrator if it is declared in the RTR file. This property is optional if a default value is specified in the RTR file. If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled. This property is required if the Default attribute is not specified in the property declaration in the RTR file.
Category: Conditional Default: See above Tunable: When disabled |
|
Extension properties |
The developer declares the resource type properties in the initial configuration of the data service at the time the cluster administrator registers the data service with Sun Cluster. For information on the individual attributes you can set for extension properties. see Table A-4.
Category: Conditional Default: No Default Tunable: Depends on the specific property |
|
Failover_mode (enum) |
Controls whether the RGM relocates a resource group or aborts a node in response to a failure of a START or STOP method call on the resource. None indicates that the RGM should just set the resource state on method failure and wait for operator intervention. Soft indicates that failure of a START method should cause the RGM to relocate the resource's group to a different node while failure of a STOP method should cause the RGM to set the resource state and wait for operator intervention. Hard indicates that failure of a START method should cause the relocation of the group and failure of a STOP method should cause the forcible stop of the resource by aborting the cluster node.
Category: Optional Default: No Default Tunable: Any time |
|
Load_balancing_policy (string) |
A string that defines the load-balancing policy in use. This property is used only for scalable services. The RGM automatically creates this property if the Scalable property is declared in the RTR file. Load_balancing_policy can take the following values: Lb_weighted (the default). The load is distributed among various nodes according to the weights set in the Load_balancing_weights property.
Lb_sticky. A given client (identified by the client's IP address) of the scalable service is always sent to the same node of the cluster.
Lb_sticky_wild. A given client (identified by the client's IP address), who connects to an IP address of a wildcard sticky service, is always sent to the same cluster node regardless of the port number it is coming to.
Category: Conditional/Optional Default: Lb_weighted Tunable: At creation |
|
Load_balancing_weights (string array) |
For scalable resources only. The RGM automatically creates this property if the Scalable property is declared in the RTR file. The format is weight@node,weight@node, where weight is an integer that reflects the relative portion of load distributed to the specified node. The fraction of load distributed to a node is the weight for this node divided by the sum of all weights. For example, 1@1,3@2 specifies that node 1 receives 1/4 of the load and node 2 receives 3/4. The empty string (""), the default, sets a uniform distribution. Any node that is not assigned an explicit weight, receives a default weight of 1.
If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is Anytime. Changing this property revises the distribution for new connections only.
Category: Conditional/Optional Default: The empty string Tunable: Any time |
|
method_timeout for each callback method (integer) |
A time lapse, in seconds, after which the RGM concludes that an invocation of the method has failed.
Category: Conditional/Optional Default: 3,600 (one hour) if the method itself is declared in the RTR file. Tunable: Any time |
|
Monitored_switch (enum) |
Set to Enabled or Disabled by the RGM if the cluster administrator enables or disables the monitor with an administrative utility. If Disabled, the monitor does not have its START method called until it is enabled again. If the resource does not have a monitor callback method, this property does not exist.
Category: Query-only Default: Enabled Tunable: Never |
|
Network_resources_used (string array) |
A comma-separated list of logical host name or shared address network resources used by the resource. For scalable services, this property must refer to shared address resources that exist in a separate resource group. For failover services, this property refers to logical host name or shared address resources that exist in the same resource group. The RGM automatically creates this property if the Scalable property is declared in the RTR file. If Scalable is not declared in the RTR file, Network_resources_used is unavailable unless it is explicitly declared in the RTR file.
If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is At_creation.
Category: Conditional/Required Default: No Default Tunable: At creation |
|
On_off_switch (enum) |
Set to Enabled or Disabled by the RGM if the cluster administrator enables or disables the resource with an administrative utility. If disabled, a resource has no callbacks invoked until it is enabled again.
Category: Query-only Default: Disabled Tunable: Never |
|
Port_list (string array) |
A comma-separated list of port numbers on which the server is listening. Appended to each port number is the protocol being used by that port, for example, Port_list=80/tcp. If the Scalable property is declared in the RTR file, the RGM automatically creates Port_list; otherwise, this property is unavailable unless it is explicitly declared in the RTR file.
For specifics on setting up this property for Apache, see the Apache chapter in the Sun Cluster 3.0 12/01 Data Services Installation and Configuration Guide.
Category: Conditional/Required Default: No Default Tunable: At creation |
|
R_description (string) |
A brief description of the resource.
Category: Optional Default: The empty string Tunable: Any time |
|
Resource_dependencies (string array) |
A comma-separated list of resources in the same group that must be online in order for this resource to be online. This resource cannot be started if the start of any resource in the list fails. When bringing the group offline, this resource is stopped before those in the list. Resources in the list are not allowed to be disabled unless this resource is disabled first.
Category: Optional Default: The empty list Tunable: Any time |
|
Resource_dependencies_ weak (string array) |
A list of resources in the same group that determines the order of method calls within the group. The RGM calls the START methods of the resources in this list before the START method of this resource and the STOP methods of this resource before the STOP methods of those in the list. The resource can still be online if those in the list fail to start or are disabled.
Category: Optional Default: The empty list Tunable: Any time |
|
Resource_name (string) |
The name of the resource instance. Must be unique within the cluster configuration and cannot be changed after a resource has been created.
Category: Required Default: No Default Tunable: Never |
|
Resource_state: on each cluster node (enum) |
The RGM-determined state of the resource on each cluster node. Possible states are: Online, Offline, Stop_failed, Start_failed, Monitor_failed, and Online_not_monitored.
This property is not user configurable.
Category: Query-only Default: No Default Tunable: Never |
|
Retry_count (integer) |
The number of times a monitor attempts to restart a resource if it fails. This property is created by the RGM only and available to the administrator if it is declared in the RTR file. It is optional if a default value is specified in the RTR file.
If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled. This property is required if the Default attribute is not specified in the property declaration in the RTR file.
Category: Conditional Default: See above Tunable: When disabled |
|
Retry_interval (integer) |
The number of seconds over which to count attempts to restart a failed resource. The resource monitor uses this property in conjunction with Retry_count. This property is created by the RGM only and available to the administrator if it is declared in the RTR file. It is optional if a default value is specified in the RTR file.
If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled. This property is required if the Default attribute is not specified in the property declaration in the RTR file.
Category: Conditional Default: See above Tunable: When disabled |
|
Scalable (Boolean) |
Indicates whether the resource is scalable. If this property is declared in the RTR file, the RGM automatically creates the scalable service properties Network_resources_used, Port_list, Load_balancing_policy, and Load_balancing_weights for resources of that type. These properties have their default values unless they are explicitly declared in the RTR file. The default for Scalable-when it is declared in the RTR file-is True.
When this property is declared in RTR file, the Tunable attribute must be set to At_creation or resource creation fails.
If this property is not declared in the RTR file, the resource is not scalable, the cluster administrator cannot tune this property, and no scalable service properties are set by the RGM. However, you can explicitly declare the Network_resources_used and Port_list properties in the RTR file, if desired, because they can be useful in a non-scalable service as well as in a scalable service.
Category: Optional Default: See above Tunable: At creation |
|
Status: on each cluster node (enum) |
Set by the resource monitor. Possible values include OK, degraded, faulted, unknown, and offline. The RGM sets the value to unknown when the resource is brought online and to Offline when it is brought offline.
Category: Query-only Default: No Default Tunable: Never |
|
Status_msg: on each cluster node (string) |
Set by the resource monitor at the same time as the Status property. This property is tunable per resource per node. The RGM sets it to the empty string when the resource is brought offline.
Category: Query-only Default: No Default Tunable: Never |
|
Thorough_probe_interval (integer) |
The number of seconds between invocations of a high-overhead fault probe of the resource. This property is created by the RGM only and available to the administrator if it is declared in the RTR file. It is optional if a default value is specified in the RTR file.
If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled. This property is required if the Default attribute is not specified in the property declaration in the RTR file.
Category: Conditional Default: No Default Tunable: When disabled |
|
Type (string) |
An instance's resource type.
Category: Required Default: No Default Tunable: Never |
- © 2010, Oracle Corporation and/or its affiliates