Skip to main content

Create cleanroom target​

Select

SaaS
Customer Managed

Create cleanroom target for automation of resources

Request Body
  • 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

  • isScaleProfile boolean

    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

    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

  • 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

  • isScaleProfile boolean

    True if the access node is a scale profile client

  • region object required
  • guid string
  • name string
Responses

Success

Schema
  • id int32
  • name string
Loading...