Modify VM Group Details
Select
SaaS
Customer Managed
Updates the VM Group
Path Parameters
- VmGroupId int32 required
Id of the VMgroup to update
- application/json
Request Body
- newName string
subclient name
content object
plan object
storage object
filters object
diskFilters object
securityAssociations object[]
settings object
snapshotManagement object
activityControl object
applicationValidation object
- enableFileIndexing boolean
Default value:
false
True if file indexing needs to be enabled
timeZone object
accessNode object[]
meditechSystems object
Responses
- 200
- 400
- 500
Success
- 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"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
PUT /v4/vmgroup/:vmgroupid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VmGroup/:VmGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"content": {
"overwrite": false,
"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"
}
]
}
]
},
"plan": {
"id": 0,
"name": "string"
},
"storage": {
"id": 0,
"name": "string"
},
"filters": {
"overwrite": false,
"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"
}
]
},
"securityAssociations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"settings": {
"useChangedBlockTrackingOnVM": true,
"customSnapshotResourceGroup": "string",
"customSnapshotTags": [
{
"name": "string",
"value": "string"
}
],
"regionalSnapshot": true,
"autoDetectVMOwner": true,
"allowEmptySubclient": true,
"noOfReaders": 5,
"isVMGroupDiskFiltersIncluded": true,
"vmBackupType": "APPLICATION_AWARE",
"isApplicationAware": true,
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"useVMCheckpointSetting": false,
"transportMode": "AUTO",
"datastoreFreespaceCheck": true,
"datastoreFreespaceRequired": 10,
"collectFileDetailsforGranularRecovery": false,
"collectFileDetailsFromSnapshotCopy": false,
"jobStartTime": 0,
"crossAccount": {
"shareOnly": true,
"fullCopy": true,
"destinationAccount": {
"id": 0,
"name": "string"
}
},
"quiesceGuestFileSystemAndApplications": true,
"useBackupsetDiskFilters": true
},
"snapshotManagement": {
"enableHardwareSnapshot": false,
"snapEngine": {
"id": 0,
"name": "string"
},
"snapMountESXHost": "string",
"isIndependentDisksEnabled": true,
"isRawDeviceMapsEnabled": true,
"useSeparateProxyForSnapToTape": true,
"snapMountProxy": {
"id": 0,
"name": "string"
},
"vmApplicationUserName": "string",
"backupCopyInterface": "FILE_SYSTEM"
},
"activityControl": {
"enableBackup": true,
"enableRestore": true,
"backupActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
},
"restoreActivityControlOptions": {
"activityType": "BACKUP",
"enableAfterADelay": true,
"enableActivityType": true,
"delayTime": {
"timeZone": {
"id": 0,
"name": "string"
},
"time": 0,
"value": "string"
}
}
},
"applicationValidation": {
"validateVMBackups": true,
"recoveryTarget": {
"id": 0,
"name": "string"
},
"schedule": {
"id": 0,
"taskId": 0,
"description": "string",
"isScheduleEnabled": true
},
"useSourceVmESXToMount": true,
"keepValidatedVMsRunning": true,
"maximumNoOfThreads": 0,
"customValidationScript": {
"windows": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
},
"unix": {
"path": "string",
"arguments": "string",
"isDisabled": false,
"isLocal": true,
"UNCCredentials": {
"name": "string",
"password": "string"
},
"UNCSavedCredentials": {
"id": 0,
"name": "string"
}
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"copy": {
"id": 0,
"name": "string",
"isActive": true,
"isSnapCopy": true,
"copyPrecedence": 0,
"backupDestination": {
"id": 0,
"name": "string"
}
}
},
"enableFileIndexing": false,
"timeZone": {
"id": 0,
"name": "string"
},
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"meditechSystems": {
"systemName": "string",
"listenerIP": "string",
"listenerPort": 0,
"MBFtimeout": 60,
"userAccount": {
"name": "string",
"password": "string"
}
}
}'