IBM DataPower Operations Dashboard v1.0.8.5

Note: A more recent version of DPOD is available. See DPOD Documentation for the latest documentation.

DR REST API

User will need an admin or operator access for this API, Unauthorized users will get "401 Unauthorized"

Make a DPOD device the standby installation:
After intalling DPOD, run the following API to make it the standby machine,
you only need to run this API once after installation.

POST /op/api/v1/dr/makeStandby

{
"resultCode": "SUCCESS",
"resultErrorCode": "SUCCESS",
"resultMessage": "Success"
}


ERROR:
{
"resultCode": "ERROR",
"resultErrorCode": "EXCEPTION_OCCURRED",
"resultMessage": " Exception occurred while running DR API, exception UUID=01eef1c2-c0f9-4a4f-818c-0127d9c89400"
}


Change a standby DPOD installation to active mode:
Change the DPOD standby installation to active, this will change DPOD's log targets and host aliases on all monitored devices to point to the standby machine

This API call may take several minutes to complete


POST /op/api/v1/dr/standbyToActive

{
"resultCode": "SUCCESS",
"resultErrorCode": "SUCCESS",
"resultMessage": "Success"
}


ERROR (all devices that are not mentioned in the error message were setup successfully):

{
"resultCode": "ERROR",
"resultErrorCode": "ERROR_FROM_SETUP_SYSLOGS",
"resultMessage": " -- could not connect to device, deviceName=XG45-QA-101 deviceHost=192.168.72.50"
}


Change a standby DPOD installation back to inactive mode:

POST /op/api/v1/dr/standbyToInactive

{
"resultCode": "SUCCESS",
"resultErrorCode": "SUCCESS",
"resultMessage": "Success"
}

ERROR:

{
"resultCode": "ERROR",
"resultErrorCode": "ALREADY_IN_STANDBY_MODE",
"resultMessage": "DPOD is already in standby mode"
}


Change the active DPOD installation back to active mode:
Change the active DPOD installation to be active again after recovering from the DR situation, this will change DPOD's log targets and host aliases on all monitored devices to point to the active machine

This API call may take several minutes to complete


POST /op/api/v1/dr/activeBackToActive

{
"resultCode": "SUCCESS",
"resultErrorCode": "SUCCESS",
"resultMessage": "Success"
}


ERROR (all devices that are not mentioned in the error message were setup successfully):

{
"resultCode": "ERROR",
"resultErrorCode": "ERROR_FROM_SETUP_SYSLOGS",
"resultMessage": " -- could not connect to device, deviceName=XG45-QA-101 deviceHost=192.168.72.50"
}


IBM DataPower Operations Dashboard (DPOD) v1.0.8.5