View Test Failover VM's

Select

SaaS

Customer Managed

Request Body

Name	Description
vAppId	Failover Group ID

Header Parameters

• Accept string required

application/json

Request Body

• filter object

  isTestFailOver boolean

  vappEntity object

  vAppId integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• virtualMachines object[]

  operatingSystem string

  userCapabilities integer

  numberOfDisks integer

  memory integer

  flags integer

  isVirtualLabGateway boolean

  vmAllocPolicyId integer

  numberOfCPUs integer

  vmState integer

  modifiedTime object

  _type_ integer

  time integer

  proxyClient object

  clientId integer

  ipAddress object

  subnet integer

  address string

  family integer

  vmLocation object

  hostName string

  dataCenterName string

  vCenter string

  expirationTime object

  _type_ integer

  time integer

  vm object

  hostName string

  vmName string

  clientId integer

  clientName string

  vmGUID string

  creationTime object

  _type_ integer

  time integer

  lastPowerOnTime object

  time integer

  creator object

  userGUID string

  userName string

  userId integer

  instanceTypeEntity object

  vmInstanceTypeName string

  advancedProperties object

  connectionString string

  additionalFlags integer

  entity object

  instanceId integer

{
  "virtualMachines": [
    {
      "operatingSystem": "string",
      "userCapabilities": 0,
      "numberOfDisks": 0,
      "memory": 0,
      "flags": 0,
      "isVirtualLabGateway": true,
      "vmAllocPolicyId": 0,
      "numberOfCPUs": 0,
      "vmState": 0,
      "modifiedTime": {
        "_type_": 0,
        "time": 0
      },
      "proxyClient": {
        "clientId": 0
      },
      "ipAddress": {
        "subnet": 0,
        "address": "string",
        "family": 0
      },
      "vmLocation": {
        "hostName": "string",
        "dataCenterName": "string",
        "vCenter": "string"
      },
      "expirationTime": {
        "_type_": 0,
        "time": 0
      },
      "vm": {
        "hostName": "string",
        "vmName": "string",
        "clientId": 0,
        "clientName": "string",
        "vmGUID": "string"
      },
      "creationTime": {
        "_type_": 0,
        "time": 0
      },
      "lastPowerOnTime": {
        "time": 0
      },
      "creator": {
        "userGUID": "string",
        "userName": "string",
        "userId": 0
      },
      "instanceTypeEntity": {
        "vmInstanceTypeName": "string"
      },
      "advancedProperties": {
        "connectionString": "string",
        "additionalFlags": 0
      },
      "entity": {
        "instanceId": 0
      }
    }
  ]
}

{
  "virtualMachines": [
    {
      "operatingSystem": "Other Linux (64-bit)",
      "userCapabilities": 65535,
      "numberOfDisks": 2,
      "memory": 48,
      "flags": 101,
      "isVirtualLabGateway": false,
      "vmAllocPolicyId": 2,
      "numberOfCPUs": 1,
      "vmState": 1,
      "modifiedTime": {
        "_type_": 55,
        "time": 1651260582
      },
      "proxyClient": {
        "clientId": 4
      },
      "ipAddress": {
        "subnet": 0,
        "address": "",
        "family": 32
      },
      "vmLocation": {
        "hostName": "172.24.33.2",
        "dataCenterName": "Rajesh",
        "vCenter": "devvsvc.commvault.com"
      },
      "expirationTime": {
        "_type_": 55,
        "time": 1651264182
      },
      "vm": {
        "hostName": "",
        "vmName": "tinyvm49DR-Clone-10580-65",
        "clientId": 9,
        "clientName": "tinyvm49DR-Clone-10580-65",
        "vmGUID": "591836ee-f414-4082-a391-bf7dcb1e040f"
      },
      "creationTime": {
        "_type_": 55,
        "time": 1651260581
      },
      "lastPowerOnTime": {
        "time": 0
      },
      "creator": {
        "userGUID": "A492CDFD-8548-4C65-96E1-9D04C2E671AA",
        "userName": "testadmin",
        "userId": 1
      },
      "instanceTypeEntity": {
        "vmInstanceTypeName": ""
      },
      "advancedProperties": {
        "connectionString": "",
        "additionalFlags": 3
      },
      "entity": {
        "instanceId": 4
      }
    },
    {
      "operatingSystem": "Other Linux (64-bit)",
      "userCapabilities": 65535,
      "numberOfDisks": 2,
      "memory": 48,
      "flags": 101,
      "isVirtualLabGateway": false,
      "vmAllocPolicyId": 2,
      "numberOfCPUs": 1,
      "vmState": 1,
      "modifiedTime": {
        "_type_": 55,
        "time": 1651260582
      },
      "proxyClient": {
        "clientId": 4
      },
      "ipAddress": {
        "subnet": 0,
        "address": "",
        "family": 32
      },
      "vmLocation": {
        "hostName": "172.24.33.2",
        "dataCenterName": "Rajesh",
        "vCenter": "devvsvc.commvault.com"
      },
      "expirationTime": {
        "_type_": 55,
        "time": 1651264182
      },
      "vm": {
        "hostName": "",
        "vmName": "tinyvm50DR-Clone-10580-65",
        "clientId": 10,
        "clientName": "tinyvm50DR-Clone-10580-65",
        "vmGUID": "f18d0f24-2823-4595-be33-6857a468a044"
      },
      "creationTime": {
        "_type_": 55,
        "time": 1651260581
      },
      "lastPowerOnTime": {
        "time": 0
      },
      "creator": {
        "userGUID": "A492CDFD-8548-4C65-96E1-9D04C2E671AA",
        "userName": "testadmin",
        "userId": 1
      },
      "instanceTypeEntity": {
        "vmInstanceTypeName": ""
      },
      "advancedProperties": {
        "connectionString": "",
        "additionalFlags": 3
      },
      "entity": {
        "instanceId": 4
      }
    }
  ]
}

POST /getvirtualmachinelist    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Accept — header required

Body

• Default
• Example 1

---

{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/getVirtualMachineList' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "isTestFailOver": true,
    "vappEntity": {
      "vAppId": 0
    }
  }
}'