Get test failover VMs list

Select

SaaS

Customer Managed

API to get test failover machines for failover group

Path Parameters

• failoverGroupId int32 required

  Id of the failover group

Responses

• 200
• 404
• 503

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• virtualMachines object[]

  name string

  The name of the clone VM

  state string

  Possible values: [STOPPED, RUNNING, SUSPENDED, UNKNOWN, ARCHIVED, EXPIRED, UNAVAILABLE, CREATING, CLONING, CREATING_SNAPSHOT, REVERTING_SNAPSHOT, DELETING_SNAPSHOT, STARTING, STOPPING, SUSPENDING, RESTARTING, RECOVERING, RETRIEVING]

  Power state of the clone VM

  ipAddress string

  The IP address of the clone VM

  operatingSystem string

  Name of operating system of VM

  creator object

  id int32

  GUID string

  name string

  expirationTime int32

  Expiration timestamp of cloned VM in unix time (epoch) format

{
  "virtualMachines": [
    {
      "name": "string",
      "state": "STOPPED",
      "ipAddress": "string",
      "operatingSystem": "string",
      "creator": {
        "id": 0,
        "GUID": "string",
        "name": "string"
      },
      "expirationTime": 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
}

GET /v4/failovergroups/:failovergroupid/testfailovermachines    

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/V4/FailoverGroups/:failoverGroupId/TestFailoverMachines' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

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

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

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

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

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

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