Disaster Recovery Configure Active For Replication

Disaster Recovery Configure Active For Replication

Configures the current Orchestrator to be active and the specified Orchestrator to be standby for Orchestrator disaster recovery replication. Required attributes: 1) standbyList, a single-entry array containing the standbyAddress and standbyUuid, 2) drVCOUser, a Orchestrator super user available on both the active and standby VCOs, and 3) drVCOPassword, the password of drVCOUser on the standby Orchestrator (unless the autoConfigStandby option is specified as false). The call sets up the active Orchestrator to allow replication from the standby and then (unless autoConfigStandby is false) makes a transitionToStandby API call to the specified standby, expected to have been previously placed in STANDBY_CANDIDATE state via prepareForStandby. After this call, the active and standby VCOs should be polled via getReplicationStatus until they both reach STANDBY_RUNNING drState (or a configuration error is reported). (Note: drVCOPassword is not persisted.)

Privileges required:

CREATE REPLICATION

Request
URI
POST
https://{api_host}/portal/rest/disasterRecovery/configureActiveForReplication
COPY
Request Body

Show optional properties

{
    "standbyList": [
        {
            "standbyAddress": "string",
            "standbyUuid": "string"
        }
    ],
    "drVCOUser": "string",
    "drVCOPassword": "string"
}
{
    "standbyList": [
        {
            "standbyAddress": "string",
            "standbyAddressV6": "string",
            "standbyReplicationAddress": "string",
            "standbyUuid": "string"
        }
    ],
    "autoConfigStandby": false,
    "drVCOUser": "string",
    "drVCOPassword": "string"
}
array of object
standbyList
Required

standbyList

boolean
autoConfigStandby
Optional
Constraints: default: true

autoConfigStandby

string
drVCOUser
Required

drVCOUser

string
drVCOPassword
Required

drVCOPassword

Responses
200

Request was successfully processed

This response body class contains all of the following: Inlinedisaster_recovery_configure_active_for_replication_result0
{
    "rows": 1
}

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"standbyList:"array","drVCOUser:"string","drVCOPassword:"string"}' https://{api_host}/portal/rest/disasterRecovery/configureActiveForReplication