r_properties(5)

NAME | DESCRIPTION | SEE ALSO

NAME

r_properties– resource properties

DESCRIPTION

The list below 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

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.

All properties that are designated as tunable can be edited by the system administrator using the command:

# scrgadm -c -j <resource> -y <property>=<new value>

Resource Properties and Descriptions

Affinity_timeout (integer)

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

-1

All connections are sent to the same node.

0

All open connections are sent to the same node.

<n>

Specified <n> number of seconds after the last connection has closed, all new connections are sent to the same node as the last connection.

In all cases, if the server node leaves the cluster as a result of a failure, a new server node will be selected.

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

Conditional/Optional

Default

0

Tunable

Anytime

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 RTR file. The RTR file defines 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 property_attributes(5).

Category

Conditional

Default

No Default

Tunable

Depends on the specific property

Failover_mode (enum)

Possible settings are None, Soft, and Hard. Controls whether the RGM relocates a resource group or aborts a node in response to a failure of a START, STOP, or MONITOR_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 or MONITOR_STOP method should cause the RGM to set the resource to STOP_FAILED state and the resource group to ERROR_STOP_FAILED state and wait for operator intervention. For STOP or MONITOR_STOP failures, the None and Soft settings are equivalent. Hard indicates that failure of a START method should cause the relocation of the group and failure of a STOP or MONITOR_STOP method should cause the forcible stop of the resource by aborting the cluster node.

Category

Optional

Default

None

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. The set of ports is known at the time the application resources are configured. 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. The port numbers are not known in advance but are dynamically assigned. 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. You can specify weight 0 to assign no load to a node.

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

Null

Tunable

Any time

method_timeout for each callback method

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

Note: You cannot specify a maximum value for a method timeout (using the Max attribute). Likewise, you cannot specify a minimum value of zero (Min=0).

Category

Conditional/Optional

Default

3,600 (one hour) if the method itself is declared in the RTR file.

Tunable

Any time

Monitored_switch (enum)

You cannot directly set this property. Rather, it is 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_START method will not be called on the resource until monitoring is enabled again. If the resource does not have a monitor callback method, this property evaluates to Disabled.

Category

Query-only

Default

Enabled if the resource type has monitoring methods; disabled otherwise.

Tunable

See description

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

Num_resource_restarts: on each cluster node (integer)

You cannot directly set this property. Rather, it is set by the RGM to the number of scha_control RESOURCE_RESTART and/or RESOURCE_IS_RESTARTED calls that have been made for this resource 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_resource_restarts property is not available for resources of that type.

Category

Query-only

Default

No Default

Tunable

See description

Num_rg_restarts: on each cluster node (integer)

You cannot directly set this property. Rather, it is set by the RGM to the number of scha_control RESTART calls that have been made by this resource for its containing RG 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

Query-only

Default

No Default

Tunable

See description

On_off_switch (enum)

You cannot directly set this property. Rather, it is 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

See description

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.1 Data Services Installation

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. Resources in the list are not allowed to be disabled unless this resource is first 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_project_name (string)

The Solaris project name (see projects(1)) 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 will be 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 will use 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 (see projects(1) and System Administration Guide: Resource Management and Network Services). This property is only suppored starting in Solaris 9.

---

Note –

Changes to this property take effect after the resource has been restarted.

---

Category

Optional

Default

Null

Tunable

Any time

Valid value

Any valid Solaris project name, or Null

Resource_state: on each cluster node (enum)

The RGM-determined state of the resource on each cluster node. Possible states include: 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 and made available to the administrator only 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 and made available to the administrator only 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.

---

Note –

If the Retry_interval property is not declared, the call to scha_resource_get (num_*_restarts) fails with exit 13 (SCHA_ERR_RT).

---

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 following scalable service properties for resources of that type: Network_resources_used, Port_list, Load_balancing_policy, and Load_balancing_weights. 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, 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 are: Online, Degraded, Faulted, Unknown, and Offline. The RGM sets the value to Online when the resource is started, if it is not already set by the START (or PRENET_START) method; and to Offline when the resource is stopped, if it is not already set by the STOP (or POSTNET_STOP) method.

Category

Query-only

Default

No Default

Tunable

Only by using scha_resource_setstatus(1HA)

Status_msg: on each cluster node (string)

Set by the resource monitor at the same time as the Status property. The RGM sets it to the empty string when the resource is brought Offline, if it was not already set by the STOP (or POSTNET_STOP) method.

Category

Query-only

Default

No Default

Tunable

Only by using scha_resource_setstatus(1HA)

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. 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

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 explictly, though it may appear as a suffix of the resource type name. When a resource is edited, the Type_version may be changed to a new value.

Category

See above

Default

None

Tunable

Its tunability is derived from:

• The current version of the resource type

• The #$upgrade_from directive in the resource type registration file (see rt_reg(4))

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

Conditional/Optional

Default

False

Tunable

Anytime

Weak_affinity (Boolean)

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

• When a server listener starts up, for example, due to a fault monitor restart, a resource failover or switchover, or a node rejoining a cluster after failing.

• When load_balancing_weights for the scalable resource changes due to an administration 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

Conditional/Optional

Default

False

Tunable

Anytime

SEE ALSO

projects(1), scrgadm(1M), rt_reg(4), property_attributes(5), rg_properties(5), rt_properties(5)

Sun Cluster 3.1 Data Services Developer's Guide, System Administration Guide: Resource Management and Network Services

Sun Cluster 3.1  Last Revised 29 Apr 2002

NAME | DESCRIPTION | SEE ALSO