Resource Properties

This section describes the resource properties that are defined by Sun Cluster. The property values are categorized as follows (after Category):

• 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 that is 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.

Tunable lists whether and when you can update resource properties, as follows:

Property names are shown first, followed by a description.

Affinity_timeout (integer)

Length of time in seconds during which connections from a given client IP address for any service in the resource are sent to the same server node.

This property is relevant only when Load_balancing_policy is either Lb_sticky or Lb_sticky_wild. In addition, Weak_affinity must be set to FALSE (the default value).

This property is only used for scalable services.

Category:

Optional

Default:

No default

Tunable:

ANYTIME

Cheap_probe_interval (integer)

The number of seconds between invocations of a quick fault probe of the resource. This property is created by the RGM and available to the administrator only 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 it is declared in the RTR file and the Default attribute is not specified.

Category:

Conditional

Default:

No default

Tunable:

WHEN_DISABLED

Extension properties

Extension properties as declared in the RTR file of the resource's type. The implementation of the resource type defines these properties. Resource Property Attributes contains information about the individual attributes that you can set for extension properties.

Category:

Conditional

Default:

No default

Tunable:

Depends on the specific property

Failover_mode (enum)

NONE, SOFT, and HARD affect only failover behavior when a start method (Prenet_start or Start) fails. Once the resource has started successfully, however, NONE, SOFT, and HARD have no effect on subsequent resource restart or giveover behavior that the resource monitor initiates with scha_control(1HA) or scha_control(3HA). NONE (the default) indicates that the RGM is to set the resource state on method failure and wait for the user to intervene. SOFT indicates that, if a Start method fails, the RGM is to relocate the resource's group to a different node. If a Stop or Monitor_stop method fails, the RGM sets the resource to Stop_failed state and the resource group to Error_stop_failed state. The RGM then waits for the user to intervene. For Stop or Monitor_stop failures, NONE and SOFT are the same. HARD indicates that, if a Start method fails, the RGM is to relocate the group. If a Stop or Monitor_stop method fails, the RGM is to stop the resource by aborting the cluster node. HARD, NONE, SOFT affect failover behavior when a Start or Prenet_start method fails.

Unlike NONE, SOFT, and HARD, RESTART_ONLY and LOG_ONLY affect all failover behavior, including monitor-initiated (scha_control) restarts of resources and resource groups, and giveovers that are initiated by the resource monitor (scha_control). RESTART_ONLY indicates that the monitor can run scha_control to restart a resource, but attempts to perform a resource group restart or giveover with scha_control subsequently fail. The RGM allows Retry_count restarts within Retry_interval. If Retry_count is exceeded, no resource restarts are permitted. If Failover_mode is set to LOG_ONLY, no resource restarts or giveovers are permitted. Setting Failover_mode to LOG_ONLY is the same as setting Failover_mode to RESTART_ONLY with Retry_count set to zero. If a start method fails, RESTART_ONLY and LOG_ONLY are the same as NONE: no failover occurs and the resource moves to Start_failed state.

Category:

Optional

Default:

No default

Tunable:

ANYTIME

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 IP address) of the scalable service is always sent to the same node of the cluster.

Lb_sticky_wild. A given client's IP address that connects to an IP address of a wildcard sticky service is always sent to the same cluster node, regardless of the port number to which the IP address is coming.

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:

ANYTIME

method_timeout for each callback method in the Type (integer)

A time lapse, in seconds, after which the RGM concludes that an invocation of the method has failed.

Category:

Conditional/Optional

Default:

3600 (one hour), if the method itself is declared in the RTR file

Tunable:

ANYTIME

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:

No default

Tunable:

Never

Network_resources_used (string_array)

A list of logical host name or shared address network resources that are 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 resource type file, the Tunable value for the property is AT_CREATION.

---

Note –

The SUNW.Event(5) man page describes how to set up this property for CRNP.

---

Category:

Conditional/Required

Default:

No default

Tunable:

AT_CREATION

Num_resource_restarts on each cluster node (integer)

You cannot directly set this property, as it is set by the RGM to the number of scha_control, Resource_restart, or Resource_is_restarted calls that have been made for this resource on this node within the past n seconds. n is the value of the Retry_interval property of the resource. The resource restart counter is reset to zero by the RGM whenever a scha_control giveover is executed by this resource, whether the giveover attempt succeeds or fails.

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.

Category:

Query-only

Default:

No default

Tunable:

No

Num_rg_restarts on each cluster node (integer)

You cannot directly set this property, which is set by the RGM to the number of scha_control Restart calls that have been made by this resource for its containing resource group 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_rg_restarts property is not available for resources of that type.

Category:

See description

Default:

No default

Tunable:

No

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 is brought offline and then has no callbacks invoked until it is enabled again.

Category:

Query-only

Default:

No default

Tunable:

Never

Port_list (string_array)

A list of port numbers on which the server is listening. Appended to each port number is a slash (/) followed by the protocol that is being used by that port, for example, Port_list=80/tcp or Port_list=80/tcp6,40/udp6. You can specify the following protocol values:

• tcp, for TCP IPv4

• tcp6, for TCP IPv6

• udp, for UDP IPv4

• udp6, for UDP IPv6

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.

Setting up this property for Apache is described in the Sun Cluster Data Service for Apache Guide for Solaris OS.

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:

ANYTIME

Resource_dependencies (string_array)

A list of resources in the same or in different groups on which this resource has a strong dependency. This resource cannot be started if any resource in the list is not online. If this resource and one of the resources in the list start at the same time, the RGM waits until the resource in the list starts before the RGM starts this resource. If the resource in this resource's Resource_dependencies list does not start, this resource also remains offline. The resource in this resource's list might not start because the resource group for the resource in the list remains offline or because the resource in the list is in a Start_failed state. If this resource remains offline because of a dependency on a resource in a different resource group that fails to start, this resource's group enters a Pending_online_blocked state.

If this resource is brought offline at the same time as those resources in the list, this resource stops before those in the list. However, if this resource remains online or fails to stop, a resource in the list that is in a different resource group stops anyway. Resources in the list cannot be disabled unless this resource is disabled first.

By default in a resource group, application resources have an implicit strong resource dependency on network address resources. Implicit_network_dependencies in Resource Group Properties contains more information.

Within a resource group, Prenet_start methods are run in dependency order before Start methods. Postnet_stop methods are run in dependency order after Stop methods. In different resource groups, the dependent waits for the depended-on resource to finish Prenet_start and Start before it runs Prenet_start. The depended-on resource waits for the dependent to finish Stop and Postnet_stop before it runs Stop.

Category:

Optional

Default:

The empty list

Tunable:

ANYTIME

Resource_dependencies_restart (string_array)

A list of resources in the same or in different groups on which this resource has a restart dependency.

This property works just as Resource_dependencies does, except that, if any resource in the restart dependency list is restarted, this resource is restarted. The restart of this resource occurs after the resource in the list comes back online.

Category:

Optional

Default:

The empty list

Tunable:

ANYTIME

Resource_dependencies_weak (string_array)

A list of resources in the same or in different groups on which this resource has a weak dependency. A weak dependency determines the order of method calls The RGM calls the Start methods of the resources in this list before the Start method of this resource. The RGM calls the Stop methods of this resource before the Stop methods of those in the list. The resource can still start if those in the list fail to start or remain offline.

If this resource and a resource in its Resource_dependencies_weak list start concurrently, the RGM waits until the resource in the list starts before the RGM starts this resource. If the resource in the list does not start—for example, if the resource group for the resource in the list remains offline or the resource in the list is in a Start_failed state—this resource starts. This resource's resource group might enter a Pending_online_blocked state temporarily as resources in this resource's Resource_dependencies_weak list start. When all resources in the list have started or failed to start, this resource starts and its group reenters the Pending_online state.

If this resource is brought offline at the same time as those in the list, this resource stops before those in the list. If this resource remains online or fails to stop, a resource in the list stops anyway. You cannot disable resources in the list unless this resource is disabled first.

Within a resource group, Prenet_start methods are run in dependency order before Start methods. Postnet_stop methods are run in dependency order after Stop methods. In different resource groups, the dependent waits for the depended-on resource to finish Prenet_start and Start before it runs Prenet_start. The depended-on resource waits for the dependent to finish Stop and Postnet_stop before it runs Stop.

Category:

Optional

Default:

The empty list

Tunable:

ANYTIME

Resource_name (string)

The name of the resource instance. This name 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_project_name (string)

The Solaris project name that is associated with the resource. Use this property to apply Solaris resource management features such as CPU shares and resource pools to cluster data services. When the RGM brings resources online, it launches the related processes under this project name. If this property is not specified, the project name is taken from the RG_project_name property of the resource group that contains the resource (see rg_properties (5)). If neither property is specified, the RGM uses the predefined project name default. The specified project name must exist in the projects database and the user root must be configured as a member of the named project. This property is supported in Solaris 9 and later versions of Solaris only.

---

Note –

Changes to this property take effect the next time the resource is started.

---

Category:

Optional

Default:

Null

Tunable:

ANYTIME

Resource_state on each cluster node (enum)

The RGM-determined state of the resource on each cluster node. Possible states are Online, Offline, Start_failed, Stop_failed, Monitor_failed, Online_not_monitored, Starting, and Stopping.

You cannot configure this property.

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 and available to the administrator only if it is declared in the RTR file. Retry_count 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 it is declared in the RTR file and the Default attribute is not specified.

Category:

Conditional

Default:

No default

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 and available to the administrator only if it is declared in the RTR file. Retry_interval 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 it is declared in the RTR file and the Default attribute is not specified.

Category:

Conditional

Default:

No default

Tunable:

WHEN_DISABLED

Scalable (boolean)

Indicates whether the resource is scalable, that is, whether the resource uses the networking load-balancing features of Sun Cluster.

If this property is declared in the RTR file, the RGM automatically creates the following scalable service properties for resources of that type: Affinity_timeout, Load_balancing_policy, Load_balancing_weights, Network_resources_used, Port_list, UDP_affinity, and Weak_affinity. 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.

If this property is declared in the RTR file, it is not permitted to be assigned a Tunable attribute other than AT_CREATION.

If this property is not declared in the RTR file, the resource is not scalable, you 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, because these properties can be useful in a nonscalable service as well as in a scalable service.

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

Using this resource property in combination with the Failover resource type property is described in more detail in r_properties(5).

Category:

Optional

Default:

No default

Tunable:

AT_CREATION

Status on each cluster node (enum)

Set by the resource monitor with scha_resource_setstatus(1HA) or scha_resource_setstatus(3HA). Possible values are OK, degraded, faulted, unknown, and offline. When a resource is brought online or offline, the RGM automatically sets the Status value if the Status value is not set by the resource's monitor or methods.

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. When a resource is brought online or offline, the RGM automatically resets this property to the empty string if this property is not set by the resource's methods.

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 and available to the administrator only if it is declared in the RTR file. Thorough_probe_interval 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)

The resource type of which this resource is an instance.

Category:

Required

Default:

No default

Tunable:

Never

Type_version (string)

Specifies which version of the resource type is currently associated with this resource. The RGM automatically creates this property, which cannot be declared in the RTR file. The value of this property is equal to the RT_version property of the resource's type. When a resource is created, the Type_version property is not specified explicitly, though it might appear as a suffix of the resource type name. When a resource is edited, the Type_version can be changed to a new value.

The tunability of this property is derived from the following sources:

• The current version of the resource type

• The #$upgrade_from directive in the RTR file

Category:

See description

Default:

No default

Tunable:

See description

UDP_affinity (boolean)

If true, all UDP traffic from a given client is sent to the same server node that currently handles all TCP traffic for the client.

This property is relevant only when Load_balancing_policy is either Lb_sticky or Lb_sticky_wild. In addition, Weak_affinity must be set to FALSE (the default value).

This property is only used for scalable services.

Category:

Optional

Default:

No default

Tunable:

WHEN_DISABLED

Weak_affinity (boolean)

If true, enable the weak form of the client affinity. The weak form of the client affinity allows connections from a given client to be sent to the same server node except when the following conditions occur:

• A server listener starts, in response to, for example, a fault monitor's restarting, a resource's failing over or switching over, or a node's rejoining a cluster after failing

• Load_balancing_weights for the scalable resource changes because of an administrative action

Weak affinity provides a low-overhead alternative to the default form, both in terms of memory consumption and processor cycles.

This property is relevant only when Load_balancing_policy is either Lb_sticky or Lb_sticky_wild.

This property is only used for scalable services.

Category:

Optional

Default:

No default

Tunable:

WHEN_DISABLED