Resource Type Attributes

ActionTimeout

(user-defined)

integer-scalar

Timeout value for the Action entry point.

Default = 40 seconds

AgentClass

(user-defined)

string-scalar

Indicates the scheduling class for the VCS agent process.

Default = TS

AgentFailedOn

(system use only)

string-keylist

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

Default is non-applicable.

AgentPriority

(user-defined)

string-scalar

Indicates the priority in which the agent process runs.

Default = 0

AgentReplyTimeout

(user-defined)

integer-scalar

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

Default = 130 seconds

AgentStartTimeout

(user-defined)

integer-scalar

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

Default = 60 seconds

ArgList

(user-defined)

string-vector

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

Default is non-applicable.

AttrChangedTimeout

(user-defined)

integer-scalar

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

Default = 60 seconds

CleanTimeout

(user-defined)

integer-scalar

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

Default = 60 seconds

CloseTimeout

(user-defined)

integer-scalar

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

Default = 60 seconds

ConfInterval

(user-defined)

integer-scalar

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

Default = 600 seconds

FaultOnMonitorTimeouts

(user-defined)

integer-scalar

When a monitor times out as many times as the value specified, the corresponding resource is brought down by calling the clean entry point. 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.

Default = 4

FireDrill

(user-defined)

boolean-scalar

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.

Default = 0

InfoInterval

(user-defined)

integer-scalar

Duration (in seconds) after which the info entry point 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 entry point. To manually invoke the info entry point, use the command hares -refreshinfo. If the value you designate is 30, for example, the entry point is invoked every 30 seconds for all ONLINE resources of the particular resource type.

Default = 0

InfoTimeout

(user-defined)

integer-scalar

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

Default = 30 seconds

LogDbg

(user-defined)

string-keylist

Indicates the debug severities enabled for the resource type or agent framework. Debug severities used by the agent entry points 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.

Default = {} (none)

This attribute replaces the attributes LogLevel and LogTags. The following chart compares the previous functionality with the latest.

LogLevel   ->   LogDbg

info                    (DBG_AGINFO)

debug                (DBG_AGINFO, DBG_AGDEBUG)

all                       (DBG_AGINFO, DBG_AGDEBUG

                               and DBG_AGTRACE)

LogTags   ->   LogDbg

F                    (DBG_1)

G                   (DBG_2)

:                    (DBG_21)

LogFileSize

(user-defined)

integer-scalar

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

Default = 33554432 (32MB)

MonitorInterval

(user-defined)

integer-scalar

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

Default = 60 seconds

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

MonitorStatsParam

(user-defined)

integer-association

Stores the required parameter values for calculating monitor time statistics.

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

Frequency: Defines 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. It is set to 0 by default.

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

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.

MonitorTimeout

(user-defined)

integer-scalar

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

Default = 60 seconds

NameRule

string-scalar

This attribute is no longer used by VCS.

NumThreads

(user-defined)

integer-scalar

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

Default = 10

Increasing to a significantly large value can degrade system performance. Decreasing to 1 prevents multiple threads. The agent framework limits the maximum value of this attribute to 20.

OfflineMonitorInterval

(user-defined)

integer-scalar

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

Default = 300 seconds

OfflineTimeout

(user-defined)

integer-scalar

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

Default = 300 seconds

OnlineRetryLimit

(user-defined)

integer-scalar

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

Default = 0

OnlineTimeout

(user-defined)

integer-scalar

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

Default = 300 seconds

Increase only if resource is likely to take a longer time to come online.

OnlineWaitLimit

(user-defined)

integer-scalar

Number of monitor intervals to wait after completing the online procedure, and before the resource becomes online.

Default = 2

OpenTimeout

(user-defined)

integer-scalar

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

Default = 60 seconds

Operations

(user-defined)

string-scalar

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

Default = OnOff

RestartLimit

(user-defined)

integer-scalar

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

Default = 0

ScriptClass

(user-defined)

string-scalar

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

Default = TS

ScriptPriority

(user-defined)

string-scalar

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

Default = 0

SourceFile

(user-defined)

string-scalar

File from which the configuration was read. Always set to .\types.cf.

SupportedActions

(user-defined)

string-vector

Valid action tokens for resource.

Default = {}

ToleranceLimit

(user-defined)

integer-scalar

Number of times the monitor entry point should return OFFLINE before declaring the resource FAULTED.

Default = 0

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