Create cleanroom target
Select
Create cleanroom target for automation of resources
- application/json
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 int32name stringoptionsAzure object
Create a hypervisor group
name string requiredThe name of the hypervisor group being created
skipCredentialValidation booleanDefault value:
false
if credential validation has to be skipped.
useHostedInfrastructure booleanDefault value:
false
Describes if the infra has to be managed by commvault
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
credentials object
id int32name stringetcdProtection object
Create an application group etcd (system generated) with pre-defined content
enabled booleanDenote if etcd protection is enabled
plan object
id int32name stringplanEntity object
id int32name stringenableCloudConfigProtection booleanDefault value:
false
Protect Cloud Config entities
workloadType stringworkloadRegion object
id int32name stringforceAccessNodeRegion booleanDefault 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 requiredPossible values: [
AZURE_V2
]useManagedIdentity booleanDefault value:
false
set to true, if you want to use System Managed identitiy of Access node for Authentication
subscriptionId string requiredSubscription ID of Azure
isAuthorizedUsingMTA booleanDefault value:
false
Indicates whether the hypervisor was created by authorizing the multitenant app in this tenant.
optionsAmazon object
Create a hypervisor group
name string requiredThe name of the hypervisor group being created
skipCredentialValidation booleanDefault value:
false
if credential validation has to be skipped.
useHostedInfrastructure booleanDefault value:
false
Describes if the infra has to be managed by commvault
accessNodes object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
credentials object
id int32name stringetcdProtection object
Create an application group etcd (system generated) with pre-defined content
enabled booleanDenote if etcd protection is enabled
plan object
id int32name stringplanEntity object
id int32name stringenableCloudConfigProtection booleanDefault value:
false
Protect Cloud Config entities
workloadType stringworkloadRegion object
id int32name stringforceAccessNodeRegion booleanDefault 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 requiredPossible values: [
Amazon
]accessKey string requiredAccess Key of Amazon login
RoleARN stringRole ARN for STS assume role with IAM policy
secretKey string requiredsecret Key of Amazon login
Region stringAWS region if Iam role is used
useIamRole boolean requiredif Iam Role is used
enableAWSAdminAccount booleanuseServiceAccount stringClientname to be used as Admin Account
accessNode object
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
region object required
guid stringname string
- 200
- 400
- 409
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- id int32
- name string
{
"id": 0,
"name": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}