Enable Overlay Over Management Network
Enable Overlay over Management Network for NSX VLAN Backed Domain
This is deprecated. Use vCenter or NSX to enable Overlay.
Request
URI
PATCH
https://{api_host}/v1/domains/{id}/overlay
COPY
Path Parameters
string
id
Required
Domain ID
Responses
200
Ok
Returns
Task
of type(s)
application/json
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED, QUEUED, TIMED_OUT, Queued, Timed Out",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
],
"documentationLink": {
"url": "string",
"label": "string"
}
}
],
"documentationLink": {
"url": "string",
"label": "string"
}
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}
string
id
Required
Read-Only
Constraints:
minLength: 1
Task ID
string
name
Required
Read-Only
Constraints:
minLength: 1
Task name
object
localizableDescriptionPack
Read-Only
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
type
Read-Only
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
string
status
Required
Read-Only
Constraints:
minLength: 1
Task status
string
creationTimestamp
Required
Read-Only
Task creation timestamp
string
completionTimestamp
Read-Only
Task completion timestamp
array of
object
subTasks
Read-Only
List of sub-tasks of the task
array of
object
errors
Optional
List of errors in case of a failure
array of
object
resources
Read-Only
List of resources associated with task
string
resolutionStatus
Read-Only
Resolution state
boolean
isCancellable
Read-Only
Represents task can be cancellable or not.
boolean
isRetryable
Read-Only
Indicates whether a task is eligible for retry or not.
202
Accepted
Returns
Task
of type(s)
application/json
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED, QUEUED, TIMED_OUT, Queued, Timed Out",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
],
"documentationLink": {
"url": "string",
"label": "string"
}
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}
string
id
Required
Read-Only
Constraints:
minLength: 1
Task ID
string
name
Required
Read-Only
Constraints:
minLength: 1
Task name
object
localizableDescriptionPack
Read-Only
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
type
Read-Only
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
string
status
Required
Read-Only
Constraints:
minLength: 1
Task status
string
creationTimestamp
Required
Read-Only
Task creation timestamp
string
completionTimestamp
Read-Only
Task completion timestamp
array of
object
subTasks
Read-Only
List of sub-tasks of the task
array of
object
errors
Optional
List of errors in case of a failure
array of
object
resources
Read-Only
List of resources associated with task
string
resolutionStatus
Read-Only
Resolution state
boolean
isCancellable
Read-Only
Represents task can be cancellable or not.
boolean
isRetryable
Read-Only
Indicates whether a task is eligible for retry or not.
400
Bad Request
Returns
Error
of type(s)
application/json
"Error Object"
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
array of
object
notifications
Read-Only
Detailed results of the precheck validation.
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
label
Read-Only
The localized label message
string
remediationUrl
Read-Only
The URL string for remediation documentation link
404
Not Found
Returns
Error
of type(s)
application/json
"Error Object"
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
array of
object
notifications
Read-Only
Detailed results of the precheck validation.
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
label
Read-Only
The localized label message
string
remediationUrl
Read-Only
The URL string for remediation documentation link
500
InternalServerError
Returns
Error
of type(s)
application/json
"Error Object"
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
array of
object
notifications
Read-Only
Detailed results of the precheck validation.
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
label
Read-Only
The localized label message
string
remediationUrl
Read-Only
The URL string for remediation documentation link
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>'
Deprecated
On This Page
Domains Operations
GET
Get Tags Assigned To Domain
PUT
Assign Tags To Domain
DELETE
Remove Tags From Domain
GET
Get Domains
POST
Create Domain
PATCH
Update Domains
POST
Validate Domain Update Spec
POST
Perform Domain Isolation Precheck
POST
Query Domain Image Compliance
POST
Post Datastore Query
POST
Post Cluster Query
POST
Post Clusters Query
POST
Validate Domain Creation Spec
GET
Get Domain
DELETE
Delete Domain
PATCH
Update Domain
PATCH
Enable Overlay Over Management Network
Deprecated
GET
Get Domain Update Validation
GET
Get Domain Tag Manager Url
GET
Get Assignable Tags For Domain
GET
Get Domain Endpoints
GET
Get Domain Datacenters
GET
Get Domain Capabilities By Domain Id
GET
Get Domain Isolation Precheck Status
GET
Get Domain Image Compliance Query Response
GET
Get Datastore Query Response
GET
Get Datastores Criteria
GET
Get Datastore Criterion
GET
Get Cluster Query Response
GET
Get Clusters Query Response
GET
Get Cluster Criteria
GET
Get Cluster Criterion
GET
Domain Create Validation
GET
Get Tags Assigned To Domains
GET
Get Domain Capabilities