Skip to main content

Add VM to Replication Group​

Select

SaaS
Customer Managed

This operation adds VM to replication group.

Request Body
  • taskInfo object
  • taskOperation integer
  • 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
  • trackingPolicyId integer
  • appName string
  • flags object
  • exclude boolean
  • task object
  • description string
  • ownerId integer
  • runUserId integer
  • taskType integer
  • ownerName string
  • alertId integer
  • GUID string
  • initiatedFrom integer
  • policyType integer
  • associatedObjects integer
  • taskName string
  • taskId integer
  • securityAssociations object
  • ownerAssociations object
  • categoryPermission object
  • originalCC object
  • commCellId integer
  • flags object
  • taskSecurity object
  • entityDataSecurity object
  • associatedUserGroups object[]
  • userGroupId integer
  • userGroupName string
  • ownerCapabilities object
  • changePassword object
  • createAs object
  • user object
  • user object
  • userName string
  • userId integer
  • flags object
  • userGroup object
  • flags object
  • alert object
  • flags object
  • taskFlags object
  • isEdgeDrive boolean
  • isEZOperation boolean
  • forDDB boolean
  • uninstalled boolean
  • isSystem boolean
  • disabled boolean
  • script object
  • mode integer
  • userCreation integer
  • scriptCredentials object
  • task object
  • taskName string
  • taskId integer
  • flags object
  • 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
  • backupOpts object
  • backupLevel integer
  • vsaBackupOptions object
  • dataOpt object
  • autoCopy boolean
  • adminOpts object
  • contentIndexingOption object
  • subClientBasedAnalytics boolean
  • restoreOptions object
  • replicationType integer
  • virtualServerRstOption object
  • isVolumeBrowse boolean
  • isVirtualLab boolean
  • esxServer string
  • isAttachToNewVM boolean
  • isBlockLevelReplication boolean
  • isDiskBrowse boolean
  • viewType integer
  • replicationGuid string
  • isFileBrowse boolean
  • vCenterInstance object
  • clientId integer
  • clientName string
  • instanceName string
  • appName string
  • instanceId integer
  • applicationId integer
  • diskLevelVMRestoreOption object
  • vmFolderName string
  • passUnconditionalOverride boolean
  • dataCenterName string
  • hostOrCluster string
  • useVcloudCredentials boolean
  • diskOption integer
  • vmName string
  • powerOnVmAfterRestore boolean
  • esxServerName string
  • transportMode integer
  • maxNumOfVMPerJob integer
  • userPassword object
  • domainName string
  • userName string
  • advancedRestoreOptions object[]
  • esxHost string
  • destComputerUserName string
  • resourcePoolPath string
  • vmSize string
  • destComputerName string
  • datacenter string
  • newName string
  • Datastore string
  • name string
  • guid string
  • nics object[]
  • sourceNetwork string
  • destinationNetwork string
  • subnetId string
  • sourceNetworkId string
  • networkName string
  • dataStore object
  • totalSizeInBytes integer
  • freeSpaceInBytes integer
  • dataStoreName string
  • allocationPolicy object
  • vmAllocPolicyName string
  • vmAllocPolicyId integer
  • policyType integer
  • instanceEntity object
  • flags object
  • flags object
  • region object
  • flags object
  • volumeRstOption object
  • volumeLeveRestore boolean
  • volumeLevelRestoreType integer
  • destinationVendor integer
  • browseOption object
  • listMedia boolean
  • useExactIndex boolean
  • noImage boolean
  • commCellId integer
  • showDeletedItems boolean
  • mediaOption object
  • mediaAgent object
  • mediaAgentId integer
  • library object
  • libraryId integer
  • copyPrecedence object
  • copyPrecedence integer
  • synchronousCopyPrecedence integer
  • copyPrecedenceApplicable boolean
  • drivePool object
  • drivePoolId integer
  • drive object
  • driveId integer
  • backupset object
  • clientId integer
  • instanceName string
  • backupsetId integer
  • applicationId integer
  • timeZone object
  • TimeZoneID integer
  • TimeZoneName string
  • timeRange object
  • commonOptions object
  • systemStateBackup boolean
  • clusterDBBackedup boolean
  • powerRestore boolean
  • restoreToDisk boolean
  • offlineMiningRestore boolean
  • copyToObjectStore boolean
  • onePassRestore boolean
  • revert boolean
  • syncRestore boolean
  • detectRegularExpression boolean
  • wildCard boolean
  • destination object
  • isLegalHold boolean
  • noOfStreams integer
  • inPlace boolean
  • destClient object
  • clientId integer
  • clientName string
  • fileOption object
  • sourceItem string[]
  • browseFilters string[]
  • distributedAppsRestoreOptions object
  • distributedRestore boolean
  • isMultiNodeRestore boolean
  • sharePointRstOption object
  • is90OrUpgradedClient boolean
  • commonOpts object
  • jobDescription string
  • jobRetryOpts object
  • killRunningJobWhenTotalRunningTimeExpires boolean
  • numberOfRetries integer
  • enableNumberOfRetries boolean
  • runningTime object
  • enableTotalRunningTime boolean
  • totalRunningTime integer
  • startUpOpts object
  • startInSuspendedState boolean
  • useDefaultPriority boolean
  • priority integer
  • perfJobOpts object
  • rstPerfJobOpts object
  • mediaReadSpeed boolean
  • pipelineTransmittingSpeed boolean
Responses

OK

POST /modifytask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "taskOperation": 0,

    "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",

        "trackingPolicyId": 0,

        "appName": "string",

        "flags": {

          "exclude": true

        }

      }

    ],

    "task": {

      "description": "string",

      "ownerId": 0,

      "runUserId": 0,

      "taskType": 0,

      "ownerName": "string",

      "alertId": 0,

      "GUID": "string",

      "initiatedFrom": 0,

      "policyType": 0,

      "associatedObjects": 0,

      "taskName": "string",

      "taskId": 0,

      "securityAssociations": {

        "ownerAssociations": {

          "categoryPermission": {}

        }

      },

      "originalCC": {

        "commCellId": 0,

        "flags": {}

      },

      "taskSecurity": {

        "entityDataSecurity": {},

        "associatedUserGroups": [

          {

            "userGroupId": 0,

            "userGroupName": "string"

          }

        ],

        "ownerCapabilities": {},

        "changePassword": {}

      },

      "createAs": {

        "user": {

          "user": {

            "userName": "string",

            "userId": 0,

            "flags": {}

          }

        },

        "userGroup": {

          "flags": {}

        }

      },

      "alert": {

        "flags": {}

      },

      "taskFlags": {

        "isEdgeDrive": true,

        "isEZOperation": true,

        "forDDB": true,

        "uninstalled": true,

        "isSystem": true,

        "disabled": true

      },

      "script": {

        "mode": 0,

        "userCreation": 0,

        "scriptCredentials": {}

      },

      "task": {

        "taskName": "string",

        "taskId": 0,

        "flags": {}

      }

    },

    "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": {

          "backupOpts": {

            "backupLevel": 0,

            "vsaBackupOptions": {},

            "dataOpt": {

              "autoCopy": true

            }

          },

          "adminOpts": {

            "contentIndexingOption": {

              "subClientBasedAnalytics": true

            }

          },

          "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": 0,

              "destinationVendor": 0

            },

            "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,

              "clusterDBBackedup": true,

              "powerRestore": true,

              "restoreToDisk": true,

              "offlineMiningRestore": true,

              "copyToObjectStore": true,

              "onePassRestore": true,

              "revert": true,

              "syncRestore": true,

              "detectRegularExpression": true,

              "wildCard": true

            },

            "destination": {

              "isLegalHold": true,

              "noOfStreams": 0,

              "inPlace": true,

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ],

              "browseFilters": [

                "string"

              ]

            },

            "distributedAppsRestoreOptions": {

              "distributedRestore": true,

              "isMultiNodeRestore": true

            },

            "sharePointRstOption": {

              "is90OrUpgradedClient": true

            }

          },

          "commonOpts": {

            "jobDescription": "string",

            "jobRetryOpts": {

              "killRunningJobWhenTotalRunningTimeExpires": true,

              "numberOfRetries": 0,

              "enableNumberOfRetries": true,

              "runningTime": {

                "enableTotalRunningTime": true,

                "totalRunningTime": 0

              }

            },

            "startUpOpts": {

              "startInSuspendedState": true,

              "useDefaultPriority": true,

              "priority": 0

            },

            "perfJobOpts": {

              "rstPerfJobOpts": {

                "mediaReadSpeed": true,

                "pipelineTransmittingSpeed": true

              }

            }

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ModifyTask' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "taskOperation": 0,
    "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",
        "trackingPolicyId": 0,
        "appName": "string",
        "flags": {
          "exclude": true
        }
      }
    ],
    "task": {
      "description": "string",
      "ownerId": 0,
      "runUserId": 0,
      "taskType": 0,
      "ownerName": "string",
      "alertId": 0,
      "GUID": "string",
      "initiatedFrom": 0,
      "policyType": 0,
      "associatedObjects": 0,
      "taskName": "string",
      "taskId": 0,
      "securityAssociations": {
        "ownerAssociations": {
          "categoryPermission": {}
        }
      },
      "originalCC": {
        "commCellId": 0,
        "flags": {}
      },
      "taskSecurity": {
        "entityDataSecurity": {},
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {},
        "changePassword": {}
      },
      "createAs": {
        "user": {
          "user": {
            "userName": "string",
            "userId": 0,
            "flags": {}
          }
        },
        "userGroup": {
          "flags": {}
        }
      },
      "alert": {
        "flags": {}
      },
      "taskFlags": {
        "isEdgeDrive": true,
        "isEZOperation": true,
        "forDDB": true,
        "uninstalled": true,
        "isSystem": true,
        "disabled": true
      },
      "script": {
        "mode": 0,
        "userCreation": 0,
        "scriptCredentials": {}
      },
      "task": {
        "taskName": "string",
        "taskId": 0,
        "flags": {}
      }
    },
    "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": {
          "backupOpts": {
            "backupLevel": 0,
            "vsaBackupOptions": {},
            "dataOpt": {
              "autoCopy": true
            }
          },
          "adminOpts": {
            "contentIndexingOption": {
              "subClientBasedAnalytics": true
            }
          },
          "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": 0,
              "destinationVendor": 0
            },
            "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,
              "clusterDBBackedup": true,
              "powerRestore": true,
              "restoreToDisk": true,
              "offlineMiningRestore": true,
              "copyToObjectStore": true,
              "onePassRestore": true,
              "revert": true,
              "syncRestore": true,
              "detectRegularExpression": true,
              "wildCard": true
            },
            "destination": {
              "isLegalHold": true,
              "noOfStreams": 0,
              "inPlace": true,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ],
              "browseFilters": [
                "string"
              ]
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true
            },
            "sharePointRstOption": {
              "is90OrUpgradedClient": true
            }
          },
          "commonOpts": {
            "jobDescription": "string",
            "jobRetryOpts": {
              "killRunningJobWhenTotalRunningTimeExpires": true,
              "numberOfRetries": 0,
              "enableNumberOfRetries": true,
              "runningTime": {
                "enableTotalRunningTime": true,
                "totalRunningTime": 0
              }
            },
            "startUpOpts": {
              "startInSuspendedState": true,
              "useDefaultPriority": true,
              "priority": 0
            },
            "perfJobOpts": {
              "rstPerfJobOpts": {
                "mediaReadSpeed": true,
                "pipelineTransmittingSpeed": true
              }
            }
          }
        }
      }
    ]
  }
}'