Service Group Attributes

ActiveCount

(system use only)

integer-scalar

Number of resources in a service group that are active (online or waiting to go online). When the number drops to zero, the service group is considered offline.

Administrators

(user-defined)

string-keylist

List of VCS users with privileges to administer the group.

Default = ""

Authority

(user-defined)

integer-scalar

Indicates whether or not the local cluster is allowed to bring the service group online. If set to 0, it is not, if set to 1, it is. Only one cluster can have this attribute set to 1 for a specific global group. See Administering Service Groups for details.

Default = 0

AutoDisabled

(system use only)

boolean-scalar

Indicates that VCS does not know the status of a service group (or specified system for parallel service groups). This is due to:

• Group not probed (on specified system for parallel groups) in the SystemList attribute.
• VCS engine is not running on a node designated in the SystemList attribute, but the node is visible.

AutoFailOver

(user-defined)

boolean-scalar

Indicates whether VCS initiates an automatic failover if the service group faults.

Default = 1 (enabled)

AutoRestart

(user-defined)

boolean-scalar

Restarts a service group after a faulted persistent resource becomes online. See Categories of Service Group Dependencies for details.

Default = 1 (enabled)

AutoStart

(user-defined)

boolean-scalar

Designates whether a service group is automatically started when VCS is started. Default = 1 (enabled)

AutoStartIfPartial

(user-defined)

boolean-scalar

Indicates whether to initiate bringing a service group online if the group is probed and discovered to be in a PARTIAL state when VCS is started.

Default = 1 (enabled)

AutoStartList

(user-defined)

string-keylist

List of systems on which, under specific conditions, the service group will be started with VCS (usually at system boot). For example, if a system is a member of a failover service group's AutoStartList attribute, and if it is not already running on another system in the cluster, the group is brought online when the system is started.

VCS uses the AutoStartPolicy attribute (described below) to determine the system on which to bring the service group online.

Default = "" (none)

AutoStartPolicy

(user-defined)

string-scalar

Sets the policy VCS uses to determine on which system to bring a service group online if multiple systems are available.

This attribute has three options:

Order (default): Systems are chosen in the order in which they are defined in the AutoStartList attribute.

Load: Systems are chosen in the order of their capacity, as designated in the AvailableCapacity system attribute. System with the highest capacity is chosen first.

Priority: Systems are chosen in the order of their priority in the SystemList attribute. Systems with the lowest priority is chosen first.

Default = Order

ClusterFailOverPolicy

(user-defined)

string-scalar

Determines how a global service group behaves when a cluster faults.

• If set to Manual, the group does not fail over to another cluster automatically.
• If set to Auto, the group fails over to another cluster automatically if it is unable to fail over within the local cluster, or if the entire cluster faults.
• If set to Connected, the group fails over automatically to another cluster only if it is unable to fail over within the local cluster.

Default = Manual

ClusterList

(user-defined)

integer-association

Specifies the list of clusters on which the service group is configured to run.

Default is non-applicable.

CurrentCount

(system use only)

integer-scalar

Number of systems on which the service group is active.

DeferAutoStart

(system use only)

boolean-scalar

Indicates whether HAD defers the auto-start of a local group in case the global cluster is not fully connected.

Enabled

(user-defined)

boolean-scalar

Indicates if a group can be failed over or brought online. If any of the local values are disabled, the group is disabled.

Default = 1 (enabled)

Evacuate

(user-defined)

boolean-scalar

Indicates if VCS initiates an automatic failover when user issues hastop -local -evacuate.

Default = 1

Evacuating

(system use only)

integer-scalar

Indicates the node ID from which the service group is being evacuated.

Failover

(system use only)

boolean-scalar

Indicates service group is in the process of failing over.

FailOverPolicy

(user-defined)

string-scalar

Sets the policy VCS uses to determine which system a group fails over to if multiple systems exist.

Values:

Priority (default): The system defined as the lowest priority in the SystemList attribute is chosen.

Load: The system defined with the least value in the system's Load attribute is chosen.

RoundRobin: Systems are chosen according to how many active service groups they are hosting. The system with the least number of active service groups is chosen first.

FaultPropagation

(user-defined)

boolean-scalar

Specifies if VCS should propagate the fault up to parent resources and take the entire service group offline when a resource faults, or if VCS should not take the group offline, but fail the group over only when the system faults. This attribute value can be set to 0 or 1.

Default = 1

If FaultPropagation is set to 1, when a resource in the service group faults, the group is failed over if the group's AutoFailOver attribute is set to 1. If FaultPropagation is set to 0, when a resource in the service group faults, no other resources are taken offline nor the parent group, regardless of the value set for the attribute Critical.

FromQ

(system use only)

string-association

Indicates the system name from which the service group is failing over. This attribute is specified when service group failover is a direct consequence of the group event, such as a resource fault within the group or a group switch.

Frozen

(user-defined)

boolean-scalar

Disables all actions, including autostart, online and offline, and failover, except for monitor actions performed by agents. (This convention is observed by all agents supplied with VCS.)

Default = 0 (not frozen)

GroupOwner

(user-defined)

string-scalar

This attribute is used for VCS email notification and logging. VCS sends email notification to the person designated in this attribute when an event occurs related to the service group. VCS also logs the owner name when an event occurs.

If GroupOwner is not specified in main.cf, the default value is "unknown".

IntentOnline

(system use only)

integer-scalar

Indicates whether to keep service groups online or offline. It is set to 1 by VCS if an attempt has been made, successful or not, to online the service group. For failover groups, this attribute is set to 0 by VCS when the group is taken offline. For parallel groups, it is set to 0 for the system when the group is taken offline or when the group faults and can fail over to another system.

This attribute is set to 2 by VCS for failover groups if VCS attempts to autostart a service group; for example, attempting to bring a service group online on a system from AutoStartList.

LastSuccess

(system use only)

integer-scalar

Indicates the time when service group was last brought online.

Load

(user-defined)

integer-scalar

Integer value expressing total system load this group will put on a system.

For example, the administrator may assign a value of 100 to a large production SQL and 15 to a Web server.

Default = 0

ManageFaults

(user-defined)

string-scalar

Specifies if VCS manages resource failures within the service group by calling clean entry point for the resources. This attribute value can be set to ALL or NONE.

Default = ALL

If set to NONE, VCS does not call clean entry point for any resource in the group. User intervention is required to handle resource faults/failures. When ManageFaults is set to NONE and one of the following events occur, the resource enters the ADMIN_WAIT state:

1 - The offline entry point did not complete within the expected time. Resource state is ONLINE|ADMIN_WAIT

2 - The offline entry point was ineffective. Resource state is ONLINE|ADMIN_WAIT

3 - The online entry point did not complete within the expected time. Resource state is OFFLINE|ADMIN_WAIT

4 - The online entry point was ineffective. Resource state is OFFLINE|ADMIN_WAIT

5 - The resource was taken offline unexpectedly. Resource state is OFFLINE|ADMIN_WAIT

6 - For the online resource the monitor entry point consistently failed to complete within the expected time. Resource state is ONLINE|
MONITOR_ TIMEDOUT|ADMIN_WAIT

See Clearing Resources in the ADMIN_WAIT State for more information.

ManualOps

(user-defined)

string-scalar

Indicates if manual operations are allowed on the service group.

Default = 1 (enabled)

MigrateQ

(system use only)

string-association

Indicates the system from which the service group is migrating. This attribute is specified when group failover is an indirect consequence (in situations such as a system shutdown or another group faults and is linked to this group).

NumRetries

(system use only)

integer-scalar

Indicates the number of attempts made to bring a service group online. This attribute is used only if the attribute OnlineRetryLimit is set for the service group.

OnlineRetryInterval

(user-defined)

integer-scalar

Indicates the interval, in seconds, during which a service group that has successfully restarted on the same system and faults again should be failed over, even if the attribute OnlineRetryLimit is non-zero. This prevents a group from continuously faulting and restarting on the same system.

Default = 0

OnlineRetryLimit

(user-defined)

integer-scalar

If non-zero, specifies the number of times the VCS engine tries to restart a faulted service group on the same system on which the group faulted, before it gives up and tries to fail over the group to another system.

Default = 0

Operators

(user-defined)

string-keylist

List of VCS users with privileges to operate the group. A Group Operator can only perform online/offline, and temporary freeze/unfreeze operations pertaining to a specific group. See VCS User Privileges for details.

Default = ""

Parallel

(user-defined)

integer-scalar

Indicates if service group is failover (0), parallel (1), or hybrid(2).

Default = 0

PathCount

(system use only)

integer-scalar

Number of resources in path not yet taken offline. When this number drops to zero, the engine may take the entire service group offline if critical fault has occurred.

PreOnline

(user-defined)

boolean-scalar

Indicates that the VCS engine should not online a service group in response to a manual group online, group autostart, or group failover. The engine should instead call a user-defined script that checks for external conditions before bringing the group online.

Default = 0

PreOnlining

(system use only)

integer-scalar

Indicates that VCS engine invoked the preonline script; however, the script has not yet returned with group online.

PreonlineTimeout

(user-defined)

integer-scalar

Defines the maximum amount of time the preonline script takes to run the command
hagrp -online -nopre for the group. Note that HAD uses this timeout during evacuation only. For example, when a user runs the command hastop -local -evacuate and the Preonline trigger is invoked on the system on which the service groups are being evacuated.

Default = 300 seconds

Prerequisites

(user-defined)

integer-association

An unordered set of name=value pairs denoting specific resources required by a service group. If prerequisites are not met, the group cannot go online. The format for Prerequisites is:

Prerequisites() = { Name=Value, name2=value2}.

Names used in setting Prerequisites are arbitrary and not obtained from the system. Coordinate name=value pairs listed in Prerequisites with the same name=value pairs in Limits(). See Limits and Prerequisites for details.

PrintTree

(user-defined)

boolean-scalar

Indicates whether or not the resource dependency tree is written to the configuration file.

Default = 1

Priority

(user-defined)

integer-scalar

Enables users to designate and prioritize the service group. VCS does not interpret the value; rather, this attribute enables the user to configure the priority of a service group and the sequence of actions required in response to a particular event.

Default = 0

Probed

(system use only)

boolean-scalar

Indicates whether all enabled resources in the group have been detected by their respective agents.

ProbesPending

(system use only)

integer-scalar

The number of resources that remain to be detected by the agent on each system.

Responding

(system use only)

integer-scalar

Indicates VCS engine is responding to a failover event and is in the process of bringing the service group online or failing over the node.

Restart

(system use only)

integer-scalar

For internal use only.

SourceFile

(system use only)

string-scalar

File from which the configuration was read. Always set to ./main.cf.

State

(system use only)

integer-scalar

Group state on each system:

OFFLINE  All non-persistent resources are offline.

ONLINE   All resources whose AutoStart attribute is equal to 1 are online.

FAULTED  At least one critical resource in the group is faulted or is affected by a fault.

PARTIAL  At least one, but not all, resources with Operations=OnOff is online, and not all AutoStart resources are online.

STARTING  Group is attempting to go online.

STOPPING  Group is attempting to go offline.

It is possible that a group state is a combination of the multiple states described above. For example, OFFLINE | FAULTED

OFFLINE | STARTED

PARTIAL | FAULTED

PARTIAL | STARTING

PARTIAL | STOPPING

ONLINE | STOPPING

SystemList

(user-defined)

string-association

List of systems on which the service group is configured to run and their priorities. Lower numbers indicate a preference for the system as a failover target.

Default = "" (none)

SystemZones

(user-defined)

integer-association

Indicates the virtual sublists within the SystemList attribute that grant priority in failing over. Values are string/integer pairs. The string key is the name of a system in the SystemList attribute, and the integer is the number of the zone. Systems with the same zone number are members of the same zone. If a service group faults on one system in a zone, it is granted priority to fail over to another system within the same zone, despite the policy granted by the FailOverPolicy attribute.

Tag

(user-defined)

string-scalar

Identifies special-purpose service groups created for specific VCS products.

TargetCount

(system use only)

integer-scalar

Indicates the number of target systems on which the service group should be brought online.

TFrozen

(user-defined)

boolean-scalar

Indicates if service groups can be brought online on the system. Groups cannot be brought online if the attribute value is 1.

Default = 0 (not frozen)

ToQ

(system use only)

string-association

Indicates the node name to which the service is failing over. This attribute is specified when service group failover is a direct consequence of the group event, such as a resource fault within the group or a group switch.

TriggerEvent

(system use only)

boolean-scalar

For internal use only.

TriggerResStateChange

(user-defined)

boolean-scalar

Determines whether or not to invoke the resstatechange trigger if resource state changes.

Default = 0 (disabled)

TypeDependencies

(user-defined)

string-keylist

Creates a dependency (via an ordered list) between resource types specified in the service group list, and all instances of the respective resource type.

Default = ""

UserIntGlobal

(user-defined)

integer-scalar

Use this attribute for any purpose.
It is not used by VCS.

Default = 0

UserStrGlobal

(user-defined)

string-scalar

VCS uses this attribute in the ClusterService group. Do not modify this attribute in the ClusterService group.

Use the attribute for any purpose in other service groups.
Default = 0

UserIntLocal

(user-defined)

integer-scalar

Use this attribute for any purpose.
It is not used by VCS.

Default = 0

UserStrLocal

(user-defined)

string-scalar

Use this attribute for any purpose.
It is not used by VCS.

Default = ""