18 Hot Standby

18.1 Get

GET https://<HOST>:<PORT>/api/hotStandby/get?version=0

Returns the configured Hot Standby objects

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the hot standby object.

Response Body Structure

The response body is structured as HotStandbyOptions JSON object. A description for its fields is at section 30.26.1. For the JSON schema refer to section 30.26.2.

Example

GET http://127.0.0.1:8888/api/hotStandby/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

18.2 Add

POST https://<HOST>:<PORT>/api/hotStandby/add?version=0

Creates a new Hot Standby object.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • mode

    Determines what kind of hot standby object will be added.

    Possible values:

    • addMainSystemHotStandbyObjects

      Create a hot standby object on the main system.

    • addStandbySystemHotStandbyObjects

      Create a hot standby object on the standby system.

    • addMainAndStandbySystemHotStandbyObjects

      Create a complete hot standby object on the main system, where replication ensures that both configuration parts are active on the correct system.

Request Body Structure

The request body is structured as HotStandbyOptions JSON object. A description for its fields is at section 30.26.1. For the JSON schema refer to section 30.26.2.

Response Body Structure

The response body is structured as AddHotStandbyResponse JSON object. A description for its fields is at section 30.27.1. For the JSON schema refer to section 30.27.2.

Example

POST http://localhost:8088/api/hotStandby/add?mode=addMainSystemHotStandbyObjects&version=0
HTTP Request Body
{
  "name": "REST Hot Standby Main Object",
  "standbySystemBackendName": "d193ebc2-7bed-43f9-84d2-f5fcaff469bf"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "networkControllerId": "374d606b-cdc5-4c23-9959-eb89455d5a8d",
  "ipcClientId": "fb1cf43c-3581-44be-9d33-009eb6083d39",
  "networkSecurityProfileId": "8705c898-e3a5-4d03-a63b-762e5be93988",
  "hotStandbyId": "92a3bb62-9277-4dfc-bdd5-116c1d1168d3"
}

18.3 Set

POST https://<HOST>:<PORT>/api/hotStandby/set?version=0

Modifies the settings of a Hot Standby object.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • id

    The identifier or display name of the hot standby object that will be modified.

Request Body Structure

The request body is structured as HotStandbyOptions JSON object. A description for its fields is at section 30.26.1. For the JSON schema refer to section 30.26.2.

Response Body Structure

The response body is structured as HotStandbyOptions JSON object. A description for its fields is at section 30.26.1. For the JSON schema refer to section 30.26.2.

Example

POST http://localhost:8088/api/hotStandby/set?id=92a3bb62-9277-4dfc-bdd5-116c1d1168d3&version=0
HTTP Request Body
{"mainSystem": {
  "maxLinkRetryTimeout": 60000,
  "linkPingInterval": 1000
}}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "mainSystem": {
    "maxLinkRetryTimeout": 60000,
    "disabledHere": false,
    "ipcClientId": "fb1cf43c-3581-44be-9d33-009eb6083d39",
    "linkPingInterval": 1000,
    "replicationOptions": {
      "systemIdentifiers": ["E40EE7457BA4C402825ABD0C64AEA55B"],
      "systemIdentifiersEnabled": true
    }
  },
  "name": "REST Hot Standby Main Object",
  "id": "92a3bb62-9277-4dfc-bdd5-116c1d1168d3"
}

18.4 Get Status

GET https://<HOST>:<PORT>/api/hotStandby/status?version=0

Returns status information for a Hot Standby object.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the hot standby object.

Response Body Structure

The response body is structured as HotStandbyStatus JSON object. A description for its fields is at section 30.28.1. For the JSON schema refer to section 30.28.2.

Example

GET http://localhost:8088/api/hotStandby/status?id=92a3bb62-9277-4dfc-bdd5-116c1d1168d3&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "linkStatus": "UNKNOWN",
  "standbyLinkActive": false,
  "mainStatus": "UNKNOWN",
  "onlyImmediateRoleChangePossible": false,
  "standbySetEnabledPossible": false,
  "standbyStatus": "NOT_COMMITTED",
  "mainSetEnabledPossible": false,
  "mainLinkActive": false,
  "handoverPossible": false,
  "recoveryPossible": false
}

18.5 Create Conditions

POST https://<HOST>:<PORT>/api/hotStandby/createConditions?version=0

Creates the conditions for a Hot Standby object.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • id

    The identifier or display name of the hot standby object for that the conditions will be created.

Request Body Structure

The request body is structured as CreateConditionsOptions JSON object. A description for its fields is at section 30.29.1. For the JSON schema refer to section 30.29.2.

Example

POST http://localhost:8088/api/hotStandby/createConditions?id=92a3bb62-9277-4dfc-bdd5-116c1d1168d3&version=0
HTTP Request Body
{
  "createIsNotSystemIntentToBecomeActiveCondition": true,
  "createIsStandbySystemCondition": true,
  "createIsSystemActiveCondition": true,
  "createIsMainSystemCondition": true,
  "createIsSystemNotActiveCondition": true,
  "createIsSystemIntentToBecomeActiveCondition": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Conditions successfully created

18.6 Hand over

GET https://<HOST>:<PORT>/api/hotStandby/handover?version=0

Hands over the active role to the standby system.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the hot standby object.

Example

GET http://localhost:8088/api/hotStandby/handover?id=f7ffeb98-f3a8-4955-a8b2-803b538fcee5&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
SUCCESS

18.7 Recover

GET https://<HOST>:<PORT>/api/hotStandby/recover?version=0

Recovers the active role from the standby system.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the hot standby object.

Example

GET http://localhost:8088/api/hotStandby/recover?id=f7ffeb98-f3a8-4955-a8b2-803b538fcee5&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
SUCCESS

18.8 Enable Main System

GET https://<HOST>:<PORT>/api/hotStandby/enableMainSystem?version=0

Enanles of disables the main systems ability to assume the active role.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the hot standby object.

Example

GET http://localhost:8088/api/hotStandby/enableMainSystem?id=f7ffeb98-f3a8-4955-a8b2-803b538fcee5&version=0
HTTP Response
HTTP/1.1 200 OK

18.9 Enable Standby System

GET https://<HOST>:<PORT>/api/hotStandby/enableStandbySystem?version=0

Enanles of disables the standby systems ability to assume the active role.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the hot standby object.

Example

GET http://localhost:8088/api/hotStandby/enableStandbySystem?id=f92331d1-bd82-4ef7-b259-31210091366c&version=0
HTTP Response
HTTP/1.1 200 OK