Perform failover group DR operation

Select

SaaS

Customer Managed

API to perform planned failover for failover group

Path Parameters

• failoverGroupId int32 required

  Id of the failover group

• drOperation string required

  Possible values: [PlannedFailover, UnplannedFailover, Failback, RevertFailover, UndoFailover, TestBoot, PITFailover, ReverseReplication, CleanupDestinationVM, TestFailover, UndoTestFailover]

  Name of DR operation. Case insensitive

Query Parameters

• skipDisableNetworkAdapter boolean

  Whether to skip disabling network adapter in DR job

• replicationId int32

  Replication ID of particular VM in group to perform DR job on

• expirationTimeInHours int32

  Possible values: >= 1

  Custom expiration time of test failover VMs

Responses

• 200
• 400
• 404
• 503

---

Job initiated

application/json

• Schema
• Example (from schema)

---

Schema

• jobId string

{
  "jobId": "string"
}

Bad request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Service Unavailable

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

PUT /v4/failovergroups/:failovergroupid/action/:droperation    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

failoverGroupId — path required

drOperation — path required

---PlannedFailoverUnplannedFailoverFailbackRevertFailoverUndoFailoverTestBootPITFailoverReverseReplicationCleanupDestinationVMTestFailoverUndoTestFailover

skipDisableNetworkAdapter — query

---truefalse

replicationId — query

expirationTimeInHours — query

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Action/:drOperation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'