hagroups

Mandatory parameters are denoted by an * (asterisk).

header	type	description	required	encoding	sample	object_headers

header	type	description	required	encoding	object_headers
HEADER-ipamdhcp-v2-hagroup*	string	The primary identifier of the header stating the type of object.	TRUE	string
key*	string	The primary identifier of an individual object. For an HA group, the name is used as the key.	TRUE	string
name*	string	The name of the HA group. May contain 1 to 256 characters. May include UTF-8.	TRUE	string
comment	string	The description of the HA group. May contain 0 to 1024 characters. May include UTF-8.	FALSE	string
hosts*	array	The list of on-prem hosts in the HA group.	TRUE	nios	host_host	host_port	host_role	host_address
tags	string	The tags for the HA group, in JSON format.	FALSE	expandtags
mode*	string	The mode of the HA group. Valid values: active-active_: Both on-prem hosts remain active. active-passive_: One on-prem host remains active, and one remains passive. When the active on-prem host is down, the passive on-prem host takes over. advanced-active-passive_: One on-prem host may be part of multiple HA groups. When the active on-prem host is down, the passive on-prem host takes over.	TRUE	string