Skip to main content

Replication Group Details​

Select

SaaS
Customer Managed

This operation returns details of Replication group.

Path Parameters
  • taskId string required
Responses

OK

Schema
  • taskInfo object
  • associations object[]
  • srmReportSet integer
  • srmTemplateId integer
  • subclientId integer
  • clientGroupId integer
  • storagePolicyId integer
  • copyId integer
  • applicationId integer
  • clientName string
  • displayName string
  • backupsetId integer
  • instanceId integer
  • sidbStoreId integer
  • clientId integer
  • subclientName string
  • srmTemplateName string
  • agentlessPolicyId integer
  • mediaAgentId integer
  • backupsetName string
  • workflowId integer
  • instanceName string
  • _type_ integer
  • trackingPolicyId integer
  • appName string
  • flags object
  • exclude boolean
  • task object
  • description string
  • ownerId integer
  • runUserId integer
  • taskType integer
  • ownerName string
  • alertId integer
  • GUID string
  • policyType integer
  • associatedObjects integer
  • taskName string
  • taskId integer
  • securityAssociations object
  • ownerAssociations object
  • originalCC object
  • commCellId integer
  • taskSecurity object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • ownerCapabilities object
  • createAs object
  • user object
  • user object
  • userName string
  • userId integer
  • taskFlags object
  • isEdgeDrive boolean
  • isEZOperation boolean
  • forDDB boolean
  • uninstalled boolean
  • isSystem boolean
  • disabled boolean
  • task object
  • taskName string
  • taskId integer
  • appGroup object
  • subTasks object[]
  • subTask object
  • subTaskOrder integer
  • subTaskName string
  • subTaskType integer
  • flags integer
  • operationType integer
  • subTaskId integer
  • subTask object
  • subtaskId integer
  • subtaskName string
  • pattern object
  • active_end_occurence integer
  • freq_subday_interval integer
  • freq_type integer
  • patternId integer
  • flags integer
  • description string
  • active_end_time integer
  • active_end_date integer
  • skipOccurence integer
  • skipDayNumber integer
  • active_start_time integer
  • freq_restart_interval integer
  • active_start_date integer
  • freq_interval integer
  • freq_relative_interval integer
  • name string
  • freq_recurrence_factor integer
  • calendar object
  • calendarName string
  • calendarId integer
  • timeZone object
  • TimeZoneID integer
  • options object
  • adminOpts object
  • updateOption object
  • invokeLevel integer
  • restoreOptions object

    Comprehensive restore options for bringing up DR VMs during failover operations.

  • replicationType integer

    Type of replication used for the DR operation.

  • virtualServerRstOption object required

    Virtual server specific restore options for DR VM deployment

  • isVolumeBrowse boolean

    Indicates whether volume-level browsing is enabled for the restore operation.

  • isVirtualLab boolean

    Specifies if the restore is for a virtual lab environment.

  • esxServer string

    ESX server hostname or IP address for the restore destination.

  • isAttachToNewVM boolean

    Determines if the restored disks should be attached to a new virtual machine.

  • isBlockLevelReplication boolean

    Indicates whether block-level replication is used for the restore operation.

  • isDiskBrowse boolean

    Specifies if disk-level browsing is enabled for the restore operation.

  • viewType integer

    Type of view used for browsing during the restore operation.

  • replicationGuid string

    Unique identifier for the replication.

  • isFileBrowse boolean

    Indicates whether file-level browsing is enabled for the restore operation.

  • vCenterInstance object

    vCenter server instance details for VM restore operations.

  • clientId integer

    Unique identifier for the vCenter client.

  • clientName string

    Name of the vCenter client or server.

  • instanceName string

    Name of the vCenter instance.

  • appName string

    Name of the application associated with the vCenter instance.

  • instanceId integer

    Unique identifier for the vCenter instance.

  • applicationId integer

    Virtual server application ID.

  • diskLevelVMRestoreOption object required

    Configuration options for disk-level virtual machine restore operations.

  • vmFolderName string

    Name of the folder where the restored VM will be placed.

  • passUnconditionalOverride boolean

    Allows unconditional override of existing VMs during restore.

  • dataCenterName string

    Name of the datacenter where the VM will be restored.

  • hostOrCluster string

    Target host or cluster for the restored virtual machine.

  • useVcloudCredentials boolean

    Indicates whether to use vCloud credentials for the restore operation.

  • diskOption integer

    Possible values: [0, 1, 2, 3]

    Disk restoration option (e.g., 0- Original, 1- Thick provisioned, 2- Thin provisioned, 3- Thick eager zero).

  • vmName string

    Name to be assigned to the restored virtual machine.

  • powerOnVmAfterRestore boolean

    Specifies whether to power on the VM automatically after restore completion.

  • esxServerName string

    Name of the ESX server where the VM will be restored.

  • transportMode integer

    Transport mode for data transfer during the restore operation.

  • maxNumOfVMPerJob integer

    Maximum number of VMs that can be restored in a single job.

  • userPassword object

    User credentials for accessing the restored virtual machine.

  • domainName string

    Domain name for the user account.

  • userName string

    Username for accessing the restored VM.

  • advancedRestoreOptions object[]

    Advanced options for DR VM restore configuration during failover operations.

  • esxHost string

    ESX host where the DR VM will be restored and powered on.

  • destComputerUserName string

    Username of the DR VM.

  • resourcePoolPath string

    Resource pool path where the DR VM will be allocated during failover.

  • vmSize string

    Size configuration for the DR VM after failover operation.

  • destComputerName string

    Hostname of the DR VM.

  • datacenter string

    Datacenter of the DR VM.

  • newName string

    New name to be assigned to the DR VM after failover.

  • Datastore string

    Datastore where the DR VM's virtual disks will be stored.

  • name string

    Original name of the VM being restored as a DR VM.

  • guid string

    Unique identifier (GUID) of the DR VM.

  • nics object[] required

    Network interface card configurations for the DR VM.

  • sourceNetwork string

    Original network name from the source VM.

  • destinationNetwork string

    Target network where the DR VM's NIC will be connected.

  • subnetId string

    Subnet identifier for the DR VM's network interface.

  • sourceNetworkId string

    Original network ID from the source VM.

  • networkName string

    Network name for the DR VM's network interface.

  • dataStore object

    Datastore information for the restored virtual machine.

  • totalSizeInBytes integer

    Total size of the datastore in bytes.

  • freeSpaceInBytes integer

    Available free space in the datastore in bytes.

  • dataStoreName string

    Name of the datastore where VM files will be stored.

  • allocationPolicy object

    VM allocation policy for determining resource allocation during restore.

  • vmAllocPolicyName string

    Name of the VM allocation policy.

  • vmAllocPolicyId integer

    Unique identifier for the VM allocation policy.

  • policyType integer

    Type 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 boolean

    Indicates whether volume-level restore is enabled.

  • volumeLevelRestoreType integer

    Possible values: [1]

    Type of volume-level restore operation to perform. (1- Full VM)

  • destinationVendor integer

    Possible 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 boolean

    Indicates whether to list available media for the restore operation.

  • useExactIndex boolean

    Specifies whether to use exact index matching during browse operations.

  • noImage boolean

    Indicates whether image-based restore should be disabled.

  • commCellId integer

    Unique identifier for the CommCell environment.

  • showDeletedItems boolean

    Specifies 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 integer

    Unique identifier for the media agent.

  • library object

    Library configuration for media management.

  • libraryId integer

    Unique identifier for the media library.

  • copyPrecedence object

    Copy precedence settings for selecting restore source.

  • copyPrecedence integer

    Primary copy precedence value for restore operations.

  • synchronousCopyPrecedence integer

    Synchronous copy precedence value for restore operations.

  • copyPrecedenceApplicable boolean

    Indicates whether copy precedence rules apply to this restore.

  • drivePool object

    Drive pool configuration for media access.

  • drivePoolId integer

    Unique identifier for the drive pool.

  • drive object

    Specific drive configuration for media access.

  • driveId integer

    Unique identifier for the drive.

  • backupset object

    Backupset information for the restore operation.

  • clientId integer

    Unique identifier for the client associated with the backupset.

  • instanceName string

    Name of the instance associated with the backupset.

  • backupsetId integer

    Unique identifier for the backupset.

  • applicationId integer

    Unique identifier for the application associated with the backupset.

  • timeZone object

    Time zone configuration for the restore operation.

  • TimeZoneID integer

    Unique identifier for the time zone.

  • TimeZoneName string

    Display 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 boolean

    Indicates whether system state backup is used by the restore.

  • restoreToDisk boolean

    Indicates whether to restore data directly to disk.

  • preserveLevel integer

    Level from end of the source path.

  • stripLevelType integer

    If level strip should be preserved or removed.

  • restoreACLs boolean

    Indicates whether to restore Access Control Lists (ACLs).

  • stripLevel integer

    Level from beginning of the source path.

  • overwriteFiles boolean

    Specifies whether to overwrite existing files during restore.

  • onePassRestore boolean

    Indicates whether to perform a one-pass restore operation.

  • unconditionalOverwrite boolean

    Allows unconditional overwriting of files during restore.

  • detectRegularExpression boolean

    Automatically detect regular expressions.

  • storagePolicy object

    Storage policy configuration for the restore operation.

  • copyId integer

    Unique identifier for the storage copy.

  • copyName string

    Name of the storage copy used for restore.

GET /task/:taskid/details

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
taskId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Task/:taskId/Details' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'