Get Failover Group Properties

Select

SaaS

Customer Managed

This operation returns the properties associated with a Failover group.

More Details

Path Parameters

• FailoverGroupId string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Get Failover Group Properties

---

Schema

• vApp object[]

  source integer

  isClientGroup boolean

  version integer

  approvalRequired boolean

  operationType integer

  selectedEntities object[]

  instanceId integer

  clientId integer

  entityName string

  _type_ integer

  entityId integer

  workflow object[]

  type integer

  entity object

  workflowId integer

  vAppEntity object

  _type_ integer

  vAppId integer

  vAppName string

  clientList object[]

  clientName string

  backupsetId integer

  clientId integer

  GUID string

  backupsetName string

  _type_ integer

  entityId integer

  config object

  vmGroups object[]

  delay integer

  groupId integer

  vmSequence object[]

  copyPrecedence integer

  replicationId integer

  delay integer

  createPublicIp boolean

  vmInfo object

  vmName string

  _type_ integer

  vmGUID string

{
  "vApp": [
    {
      "source": 0,
      "isClientGroup": true,
      "version": 0,
      "approvalRequired": true,
      "operationType": 0,
      "selectedEntities": [
        {
          "instanceId": 0,
          "clientId": 0,
          "entityName": "string",
          "_type_": 0,
          "entityId": 0
        }
      ],
      "workflow": [
        {
          "type": 0,
          "entity": {
            "workflowId": 0
          }
        }
      ],
      "vAppEntity": {
        "_type_": 0,
        "vAppId": 0,
        "vAppName": "string"
      },
      "clientList": [
        {
          "clientName": "string",
          "backupsetId": 0,
          "clientId": 0,
          "GUID": "string",
          "backupsetName": "string",
          "_type_": 0,
          "entityId": 0
        }
      ],
      "config": {
        "vmGroups": [
          {
            "delay": 0,
            "groupId": 0,
            "vmSequence": [
              {
                "copyPrecedence": 0,
                "replicationId": 0,
                "delay": 0,
                "createPublicIp": true,
                "vmInfo": {
                  "vmName": "string",
                  "_type_": 0,
                  "vmGUID": "string"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

{
  "vApp": [
    {
      "source": 1,
      "isClientGroup": false,
      "version": 2,
      "approvalRequired": false,
      "operationType": 16,
      "selectedEntities": [
        {
          "instanceId": 4,
          "clientId": 3,
          "entityName": "vsa-vc6",
          "_type_": 3,
          "entityId": 3
        }
      ],
      "workflow": [
        {
          "type": 7,
          "entity": {
            "workflowId": 49
          }
        },
        {
          "type": 1,
          "entity": {
            "workflowId": 50
          }
        }
      ],
      "vAppEntity": {
        "_type_": 164,
        "vAppId": 47,
        "vAppName": "NewFailoverGroup1"
      },
      "clientList": [
        {
          "clientName": "testboot",
          "backupsetId": 6,
          "clientId": 62,
          "GUID": "5026707a-0a15-d7c6-69a9-9f781514a932",
          "backupsetName": "defaultBackupSet",
          "_type_": 3,
          "entityId": 3
        },
        {
          "clientName": "testboot1",
          "backupsetId": 6,
          "clientId": 63,
          "GUID": "5026ddf0-3cb1-ba7c-1417-0328aeb53db1",
          "backupsetName": "defaultBackupSet",
          "_type_": 3,
          "entityId": 4
        }
      ],
      "config": {
        "vmGroups": [
          {
            "delay": 2,
            "groupId": 1,
            "vmSequence": [
              {
                "copyPrecedence": 0,
                "replicationId": 3,
                "delay": 1,
                "createPublicIp": false,
                "vmInfo": {
                  "vmName": "testboot",
                  "_type_": 88,
                  "vmGUID": "5026707a-0a15-d7c6-69a9-9f781514a932"
                }
              },
              {
                "copyPrecedence": 0,
                "replicationId": 4,
                "delay": 1,
                "createPublicIp": false,
                "vmInfo": {
                  "vmName": "testboot1",
                  "_type_": 88,
                  "vmGUID": "5026ddf0-3cb1-ba7c-1417-0328aeb53db1"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

GET /failovergroups/:failovergroupid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

FailoverGroupId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'