Skip to main content

Edit cleanroom target​

Edit cleanroom target for automation of resources

Path Parameters
  • id int32 required

    ID of the cleanroom target

Query Parameters
  • resetRunbookResources boolean

    Set to true to reset recovery options for all resources in associated runbooks to match the target.

Request Body
  • general object
  • deployCleanroomResources object
  • isEnabled boolean

    If enabled, all supported resources will be automatically created for recovery. Otherwise, all supported resources will have to be manually created by the user and linked to target.

  • target object
  • id int32

    Target id

  • name string

    Target name

  • vendor string

    Possible values: [NONE, AZURE_V2, AMAZON]

    Target vendor

  • applicationType string

    Possible values: [NONE, CLEAN_ROOM]

    Target application type

  • hypervisor object
  • id int32

    Hypervisor id

  • name string

    Hypervisor name

  • displayName string

    Hypervisor display name

  • instanceId int32

    Hypervisor instance id

  • hypervisorV2 object

    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

  • isScaleProfile boolean

    Default value: false

    True if the access node is a scale profile client

  • credentials object required
  • 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

  • managedIdentityAuthType string

    Type of Managed Identity to be used 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.

  • useSharedInfrastructure boolean

    Default value: false

    Use Metallic hosted infrastructure

  • 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

  • isScaleProfile boolean

    Default value: false

    True if the access node is a scale profile client

  • credentials object required
  • 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

    Access Key of Amazon login (DEPRECATED; will be removed in future release)

  • RoleARN string

    Role ARN for STS assume role with IAM policy (DEPRECATED; will be removed in future release)

  • secretKey string

    secret Key of Amazon login (DEPRECATED; will be removed in future release)

  • Region string

    AWS region if Iam role is used

  • useIamRole boolean

    if Iam Role is used

  • isSTSAssumeRole boolean

    if STS Assume Role is used

  • enableAWSAdminAccount boolean
  • useServiceAccount string

    Clientname to be used as Admin Account

  • optionsVMWare 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[] required
  • 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

  • isScaleProfile boolean

    Default value: false

    True if the access node is a scale profile client

  • credentials object required
  • 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: [VMW]

  • vcenterHostName string required

    Vcenter hostname

  • skipSSLValidation boolean

    Default value: false

    Skip SSL validation

  • additionalOVARow boolean

    Add additional OVA row

  • userName string

    Vcenter username (DEPRECATED; will be removed in future release)

  • password string

    Vcenter password (DEPRECATED; will be removed in future release)

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

    Possible values: [Client, Group, Automatic]

    Target application type

  • security object
  • users object[]

    Users that have access to the target

  • id int32
  • name string
  • fullName string
  • userGroups object[]

    User groups that have access to the target

  • id int32
  • name string
  • entityDisplayName object

    Prefix or Suffix appended to create display name for destination instance

  • prefix string

    A prefix string that will be appended to the source VM to create a display name for each destination VM

  • suffix string

    A suffix string that will be appended to the source VM to create a display name for each destination VM

  • useOriginalName boolean

    Default value: false

    If true, ignore prefix and suffix and use the original VM name.

  • recovery object
  • resourceGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • region object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • storageAccount object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • availabilityZone object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • storageType object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • virtualNetwork object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • vpc object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • securityGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • iamRole object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • vmSize object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • instanceType object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • createPublicIPAddress boolean
  • volumeType string
  • encryptionKey object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • instanceProfile object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • securityGroups object[]

    List of security groups that provide controlled access.

  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • keyPair object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • vmExtensionRestorePolicy string

    Possible values: [DEFAULT, DO_NOT_RESTORE, RESTORE, RESTORE_BUT_IGNORE_FAILURES]

  • esxServer object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • storagePolicy object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • dataStore object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • resourcePool object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • folderPath object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • destinationNetwork object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • infrastructure object
  • maxNoOfAccessNodes int32
  • networkSettings object
  • virtualNetwork object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • vpc object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • natGatewayPublicIPSettings object
  • createPublicIPAddress boolean
  • ipPrefix object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • securityGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • createPublicIPAddress boolean
  • infrastructurePublicIPSettings object
  • createPublicIPAddress boolean
  • ipPrefix object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • securityGroups object[]

    List of security groups that provide controlled access.

  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • networkTopologySettings object
  • workloadServerGroup object
  • id int32
  • name string
  • type string
  • infrastructureServerGroup object
  • id int32
  • name string
  • type string
  • infrastructureNetworkGateway string

    Optional network gateway used by infrastructure. To use, specify in the format hostname:port, else leave empty.

  • advancedSettings object
  • serverGroup object
  • id int32
  • name string
  • type string
  • resourceGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • iamRole object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • vmSize object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • instanceType object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • customImages object[]
  • imageGUID string
  • imageName string
  • operatingSystem string

    Possible values: [UNIX, WINDOWS]

  • advanced object
  • networkAddressSpace object
  • virtualNetwork string
  • recoveredEntity string
  • infrastructure string
  • deploySecureConnection boolean
  • endpointSubnet string
  • publicSubnet string
  • bastion string
  • securityGroupRules object
  • recoveredEntity object[]
  • priority int32
  • isDefault boolean
  • name string
  • sourceIPRange string
  • sourcePortRange string
  • destinationIPRange string
  • destinationPortRange string
  • sourceIPRanges string[]
  • sourcePortRanges string[]
  • destinationIPRanges string[]
  • destinationPortRanges string[]
  • direction string

    Possible values: [INBOUND, OUTBOUND]

    Security group rule direction

  • access string

    Possible values: [ALLOW, DENY]

    Security group rule access

  • infrastructure object[]
  • priority int32
  • isDefault boolean
  • name string
  • sourceIPRange string
  • sourcePortRange string
  • destinationIPRange string
  • destinationPortRange string
  • sourceIPRanges string[]
  • sourcePortRanges string[]
  • destinationIPRanges string[]
  • destinationPortRanges string[]
  • direction string

    Possible values: [INBOUND, OUTBOUND]

    Security group rule direction

  • access string

    Possible values: [ALLOW, DENY]

    Security group rule access

  • tags object[]
  • type TargetResourceTagType

    Possible values: [WORKLOAD, INFRASTRUCTURE]

  • key string
  • value string
Responses

Success

Schema
  • id int32
  • name string
Loading...