Replication Group Details
Select
This operation returns details of Replication group.
Path Parameters
- taskId string required
- 200
OK
- application/json
- Schema
- Example (from schema)
- Replication Group details
Schema
taskInfo object
associations object[]
srmReportSet integersrmTemplateId integersubclientId integerclientGroupId integerstoragePolicyId integercopyId integerapplicationId integerclientName stringdisplayName stringbackupsetId integerinstanceId integersidbStoreId integerclientId integersubclientName stringsrmTemplateName stringagentlessPolicyId integermediaAgentId integerbackupsetName stringworkflowId integerinstanceName string_type_ integertrackingPolicyId integerappName stringflags object
exclude booleantask object
description stringownerId integerrunUserId integertaskType integerownerName stringalertId integerGUID stringpolicyType integerassociatedObjects integertaskName stringtaskId integersecurityAssociations object
ownerAssociations object
originalCC object
commCellId integertaskSecurity object
associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringownerCapabilities object
createAs object
user object
user object
userName stringuserId integertaskFlags object
isEdgeDrive booleanisEZOperation booleanforDDB booleanuninstalled booleanisSystem booleandisabled booleantask object
taskName stringtaskId integerappGroup object
subTasks object[]
subTask object
subTaskOrder integersubTaskName stringsubTaskType integerflags integeroperationType integersubTaskId integersubTask object
subtaskId integersubtaskName stringpattern object
active_end_occurence integerfreq_subday_interval integerfreq_type integerpatternId integerflags integerdescription stringactive_end_time integeractive_end_date integerskipOccurence integerskipDayNumber integeractive_start_time integerfreq_restart_interval integeractive_start_date integerfreq_interval integerfreq_relative_interval integername stringfreq_recurrence_factor integercalendar object
calendarName stringcalendarId integertimeZone object
TimeZoneID integeroptions object
adminOpts object
updateOption object
invokeLevel integerrestoreOptions object
Comprehensive restore options for bringing up DR VMs during failover operations.
replicationType integerType of replication used for the DR operation.
virtualServerRstOption object required
Virtual server specific restore options for DR VM deployment
isVolumeBrowse booleanIndicates whether volume-level browsing is enabled for the restore operation.
isVirtualLab booleanSpecifies if the restore is for a virtual lab environment.
esxServer stringESX server hostname or IP address for the restore destination.
isAttachToNewVM booleanDetermines if the restored disks should be attached to a new virtual machine.
isBlockLevelReplication booleanIndicates whether block-level replication is used for the restore operation.
isDiskBrowse booleanSpecifies if disk-level browsing is enabled for the restore operation.
viewType integerType of view used for browsing during the restore operation.
replicationGuid stringUnique identifier for the replication.
isFileBrowse booleanIndicates whether file-level browsing is enabled for the restore operation.
vCenterInstance object
vCenter server instance details for VM restore operations.
clientId integerUnique identifier for the vCenter client.
clientName stringName of the vCenter client or server.
instanceName stringName of the vCenter instance.
appName stringName of the application associated with the vCenter instance.
instanceId integerUnique identifier for the vCenter instance.
applicationId integerVirtual server application ID.
diskLevelVMRestoreOption object required
Configuration options for disk-level virtual machine restore operations.
vmFolderName stringName of the folder where the restored VM will be placed.
passUnconditionalOverride booleanAllows unconditional override of existing VMs during restore.
dataCenterName stringName of the datacenter where the VM will be restored.
hostOrCluster stringTarget host or cluster for the restored virtual machine.
useVcloudCredentials booleanIndicates whether to use vCloud credentials for the restore operation.
diskOption integerPossible values: [
0
,1
,2
,3
]Disk restoration option (e.g., 0- Original, 1- Thick provisioned, 2- Thin provisioned, 3- Thick eager zero).
vmName stringName to be assigned to the restored virtual machine.
powerOnVmAfterRestore booleanSpecifies whether to power on the VM automatically after restore completion.
esxServerName stringName of the ESX server where the VM will be restored.
transportMode integerTransport mode for data transfer during the restore operation.
maxNumOfVMPerJob integerMaximum number of VMs that can be restored in a single job.
userPassword object
User credentials for accessing the restored virtual machine.
domainName stringDomain name for the user account.
userName stringUsername for accessing the restored VM.
advancedRestoreOptions object[]
Advanced options for DR VM restore configuration during failover operations.
esxHost stringESX host where the DR VM will be restored and powered on.
destComputerUserName stringUsername of the DR VM.
resourcePoolPath stringResource pool path where the DR VM will be allocated during failover.
vmSize stringSize configuration for the DR VM after failover operation.
destComputerName stringHostname of the DR VM.
datacenter stringDatacenter of the DR VM.
newName stringNew name to be assigned to the DR VM after failover.
Datastore stringDatastore where the DR VM's virtual disks will be stored.
name stringOriginal name of the VM being restored as a DR VM.
guid stringUnique identifier (GUID) of the DR VM.
nics object[] required
Network interface card configurations for the DR VM.
sourceNetwork stringOriginal network name from the source VM.
destinationNetwork stringTarget network where the DR VM's NIC will be connected.
subnetId stringSubnet identifier for the DR VM's network interface.
sourceNetworkId stringOriginal network ID from the source VM.
networkName stringNetwork name for the DR VM's network interface.
dataStore object
Datastore information for the restored virtual machine.
totalSizeInBytes integerTotal size of the datastore in bytes.
freeSpaceInBytes integerAvailable free space in the datastore in bytes.
dataStoreName stringName of the datastore where VM files will be stored.
allocationPolicy object
VM allocation policy for determining resource allocation during restore.
vmAllocPolicyName stringName of the VM allocation policy.
vmAllocPolicyId integerUnique identifier for the VM allocation policy.
policyType integerType of allocation policy (e.g., resource pool, cluster).
instanceEntity object
Instance entity details for the allocation policy.
flags object
Configuration flags for the instance entity.
flags object
General configuration flags for the allocation policy.
region object
Region-specific configuration for the allocation policy.
flags object
Region-specific configuration flags.
volumeRstOption object required
Volume-level restore options for disk recovery operations.
volumeLeveRestore booleanIndicates whether volume-level restore is enabled.
volumeLevelRestoreType integerPossible values: [
1
]Type of volume-level restore operation to perform. (1- Full VM)
destinationVendor integerPossible values: [
1
,2
,4
]Vendor type for the destination storage system. ( 1- VMware, 2- Hyper-V, 4- Amazon)
browseOption object
Options for browsing and selecting data during restore operations.
listMedia booleanIndicates whether to list available media for the restore operation.
useExactIndex booleanSpecifies whether to use exact index matching during browse operations.
noImage booleanIndicates whether image-based restore should be disabled.
commCellId integerUnique identifier for the CommCell environment.
showDeletedItems booleanSpecifies whether to show deleted items during browse operations.
mediaOption object
Media-specific options for the restore operation.
mediaAgent object
Media agent configuration for handling restore data.
mediaAgentId integerUnique identifier for the media agent.
library object
Library configuration for media management.
libraryId integerUnique identifier for the media library.
copyPrecedence object
Copy precedence settings for selecting restore source.
copyPrecedence integerPrimary copy precedence value for restore operations.
synchronousCopyPrecedence integerSynchronous copy precedence value for restore operations.
copyPrecedenceApplicable booleanIndicates whether copy precedence rules apply to this restore.
drivePool object
Drive pool configuration for media access.
drivePoolId integerUnique identifier for the drive pool.
drive object
Specific drive configuration for media access.
driveId integerUnique identifier for the drive.
backupset object
Backupset information for the restore operation.
clientId integerUnique identifier for the client associated with the backupset.
instanceName stringName of the instance associated with the backupset.
backupsetId integerUnique identifier for the backupset.
applicationId integerUnique identifier for the application associated with the backupset.
timeZone object
Time zone configuration for the restore operation.
TimeZoneID integerUnique identifier for the time zone.
TimeZoneName stringDisplay name of the time zone.
timeRange object
Time range specification for point-in-time restore operations.
commonOptions object
Common restore options applicable across different restore types.
systemStateBackup booleanIndicates whether system state backup is used by the restore.
restoreToDisk booleanIndicates whether to restore data directly to disk.
preserveLevel integerLevel from end of the source path.
stripLevelType integerIf level strip should be preserved or removed.
restoreACLs booleanIndicates whether to restore Access Control Lists (ACLs).
stripLevel integerLevel from beginning of the source path.
overwriteFiles booleanSpecifies whether to overwrite existing files during restore.
onePassRestore booleanIndicates whether to perform a one-pass restore operation.
unconditionalOverwrite booleanAllows unconditional overwriting of files during restore.
detectRegularExpression booleanAutomatically detect regular expressions.
storagePolicy object
Storage policy configuration for the restore operation.
copyId integerUnique identifier for the storage copy.
copyName stringName of the storage copy used for restore.
{
"taskInfo": {
"associations": [
{
"srmReportSet": 0,
"srmTemplateId": 0,
"subclientId": 0,
"clientGroupId": 0,
"storagePolicyId": 0,
"copyId": 0,
"applicationId": 0,
"clientName": "string",
"displayName": "string",
"backupsetId": 0,
"instanceId": 0,
"sidbStoreId": 0,
"clientId": 0,
"subclientName": "string",
"srmTemplateName": "string",
"agentlessPolicyId": 0,
"mediaAgentId": 0,
"backupsetName": "string",
"workflowId": 0,
"instanceName": "string",
"_type_": 0,
"trackingPolicyId": 0,
"appName": "string",
"flags": {
"exclude": true
}
}
],
"task": {
"description": "string",
"ownerId": 0,
"runUserId": 0,
"taskType": 0,
"ownerName": "string",
"alertId": 0,
"GUID": "string",
"policyType": 0,
"associatedObjects": 0,
"taskName": "string",
"taskId": 0,
"securityAssociations": {
"ownerAssociations": {}
},
"originalCC": {
"commCellId": 0
},
"taskSecurity": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": 0,
"userGroupName": "string"
}
],
"ownerCapabilities": {}
},
"createAs": {
"user": {
"user": {
"userName": "string",
"userId": 0
}
}
},
"taskFlags": {
"isEdgeDrive": true,
"isEZOperation": true,
"forDDB": true,
"uninstalled": true,
"isSystem": true,
"disabled": true
},
"task": {
"taskName": "string",
"taskId": 0
}
},
"appGroup": {},
"subTasks": [
{
"subTask": {
"subTaskOrder": 0,
"subTaskName": "string",
"subTaskType": 0,
"flags": 0,
"operationType": 0,
"subTaskId": 0,
"subTask": {
"subtaskId": 0,
"subtaskName": "string"
}
},
"pattern": {
"active_end_occurence": 0,
"freq_subday_interval": 0,
"freq_type": 0,
"patternId": 0,
"flags": 0,
"description": "string",
"active_end_time": 0,
"active_end_date": 0,
"skipOccurence": 0,
"skipDayNumber": 0,
"active_start_time": 0,
"freq_restart_interval": 0,
"active_start_date": 0,
"freq_interval": 0,
"freq_relative_interval": 0,
"name": "string",
"freq_recurrence_factor": 0,
"calendar": {
"calendarName": "string",
"calendarId": 0
},
"timeZone": {
"TimeZoneID": 0
}
},
"options": {
"adminOpts": {
"updateOption": {
"invokeLevel": 0
}
},
"restoreOptions": {
"replicationType": 0,
"virtualServerRstOption": {
"isVolumeBrowse": true,
"isVirtualLab": true,
"esxServer": "string",
"isAttachToNewVM": true,
"isBlockLevelReplication": true,
"isDiskBrowse": true,
"viewType": 0,
"replicationGuid": "string",
"isFileBrowse": true,
"vCenterInstance": {
"clientId": 0,
"clientName": "string",
"instanceName": "string",
"appName": "string",
"instanceId": 0,
"applicationId": 0
},
"diskLevelVMRestoreOption": {
"vmFolderName": "string",
"passUnconditionalOverride": true,
"dataCenterName": "string",
"hostOrCluster": "string",
"useVcloudCredentials": true,
"diskOption": 0,
"vmName": "string",
"powerOnVmAfterRestore": true,
"esxServerName": "string",
"transportMode": 0,
"maxNumOfVMPerJob": 0,
"userPassword": {
"domainName": "string",
"userName": "string"
},
"advancedRestoreOptions": [
{
"esxHost": "string",
"destComputerUserName": "string",
"resourcePoolPath": "string",
"vmSize": "string",
"destComputerName": "string",
"datacenter": "string",
"newName": "string",
"Datastore": "string",
"name": "string",
"guid": "string",
"nics": [
{
"sourceNetwork": "string",
"destinationNetwork": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"networkName": "string"
}
]
}
],
"dataStore": {
"totalSizeInBytes": 0,
"freeSpaceInBytes": 0,
"dataStoreName": "string"
}
},
"allocationPolicy": {
"vmAllocPolicyName": "string",
"vmAllocPolicyId": 0,
"policyType": 0,
"instanceEntity": {
"flags": {}
},
"flags": {},
"region": {
"flags": {}
}
}
},
"volumeRstOption": {
"volumeLeveRestore": true,
"volumeLevelRestoreType": 1,
"destinationVendor": 1
},
"browseOption": {
"listMedia": true,
"useExactIndex": true,
"noImage": true,
"commCellId": 0,
"showDeletedItems": true,
"mediaOption": {
"mediaAgent": {
"mediaAgentId": 0
},
"library": {
"libraryId": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"synchronousCopyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"drivePoolId": 0
},
"drive": {
"driveId": 0
}
},
"backupset": {
"clientId": 0,
"instanceName": "string",
"backupsetId": 0,
"applicationId": 0
},
"timeZone": {
"TimeZoneID": 0,
"TimeZoneName": "string"
},
"timeRange": {}
},
"commonOptions": {
"systemStateBackup": true,
"restoreToDisk": true,
"preserveLevel": 0,
"stripLevelType": 0,
"restoreACLs": true,
"stripLevel": 0,
"overwriteFiles": true,
"onePassRestore": true,
"unconditionalOverwrite": true,
"detectRegularExpression": true
},
"storagePolicy": {
"copyId": 0,
"copyName": "string"
}
}
}
}
]
}
}
{
"taskInfo": {
"associations": [
{
"srmReportSet": 0,
"srmTemplateId": 0,
"subclientId": 9,
"clientGroupId": 0,
"storagePolicyId": 0,
"copyId": 0,
"applicationId": 106,
"clientName": "vsa-vc6.test.com",
"displayName": "vsa-vc6.test.com",
"backupsetId": 7,
"instanceId": 3,
"sidbStoreId": 0,
"clientId": 4,
"subclientName": "DRAuto",
"srmTemplateName": "",
"agentlessPolicyId": 0,
"mediaAgentId": 0,
"backupsetName": "defaultBackupSet",
"workflowId": 0,
"instanceName": "VMware",
"_type_": 7,
"trackingPolicyId": 0,
"appName": "Virtual Server",
"flags": {
"exclude": false
}
}
],
"task": {
"description": "",
"ownerId": 1,
"runUserId": 1,
"taskType": 2,
"ownerName": "Administrator",
"alertId": 0,
"GUID": "aa000112-0512-41b0-a3b3-3f9bf626f2a1",
"policyType": 0,
"associatedObjects": 0,
"taskName": "",
"taskId": 57,
"securityAssociations": {
"ownerAssociations": {}
},
"originalCC": {
"commCellId": 2
},
"taskSecurity": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
},
{
"userGroupId": 3,
"_type_": 15,
"userGroupName": "View All"
}
],
"ownerCapabilities": {}
},
"createAs": {
"user": {
"user": {
"userName": "testadmin",
"userId": 1
}
}
},
"taskFlags": {
"isEdgeDrive": false,
"isEZOperation": false,
"forDDB": false,
"uninstalled": false,
"isSystem": false,
"disabled": false
},
"task": {
"taskName": "",
"taskId": 57
}
},
"appGroup": {},
"subTasks": [
{
"subTask": {
"subTaskOrder": 0,
"subTaskName": "DRAuto_Immediately after the backup job completes",
"subTaskType": 3,
"flags": 0,
"operationType": 1007,
"subTaskId": 60,
"subTask": {
"subtaskId": 60,
"subtaskName": "DRAuto_Immediately after the backup job completes"
}
},
"pattern": {
"active_end_occurence": 0,
"freq_subday_interval": 0,
"freq_type": 4096,
"patternId": 22,
"flags": 0,
"description": "After Each Backup Job Schedule",
"active_end_time": 0,
"active_end_date": 0,
"skipOccurence": 0,
"skipDayNumber": 0,
"active_start_time": 0,
"freq_restart_interval": 0,
"active_start_date": 1519948800,
"freq_interval": 0,
"freq_relative_interval": 0,
"name": "",
"freq_recurrence_factor": 4096,
"calendar": {
"calendarName": "Standard",
"calendarId": 1
},
"timeZone": {
"TimeZoneID": 1000
}
},
"options": {
"adminOpts": {
"updateOption": {
"invokeLevel": 0
}
},
"restoreOptions": {
"useAllocationPolicyForRestore": true,
"restoreACLsType": 3,
"virtualServerRstOption": {
"isVolumeBrowse": false,
"isDiskBrowse": true,
"viewType": 0,
"isFileBrowse": false,
"userPassword": {
"userName": "root"
},
"diskLevelVMRestoreOption": {
"powerOnVmAfterRestore": true,
"maxNumOfVMPerJob": 0
},
"allocationPolicy": {
"vmAllocPolicyName": "DRAuto",
"vmAllocPolicyId": 2
}
},
"volumeRstOption": {
"volumeLeveRestore": false,
"volumeLevelRestoreType": 1,
"destinationVendor": 0
},
"browseOption": {
"listMedia": false,
"useExactIndex": false,
"noImage": true,
"commCellId": 2,
"mediaOption": {
"mediaAgent": {},
"library": {},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": false
},
"drivePool": {}
}
},
"commonOptions": {
"systemStateBackup": false,
"clusterDBBackedup": false,
"isFromBrowseBackup": true,
"powerRestore": false,
"restoreToDisk": false,
"offlineMiningRestore": false,
"preserveLevel": 1,
"stripLevelType": 0,
"restoreACLs": true,
"stripLevel": 0,
"overwriteFiles": true,
"onePassRestore": false,
"unconditionalOverwrite": true,
"detectRegularExpression": true,
"wildCard": false
},
"destination": {
"isLegalHold": false
},
"storagePolicy": {
"copyId": 9,
"copyName": "Secondary"
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}