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.

  • useHostedInfrastructure boolean

    Default value: false

    Describes if the infra has to be managed by commvault

  • 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
  • forceAccessNodeRegion boolean

    Default value: true

    If workloadRegion is set, use only access nodes from that region when true (fail if none found). When false, prefer that region but use any node if needed.

  • 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.

  • useHostedInfrastructure boolean

    Default value: false

    Describes if the infra has to be managed by commvault

  • 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
  • forceAccessNodeRegion boolean

    Default value: true

    If workloadRegion is set, use only access nodes from that region when true (fail if none found). When false, prefer that region but use any node if needed.

  • 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

  • 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
Loading...