Heartbeat attributes (for global clusters)

Heartbeat attributes lists the heartbeat attributes. These attributes apply to global clusters.

Heartbeat attributes

Heartbeat Attributes

Definition

AgentState 

(system use only) 

The state of the heartbeat agent. 

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

Arguments 

(user-defined) 

List of arguments to be passed to the agent functions. For the Icmp agent, this attribute can be the IP address of the remote cluster. 

  • Type and dimension: string-vector
  • Default: ""

AYAInterval 

(user-defined) 

The interval in seconds between two heartbeats. 

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

AYARetryLimit 

(user-defined) 

The maximum number of lost heartbeats before the agent reports that heartbeat to the cluster is down.  

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

AYATimeout 

(user-defined) 

The maximum time (in seconds) that the agent will wait for a heartbeat AYA function to return ALIVE or DOWN before being canceled. 

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

CleanTimeOut 

(user-defined) 

Number of seconds within which the Clean function must complete or be canceled. 

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

ClusterList 

(user-defined) 

List of remote clusters. 

  • Type and dimension: string-keylist
  • Default: ""

InitTimeout 

(user-defined) 

Number of seconds within which the Initialize function must complete or be canceled.  

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

LogDbg 

(user-defined) 

The log level for the heartbeat.  

  • Type and dimension: string-keylist
  • Default: ""

State 

The state of the heartbeat. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

StartTimeout 

(user-defined) 

Number of seconds within which the Start function must complete or be canceled. 

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

StopTimeout 

(user-defined) 

Number of seconds within which the Stop function must complete or be canceled without stopping the heartbeat. 

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