Skip to main content

Cleanroom Runbook Create

Select

SaaS
Customer Managed

Creation of Cleanroom Runbook

Request Body
  • name string required

    Name of the recovery group. The same name will be used for Target and Hypervisor creation, if Create new option is used.

  • target object required

    Options to use an existing target or create a new one in Cleanroom

  • entity object
  • id int32
  • name string
  • options object

    Options to create a new cleanroom target

  • name string

    Name of the target

  • vendor string

    Possible values: [NONE, AZURE_V2, AMAZON]

    The vendor where the target needs to be created

  • hypervisor object required

    Options to provide an existing hypervisor or create a new one

  • entity object
  • id int32
  • name string
  • optionsAzure object

    Create a hypervisor group

  • name string required

    The name of the hypervisor group being created

  • skipCredentialValidation boolean

    Default value: false

    if credential validation has to be skipped.

  • accessNodes object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • credentials object
  • id int32
  • name string
  • etcdProtection object

    Create an application group etcd (system generated) with pre-defined content

  • enabled boolean

    Denote if etcd protection is enabled

  • plan object
  • id int32
  • name string
  • planEntity object
  • id int32
  • name string
  • enableCloudConfigProtection boolean

    Default value: false

    Protect Cloud Config entities

  • workloadType string
  • workloadRegion object
  • id int32
  • name string
  • hypervisorType string required

    Possible values: [AZURE_V2]

  • useManagedIdentity boolean

    Default value: false

    set to true, if you want to use System Managed identitiy of Access node for Authentication

  • subscriptionId string required

    Subscription ID of Azure

  • isAuthorizedUsingMTA boolean

    Default value: false

    Indicates whether the hypervisor was created by authorizing the multitenant app in this tenant.

  • optionsAmazon object

    Create a hypervisor group

  • name string required

    The name of the hypervisor group being created

  • skipCredentialValidation boolean

    Default value: false

    if credential validation has to be skipped.

  • accessNodes object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • credentials object
  • id int32
  • name string
  • etcdProtection object

    Create an application group etcd (system generated) with pre-defined content

  • enabled boolean

    Denote if etcd protection is enabled

  • plan object
  • id int32
  • name string
  • planEntity object
  • id int32
  • name string
  • enableCloudConfigProtection boolean

    Default value: false

    Protect Cloud Config entities

  • workloadType string
  • workloadRegion object
  • id int32
  • name string
  • hypervisorType string required

    Possible values: [Amazon]

  • accessKey string required

    Access Key of Amazon login

  • RoleARN string

    Role ARN for STS assume role with IAM policy

  • secretKey string required

    secret Key of Amazon login

  • Region string

    AWS region if Iam role is used

  • useIamRole boolean required

    if Iam Role is used

  • enableAWSAdminAccount boolean
  • useServiceAccount string

    Clientname to be used as Admin Account

  • useHostedInfrastructure boolean

    Use Metallic hosted infrastructure

  • accessNode object
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • region object required
  • guid string
  • name string
  • entities object[] required

    Array of entities that have to be part of the group.

  • advancedOptions object

    Advanced options for cleanroom runbook

  • postRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • delayBetweenPriorityMachines int32

    The delay between machines in different priorities in minutes

  • continueOnFailure boolean

    Default value: false

    Set to true to continue to the next priority machines on failure

  • recoveryExpirationOptions object
  • enableExpirationOption boolean

    Default value: true

    If true, cleans up recovered VMs after the set daysToExpire value

  • daysToExpire int32

    Default value: 7

    Number of days after which recovered VMs are automatically cleaned up

  • isRescuedCommServe boolean

    Whether the CommServe is rescued or not

  • expirationTime int32

    Timestamp when the clean up of all recovered VMs happens on the rescued CommServe. It happens 4 hours before the CommServe expiration time

  • enableThreatScan boolean

    Default value: false

    Indicates whether a threat scan should be performed after recovery

  • enableWindowsDefenderScan boolean

    Default value: false

    A boolean that specifies whether a windows defender scan is required

  • powerOffVMPostValidation boolean

    Default value: false

    Specifies whether the destination VM should be powered off after recovery and validation

  • useAutoScale boolean

    Default value: true

    Set to true to use auto scale during cleanroom recovery

Responses

OK


Schema
  • recoveryGroup object
  • id int32
  • name string
  • error object
  • errorMessage string
  • errorCode int32
POST /cleanroom/runbook    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{
"name": "string",
"target": {
"entity": {
"id": 0,
"name": "string"
},
"options": {
"name": "string",
"vendor": "NONE",
"hypervisor": {
"entity": {
"id": 0,
"name": "string"
},
"optionsAzure": {
"name": "string",
"skipCredentialValidation": false,
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"credentials": {
"id": 0,
"name": "string"
},
"etcdProtection": {
"enabled": true,
"plan": {
"id": 0,
"name": "string"
}
},
"planEntity": {
"id": 0,
"name": "string"
},
"enableCloudConfigProtection": false,
"workloadType": "string",
"workloadRegion": {
"id": 0,
"name": "string"
},
"hypervisorType": "AZURE_V2",
"useManagedIdentity": false,
"subscriptionId": "string",
"isAuthorizedUsingMTA": false
},
"optionsAmazon": {
"name": "string",
"skipCredentialValidation": false,
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"credentials": {
"id": 0,
"name": "string"
},
"etcdProtection": {
"enabled": true,
"plan": {
"id": 0,
"name": "string"
}
},
"planEntity": {
"id": 0,
"name": "string"
},
"enableCloudConfigProtection": false,
"workloadType": "string",
"workloadRegion": {
"id": 0,
"name": "string"
},
"hypervisorType": "Amazon",
"accessKey": "string",
"RoleARN": "string",
"secretKey": "string",
"Region": "string",
"useIamRole": true,
"enableAWSAdminAccount": true,
"useServiceAccount": "string",
"useHostedInfrastructure": true
}
},
"accessNode": {
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
},
"region": {
"guid": "string",
"name": "string"
}
}
},
"entities": [
{
"id": 0,
"name": "string",
"entity": {
"id": 0,
"name": "string"
},
"recoveryGroup": {
"id": 0,
"name": "string"
},
"workload": "GENERIC",
"client": {
"id": 0,
"name": "string"
},
"backupSet": {
"id": 0,
"name": "string"
},
"vmGroup": {
"id": 0,
"name": "string"
},
"virtualMachine": {
"GUID": "string",
"name": "string"
},
"subclient": {
"id": 0,
"name": "string"
},
"recoveryConfiguration": {
"advancedOptions": {
"azure": {
"unconditionalOverwrite": false,
"deployVmOnlyDuringfailover": true
},
"amazon": {
"validateDestinationVM": true,
"unconditionalOverwrite": true,
"deployVmWhenFailover": true,
"continueOnFailure": true,
"failoverDelay": 0,
"transportMode": "AUTO"
},
"gcp": {
"unconditionalOverwrite": true,
"failoverDelay": 0,
"continueOnFailure": true
}
},
"configuration": {
"azure": {
"sourceVM": "string",
"destinationVM": "string",
"resourceGroup": "string",
"storageAccount": "string",
"vmSize": "string",
"createPublicIP": true,
"restoreAsManagedVm": true,
"overrideReplicationOptions": {
"availabilityZone": "string",
"securityGroup": {
"id": "string",
"name": "string"
},
"testFailoverVirtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
},
"virtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
}
},
"diskType": "string",
"sourceVMGuid": "string",
"region": "string",
"testFailoverVmSize": "string"
},
"amazon": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"datacenter": "string",
"availabilityZone": "string",
"instanceType": "string",
"testFailoverInstanceType": "string",
"overrideReplicationOptions": {
"IAMRole": {
"guid": "string",
"name": "string"
},
"volumeType": "string",
"keyPair": "string",
"encryptionKey": "string",
"guestCreds": {
"computerName": "string",
"userName": "string",
"password": "string"
},
"network": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectSecurityGroup": true,
"securityGroups": [
{
"id": "string",
"name": "string"
}
],
"testFailoverNetwork": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectTestFailoverSecurityGroup": true,
"testFailoverSecurityGroups": [
{
"id": "string",
"name": "string"
}
]
}
},
"gcp": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"primaryZone": "string",
"datacenter": "string",
"projectId": "string",
"createPublicIP": true,
"machineType": "string",
"secondaryZone": "string",
"overrideReplicationOptions": {
"tags": [
{
"name": "string",
"value": "string"
}
],
"vmNodeAffinity": [
{
"name": "string",
"value": "string"
}
],
"network": {
"networkDisplayName": "string",
"networkName": "string",
"subnetId": "string",
"publicIPaddress": "string",
"publicIPaddressID": "string",
"privateIPaddress": "string",
"privateIPType": "AUTOMATIC"
}
}
}
},
"dbConfig": {
"server": {
"id": 0,
"name": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"databases": [
{
"id": 0,
"sourceName": "string",
"destinationName": "string",
"fileMappings": [
{
"source": {
"logicalName": "string",
"physicalPath": "string"
},
"destination": {
"logicalName": "string",
"physicalPath": "string"
}
}
]
}
]
},
"imageDetails": {
"vmCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"vmTemplate": {
"GUID": "string",
"name": "string"
},
"skipOSDisk": false,
"osType": "WINDOWS"
},
"mediaAgent": {
"id": 0,
"name": "string"
},
"copyPrecedence": 0,
"hardwareConfiguration": {
"dataDiskConfiguration": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
],
"volumeConfiguration": [
{
"name": "string",
"totalSize": 0,
"enabled": true,
"disks": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
]
}
],
"systemDiskConfiguration": {
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
},
"credentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"instance": {
"id": 0,
"name": "string"
},
"preRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"target": {
"id": 0,
"name": "string"
},
"recoveryPointDetails": {
"entityRecoveryPoint": 0,
"entityRecoveryPointCategory": "LATEST",
"inheritedFrom": "RECOVERY_GROUP",
"timeZoneId": 0
},
"recoveryPoint": 0,
"executionOrder": {
"priority": 0,
"order": 0,
"group": 0
},
"connectionDetails": {
"guestCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"csCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"topologyDetails": {
"serverGroups": [
{
"id": 0,
"name": "string"
}
],
"networkGateway": [
{
"hostname": "string",
"port": 0
}
]
},
"vmHostName": "string",
"vmClientName": "string",
"domainCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"blockSysrepForRecovery": true,
"recoveryStatus": "NO_STATUS",
"validationStatus": "NO_STATUS",
"validationResults": [
{
"output": "string",
"name": "string",
"validationStatus": "NO_STATUS",
"failureReason": "string",
"threatInfo": [
{
"count": 0,
"threatType": "string"
}
]
}
],
"recoveryFailureReason": "string",
"validationFailureReason": "string",
"recoveryStatusNotReadyReason": "string",
"recoveryStatusNotReadyCategory": "NONE = 0",
"lastRecoveryJobId": 0,
"osType": "WINDOWS",
"copyAvailableTime": 0,
"lastFullBackupTime": 0,
"installedWorkloads": [
"GENERIC"
],
"sourceVendor": "NONE",
"fileShare": {
"name": "string",
"shareURL": "string"
},
"recoveredVMState": "STOPPED = 0",
"destinationVirtualMachine": {
"GUID": "string",
"name": "string"
},
"destinationName": "string",
"threatScan": {
"status": "NONE"
},
"vmConnectionInfo": {
"resourceGroupName": "string",
"subscriptionId": "string",
"url": "string"
},
"hasRecoverySubEntities": false,
"subEntities": [
{
"id": 0,
"name": "string",
"entity": {
"id": 0,
"name": "string"
},
"recoveryGroup": {
"id": 0,
"name": "string"
},
"workload": "GENERIC",
"client": {
"id": 0,
"name": "string"
},
"backupSet": {
"id": 0,
"name": "string"
},
"vmGroup": {
"id": 0,
"name": "string"
},
"virtualMachine": {
"GUID": "string",
"name": "string"
},
"subclient": {
"id": 0,
"name": "string"
},
"recoveryConfiguration": {
"advancedOptions": {
"azure": {
"unconditionalOverwrite": false,
"deployVmOnlyDuringfailover": true
},
"amazon": {
"validateDestinationVM": true,
"unconditionalOverwrite": true,
"deployVmWhenFailover": true,
"continueOnFailure": true,
"failoverDelay": 0,
"transportMode": "AUTO"
},
"gcp": {
"unconditionalOverwrite": true,
"failoverDelay": 0,
"continueOnFailure": true
}
},
"configuration": {
"azure": {
"sourceVM": "string",
"destinationVM": "string",
"resourceGroup": "string",
"storageAccount": "string",
"vmSize": "string",
"createPublicIP": true,
"restoreAsManagedVm": true,
"overrideReplicationOptions": {
"availabilityZone": "string",
"securityGroup": {
"id": "string",
"name": "string"
},
"testFailoverVirtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
},
"virtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
}
},
"diskType": "string",
"sourceVMGuid": "string",
"region": "string",
"testFailoverVmSize": "string"
},
"amazon": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"datacenter": "string",
"availabilityZone": "string",
"instanceType": "string",
"testFailoverInstanceType": "string",
"overrideReplicationOptions": {
"IAMRole": {
"guid": "string",
"name": "string"
},
"volumeType": "string",
"keyPair": "string",
"encryptionKey": "string",
"guestCreds": {
"computerName": "string",
"userName": "string",
"password": "string"
},
"network": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectSecurityGroup": true,
"securityGroups": [
{
"id": "string",
"name": "string"
}
],
"testFailoverNetwork": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectTestFailoverSecurityGroup": true,
"testFailoverSecurityGroups": [
{
"id": "string",
"name": "string"
}
]
}
},
"gcp": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"primaryZone": "string",
"datacenter": "string",
"projectId": "string",
"createPublicIP": true,
"machineType": "string",
"secondaryZone": "string",
"overrideReplicationOptions": {
"tags": [
{
"name": "string",
"value": "string"
}
],
"vmNodeAffinity": [
{
"name": "string",
"value": "string"
}
],
"network": {
"networkDisplayName": "string",
"networkName": "string",
"subnetId": "string",
"publicIPaddress": "string",
"publicIPaddressID": "string",
"privateIPaddress": "string",
"privateIPType": "AUTOMATIC"
}
}
}
},
"dbConfig": {
"server": {
"id": 0,
"name": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"databases": [
{
"id": 0,
"sourceName": "string",
"destinationName": "string",
"fileMappings": [
{
"source": {
"logicalName": "string",
"physicalPath": "string"
},
"destination": {
"logicalName": "string",
"physicalPath": "string"
}
}
]
}
]
},
"imageDetails": {
"vmCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"vmTemplate": {
"GUID": "string",
"name": "string"
},
"skipOSDisk": false,
"osType": "WINDOWS"
},
"mediaAgent": {
"id": 0,
"name": "string"
},
"copyPrecedence": 0,
"hardwareConfiguration": {
"dataDiskConfiguration": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
],
"volumeConfiguration": [
{
"name": "string",
"totalSize": 0,
"enabled": true,
"disks": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
]
}
],
"systemDiskConfiguration": {
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
},
"credentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"instance": {
"id": 0,
"name": "string"
},
"preRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"target": {
"id": 0,
"name": "string"
},
"recoveryPointDetails": {
"entityRecoveryPoint": 0,
"entityRecoveryPointCategory": "LATEST",
"inheritedFrom": "RECOVERY_GROUP",
"timeZoneId": 0
},
"recoveryPoint": 0,
"executionOrder": {
"priority": 0,
"order": 0,
"group": 0
},
"connectionDetails": {
"guestCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"csCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"topologyDetails": {
"serverGroups": [
{
"id": 0,
"name": "string"
}
],
"networkGateway": [
{
"hostname": "string",
"port": 0
}
]
},
"vmHostName": "string",
"vmClientName": "string",
"domainCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"blockSysrepForRecovery": true,
"recoveryStatus": "NO_STATUS",
"validationStatus": "NO_STATUS",
"validationResults": [
{
"output": "string",
"name": "string",
"validationStatus": "NO_STATUS",
"failureReason": "string",
"threatInfo": [
{
"count": 0,
"threatType": "string"
}
]
}
],
"recoveryFailureReason": "string",
"validationFailureReason": "string",
"recoveryStatusNotReadyReason": "string",
"recoveryStatusNotReadyCategory": "NONE = 0",
"lastRecoveryJobId": 0,
"osType": "WINDOWS",
"copyAvailableTime": 0,
"lastFullBackupTime": 0,
"installedWorkloads": [
"GENERIC"
],
"sourceVendor": "NONE",
"fileShare": {
"name": "string",
"shareURL": "string"
},
"recoveredVMState": "STOPPED = 0",
"destinationVirtualMachine": {
"GUID": "string",
"name": "string"
},
"destinationName": "string",
"threatScan": {
"status": "NONE"
},
"vmConnectionInfo": {
"resourceGroupName": "string",
"subscriptionId": "string",
"url": "string"
},
"hasRecoverySubEntities": false
}
]
}
],
"advancedOptions": {
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"delayBetweenPriorityMachines": 0,
"continueOnFailure": false,
"recoveryExpirationOptions": {
"enableExpirationOption": true,
"daysToExpire": 7,
"isRescuedCommServe": true,
"expirationTime": 0
},
"enableThreatScan": false,
"enableWindowsDefenderScan": false,
"powerOffVMPostValidation": false,
"useAutoScale": true
}
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Cleanroom/Runbook' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"name": "string",
"target": {
"entity": {
"id": 0,
"name": "string"
},
"options": {
"name": "string",
"vendor": "NONE",
"hypervisor": {
"entity": {
"id": 0,
"name": "string"
},
"optionsAzure": {
"name": "string",
"skipCredentialValidation": false,
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"credentials": {
"id": 0,
"name": "string"
},
"etcdProtection": {
"enabled": true,
"plan": {
"id": 0,
"name": "string"
}
},
"planEntity": {
"id": 0,
"name": "string"
},
"enableCloudConfigProtection": false,
"workloadType": "string",
"workloadRegion": {
"id": 0,
"name": "string"
},
"hypervisorType": "AZURE_V2",
"useManagedIdentity": false,
"subscriptionId": "string",
"isAuthorizedUsingMTA": false
},
"optionsAmazon": {
"name": "string",
"skipCredentialValidation": false,
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
],
"credentials": {
"id": 0,
"name": "string"
},
"etcdProtection": {
"enabled": true,
"plan": {
"id": 0,
"name": "string"
}
},
"planEntity": {
"id": 0,
"name": "string"
},
"enableCloudConfigProtection": false,
"workloadType": "string",
"workloadRegion": {
"id": 0,
"name": "string"
},
"hypervisorType": "Amazon",
"accessKey": "string",
"RoleARN": "string",
"secretKey": "string",
"Region": "string",
"useIamRole": true,
"enableAWSAdminAccount": true,
"useServiceAccount": "string",
"useHostedInfrastructure": true
}
},
"accessNode": {
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
},
"region": {
"guid": "string",
"name": "string"
}
}
},
"entities": [
{
"id": 0,
"name": "string",
"entity": {
"id": 0,
"name": "string"
},
"recoveryGroup": {
"id": 0,
"name": "string"
},
"workload": "GENERIC",
"client": {
"id": 0,
"name": "string"
},
"backupSet": {
"id": 0,
"name": "string"
},
"vmGroup": {
"id": 0,
"name": "string"
},
"virtualMachine": {
"GUID": "string",
"name": "string"
},
"subclient": {
"id": 0,
"name": "string"
},
"recoveryConfiguration": {
"advancedOptions": {
"azure": {
"unconditionalOverwrite": false,
"deployVmOnlyDuringfailover": true
},
"amazon": {
"validateDestinationVM": true,
"unconditionalOverwrite": true,
"deployVmWhenFailover": true,
"continueOnFailure": true,
"failoverDelay": 0,
"transportMode": "AUTO"
},
"gcp": {
"unconditionalOverwrite": true,
"failoverDelay": 0,
"continueOnFailure": true
}
},
"configuration": {
"azure": {
"sourceVM": "string",
"destinationVM": "string",
"resourceGroup": "string",
"storageAccount": "string",
"vmSize": "string",
"createPublicIP": true,
"restoreAsManagedVm": true,
"overrideReplicationOptions": {
"availabilityZone": "string",
"securityGroup": {
"id": "string",
"name": "string"
},
"testFailoverVirtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
},
"virtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
}
},
"diskType": "string",
"sourceVMGuid": "string",
"region": "string",
"testFailoverVmSize": "string"
},
"amazon": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"datacenter": "string",
"availabilityZone": "string",
"instanceType": "string",
"testFailoverInstanceType": "string",
"overrideReplicationOptions": {
"IAMRole": {
"guid": "string",
"name": "string"
},
"volumeType": "string",
"keyPair": "string",
"encryptionKey": "string",
"guestCreds": {
"computerName": "string",
"userName": "string",
"password": "string"
},
"network": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectSecurityGroup": true,
"securityGroups": [
{
"id": "string",
"name": "string"
}
],
"testFailoverNetwork": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectTestFailoverSecurityGroup": true,
"testFailoverSecurityGroups": [
{
"id": "string",
"name": "string"
}
]
}
},
"gcp": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"primaryZone": "string",
"datacenter": "string",
"projectId": "string",
"createPublicIP": true,
"machineType": "string",
"secondaryZone": "string",
"overrideReplicationOptions": {
"tags": [
{
"name": "string",
"value": "string"
}
],
"vmNodeAffinity": [
{
"name": "string",
"value": "string"
}
],
"network": {
"networkDisplayName": "string",
"networkName": "string",
"subnetId": "string",
"publicIPaddress": "string",
"publicIPaddressID": "string",
"privateIPaddress": "string",
"privateIPType": "AUTOMATIC"
}
}
}
},
"dbConfig": {
"server": {
"id": 0,
"name": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"databases": [
{
"id": 0,
"sourceName": "string",
"destinationName": "string",
"fileMappings": [
{
"source": {
"logicalName": "string",
"physicalPath": "string"
},
"destination": {
"logicalName": "string",
"physicalPath": "string"
}
}
]
}
]
},
"imageDetails": {
"vmCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"vmTemplate": {
"GUID": "string",
"name": "string"
},
"skipOSDisk": false,
"osType": "WINDOWS"
},
"mediaAgent": {
"id": 0,
"name": "string"
},
"copyPrecedence": 0,
"hardwareConfiguration": {
"dataDiskConfiguration": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
],
"volumeConfiguration": [
{
"name": "string",
"totalSize": 0,
"enabled": true,
"disks": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
]
}
],
"systemDiskConfiguration": {
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
},
"credentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"instance": {
"id": 0,
"name": "string"
},
"preRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"target": {
"id": 0,
"name": "string"
},
"recoveryPointDetails": {
"entityRecoveryPoint": 0,
"entityRecoveryPointCategory": "LATEST",
"inheritedFrom": "RECOVERY_GROUP",
"timeZoneId": 0
},
"recoveryPoint": 0,
"executionOrder": {
"priority": 0,
"order": 0,
"group": 0
},
"connectionDetails": {
"guestCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"csCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"topologyDetails": {
"serverGroups": [
{
"id": 0,
"name": "string"
}
],
"networkGateway": [
{
"hostname": "string",
"port": 0
}
]
},
"vmHostName": "string",
"vmClientName": "string",
"domainCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"blockSysrepForRecovery": true,
"recoveryStatus": "NO_STATUS",
"validationStatus": "NO_STATUS",
"validationResults": [
{
"output": "string",
"name": "string",
"validationStatus": "NO_STATUS",
"failureReason": "string",
"threatInfo": [
{
"count": 0,
"threatType": "string"
}
]
}
],
"recoveryFailureReason": "string",
"validationFailureReason": "string",
"recoveryStatusNotReadyReason": "string",
"recoveryStatusNotReadyCategory": "NONE = 0",
"lastRecoveryJobId": 0,
"osType": "WINDOWS",
"copyAvailableTime": 0,
"lastFullBackupTime": 0,
"installedWorkloads": [
"GENERIC"
],
"sourceVendor": "NONE",
"fileShare": {
"name": "string",
"shareURL": "string"
},
"recoveredVMState": "STOPPED = 0",
"destinationVirtualMachine": {
"GUID": "string",
"name": "string"
},
"destinationName": "string",
"threatScan": {
"status": "NONE"
},
"vmConnectionInfo": {
"resourceGroupName": "string",
"subscriptionId": "string",
"url": "string"
},
"hasRecoverySubEntities": false,
"subEntities": [
{
"id": 0,
"name": "string",
"entity": {
"id": 0,
"name": "string"
},
"recoveryGroup": {
"id": 0,
"name": "string"
},
"workload": "GENERIC",
"client": {
"id": 0,
"name": "string"
},
"backupSet": {
"id": 0,
"name": "string"
},
"vmGroup": {
"id": 0,
"name": "string"
},
"virtualMachine": {
"GUID": "string",
"name": "string"
},
"subclient": {
"id": 0,
"name": "string"
},
"recoveryConfiguration": {
"advancedOptions": {
"azure": {
"unconditionalOverwrite": false,
"deployVmOnlyDuringfailover": true
},
"amazon": {
"validateDestinationVM": true,
"unconditionalOverwrite": true,
"deployVmWhenFailover": true,
"continueOnFailure": true,
"failoverDelay": 0,
"transportMode": "AUTO"
},
"gcp": {
"unconditionalOverwrite": true,
"failoverDelay": 0,
"continueOnFailure": true
}
},
"configuration": {
"azure": {
"sourceVM": "string",
"destinationVM": "string",
"resourceGroup": "string",
"storageAccount": "string",
"vmSize": "string",
"createPublicIP": true,
"restoreAsManagedVm": true,
"overrideReplicationOptions": {
"availabilityZone": "string",
"securityGroup": {
"id": "string",
"name": "string"
},
"testFailoverVirtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
},
"virtualNetwork": {
"networkId": "string",
"networkDisplayName": "string",
"subnetId": "string",
"networkName": "string",
"networkAddressDetails": {
"id": "string",
"networkId": "string",
"subnetId": "string",
"privateIpAddress": "198.51.100.42",
"publicIpAddress": "198.51.100.42",
"publicIpAddressId": "string"
},
"privateIPaddress": "string",
"publicIPAddress": "string",
"publicIPaddressID": "string"
}
},
"diskType": "string",
"sourceVMGuid": "string",
"region": "string",
"testFailoverVmSize": "string"
},
"amazon": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"datacenter": "string",
"availabilityZone": "string",
"instanceType": "string",
"testFailoverInstanceType": "string",
"overrideReplicationOptions": {
"IAMRole": {
"guid": "string",
"name": "string"
},
"volumeType": "string",
"keyPair": "string",
"encryptionKey": "string",
"guestCreds": {
"computerName": "string",
"userName": "string",
"password": "string"
},
"network": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectSecurityGroup": true,
"securityGroups": [
{
"id": "string",
"name": "string"
}
],
"testFailoverNetwork": {
"displayName": "string",
"name": "string",
"subnetId": "string",
"sourceNetworkId": "string",
"privateIPaddress": "string"
},
"autoSelectTestFailoverSecurityGroup": true,
"testFailoverSecurityGroups": [
{
"id": "string",
"name": "string"
}
]
}
},
"gcp": {
"sourceVM": "string",
"sourceVMGuid": "string",
"destinationVM": "string",
"primaryZone": "string",
"datacenter": "string",
"projectId": "string",
"createPublicIP": true,
"machineType": "string",
"secondaryZone": "string",
"overrideReplicationOptions": {
"tags": [
{
"name": "string",
"value": "string"
}
],
"vmNodeAffinity": [
{
"name": "string",
"value": "string"
}
],
"network": {
"networkDisplayName": "string",
"networkName": "string",
"subnetId": "string",
"publicIPaddress": "string",
"publicIPaddressID": "string",
"privateIPaddress": "string",
"privateIPType": "AUTOMATIC"
}
}
}
},
"dbConfig": {
"server": {
"id": 0,
"name": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"databases": [
{
"id": 0,
"sourceName": "string",
"destinationName": "string",
"fileMappings": [
{
"source": {
"logicalName": "string",
"physicalPath": "string"
},
"destination": {
"logicalName": "string",
"physicalPath": "string"
}
}
]
}
]
},
"imageDetails": {
"vmCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"vmTemplate": {
"GUID": "string",
"name": "string"
},
"skipOSDisk": false,
"osType": "WINDOWS"
},
"mediaAgent": {
"id": 0,
"name": "string"
},
"copyPrecedence": 0,
"hardwareConfiguration": {
"dataDiskConfiguration": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
],
"volumeConfiguration": [
{
"name": "string",
"totalSize": 0,
"enabled": true,
"disks": [
{
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
]
}
],
"systemDiskConfiguration": {
"name": "string",
"snapshotId": "string",
"provisioningType": "THIN",
"diskSize": 0,
"diskType": "ISCSI",
"diskId": "string"
}
},
"credentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"instance": {
"id": 0,
"name": "string"
},
"preRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"target": {
"id": 0,
"name": "string"
},
"recoveryPointDetails": {
"entityRecoveryPoint": 0,
"entityRecoveryPointCategory": "LATEST",
"inheritedFrom": "RECOVERY_GROUP",
"timeZoneId": 0
},
"recoveryPoint": 0,
"executionOrder": {
"priority": 0,
"order": 0,
"group": 0
},
"connectionDetails": {
"guestCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"csCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"topologyDetails": {
"serverGroups": [
{
"id": 0,
"name": "string"
}
],
"networkGateway": [
{
"hostname": "string",
"port": 0
}
]
},
"vmHostName": "string",
"vmClientName": "string",
"domainCreds": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
}
},
"blockSysrepForRecovery": true,
"recoveryStatus": "NO_STATUS",
"validationStatus": "NO_STATUS",
"validationResults": [
{
"output": "string",
"name": "string",
"validationStatus": "NO_STATUS",
"failureReason": "string",
"threatInfo": [
{
"count": 0,
"threatType": "string"
}
]
}
],
"recoveryFailureReason": "string",
"validationFailureReason": "string",
"recoveryStatusNotReadyReason": "string",
"recoveryStatusNotReadyCategory": "NONE = 0",
"lastRecoveryJobId": 0,
"osType": "WINDOWS",
"copyAvailableTime": 0,
"lastFullBackupTime": 0,
"installedWorkloads": [
"GENERIC"
],
"sourceVendor": "NONE",
"fileShare": {
"name": "string",
"shareURL": "string"
},
"recoveredVMState": "STOPPED = 0",
"destinationVirtualMachine": {
"GUID": "string",
"name": "string"
},
"destinationName": "string",
"threatScan": {
"status": "NONE"
},
"vmConnectionInfo": {
"resourceGroupName": "string",
"subscriptionId": "string",
"url": "string"
},
"hasRecoverySubEntities": false
}
]
}
],
"advancedOptions": {
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"delayBetweenPriorityMachines": 0,
"continueOnFailure": false,
"recoveryExpirationOptions": {
"enableExpirationOption": true,
"daysToExpire": 7,
"isRescuedCommServe": true,
"expirationTime": 0
},
"enableThreatScan": false,
"enableWindowsDefenderScan": false,
"powerOffVMPostValidation": false,
"useAutoScale": true
}
}'