ActionTimeout 

(user-defined) 

Timeout value for the Action function. 

• Type and dimension: integer-scalar
• Default: 30 seconds

AgentClass 

(user-defined) 

Indicates the scheduling class for the VCS agent process. 

• Type and dimension: string-scalar
• Default: TS

AgentDirectory 

(user-defined) 

Complete path of the directory in which the agent binary and scripts are located.  

Agents look for binaries and scripts in the following directories: 

• Directory specified by the AgentDirectory attribute
• /opt/VRTSvcs/bin/type/
• /opt/VRTSagents/ha/bin/type/

If none of the above directories exist, the agent does not start. Use this attribute in conjunction with the AgentFile attribute to specify a different location or different binary for the agent. 

• Type and dimension: string-scalar
• Default = ""

AgentFailedOn 

(system use only) 

A list of systems on which the agent for the resource type has failed. 

• Type and dimension: string-keylist
• Default: Not applicable.

AgentFile 

(user-defined) 

Complete name and path of the binary for an agent. If you do not specify a value for this attribute, VCS uses the agent binary at the path defined by the AgentDirectory attribute. 

• Type and dimension: string-scalar
• Default = ""

AgentPriority 

(user-defined) 

Indicates the priority in which the agent process runs. 

• Type and dimension: string-scalar
• Default: 0

AgentReplyTimeout 

(user-defined) 

The number of seconds the engine waits to receive a heartbeat from the agent before restarting the agent. 

• Type and dimension: integer-scalar
• Default: 130 seconds

AgentStartTimeout 

(user-defined) 

The number of seconds after starting the agent that the engine waits for the initial agent "handshake" before restarting the agent. 

• Type and dimension: integer-scalar
• Default: 60 seconds

ArgList 

(user-defined) 

An ordered list of attributes whose values are passed to the open, close, online, offline, monitor, clean, info, and action functions. 

• Type and dimension: string-vector
• Default: Not applicable.

AttrChangedTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the attr_changed function must complete or be terminated. 

• Type and dimension: integer-scalar
• Default: 60 seconds

CleanTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the clean function must complete or else be terminated. 

• Type and dimension: integer-scalar
• Default: 60 seconds

CloseTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the close function must complete or else be terminated. 

• Type and dimension: integer-scalar
• Default: 60 seconds

ConfInterval 

(user-defined) 

Note   This attribute can be overridden.

When a resource has remained online for the specified time (in seconds), previous faults and restart attempts are ignored by the agent. (See ToleranceLimit and RestartLimit attributes for details.) 

• Type and dimension: integer-scalar
• Default: 600 seconds

ExternalStateChange (user-defined) 

Note   This attribute can be overridden.

Defines how VCS handles service group state when resources are intentionally brought online or taken offline outside of VCS control.  

The attribute can take the following values: 

OnlineGroup: If the configured application is started outside of VCS control, VCS brings the corresponding service group online.

OfflineGroup:If the configured application is stopped outside of VCS control, VCS takes the corresponding service group offline.

OfflineHold: If a configured application is stopped outside of VCS control, VCS sets the state of the corresponding VCS resource as offline. VCS does not take any parent resources or the service group offline.

OfflineHold and OfflineGroup are mutually exclusive.  

FaultOnMonitorTimeouts 

(user-defined) 

Note   This attribute can be overridden.

When a monitor times out as many times as the value specified, the corresponding resource is brought down by calling the clean function. The resource is then marked faulted, or it is restarted, depending on the value set in the RestartLimit attribute. 

When FaultOnMonitorTimeouts is set to 0, monitor failures are not considered indicative of a resource fault. A low value may lead to spurious resource faults, especially on heavily loaded systems. 

• Type and dimension: integer-scalar
• Default: 4

FireDrill 

(user-defined) 

Specifies whether or not fire drill is enabled for resource type. If set to 1, fire drill is enabled. If set to 0, it is disabled. 

• Type and dimension: boolean-scalar
• Default: 0

InfoInterval 

(user-defined) 

Duration (in seconds) after which the info function is invoked by the agent framework for online resources of the particular resource type.  

If set to 0, the agent framework does not periodically invoke the info function. To manually invoke the info function, use the command hares -refreshinfo. If the value you designate is 30, for example, the function is invoked every 30 seconds for all online resources of the particular resource type. 

• Type and dimension: integer-scalar
• Default: 0

IntentionalOffline 

(user-defined) 

Defines how VCS reacts when a configured application is intentionally stopped outside of VCS control.  

Add this attribute for agents that support detection of an intentional offline outside of VCS control. Note that the intentional offline feature is available for agents registered as V51 or later.  

The value 0 instructs the agent to register a fault and initiate the failover of a service group when the supported resource is taken offline outside of VCS control.  

The value 1 instructs VCS to take the resource offline when the corresponding application is stopped outside of VCS control.  

• Type and dimension: boolean-scalar
• Default: 0

InfoTimeout 

(user-defined) 

Timeout value for info function. If function does not complete by the designated time, the agent framework cancels the function's thread. 

• Type and dimension: integer-scalar
• Default: 30 seconds

LogDbg 

(user-defined) 

Indicates the debug severities enabled for the resource type or agent framework. Debug severities used by the agent functions are in the range of dbg_1-dbg_21. The debug messages from the agent framework are logged with the severities dbg_aginfo, dbg_agdebug and dbg_agtrace, representing the least to most verbose. 

• Type and dimension: string-keylist
• Default: {} (none)

LogFileSize 

(user-defined) 

Specifies the size (in bytes) of the agent log file. Minimum value is 65536 bytes. Maximum value is 134217728 bytes (128MB). 

• Type and dimension: integer-scalar
• Default: 33554432 (32MB)

MonitorInterval 

(user-defined) 

Note   This attribute can be overridden.

Duration (in seconds) between two consecutive monitor calls for an online or transitioning resource. 

A low value may impact performance if many resources of the same type exist. A high value may delay detection of a faulted resource. 

• Type and dimension: integer-scalar
• Default: 60 seconds

MonitorStatsParam 

(user-defined) 

Stores the required parameter values for calculating monitor time statistics.  

static str MonitorStatsParam = {Frequency = 10, ExpectedValue = 3000, ValueThreshold = 100, AvgThreshold = 40}

Frequency: The number of monitor cycles after which the average monitor cycle time should be computed and sent to the engine. If configured, the value for this attribute must be between 1 and 30. The value 0 indicates that the monitor cycle ti me should not be computed. Default=0.  

ExpectedValue: The expected monitor time in milliseconds for all resources of this type. Default=100. 

ValueThreshold: The acceptable percentage difference between the expected monitor cycle time (ExpectedValue) and the actual monitor cycle time. Default=100. 

AvgThreshold: The acceptable percentage difference between the benchmark average and the moving average of monitor cycle times. Default=40. 

• Type and dimension: integer-association
• Default: Different value for each parameter.

MonitorTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the monitor function must complete or else be terminated. 

• Type and dimension: integer-scalar
• Default: 60 seconds

NumThreads 

(user-defined) 

Number of threads used within the agent process for managing resources. This number does not include threads used for other internal purposes. 

If the number of resources being managed by the agent is less than or equal to the NumThreads value, only that many number of threads are created in the agent. Addition of more resources does not create more service threads. Similarly deletion of resources causes service threads to exit. Thus, setting NumThreads to 1 forces the agent to just use 1 service thread no matter what the resource count is. The agent framework limits the value of this attribute to 30. 

• Type and dimension: integer-scalar
• Default: 10

OfflineMonitorInterval 

(user-defined) 

Note   This attribute can be overridden.

Duration (in seconds) between two consecutive monitor calls for an offline resource. If set to 0, offline resources are not monitored. 

• Type and dimension: integer-scalar
• Default: 300 seconds

OfflineTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the offline function must complete or else be terminated. 

• Type and dimension: integer-scalar
• Default: 300 seconds

OfflineWaitLimit 

(user-defined) 

Note   This attribute can be overridden.

Number of monitor intervals to wait for the resource to go offline after completing the offline procedure. Increase the value of this attribute if the resource is likely to take a longer time to go offline. 

• Type and dimension: integer-scalar
• Default: 2

OnlineRetryLimit 

(user-defined) 

Note   This attribute can be overridden.

Number of times to retry the online operation if the attempt to online a resource is unsuccessful. This parameter is meaningful only if the clean operation is implemented. 

• Type and dimension: integer-scalar
• Default: 0

OnlineTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the online function must complete or else be terminated. 

• Type and dimension: integer-scalar
• Default: 300 seconds

OnlineWaitLimit 

(user-defined) 

Note   This attribute can be overridden.

Number of monitor intervals to wait for the resource to come online after completing the online procedure. Increase the value of this attribute if the resource is likely to take a longer time to come online. 

• Type and dimension: integer-scalar
• Default: 2

OpenTimeout 

(user-defined) 

Note   This attribute can be overridden.

Maximum time (in seconds) within which the open function must complete or else be terminated. 

• Type and dimension: integer-scalar
• Default: 60 seconds

Operations 

(user-defined) 

Indicates valid operations for resources of the resource type. Values are OnOnly (can online only), OnOff (can online and offline), None (cannot online or offline). 

• Type and dimension: string-scalar
• Default: OnOff

RestartLimit 

(user-defined) 

Note   This attribute can be overridden.

Number of times to retry bringing a resource online when it is taken offline unexpectedly and before VCS declares it faulted. 

• Type and dimension: integer-scalar
• Default: 0

ScriptClass 

(user-defined) 

Indicates the scheduling class of the script processes (for example, online) created by the agent. 

• Type and dimension: string-scalar
• Default: TS

ScriptPriority 

(user-defined) 

Indicates the priority of the script processes created by the agent. 

• Type and dimension: string-scalar
• Default: 0

SourceFile 

(user-defined) 

File from which the configuration is read. Always set to.\types.cf. Make sure the path exists on all nodes before configuring this attribute.  

• Type and dimension: string-scalar
• Default: .\types.cf

SupportedActions 

(user-defined) 

Valid action tokens for the resource type. 

• Type and dimension: string-vector
• Default: {}

ToleranceLimit 

(user-defined) 

Note   This attribute can be overridden.

After a resource goes online, the number of times the monitor function should return offline before declaring the resource faulted. 

A large value could delay detection of a genuinely faulted resource. 

• Type and dimension: integer-scalar
• Default: 0