This object contains all of the parameters necessary to configure the server's high availability settings.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| groupComm | PlcmHighAvailabilityGroupComm | The supercluster group communications configuration to apply. If HA is being enabled and this is provided, then the existing supercluster group communication configuration will be update otherwise the configuration will be left as is. If HA is being disabled, this configuration is ignored. | |
| localNodeInfo | PlcmNode | Node information for this node | Mandatory |
| nodeList | Array of PlcmHighAvailabilityNode | List of all configured nodes that are part of the group | |
| highAvailabilityInterfaces | Array of PlcmHighAvailabilityInterface | List of the interfaces and their configurations | |
| haActive | boolean | Defines whether or not HA is active. Deactivating an active HA system will force the HA agent to stop completely and release all resources currently held by this node. | Mandatory |
| haMode | PlcmHighAvailabilityMode | Specifies which mode of high-availability the system is in. | |
| statusPort | PortNumber | Defines the port number that all HA status indications to the application should be posted to. The assumption is that the form of the URL is: https://localhost:status-port/api/rest/... If HA is activated, this field must be present | |
| groupPassword | string | Password used to join the HA group. For a node to join, this password must match the group password of the other nodes otherwise this node will be unable to join the group. If HA is activated, this field must be present and cannot be empty. | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. | |
| version | string | The software version of the server sending the HA configuration to the peer node. In the case of the API being used to enable HA on server by a client application, not a peer, this will be empty or not present. | |
| arpingTimeOut | ArpingTimeOut | HA system uses arping to detect whether the virtual IP address is up or not. This is used to set the timeout value of the command. Default is 3 seconds. |
| Name | Type | Restrictions |
|---|---|---|
| PlcmHighAvailabilityMode | string | Value must be one of:
|
| ArpingTimeOut | unsignedShort | |
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |