rg_properties(5)

NAME | DESCRIPTION | SEE ALSO

NAME

rg_properties– resource group properties

DESCRIPTION

The list below describes the resource group properties that are defined by Sun Cluster.

Resource Group Properties and Descriptions

---

Note –

Resource group property names, such as Auto_start_on_new_cluster and Desired_primaries, are not case sensitive. You can use any combination of uppercase and lowercase letters when you specify resource group property names.

---

Auto_start_on_new_cluster (boolean)

This property controls whether the Resource Group Manager (RGM) starts the resource group automatically when a new cluster is forming. The default is TRUE.

If set to TRUE, the RGM attempts to start the resource group automatically to achieve Desired_primaries when all the nodes of the cluster are simultaneously rebooted.

If set to FALSE, the resource group does not start automatically when the cluster is rebooted. The resource group remains offline until the first time that the resource group is manually switched online by using scswitch(1M) or the equivalent graphical user interface command. After that, the resource group resumes normal failover behavior.

Default

TRUE

Tunable

Any time

Desired_primaries (integer)

The desired number of nodes that the group can run on simultaneously.

The default is 1. If the RG_mode property is Failover, the value of this property must be no greater than 1. If the RG_mode property is Scalable, a value greater than 1 is allowed.

Default

1, see above

Tunable

Any time

Failback (boolean)

A Boolean value that indicates whether to recalculate the set of nodes where the group is online when the cluster membership changes. A recalculation can cause the RGM to bring the group offline on less preferred nodes and online on more preferred nodes.

Default

FALSE

Tunable

Any time

Global_resources_used (string_array)

Indicates whether cluster file systems are used by any resource in this resource group. Legal values that the administrator can specify are an asterisk (*) to indicate all global resources, and the empty string (“”) to indicate no global resources.

Default

All global resources

Tunable

Any time

Implicit_network_dependencies (boolean)

A Boolean value that indicates, when TRUE, that the RGM should enforce implicit strong dependencies of non-network-address resources on network-address resources within the group. This means that the RGM starts all network-address resources before all other resources and stops network address resources after all other resources within the group. Network-address resources include the logical host name and shared address resource types.

In a scalable resource group, this property has no effect because a scalable resource group does not contain any network-address resources.

Default

TRUE

Tunable

Any time

Maximum_primaries (integer)

The maximum number of nodes where the group might be online at once.

If the RG_mode property is Failover, the value of this property must be no greater than 1. If the RG_mode property is Scalable, a value greater than 1 is allowed.

Default

1, see above

Tunable

Any time

Nodelist (string_array)

A list of cluster nodes where the group can be brought online in order of preference. These nodes are known as the potential primaries or masters of the resource group.

Default

The list of all cluster nodes in arbitrary order

Tunable

Any time

Pathprefix (string)

A directory in the cluster file system in which resources in the group can write essential administrative files. Some resources might require this property. Make Pathprefix unique for each resource group.

Default

The empty string

Tunable

Any time

Pingpong_interval (integer)

A non-negative integer value (in seconds) used by the RGM to determine where to bring the resource group online in the event of a reconfiguration or as the result of an scha_control giveover command or function being executed.

In the event of a reconfiguration, if the resource group fails more than once to come online within the past Pingpong_interval seconds on a particular node (because the resource's Start or Prenet_start method exited nonzero or timed out), that node is considered ineligible to host the resource group and the RGM looks for another master.

If a scha_control(1HA) command or scha_control(3HA) giveover is executed on a given node by a resource, thereby causing its resource group to fail over to another node, the first node (on which scha_control was invoked) cannot be the destination of another scha_control giveover by the same resource until Pingpong_interval seconds have elapsed.

Default

3600 (one hour)

Tunable

Any time

Resource_list (string_array)

The list of resources that are contained in the group. The administrator does not set this property directly. Rather, the RGM updates this property as the administrator adds or removes resources from the resource group.

Default

No default

Tunable

Never

RG_affinities (string)

The RGM is to try to locate a resource group on a node that is a current master of another given resource group (positive affinity), or to locate a resource group on a node that is not a current master of a given resource group (negative affinity).

You can set RG_affinities to the following strings:

• ++, or strong positive affinity

• +, or weak positive affinity

• -, or weak negative affinity

• --, or strong negative affinity

• +++, or strong positive affinity with failover delegation

For example, RG_affinities=+RG2,--RG3 indicates that this resource group has a weak positive affinity for RG2 and a strong negative affinity for RG3.

Using RG_affinities is described in “Administering Data Service Resources” in Sun Cluster Data Services Planning and Administration Guide for Solaris OS.

Default

The empty string

Tunable

Any time

RG_dependencies (string_array)

Optional list of resource groups that indicate a preferred ordering for bringing other groups online or offline on the same node. The graph of all strong RG_affinities (positive and negative) together with RG_dependencies is not allowed to contain cycles.

For example, suppose that resource group RG2 is listed in the RG_dependencies list of resource group RG1. In other words, suppose that RG1 has a resource group dependency on RG2. The following list summarizes the effects of this resource group dependency:

• When a node joins the cluster, Boot methods on that node are not run on resources in RG1 until all Boot methods on that node have completed on resources in RG2.

• If RG1 and RG2 are both in the PENDING_ONLINE state on the same node at the same time, the starting methods (Prenet_start or Start) are not run on any resources in RG1 until all the resources in RG2 have completed their starting methods.

• If RG1 and RG2 are both in the PENDING_OFFLINE state on the same node at the same time, the stopping methods (Stop or Postnet_stop) are not run on any resources in RG2 until all the resources in RG1 have completed their stopping methods.

• An attempt to switch the primaries of RG1 or RG2 fails if switching the primaries would leave RG1 online on any node and RG2 offline on all nodes. scswitch(1M) and scsetup(1M) contain more information.

• Setting the Desired_primaries property to a value that is greater than zero on RG1 is not permitted if Desired_primaries is set to zero on RG2.

• Setting the Auto_start_on_new_cluster property to TRUE on RG1 is not permitted if Auto_start_on_new_cluster is set to FALSE on RG2.

Default

The empty list

Tunable

Any time

RG_description (string)

A brief description of the resource group.

Default

The empty string

Tunable

Any time

RG_is_frozen (boolean)

A Boolean value that indicates whether a global device on which a resource group depends is being switched over. If this property is set to TRUE, the global device is being switched over. If this property is set to FALSE, no global device is being switched over. A resource group depends on global devices as indicated by its Global_resources_used property.

You do not set the RG_is_frozen property directly. The RGM updates the RG_is_frozen property when the status of the global devices changes.

Default

No default

Tunable

Never

RG_mode (enum)

Indicates whether the resource group is a failover or a scalable group. If the value is Failover, the RGM sets the Maximum_primaries property of the group to 1 and restricts the resource group to being mastered by a single node.

If the value of this property is Scalable, the RGM allows the Maximum_primaries property to be set to a value that is greater than 1. As a result, the group can be mastered by multiple nodes simultaneously. The RGM does not allow a resource whose Failover property is TRUE to be added to a resource group whose RG_mode is Scalable.

If Maximum_primaries is 1, the default is Failover. If Maximum_primaries is greater than 1, the default is Scalable.

Default

Depends on the value of Maximum_primaries

Tunable

At creation

RG_name (string)

The name of the resource group. This property is required and must be unique within the cluster.

Default

No default

Tunable

At creation

RG_project_name (string)

The Solaris project name (see projects(1)) that is associated with the resource group. Use this property to apply Solaris resource management features, such as CPU shares and resource pools, to cluster data services. When the RGM brings resource groups online, it launches the related processes under this project name for resources that do not have the Resource_project_name property set (see r_properties(5)). The specified project name must exist in the projects database (see projects(1) and System Administration Guide: Resource Management and Network Services).

This property is only supported starting in Solaris 9.

---

Note –

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

---

Default

The text string “default”

Tunable

Any time

Valid value

Any valid Solaris project name

RG_state on each cluster node (enum)

Set by the RGM to UNMANAGED, ONLINE, OFFLINE, PENDING_ONLINE, PENDING_OFFLINE, ERROR_STOP_FAILED, ONLINE_FAULTED, or PENDING_ONLINE_BLOCKED to describe the state of the group on each cluster node.

You cannot configure this property. However, you can indirectly set this property by invoking scswitch(1M), or by using the equivalent scsetup(1M) or SunPlex Manager commands. A group can exist in an UNMANAGED state when that group is not under the control of the RGM.

The following descriptions summarize each state.

---

Note –

States apply to individual nodes only, except the UNMANAGED state, which applies across all nodes. For example, a resource group might be OFFLINE on node A, but PENDING_ONLINE on node B.

---

UNMANAGED

The initial state of a newly created resource group, or the state of a previously managed resource group. Either Init methods have not yet been run on resources in the group, or Fini methods have been run on resources in the group.

The group is not managed by the RGM.

ONLINE

The resource group has been started on the node. In other words, the starting methods (Prenet_start, Start, and Monitor_start, as applicable to each resource) have executed successfully on all enabled resources in the group.

OFFLINE

The resource group has been stopped on the node. In other words, the stopping methods (Monitor_stop, Stop, and Postnet_stop, as applicable to each resource) have executed successfully on all enabled resources in the group. This state also applies before a resource group has started for the first time on the node.

PENDING_ONLINE

The resource group is starting on the node. The starting methods (Prenet_start, Start, and Monitor_start, as applicable to each resource) are being executed on enabled resources in the group.

PENDING_OFFLINE

The resource group is stopping on the node. The stopping methods (Monitor_stop, Stop, and Postnet_stop, as applicable to each resource) are being executed on enabled resources in the group.

ERROR_STOP_FAILED

One or more resources within the resource group failed to stop successfully and are in Stop_failed state. Other resources in the group might remain online or offline. This resource group is not permitted to start on any node until the ERROR_STOP_FAILED state is cleared.

You must use an administrative command, such as scswitch -c, to manually kill the Stop_failed resource and reset its state to OFFLINE.

ONLINE_FAULTED

The resource group was PENDING_ONLINE and has finished starting on this node. However, one or more resources ended up in Start_failed state or with Faulted status.

PENDING_ONLINE_BLOCKED

The resource group failed to start fully because one or more resources within that resource group have an unsatisfied strong resource dependency on a resource in a different resource group. Such resources remain OFFLINE. When the resource dependencies are satisfied, the resource group automatically moves back to PENDING_ONLINE state.

Default

No default

Tunable

Never

RG_system (boolean)

If the RG_system property is TRUE for a resource group, particular operations are restricted for the resource group and for the resources that the resource group contains. This restriction is intended to help prevent accidental modification or deletion of critical resource groups and resources. Only scrgadm(1M) and scswitch(1M) commands are affected by this property. Operations for scha_control(1HA) and scha_control(3HA) are not affected.

Before performing a restricted operation on a resource group (or a resource group's resources), you must first set the RG_system property of the resource group to FALSE. Use care when you modify or delete a resource group that supports cluster services, or when you modify or delete the resources that such a resource group contains.

The following table shows the operations that are restricted for a resource group when RG_system is set to TRUE.

Operation	Example
Delete a resource group	scrgadm -r -g RG1
Edit a resource group property (except for RG_system)	scrgadm -c -t RG1 -y nodelist=...
Add a resource to a resource group	scrgadm -a -j R1 -g RG1
Delete a resource from a resource group	scrgadm -r -j R1 -g RG1
Edit a property of a resource that belongs to a resource group	scrgadm -c -j R1
Switch a resource group offline	scswitch -F -g RG1
Manage a resource group	scswitch -o -g RG1
Unmanage a resource group	scswitch -u -g RG1
Enable a resource	scswitch -e -j R1
Enable monitoring for a resource	scswitch -e -M -j R1
Disable a resource	scswitch -n -j R1
Disable monitoring for a resource	scswitch -n -M -j R1

If the RG_system property is TRUE for a resource group, the only property of the resource group that you can edit is the RG_system property itself. In other words, editing the RG_system property is never restricted.

Default

FALSE

Tunable

Any time

SEE ALSO

projects(1), scha_control(1HA), scrgadm(1M), scswitch(1M), scha_control(3HA), property_attributes(5), r_properties(5), rt_properties(5)

System Administration Guide: Resource Management and Network Services

Sun Cluster 3.1  Last Revised 10 Jan 2005

NAME | DESCRIPTION | SEE ALSO