Preview VM Group
Select
SaaS
Customer Managed
Preview of the vm to be protected in VMGroup
Query Parameters
- hypervisorId int32
Hypervisor Id of VMGroup
- vmgroupId int32
Id of VMGroup
- application/json
Request Body
content object
filters object
diskFilters object
- createClientsForDiscoveredVms boolean
- skipNonexistentVms boolean
Responses
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- ProtectedVMCount int32
- managementVersion string
management Version of the Hypervisor like vcenter version , Hyperv version
vmGroup object
vmList object
{
"ProtectedVMCount": 0,
"managementVersion": "string",
"vmGroup": {
"id": 0,
"name": "string"
},
"vmList": {
"name": "string",
"GUID": "string",
"poweredStatus": "string",
"toolStatus": "string",
"host": "string"
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorCode int32
- errorMessage string
Tells about the error occured
- warningCode int32
- warningMessage string
Tells about the warning occured
{
"errorCode": 0,
"errorMessage": "string",
"warningCode": 0,
"warningMessage": "string"
}
POST /v4/vmgroup/preview
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"content": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"filters": {
"overwrite": true,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
},
"diskFilters": {
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false,
"children": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string",
"filterSubResource": false
}
]
}
]
},
"createClientsForDiscoveredVms": true,
"skipNonexistentVms": true
}'