Get all VMs (Deprecated)
deprecated
This endpoint has been deprecated and may be removed in future versions of the API.
This operation returns all the VMs.
Query Parameters
- status int32
Possible values: [
All
,Protected
,Not Protected
,Pending
,Backed up with error
,Discovered
]VM Status to filter
Header Parameters
- PagingInfo string required
a,b such that a represent page number and b represent number of records
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- V Ms
Schema
- totalRecords integer
- pageNo integer
- errorMessage string
- errorCode integer
- pageSize integer
vmStatusInfoList object[]
{
"totalRecords": 0,
"pageNo": 0,
"errorMessage": "string",
"errorCode": 0,
"pageSize": 0,
"vmStatusInfoList": [
{
"vmHost": "string",
"vmGuestSpace": 0,
"bkpStartTime": 0,
"type": 0,
"vmStatus": 0,
"vmBackupJob": 0,
"strOSName": "string",
"isDeleted": true,
"vendor": 0,
"osType": 0,
"vmSize": 0,
"vmUsedSpace": 0,
"subclientId": 0,
"bkpEndTime": 0,
"vmAgent": "string",
"name": "string",
"vmHardwareVer": "string",
"strGUID": "string",
"subclientName": "string",
"client": {
"clientId": 0,
"clientName": "string"
},
"proxyClient": {
"clientId": 0,
"clientName": "string"
},
"plan": {},
"pseudoClient": {
"clientId": 0,
"clientName": "string",
"flags": {
"disabled": true
}
},
"vmSubClientEntity": {
"subclientId": 0,
"subclientName": "string"
}
}
]
}
{
"totalRecords": 4,
"pageNo": 0,
"errorMessage": "",
"errorCode": 0,
"pageSize": 100,
"vmStatusInfoList": [
{
"vmHost": "172.19.116.30",
"vmGuestSpace": 6442642704,
"bkpStartTime": 1537826493,
"type": 9,
"vmStatus": 1,
"vmBackupJob": 2159,
"strOSName": "CentOS 4/5 or later (64-bit)",
"isDeleted": false,
"vendor": 1,
"osType": 2,
"vmSize": 6442642704,
"vmUsedSpace": 191889408,
"subclientId": 10,
"bkpEndTime": 1537826609,
"vmAgent": "venkatoprime",
"name": "teeny-tiny-vm",
"vmHardwareVer": "vmx-09",
"strGUID": "502d21a1-ae8b-a75e-a0da-313df460ea03",
"subclientName": "replication_api",
"client": {
"clientId": 4,
"clientName": "teeny-tiny-vm"
},
"proxyClient": {
"clientId": 2,
"clientName": "venkatoprime"
},
"plan": {},
"pseudoClient": {
"clientId": 3,
"clientName": "vsa-vc65.test.com",
"flags": {
"disabled": false
}
}
},
{
"vmHost": "172.19.116.30",
"vmGuestSpace": 6444758241,
"bkpStartTime": 1539814806,
"type": 9,
"vmStatus": 1,
"vmBackupJob": 2473,
"strOSName": "CentOS 4/5 or later (64-bit)",
"isDeleted": false,
"vendor": 1,
"osType": 2,
"vmSize": 6443701473,
"vmUsedSpace": 0,
"subclientId": 13,
"bkpEndTime": 1539814907,
"vmAgent": "venkatoprime",
"name": "blueberry",
"vmHardwareVer": "vmx-09",
"strGUID": "502d3b95-83f7-0c8e-63ac-caa18c7618b4",
"subclientName": "sc1",
"client": {
"clientId": 6,
"clientName": "blueberry"
},
"proxyClient": {
"clientId": 2,
"clientName": "venkatoprime"
},
"plan": {},
"pseudoClient": {
"clientId": 3,
"clientName": "vsa-vc65.test.com",
"flags": {
"disabled": false
}
}
},
{
"vmHost": "172.19.116.174",
"vmGuestSpace": 11574050816,
"bkpStartTime": 1539818686,
"type": 9,
"vmStatus": 1,
"vmBackupJob": 2484,
"strOSName": "Microsoft Windows Server 2012 (64-bit)",
"isDeleted": false,
"vendor": 1,
"osType": 1,
"vmSize": 42950518723,
"vmUsedSpace": 308281344,
"subclientId": 13,
"bkpEndTime": 1539818817,
"vmAgent": "venkatoprime",
"name": "Nimble3-VM2",
"vmHardwareVer": "vmx-11",
"strGUID": "502d4368-5d71-1341-dd53-e1ffbf4f9b0d",
"subclientName": "sc1",
"client": {
"clientId": 7,
"clientName": "Nimble3-VM2"
},
"proxyClient": {
"clientId": 2,
"clientName": "venkatoprime"
},
"plan": {},
"pseudoClient": {
"clientId": 3,
"clientName": "vsa-vc65.test.com",
"flags": {
"disabled": false
}
}
},
{
"vmHost": "172.19.110.73",
"vmGuestSpace": 11335602176,
"bkpStartTime": 1538495626,
"type": 9,
"vmStatus": 1,
"vmBackupJob": 2247,
"strOSName": "Microsoft Windows Server 2012 (64-bit)",
"isDeleted": true,
"vendor": 1,
"osType": 1,
"vmSize": 42950022432,
"vmUsedSpace": 11562647552,
"subclientId": 14,
"bkpEndTime": 1538496277,
"vmAgent": "venkatoprime",
"name": "Nimble3-VM3-test1",
"vmHardwareVer": "vmx-11",
"strGUID": "502d1699-18fa-fdc3-37c9-42183493244a",
"subclientName": "no_rep_subclient",
"client": {
"clientId": 9,
"clientName": "Nimble3-VM3-test1"
},
"proxyClient": {
"clientId": 2,
"clientName": "venkatoprime"
},
"plan": {},
"pseudoClient": {
"clientId": 3,
"clientName": "vsa-vc65.test.com",
"flags": {
"disabled": false
}
}
}
]
}
GET /vm
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'