25 Hot Standby
25.1 Get-anynodeHotStandby
Returns the configured Hot Standby objects
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object.
Return Value Structure
The response body is structured as HotStandbyOptions JSON object. A description for its fields is at section 29.61.1. For the JSON schema refer to section 29.61.2.
25.2 Add-anynodeHotStandby
Creates a new Hot Standby object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: 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.
-
-
MainSystem
The options for the main system
Type: HotStandbyMainSystemOptions section 29.62
-
StandbySystem
The options for the standby system
Type: HotStandbyStandbySystemOptions section 29.63
Return Value Structure
The response body is structured as AddHotStandbyResponse JSON object. A description for its fields is at section 29.64.1. For the JSON schema refer to section 29.64.2.
25.3 Set-anynodeHotStandby
Modifies the settings of a Hot Standby object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object that will be modified.
-
MainSystem
The options for the main system
Type: HotStandbyMainSystemOptions section 29.62
-
StandbySystem
The options for the standby system
Type: HotStandbyStandbySystemOptions section 29.63
Return Value Structure
The response body is structured as HotStandbyOptions JSON object. A description for its fields is at section 29.61.1. For the JSON schema refer to section 29.61.2.
25.4 Get-anynodeHotStandbyStatus
Returns status information for a Hot Standby object.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object.
Return Value Structure
The response body is structured as HotStandbyStatus JSON object. A description for its fields is at section 29.65.1. For the JSON schema refer to section 29.65.2.
25.5 Add-anynodeHotStandbyCondiitons
Creates the conditions for a Hot Standby object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object for that the conditions will be created.
-
CreateIsMainSystemCondition
Create a condition that determines whether the current system is the main system in an active/passive failover scenario.
Type: boolean
-
CreateIsNotSystemIntentToBecomeActiveCondition
Create a condition that determines whether the current system does not intend to take the active role in an active/passive failover scenario.
Type: boolean
-
CreateIsStandbySystemCondition
Create a condition that determines whether the current system is the standby system in an active/passive failover scenario.
Type: boolean
-
CreateIsSystemActiveCondition
Create a condition that determines whether the current system has the active role in an active/passive failover scenario.
Type: boolean
-
CreateIsSystemIntentToBecomeActiveCondition
Create a condition that determines whether the current system intends to take the active role in an active/passive failover scenario.
Type: boolean
-
CreateIsSystemNotActiveCondition
Create a condition that determines whether the current system has not the active role in an active/passive failover scenario.
Type: boolean
25.6 Set-anynodeHotStandbyHandover
Hands over the active role to the standby system.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object.
25.7 Set-anynodeHotStandbyRecover
Recovers the active role from the standby system.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object.
25.8 Enable-anynodeHotStandbyMainSystem
Enanles of disables the main systems ability to assume the active role.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object.
25.9 Enable-anynodeHotStandbyStandbySystem
Enanles of disables the standby systems ability to assume the active role.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the hot standby object.