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
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
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
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
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
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
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
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
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.