Resource attributes

Table: Resource attributes lists resource attributes.

Table: Resource attributes

Resource attributes

Description

ArgListValues

(agent-defined)

List of arguments passed to the resource's agent on each system. This attribute is resource-specific and system-specific, meaning that the list of values passed to the agent depend on which system and resource they are intended.

The number of values in the ArgListValues should not exceed 425. This requirement becomes a consideration if an attribute in the ArgList is a keylist, a vector, or an association. Such type of non-scalar attributes can typically take any number of values, and when they appear in the ArgList, the agent has to compute ArgListValues from the value of such attributes. If the non-scalar attribute contains many values, it will increase the size of ArgListValues. Hence when developing an agent, this consideration should be kept in mind when adding a non-scalar attribute in the ArgList. Users of the agent need to be notified that the attribute should not be configured to be so large that it pushes that number of values in the ArgListValues attribute to be more than 425.

  • Type and dimension: string-vector

  • Default: non-applicable.

AutoStart

(user-defined)

Indicates if a resource should be brought online as part of a service group online, or if it needs the hares -online command.

For example, you have two resources, R1 and R2. R1 and R2 are in group G1. R1 has an AutoStart value of 0, R2 has an AutoStart value of 1.

In this case, you see the following effects:

# hagrp -online G1 -sys sys1

Brings only R2 to an ONLINE state. The group state is ONLINE and not a PARTIAL state. R1 remains OFFLINE.

# hares -online R1 -sys sys1

Brings R1 online, the group state is ONLINE.

# hares -offline R2 -sys sys1

Brings R2 offline, the group state is PARTIAL.

Resources with a value of zero for AutoStart, contribute to the group's state only in their ONLINE state and not for their OFFLINE state.

  • Type and dimension: boolean-scalar

  • Default: 1

ComputeStats

(user-defined)

Indicates to agent framework whether or not to calculate the resource's monitor statistics.

  • Type and dimension: boolean-scalar

  • Default: 0

ConfidenceLevel

(agent-defined)

Indicates the level of confidence in an online resource. Values range from 0 - 100. Note that some VCS agents may not take advantage of this attribute and may always set it to 0. Set the level to 100 if the attribute is not used.

  • Type and dimension: integer-scalar

  • Default: 0

Critical

(user-defined)

Indicates whether a fault of this resource should trigger a failover of the entire group or not. If Critical is 0 and no parent above has Critical = 1, then the resource fault will not cause group failover.

  • Type and dimension: boolean-scalar

  • Default: 1

Enabled

(user-defined)

Indicates agents monitor the resource.

If a resource is created dynamically while VCS is running, you must enable the resource before VCS monitors it. For more information on how to add or enable resources, see the chapters on administering VCS from the command line and graphical user interfaces.

When Enabled is set to 0, it implies a disabled resource.

  • Type and dimension: boolean-scalar

  • Default: If you specify the resource in main.cf prior to starting VCS, the default value for this attribute is 1, otherwise it is 0.

Flags

(system use only)

Provides additional information for the state of a resource. Primarily this attribute raises flags pertaining to the resource. Values:

ADMIN WAIT - The running configuration of a system is lost.

RESTARTING - The agent is attempting to restart the resource because the resource was detected as offline in latest monitor cycle unexpectedly. See RestartLimit attribute for more information.

STATE UNKNOWN - The latest monitor call by the agent could not determine if the resource was online or offline.

MONITOR TIMEDOUT - The latest monitor call by the agent was terminated because it exceeded the maximum time specified by the static attribute MonitorTimeout.

UNABLE TO OFFLINE - The agent attempted to offline the resource but the resource did not go offline. This flag is also set when a resource faults and the clean function completes successfully, but the subsequent monitor hangs or is unable to determine resource status.

  • Type and dimension: integer-scalar

  • Default: Not applicable.

Group

(system use only)

String name of the service group to which the resource belongs.

  • Type and dimension: string-scalar

  • Default: Not applicable.

IState

(system use only)

The internal state of a resource. In addition to the State attribute, this attribute shows to which state the resource is transitioning. Values:

NOT WAITING - Resource is not in transition.

WAITING TO GO ONLINE - Agent notified to bring the resource online but procedure not yet complete.

WAITING FOR CHILDREN ONLINE - Resource to be brought online, but resource depends on at least one offline resource. Resource transitions to waiting to go online when all children are online.

WAITING TO GO OFFLINE - Agent notified to take the resource offline but procedure not yet complete.

WAITING TO GO OFFLINE (propagate) - Same as above, but when completed the resource's children will also be offline.

WAITING TO GO ONLINE (reverse) - Resource waiting to be brought online, but when it is online it attempts to go offline. Typically this is the result of issuing an offline command while resource was waiting to go online.

WAITING TO GO OFFLINE (path) - Agent notified to take the resource offline but procedure not yet complete. When the procedure completes, the resource's children which are a member of the path in the dependency tree will also be offline.

WAITING TO GO OFFLINE (reverse) - Resource waiting to be brought offline, but when it is offline it attempts to go online. Typically this is the result of issuing an online command while resource was waiting to go offline.

WAITING TO GO ONLINE (reverse/path) - Resource waiting to be brought online, but when online it is brought offline. Resource transitions to WAITING TO GO OFFLINE (path). Typically this is the result of fault of a child resource while resource was waiting to go online.

WAITING FOR PARENT OFFLINE - Resource waiting for parent resource to go offline. When parent is offline the resource is brought offline.

Note:

Although this attribute accepts integer types, the command line indicates the text representations.

IState

(system use only)

WAITING TO GO ONLINE (reverse/propagate) - Same as above, but resource propagates the offline operation.

IStates on the source system for migration operations:

  • WAITING FOR OFFLINE VALIDATION (migrate) - This state is applicable for resource on source system and indicates that migration operation has been accepted and VCS is validating whether migration is possible.

  • WAITING FOR MIGRATION OFFLINE - This state is applicable for resource on source system and indicates that migration operation has passed the prerequisite checks and validations on the source system.

  • WAITING TO COMPLETE MIGRATION - This state is applicable for resource on source system and indicates that migration process is complete on the source system and the VCS engine is waiting for the resource to come online on target system.

IStates on the target system for migration operations:

  • WAITING FOR ONLINE VALIDATION (migrate) - This state is applicable for resource on target system and indicates that migration operations are accepted and VCS is validating whether migration is possible.

  • WAITING FOR MIGRATION ONLINE - This state is applicable for resource on target system and indicates that migration operation has passed the prerequisite checks and validations on the source system.

  • WAITING TO COMPLETE MIGRATION (online) - This state is applicable for resource on target system and indicates that migration process is complete on the source system and the VCS engine is waiting for the resource to come online on target system.

  • Type and dimension: integer-scalar

  • Default: 1

    NOT WAITING

LastOnline

(system use only)

Indicates the system name on which the resource was last online. This attribute is set by VCS.

  • Type and dimension: string-scalar

  • Default: Not applicable

ManageFaults (user-defined)

Specifies whether VCS responds to a resource fault by calling the Clean entry point.

Its value supersedes all the values assigned to the attribute at service group level.

This attribute can take the following values:

  • ACT: VCS invokes the Clean function with CleanReason set to Online Hung.

  • IGNORE: VCS changes the resource state to ONLINE|ADMIN_WAIT.

  • NULL (Blank): VCS takes action based on the values set for the attribute at the service group level.

Default value: ""

MonitorMethod

(system use only)

Specifies the monitoring method that the agent uses to monitor the resource:

  • Traditional - Poll-based resource monitoring

  • IMF - Intelligent resource monitoring

See About resource monitoring.

Type and dimension: string-scalar

Default: Traditional

MonitorOnly

(system use only)

Indicates if the resource can be brought online or taken offline. If set to 0, resource can be brought online or taken offline. If set to 1, resource can only be monitored.

Note:

This attribute can only be affected by the command hagrp -freeze.

  • Type and dimension: boolean-scalar

  • Default: 0

MonitorTimeStats

(system use only)

Valid keys are Average and TS. Average is the average time taken by the monitor function over the last Frequency number of monitor cycles. TS is the timestamp indicating when the engine updated the resource's Average value.

  • Type and dimension: string-association

  • Default: Average = 0

    TS = ""

Name

(system use only)

Contains the actual name of the resource.

  • Type and dimension: string-scalar

  • Default: Not applicable.

Path

(system use only)

Set to 1 to identify a resource as a member of a path in the dependency tree to be taken offline on a specific system after a resource faults.

  • Type and dimension: boolean-scalar

  • Default: 0

Probed

(system use only)

Indicates whether the state of the resource has been determined by the agent by running the monitor function.

  • Type and dimension: boolean-scalar

  • Default: 0

ResourceInfo

(system use only)

This attribute has three predefined keys: State: values are Valid, Invalid, or Stale. Msg: output of the info agent function of the resource on stdout by the agent framework. TS: timestamp indicating when the ResourceInfo attribute was updated by the agent framework

  • Type and dimension: string-association

  • Default:

    State = Valid

    Msg = ""

    TS = ""

ResourceOwner

(user-defined)

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

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

  • Type and dimension: string-scalar

  • Default: ""

  • Example: "jdoe@example.com"

ResourceRecipients

(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 resource 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 ResourceRecipients or to at least one recipient defined in the SmtpRecipients attribute of the NotifierMngr agent.

  • Type and dimension: string-association

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

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

Signaled

(system use only)

Indicates whether a resource has been traversed. Used when bringing a service group online or taking it offline.

  • Type and dimension: integer-association

  • Default: Not applicable.

Start

(system use only)

Indicates whether a resource was started (the process of bringing it online was initiated) on a system.

  • Type and dimension: integer -scalar

  • Default: 0

State

(system use only)

Resource state displays the state of the resource and the flags associated with the resource. (Flags are also captured by the Flags attribute.) This attribute and Flags present a comprehensive view of the resource's current state. Values:

ONLINE

OFFLINE

FAULTED

OFFLINE|MONITOR TIMEDOUT

OFFLINE|STATE UNKNOWN

OFFLINE|ADMIN WAIT

ONLINE|RESTARTING

ONLINE|MONITOR TIMEDOUT

ONLINE|STATE UNKNOWN

ONLINE|UNABLE TO OFFLINE

ONLINE|ADMIN WAIT

FAULTED|MONITOR TIMEDOUT

FAULTED|STATE UNKNOWN

A FAULTED resource is physically offline, though unintentionally.

Note:

Although this attribute accepts integer types, the command line indicates the text representations.

Type and dimension: integer -scalar

Default: 0

TriggerEvent

(user-defined)

A flag that turns Events on or off.

  • Type and dimension: boolean-scalar

  • Default: 0

TriggerPath

(user-defined)

Enables you to customize the trigger path.

  • Type and dimension: string-scalar

  • Default: ""

If a trigger is enabled but the trigger path at the service group level and at the resource level is "" (default), VCS invokes the trigger from the $VCS_HOME/bin/triggers directory.

The TriggerPath 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 is relative to $VCS_HOME and the trigger path defined for the service group.

Specify the path in the following format:

ServiceGroupTriggerPath/Resource/Trigger

If TriggerPath for service group sg1 is mytriggers/sg1 and TriggerPath for resource res1 is "", you must store the trigger script in the $VCS_HOME/mytriggers/sg1/res1 directory. For example, store the resstatechange trigger script in the $VCS_HOME/mytriggers/sg1/res1 directory. Yon can manage triggers for all resources for a service group more easily.

If TriggerPath for resource res1 is mytriggers/sg1/vip1 in the preceding example, you must store the trigger script in the $VCS_HOME/mytriggers/sg1/vip1 directory. For example, store the resstatechange trigger script in the $VCS_HOME/mytriggers/sg1/vip1 directory.

Modification of TriggerPath value at the resource level does not change the TriggerPath value at the service group level. Likewise, modification of TriggerPath value at the service group level does not change the TriggerPath value at the resource level.

TriggerResRestart

(user-defined)

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

See About the resrestart event trigger.

If this attribute is enabled at the group level, the resrestart trigger is invoked irrespective of the value of this attribute at the resource level.

See Service group attributes.

  • Type and dimension: boolean-scalar

  • Default: 0 (disabled)

TriggerResStateChange

(user-defined)

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

If this attribute is enabled at the group level, then the resstatechange trigger is invoked irrespective of the value of this attribute at the resource level.

See Service group attributes.

  • Type and dimension: boolean-scalar

  • Default: 0 (disabled)

TriggersEnabled

(user-defined)

Determines if a specific trigger is enabled or not.

Triggers are disabled by default. You can enable specific triggers on all nodes or only on selected nodes. Valid values are RESFAULT, RESNOTOFF, RESSTATECHANGE, RESRESTART, and RESADMINWAIT.

To enable triggers on a specific node, add trigger keys in the following format:

TriggersEnabled@node1 = {RESADMINWAIT, RESNOTOFF}

The resadminwait trigger and resnotoff trigger are enabled on node1.

To enable triggers on all nodes in the cluster, add trigger keys in the following format:

TriggersEnabled = {RESADMINWAIT, RESNOTOFF}

The resadminwait trigger and resnotoff trigger are enabled on all nodes.

  • Type and dimension: string-keylist

  • Default: {}

More Information

Troubleshooting VCS startup

About the resstatechange event trigger