Service group attributes

Table: Service group attributes lists the service group attributes.

Table: Service group attributes

Service Group Attributes

Definition

ActiveCount

(system use only)

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.

  • Type and dimension: integer-scalar

  • Default: Not applicable.

AdministratorGroups

(user-defined)

List of operating system user account groups that have administrative privileges on the service group.

This attribute applies to clusters running in secure mode.

  • Type and dimension: string-keylist

  • Default: {} (none)

Administrators

(user-defined)

List of VCS users with privileges to administer the group.

Note:

A Group Administrator can perform all operations related to a specific service group, but cannot perform generic cluster operations.

  • Type and dimension: string-keylist

  • Default: {} (none)

Authority

(user-defined)

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.

  • Type and dimension: integer-scalar

  • Default: 0

AutoDisabled

(system use only)

Indicates that VCS does not know the status of a service group (or specified system for parallel service groups). This could occur because the group is not probed (on specified system for parallel groups) in the SystemList attribute. Or the VCS engine is not running on a node designated in the SystemList attribute, but the node is visible.

When VCS does not know the status of a service group on a node but you want VCS to consider the service group enabled, perform this command to change the AutoDisabled value to 0.

hagrp -autoenable grp -sys sys1

This command instructs VCS that even though VCS has marked the service group auto-disabled, you are sure that the service group is not online on sys1. For failover service groups, this is important because the service groups now can be brought online on remaining nodes.

  • Type and dimension: boolean-scalar

  • Default: 0

AutoFailOver

(user-defined)

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

The attribute can take the following values:

  • 0 - VCS does not fail over the service group.

  • 1 - VCS automatically fails over the service group if a suitable node exists for failover.

  • 2 - VCS automatically fails over the service group only if a suitable node exists in the same system zone where the service group was online.

    To set the value as 2, you must have enabled HA/DR license and the service group must not be hybrid. If you have not defined system zones, the failover behavior is similar to 1.

  • Type and dimension: integer-scalar

  • Default: 1 (enabled)

AutoRestart

(user-defined)

Restarts a service group after a faulted persistent resource becomes online.

The attribute can take the following values:

  • 0 - Autorestart is disabled.

  • 1 - Autorestart is enabled.

  • 2 - When a faulted persistent resource recovers from a fault, the VCS engine clears the faults on all non-persistent faulted resources on the system. It then restarts the service group.

Note:

This attribute applies only to service groups containing persistent resources.

  • Type and dimension: integer-scalar

  • Default: 1 (enabled)

AutoStart

(user-defined)

Designates whether a service group is automatically started when VCS is started.

  • Type and dimension: boolean-scalar

  • Default: 1 (enabled)

AutoStartIfPartial

(user-defined)

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.

  • Type and dimension: boolean-scalar

  • Default: 1 (enabled)

AutoStartList

(user-defined)

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 the service group 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 to determine the system on which to bring the service group online.

Note:

For the service group to start, AutoStart must be enabled and Frozen must be 0. Also, beginning with 1.3.0, you must define the SystemList attribute prior to setting this attribute.

  • Type and dimension: string-keylist

  • Default: {} (none)

AutoStartPolicy

(user-defined)

Sets the policy VCS uses to determine the system on which a service group is brought online during an autostart operation if multiple systems exist.

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.

  • Type and dimension: string-scalar

  • Default: Order

ClusterFailOverPolicy

(user-defined)

Determines how a global service group behaves when a cluster faults or when a global group faults. The attribute can take the following values:

Manual - The group does not fail over to another cluster automatically.

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.

Connected - The group fails over automatically to another cluster only if it is unable to fail over within the local cluster.

  • Type and dimension: string-scalar

  • Default: Manual

ClusterList

(user-defined)

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

  • Type and dimension: integer-association

  • Default: {} (none)

ContainerInfo

(user-defined)

Specifies if you can use the service group with the container. Assign the following values to the ContainerInfo attribute:

  • Name: The name of the container.

  • Type: The type of container. You can set this to Zone or WPAR.

  • Enabled: Specify the value as 1, if you want to enable the container. Specify the value as 0, if you want to disable the container. Specify the value as 2 to enable failovers from physical computers to virtual machines and from virtual machines to physical computers. Refer to the Veritas Storage Foundation and High Availability Solutions Virtualization Guide for more information on use of value 2 for the Enabled key.

You can set a per-system value for this attribute.

  • Type and dimension: string-scalar

  • Default: {}

CurrentCount

(system use only)

Number of systems on which the service group is active.

  • Type and dimension: integer-scalar

  • Default: Not applicable.

DeferAutoStart

(system use only)

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

  • Type and dimension: boolean-scalar

  • Default: Not applicable

Enabled

(user-defined)

Indicates if a service group can be failed over or brought online.

The attribute can have global or local scope. If you define local (system-specific) scope for this attribute, VCS prevents the service group from coming online on specified systems that have a value of 0 for the attribute. You can use this attribute to prevent failovers on a system when performing maintenance on the system.

  • Type and dimension: boolean-scalar

  • Default: 1 (enabled)

Evacuate

(user-defined)

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

  • Type and dimension: boolean-scalar

  • Default: 1

Evacuating

(system use only)

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

  • Type and dimension: integer-scalar

  • Default: Not applicable

Failover

(system use only)

Indicates service group is in the process of failing over.

  • Type and dimension: boolean-scalar

  • Default: Not applicable

FailOverPolicy

(user-defined)

Sets the policy VCS uses to determine the system on which a group fails over during a manual online operation if multiple systems exist. This attribute can take the following values:

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

  • Type and dimension: string-scalar

  • Default: Priority

FaultPropagation

(user-defined)

Specifies if VCS should propagate the fault up to parent resources and take the entire service group offline when a resource faults.

The value 1 indicates that when a resource faults, VCS fails over the service group, if the group's AutoFailOver attribute is set to 1. If The value 0 indicates that when a resource faults, VCS does not take other resources offline, regardless of the value of the Critical attribute. The service group does not fail over on resource fault.

  • Type and dimension: boolean-scalar

  • Default: 1

FromQ

(system use only)

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.

  • Type and dimension: string-association

  • Default: Not applicable

Frozen

(system use only)

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

  • Type and dimension: boolean-scalar

  • Default: 0 (not frozen)

GroupOwner

(user-defined)

This attribute is used for VCS email notification and logging. VCS sends email notification to the person designated in this attribute when events occur that are related to the service group. Note that while VCS logs most events, not all events trigger notifications.

Make sure to set the severity level at which you want notifications to be sent to GroupOwner or to at least one recipient defined in the SmtpRecipients attribute of the NotifierMngr agent.

  • Type and dimension: string-scalar

  • Default: ""

GroupRecipients

(user-defined)

This attribute is used for VCS email notification. VCS sends email notification to persons designated in this attribute when events related to the service group occur and when the event's severity level is equal to or greater than the level specified in the attribute.

Make sure to set the severity level at which you want notifications to be sent to GroupRecipients or to at least one recipient defined in the SmtpRecipients attribute of the NotifierMngr agent.

  • Type and dimension: string-association

  • email id: The email address of the person registered as a recipient for notification.

    severity: The minimum level of severity at which notifications must be sent.

Guests

(user-defined)

List of operating system user accounts that have Guest privileges on the service group.

This attribute applies to clusters running in secure mode.

  • Type and dimension: string-keylist

  • Default: ""

IntentOnline

(system use only)

Indicates whether to keep service groups online or offline.

VCS sets this attribute to 1 if an attempt has been made to bring the service group online.

For failover groups, VCS sets this attribute to 0 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.

VCS sets this attribute to 2 for service groups if VCS attempts to autostart a service group; for example, attempting to bring a service group online on a system from AutoStartList.

  • Type and dimension: integer-scalar

  • Default: Not applicable.

IntentionalOnlineList

(system use only)

Lists the nodes where a resource that can be intentionally brought online is found ONLINE at first probe. IntentionalOnlineList is used along with AutoStartList to determine the node on which the service group should go online when a cluster starts.

  • Type and dimension: string-keylist

  • Default: Not applicable

LastSuccess

(system use only)

Indicates the time when service group was last brought online.

  • Type and dimension: integer-scalar

  • Default: Not applicable

Load

(user-defined)

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.

  • Type and dimension: integer-scalar

  • Default: 0

ManageFaults

(user-defined)

Specifies if VCS manages resource failures within the service group by calling the Clean function for the resources. This attribute can take the following values.

NONE - VCS does not call the Clean function for any resource in the group. User intervention is required to handle resource faults.

  • Type and dimension: string-scalar

  • Default: ALL

ManualOps

(user-defined)

Indicates if manual operations are allowed on the service group.

  • Type and dimension: boolean-scalar

  • Default = 1 (enabled)

MigrateQ

(system use only)

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

  • Type and dimension: string-association

  • Default: Not applicable

NumRetries

(system use only)

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.

  • Type and dimension: integer-scalar

  • Default: Not applicable

OnlineAtUnfreeze

(system use only)

When a node or a service group is frozen, the OnlineAtUnfreeze attribute specifies how an offline service group reacts after it or a node is unfrozen.

  • Type and dimension: integer-scalar

  • Default: Not applicable

OnlineClearParent

When this attribute is enabled for a service group and the service group comes online or is detected online, VCS clears the faults on all online type parent groups, such as online local, online global, and online remote.

  • Type and dimension: boolean-scalar

  • Default: 0

For example, assume that both the parent group and the child group faulted and both cannot failover. Later, when VCS tries again to bring the child group online and the group is brought online or detected online, the VCS engine clears the faults on the parent group, allowing VCS to restart the parent group too.

OnlineRetryInterval

(user-defined)

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.

  • Type and dimension: integer-scalar

  • Default: 0

OnlineRetryLimit

(user-defined)

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.

  • Type and dimension: integer-scalar

  • Default: 0

OperatorGroups

(user-defined)

List of operating system user groups that have Operator privileges on the service group. This attribute applies to clusters running in secure mode.

  • Type and dimension: string-keylist

  • Default: ""

Operators

(user-defined)

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.

  • Type and dimension: string-keylist

  • Default: ""

Parallel

(user-defined)

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

  • Type and dimension: integer-scalar

  • Default: 0

PathCount

(system use only)

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.

  • Type and dimension: integer-scalar

  • Default: Not applicable

PCVAllowOnline

(system use only)

Indicates whether ProPCV-enabled resources in a service group can be brought online on a node outside VCS control.

  • Type and dimension: boolean-scalar

  • Default: Not applicable

See About preventing concurrency violation.

PolicyIntention

(system use only)

Functions as a lock on service groups in the hagrp -online -propagate command and hagrp -offline -propagate command:

  • Type and dimension: integer-scalar

When PolicyIntention is set to a non-zero value for the service groups in dependency tree, this attribute protects the service groups from any other operation.

PreOnline

(user-defined)

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 run the PreOnline trigger.

You can set a local (per-system) value for this attribute to control the firing of PreOnline triggers on each node in the cluster. This attribute is strictly a per system attribute, then you must set the value for each system.

  • Type and dimension: boolean-scalar

  • Default: 0

PreOnlining

(system use only)

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

  • Type and dimension: integer-scalar

  • Default: Not applicable

PreonlineTimeout

(user-defined)

Defines the maximum amount of time in seconds 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.

  • Type and dimension: integer-scalar

  • Default: 300

Prerequisites

(user-defined)

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

  • Type and dimension: integer-association

PreSwitch

(user-defined)

Indicates whether VCS engine should invoke PreSwitch actions in response to a manual service group switch operation.

Note:

The engine does not invoke the PreSwitch action during a group fault or when you use -any option to switch a group.

This attribute must be defined in the global group definition on the remote cluster. This attribute takes the following values:

0 - VCS engine switches the service group normally.

1 - VCS engine switches the service group based on the output of PreSwitch action of the resources.

If you set the value as 1, the VCS engine looks for any resource in the service group that supports PreSwitch action. If the action is not defined for any resource, the VCS engine switches a service group normally.

If the action is defined for one or more resources, then the VCS engine invokes PreSwitch action for those resources. If all the actions succeed, the engine switches the service group. If any of the actions fail, the engine aborts the switch operation.

The engine invokes the PreSwitch action in parallel and waits for all the actions to complete to decide whether to perform a switch operation. The VCS engine reports the action's output to the engine log. The PreSwitch action does not change the configuration or the cluster state.

  • Type and dimension: boolean-scalar

  • Default: 0

PreSwitching

(system use only)

Indicates that the VCS engine invoked the agent's PreSwitch action; however, the action is not yet complete.

  • Type and dimension: integer-scalar

  • Default: Not applicable

PrintTree

(user-defined)

Indicates whether or not the resource dependency tree is written to the configuration file. The value 1 indicates the tree is written.

Note:

For very large configurations, the time taken to print the tree and to dump the configuration is high.

  • Type and dimension: boolean-scalar

  • Default: 1

Priority

(user-defined)

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.

If the cluster-level attribute value for PreferredFencingPolicy is set to Group, VCS uses this Priority attribute value to calculate the node weight to determine the surviving subcluster during I/O fencing race.

VCS assigns the following node weight based on the priority of the service group:

Priority     Node weight
1            625
2            125
3            25
4            5
0 or >=5     1

A higher node weight is associated with higher values of Priority. The node weight is the sum of node weight values for service groups which are ONLINE/PARTIAL.

See About preferred fencing.

  • Type and dimension: integer-scalar

  • Default: 0

Probed

(system use only)

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

  • Type and dimension: boolean-scalar

  • Default: Not applicable

ProbesPending

(system use only)

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

  • Type and dimension: integer-scalar

  • Default: Not applicable

ProPCV

(user-defined)

Indicates whether the service group is proactively prevented from concurrency violation for ProPCV-enabled resources.

  • Type and dimension: boolean-scalar

  • Default: 0

See About preventing concurrency violation.

Responding

(system use only)

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.

  • Type and dimension: integer-scalar

  • Default: Not applicable

Restart

(system use only)

For internal use only.

  • Type and dimension: integer-scalar

  • Default: Not applicable

SourceFile

(user-defined)

File from which the configuration is read. Do not configure this attribute in main.cf.

Make sure the path exists on all nodes before running a command that configures this attribute.

Make sure the path exists on all nodes before configuring this attribute.

  • Type and dimension: string-scalar

  • Default: ./main.cf

State

(system use only)

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.

A group state may be a combination of the multiple states described above. For example, OFFLINE | FAULTED, OFFLINE | STARTING, PARTIAL | FAULTED, PARTIAL | STARTING, PARTIAL | STOPPING, ONLINE | STOPPING

  • Type and dimension: integer-scalar

  • Default: Not applicable.

SysDownPolicy

(user-defined)

Determines whether a service group is autodisabled when the system is down and if the service group is taken offline when the system is rebooted or is shut down gracefully.

If SysDownPolicy contains the key AutoDisableNoOffline, the following conditions apply:

  • The service group is autodisabled when system is down, gracefully shut down, or is detected as down.

  • The service group is not taken offline when the system reboots or shuts down gracefully.

Valid values: Empty keylist or the key AutoDisableNoOffline

Default: Empty keylist

For example, if a service group with SysDownPolicy = AutoDisableNoOffline is online on system sys1, it has the following effect for various commands:

  • The hastop -local -evacuate command for sys1 is rejected

  • The hastop -sysoffline command is accepted but the service group with SysDownPolicy = AutoDisableNoOffline is not taken offline.

  • The hastop -all command is rejected.

SystemList

(user-defined)

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.

Note:

You must define this attribute prior to setting the AutoStartList attribute.

  • Type and dimension: integer-association

  • Default: "" (none)

SystemZones

(user-defined)

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.

  • Type and dimension: integer-association

  • Default: "" (none)

Tag

(user-defined)

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

  • Type and dimension: string-scalar

  • Default: Not applicable.

TargetCount

(system use only)

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

  • Type and dimension: integer-scalar

  • Default: Not applicable.

TFrozen

(user-defined)

Indicates if service groups can be brought online or taken offline on nodes in the cluster. Service groups cannot be brought online or taken offline if the value of the attribute is 1.

  • Type and dimension: boolean-scalar

  • Default: 0 (not frozen)

ToQ

(system use only)

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.

  • Type and dimension: string-association

  • Default: Not applicable

TriggerEvent

(user-defined)

For internal use only.

  • Type and dimension: boolean-scalar

  • Default: Not applicable

TriggerPath

(user-defined)

Enables you to customize the trigger path.

If a trigger is enabled but the trigger path is "" (default), VCS invokes the trigger from the $VCS_HOME/bin/triggers directory. If you specify an alternate directory, VCS invokes the trigger from that path. The value is case-sensitive. VCS does not trim the leading spaces or trailing spaces in the Trigger Path value. If the path contains leading spaces or trailing spaces, the trigger might fail to get executed.

The path that you specify must be in the following format:

$VCS_HOME/TriggerPath/Trigger

For example, if TriggerPath is set to mytriggers/sg1, VCS looks for the preonline trigger scripts in the $VCS_HOME/mytriggers/sg1/preonline/ directory.

  • Type and dimension: string-scalar

  • Default: ""

TriggerResFault

(user-defined)

Defines whether VCS invokes the resfault trigger when a resource faults. The value 0 indicates that VCS does not invoke the trigger.

  • Type and dimension: boolean-scalar

  • Default: 1

TriggerResRestart

(user-defined)

Determines whether or not to invoke the resrestart trigger if resource restarts.

See About the resrestart event trigger.

To invoke the resrestart trigger for a specific resource, enable this attribute at the resource level.

See Resource attributes.

  • Type and dimension: boolean-scalar

  • Default: 0 (disabled)

TriggerResStateChange

(user-defined)

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

To invoke the resstatechange trigger for a specific resource, enable this attribute at the resource level.

See Resource attributes.

  • Type and dimension: boolean-scalar

  • Default: 0 (disabled)

TriggersEnabled

(user-defined)

Determines if a specific trigger is enabled on a node or not.

Triggers are disabled by default. You can enable a specific trigger on one node and disable it on the other nodes. Valid values are VIOLATION, NOFAILOVER, PREONLINE, POSTONLINE, POSTOFFLINE, RESFAULT, RESSTATECHANGE, and RESRESTART.

To enable a trigger, add trigger keys in the following format:

TriggersEnabled@node1 = {POSTOFFLINE, POSTONLINE}

The postoffline trigger and postonline trigger are enabled on node1.

  • Type and dimension: string-keylist

  • Default: {}

TypeDependencies

(user-defined)

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

  • Type and dimension: string-keylist

  • Default: ""

UserIntGlobal

(user-defined)

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

  • Type and dimension: integer-scalar

  • Default: 0

UserStrGlobal

(user-defined)

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.

  • Type and dimension: string-scalar

  • Default: 0

UserIntLocal

(user-defined)

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

  • Type and dimension: integer-scalar

  • Default: 0

UserStrLocal

(user-defined)

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

  • Type and dimension: string-scalar

  • Default: ""

More Information

About VCS user privileges and roles

About serialization - The Authority attribute

About controlling failover on service group or system faults

About service group dependencies

About controlling Clean behavior on resource faults

About VCS user privileges and roles

???

Administering global service groups in a global cluster setup

About the resstatechange event trigger