# ha-groups

Manage high availability groups and floating IPs.
Set management node URL:

# PUT /servers/ha-groups/{id}

# Parameters

  • idintegerpath-
  • bodyobjectoptional-
    • idintegeroptional-
    • descriptionstringoptional-
    • virtualIpstringoptional-
    • servicestringoptional[nfs, rgw]
    • serversarrayoptional-
      • serverintegeroptional-
      • nicintegeroptional-
      • vlanintegeroptional-
    • failbackbooleanoptionalSwitch back to the original server after it recovers.
    • failoverTimeintegeroptionalTime in seconds until a failover is triggered after a fault state is detected.
    • failbackTimeintegeroptionalTime in seconds until the service fails back to the original server after it recovers.
    • evictNfsClientsOnFailbackbooleanoptionalForce disconnect NFS clients from a secondary when failing back to a recovering master server.

# Endpoint

curl -X PUT http://mgmt-node:8080/api/servers/ha-groups/{id}

# Example body

{
  "id": 0,
  "description": "string",
  "virtualIp": "string",
  "service": "nfs",
  "servers": [
    {
      "server": 0,
      "nic": 0,
      "vlan": 0
    }
  ],
  "failback": true,
  "failoverTime": 0,
  "failbackTime": 0,
  "evictNfsClientsOnFailback": true
}

# DELETE /servers/ha-groups/{id}

# Parameters

  • idintegerpath-

# Endpoint

curl -X DELETE http://mgmt-node:8080/api/servers/ha-groups/{id}

# GET /servers/ha-groups

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/servers/ha-groups

# Response 200

  • idintegeroptional-
  • descriptionstringoptional-
  • virtualIpstringoptional-
  • servicestringoptional[nfs, rgw]
  • serversarrayoptional-
    • serverintegeroptional-
    • nicintegeroptional-
    • vlanintegeroptional-
  • failbackbooleanoptionalSwitch back to the original server after it recovers.
  • failoverTimeintegeroptionalTime in seconds until a failover is triggered after a fault state is detected.
  • failbackTimeintegeroptionalTime in seconds until the service fails back to the original server after it recovers.
  • evictNfsClientsOnFailbackbooleanoptionalForce disconnect NFS clients from a secondary when failing back to a recovering master server.

# Example response

[
  {
    "id": 0,
    "description": "string",
    "virtualIp": "string",
    "service": "nfs",
    "servers": [
      {
        "server": 0,
        "nic": 0,
        "vlan": 0
      }
    ],
    "failback": true,
    "failoverTime": 0,
    "failbackTime": 0,
    "evictNfsClientsOnFailback": true
  }
]

# POST /servers/ha-groups

# Parameters

  • bodyobjectoptional-
    • idintegeroptional-
    • descriptionstringoptional-
    • virtualIpstringoptional-
    • servicestringoptional[nfs, rgw]
    • serversarrayoptional-
      • serverintegeroptional-
      • nicintegeroptional-
      • vlanintegeroptional-
    • failbackbooleanoptionalSwitch back to the original server after it recovers.
    • failoverTimeintegeroptionalTime in seconds until a failover is triggered after a fault state is detected.
    • failbackTimeintegeroptionalTime in seconds until the service fails back to the original server after it recovers.
    • evictNfsClientsOnFailbackbooleanoptionalForce disconnect NFS clients from a secondary when failing back to a recovering master server.

# Endpoint

curl -X POST http://mgmt-node:8080/api/servers/ha-groups

# Example body

{
  "id": 0,
  "description": "string",
  "virtualIp": "string",
  "service": "nfs",
  "servers": [
    {
      "server": 0,
      "nic": 0,
      "vlan": 0
    }
  ],
  "failback": true,
  "failoverTime": 0,
  "failbackTime": 0,
  "evictNfsClientsOnFailback": true
}