Update Domain
Update a Domain
Request
URI
PATCH
https://sfo-vcf01.rainpole.io/v1/domains/{id}
COPY
Path Parameters
string
id
Required
Domain ID
Request Body
Domain Update Data
DomainUpdateSpec of type(s) application/json
Required
{
"clusterSpec": {
"advancedOptions": {
"evcMode": "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
"highAvailability": {
"enabled": false
}
},
"clusterImageId": "string",
"datastoreSpec": {
"nfsDatastoreSpecs": [
{
"datastoreName": "string",
"nasVolume": {
"path": "string",
"readOnly": false,
"serverName": [
"string"
],
"userTag": "string"
}
}
],
"vmfsDatastoreSpec": {
"fcSpec": [
{
"datastoreName": "string"
}
]
},
"vsanDatastoreSpec": {
"datastoreName": "string",
"dedupAndCompressionEnabled": false,
"esaConfig": {
"enabled": false
},
"failuresToTolerate": 0,
"licenseKey": "string"
},
"vsanRemoteDatastoreClusterSpec": {
"vsanRemoteDatastoreSpec": [
{
"datastoreUuid": "string"
}
]
},
"vvolDatastoreSpecs": [
{
"name": "string",
"vasaProviderSpec": {
"storageContainerId": "string",
"storageProtocolType": "One among: ISCSI, NFS, FC",
"userId": "string",
"vasaProviderId": "string"
}
}
]
},
"hostSpecs": [
{
"azName": "string",
"hostName": "string",
"hostNetworkSpec": {
"networkProfileName": "string",
"vmNics": [
{
"id": "string",
"moveToNvds": false,
"uplink": "string",
"vdsName": "string"
}
]
},
"id": "string",
"ipAddress": "string",
"licenseKey": "string",
"password": "string",
"serialNumber": "string",
"sshThumbprint": "string",
"username": "string"
}
],
"name": "string",
"networkSpec": {
"nsxClusterSpec": {
"nsxTClusterSpec": {
"geneveVlanId": 0,
"ipAddressPoolSpec": {
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"name": "string",
"subnets": [
{
"cidr": "string",
"gateway": "string",
"ipAddressPoolRanges": [
{
"end": "string",
"start": "string"
}
]
}
]
},
"ipAddressPoolsSpec": [
{
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"name": "string",
"subnets": [
{
"cidr": "string",
"gateway": "string",
"ipAddressPoolRanges": [
{
"end": "string",
"start": "string"
}
]
}
]
}
],
"uplinkProfiles": [
{
"name": "string",
"supportedTeamingPolicies": {
"supportedTeamingPolicies": "string"
},
"teamings": [
{
"activeUplinks": [
"string"
],
"policy": "string",
"standByUplinks": [
"string"
]
}
],
"transportVlan": 0
}
]
}
},
"vdsSpecs": [
{
"isUsedByNsxt": false,
"nsxtSwitchConfig": {
"transportZones": [
{
"name": "string",
"transportType": "One among: VLAN, OVERLAY"
}
],
"hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
},
"mtu": 0,
"name": "string",
"niocBandwidthAllocationSpecs": [
{
"niocTrafficResourceAllocation": {
"limit": 0,
"reservation": 0,
"sharesInfo": {
"level": "One among: low, normal, high, custom",
"shares": 0
}
},
"type": "string"
}
],
"portGroupSpecs": [
{
"activeUplinks": [
"string"
],
"standByUplinks": [
"string"
],
"teamingPolicy": "One among: loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
"name": "string",
"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT"
}
]
}
],
"networkProfiles": [
{
"name": "string",
"description": "string",
"isDefault": false,
"nsxtHostSwitchConfigs": [
{
"ipAddressPoolName": "string",
"uplinkProfileName": "string",
"vdsName": "string",
"vdsUplinkToNsxUplink": [
{
"nsxUplinkName": "string",
"vdsUplinkName": "string"
}
]
}
]
}
]
},
"skipThumbprintValidation": false,
"vxRailDetails": {
"adminCredentials": {
"credentialType": "One among: SSH",
"password": "string",
"username": "string"
},
"arrayContextWithKeyValuePair": {
"arrayContextWithKeyValuePair": {
"arrayContextWithKeyValuePair": [
{
"arrayAssociationContext": {
"arrayAttributeIdsKeyValue": {
"arrayAttributeIdsKeyValue": "string"
},
"parent": "VxRailArrayAssociationContext Object"
},
"simpleAttributes": [
{
"attributeName": "string",
"datatype": "string",
"value": "string"
}
]
}
]
}
},
"contextWithKeyValuePair": {
"contextWithKeyValuePair": {
"contextWithKeyValuePair": [
{
"attributeName": "string",
"datatype": "string",
"value": "string"
}
]
}
},
"dnsName": "string",
"ipAddress": "string",
"networks": [
{
"freeIps": [
"string"
],
"gateway": "string",
"id": "string",
"ipPools": [
{
"end": "string",
"start": "string"
}
],
"mask": "string",
"mtu": 0,
"subnet": "string",
"type": "string",
"usedIps": [
"string"
],
"vlanId": 0
}
],
"nicProfile": "string",
"rootCredentials": {
"credentialType": "One among: SSH",
"password": "string",
"username": "string"
},
"sshThumbprint": "string",
"sslThumbprint": "string"
}
},
"markForDeletion": false,
"name": "string",
"nsxTSpec": {
"formFactor": "string",
"ipAddressPoolSpec": {
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"name": "string",
"subnets": [
{
"cidr": "string",
"gateway": "string",
"ipAddressPoolRanges": [
{
"end": "string",
"start": "string"
}
]
}
]
},
"licenseKey": "string",
"nsxManagerAdminPassword": "string",
"nsxManagerAuditPassword": "string",
"nsxManagerSpecs": [
{
"name": "string",
"networkDetailsSpec": {
"dnsName": "string",
"gateway": "string",
"ipAddress": "string",
"subnetMask": "string"
}
}
],
"vip": "string",
"vipFqdn": "string"
}
}
clusterSpec
Optional
This specification contains the parameters required to add a cluster to a workload domain
boolean
markForDeletion
Optional
Enable deletion for the domain
string
name
Optional
Name of the domain
nsxTSpec
Optional
This specification contains the parameters required to install and configure NSX in a workload domain
Responses
200
Ok
Returns Task of type(s) application/json
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"id": "string",
"isCancellable": false,
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"subTasks": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"stages": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type": "string"
}
],
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"subTasks": [
"SubTask Object"
],
"type": "string"
}
],
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"isRetryable": false
}string
completionTimestamp
Optional
Task completion timestamp
string
creationTimestamp
Optional
Task creation timestamp
string
id
Optional
Task ID
boolean
isCancellable
Optional
Represents task can be cancellable or not.
localizableDescriptionPack
Optional
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
name
Optional
Task name
string
resolutionStatus
Optional
Resolution state
string
status
Optional
Task status
string
type
Optional
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
boolean
isRetryable
Optional
Indicates whether a task is eligible for retry or not.
202
Accepted
Returns Task of type(s) application/json
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"id": "string",
"isCancellable": false,
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"subTasks": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"stages": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type": "string"
}
],
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"subTasks": [
"SubTask Object"
],
"type": "string"
}
],
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"isRetryable": false
}string
completionTimestamp
Optional
Task completion timestamp
string
creationTimestamp
Optional
Task creation timestamp
string
id
Optional
Task ID
boolean
isCancellable
Optional
Represents task can be cancellable or not.
localizableDescriptionPack
Optional
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
name
Optional
Task name
string
resolutionStatus
Optional
Resolution state
string
status
Optional
Task status
string
type
Optional
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
boolean
isRetryable
Optional
Indicates whether a task is eligible for retry or not.
400
Bad Request
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
404
Not Found
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
500
InternalServerError
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
On This Page
Domains Operations
PUT
Assign Tags To Domain
POST
Create Domain
DELETE
Delete Domain
GET
Get Assignable Tags For Domain
GET
Get Cluster Criteria
GET
Get Cluster Criterion
GET
Get Cluster Query Response
GET
Get Clusters Query Response
GET
Get Datastore Criterion 1
GET
Get Datastore Query Response 1
GET
Get Datastores Criteria 1
GET
Get Domain
GET
Get Domain Endpoints
GET
Get Domains
GET
Get Domain Tag Manager Url
GET
Get Tags Assigned To Domain
GET
Get Tags Assigned To Domains
POST
Post Cluster Query
POST
Post Clusters Query
POST
Post Datastore Query 1
DELETE
Remove Tags From Domain
PATCH
Update Domain
POST
Validate Domain Creation Spec