NodeState class - Platform - BlueCat Gateway - 23.1

Gateway Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
23.1

class availability_group.api.NodeState(node_role, node_dns_connection_state, last_heartbeat_time=None, heartbeat_method=None)

Details of the node’s state with respect to Availability groups.

Parameters Description
node_role (str)

The role of the node (Gateway instance).

node_dns_connection_state (str)

The DNS connection’s node state.

last_heartbeat_time (str)

The last heartbeat’s date and time. Can be empty when the node is not in a group or there’s only a single group member.

heartbeat_method (str)

The method how the last heartbeat was communicated. Can be empty when the node is not in a group or there’s only a single group member.

New in version 22.11.1.

node_role: str

The role of the node (Gateway instance). The value is one of the constants defined in NodeRole.

node_dns_connection_state: str

The DNS connection’s node state. The value is one of the constants defined in NodeRole.

last_heartbeat_time: Optional[str]

The last heartbeat’s date and time as a timestamp in ISO 8601 format in UTC.

heartbeat_method: Optional[str]

The value is one of the constants defined in HeartbeatMethod. It will be None, when the node is not in a group or there’s only a single group member.