VMware Cloud Foundation on Dell EMC VxRail API Reference Guide
3. Resources
3.1. AVNs
APIs for managing Solutions Networking (Application Virtual Networks)
3.1.1. Create AVNs
POST /v1/avns
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
avnsCreationSpec |
Avn creation data |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/avns
Request body
{
"avns" : [ {
"domainName" : "rainpole.io",
"gateway" : "192.168.31.1",
"id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
"mtu" : 1600,
"name" : "vRealize-AVN",
"portGroupName" : "sfo-m01-seg01-pg",
"regionType" : "REGION_A",
"routerName" : "sfo-m01-ec01-t1-gw01",
"subnet" : "192.168.31.0",
"subnetMask" : "255.255.255.0",
"vlanId" : 30
} ],
"edgeClusterId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.1.2. Fetches all AVNs
GET /v1/avns
Description
Returns all matching AVNs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
regionType |
Pass an optional AVN region type matching either Region-A or X-Region |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Returns the list of all matching AVNs |
< Avn > array |
500 |
Unexpected error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/avns
Example HTTP response
Response 200
[ {
"domainName" : "rainpole.io",
"gateway" : "192.168.31.1",
"id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
"mtu" : 1600,
"name" : "vRealize-AVN",
"portGroupName" : "sfo-m01-seg01-pg",
"regionType" : "REGION_A",
"routerName" : "sfo-m01-ec01-t1-gw01",
"subnet" : "192.168.31.0",
"subnetMask" : "255.255.255.0",
"vlanId" : 30
} ]Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.1.3. Validate AVN Creation Spec
POST /v1/avns/validations
Description
Returns Validation report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
avnsCreationSpec |
Provide the spec to create the AVNs |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Validation of AVN Creation spec completed |
|
500 |
Unexpected error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/avns/validations
Request body
{
"avns" : [ {
"domainName" : "rainpole.io",
"gateway" : "192.168.31.1",
"id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
"mtu" : 1600,
"name" : "vRealize-AVN",
"portGroupName" : "sfo-m01-seg01-pg",
"regionType" : "REGION_A",
"routerName" : "sfo-m01-ec01-t1-gw01",
"subnet" : "192.168.31.0",
"subnetMask" : "255.255.255.0",
"vlanId" : 30
} ],
"edgeClusterId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.2. BackupRestore
APIs for managing Backups and Restore
3.2.1. Trigger backup
POST /v1/backups/tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
backupsSpec |
backupsSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/backups/tasks
Request body
{
"elements" : [ {
"resourceType" : "SDDC_MANAGER"
} ]
}Example HTTP response
Response 200
{
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: IN_PROGRESS"
}Response 202
{
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: IN_PROGRESS"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.2.2. Trigger Restore
POST /v1/restores/tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
restoreSpec |
restoreSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/restores/tasks
Request body
{
"backupFile" : "string",
"elements" : [ {
"resourceType" : "SDDC_MANAGER"
} ],
"encryption" : {
"passphrase" : "string"
}
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.2.3. Fetch the restores task
GET /v1/restores/tasks/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The restore task ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/restores/tasks/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.2.4. Get backup configuration used to backup NSX and SDDC manager
GET /v1/system/backup-configuration
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/backup-configuration
Example HTTP response
Response 200
{
"backupLocations" : [ {
"directoryPath" : "string",
"password" : "string",
"port" : 0,
"protocol" : "SFTP",
"server" : "string",
"sshFingerprint" : "string",
"username" : "string"
} ],
"backupSchedules" : [ {
"daysOfWeek" : "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY",
"frequency" : "One among: WEEKLY, HOURLY",
"hourOfDay" : 0,
"minuteOfHour" : 0,
"resourceType" : "SDDC_MANAGER",
"retentionPolicy" : {
"numberOfDaysOfDailyBackups" : 20,
"numberOfDaysOfHourlyBackups" : 10,
"numberOfMostRecentBackups" : 15
},
"takeBackupOnStateChange" : true,
"takeScheduledBackups" : true
} ],
"encryption" : {
"passphrase" : "string"
},
"isConfigured" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.2.5. Configure backup settings to backup NSX and SDDC manager
PUT /v1/system/backup-configuration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
backupConfigurationSpec |
backupConfigurationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/backup-configuration
Request body
{
"backupLocations" : [ {
"directoryPath" : "string",
"password" : "string",
"port" : 0,
"protocol" : "SFTP",
"server" : "string",
"sshFingerprint" : "string",
"username" : "string"
} ],
"backupSchedules" : [ {
"daysOfWeek" : "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY",
"frequency" : "One among: WEEKLY, HOURLY",
"hourOfDay" : 0,
"minuteOfHour" : 0,
"resourceType" : "SDDC_MANAGER",
"retentionPolicy" : {
"numberOfDaysOfDailyBackups" : 20,
"numberOfDaysOfHourlyBackups" : 10,
"numberOfMostRecentBackups" : 15
},
"takeBackupOnStateChange" : true,
"takeScheduledBackups" : true
} ],
"encryption" : {
"passphrase" : "string"
}
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.2.6. Edit backup configuration to backup NSX and SDDC manager
PATCH /v1/system/backup-configuration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
backupConfigurationSpec |
backupConfigurationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/backup-configuration
Request body
{
"backupLocations" : [ {
"directoryPath" : "string",
"password" : "string",
"port" : 0,
"protocol" : "SFTP",
"server" : "string",
"sshFingerprint" : "string",
"username" : "string"
} ],
"backupSchedules" : [ {
"daysOfWeek" : "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY",
"frequency" : "One among: WEEKLY, HOURLY",
"hourOfDay" : 0,
"minuteOfHour" : 0,
"resourceType" : "SDDC_MANAGER",
"retentionPolicy" : {
"numberOfDaysOfDailyBackups" : 20,
"numberOfDaysOfHourlyBackups" : 10,
"numberOfMostRecentBackups" : 15
},
"takeBackupOnStateChange" : true,
"takeScheduledBackups" : true
} ],
"encryption" : {
"passphrase" : "string"
}
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.3. Bundles
APIs for managing Bundles
3.3.1. Upload a Bundle
POST /v1/bundles
Description
Upload Bundle to SDDC Manager. Used when you do not have internet connectivity for downloading bundles from VMWare/VxRail to SDDC Manager. The Bundles are manually downloaded from Depot using Bundle Transfer utility
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
bundleUploadSpec |
Bundle Upload Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/bundles
Request body
{
"bundleFilePath" : "string",
"compatibilitySetsFilePath" : "string",
"manifestFilePath" : "string",
"partnerExtensionSpec" : {
"partnerBundleMetadataFilePath" : "string",
"partnerBundleVersion" : "string"
},
"signatureFilePath" : "string"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.3.2. Get the Bundles
GET /v1/bundles
Description
Get all Bundles i.e uploaded bundles and also bundles available via depot access.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bundleType |
The type of the bundle |
string |
Query |
isCompliant |
Is compliant with the current VCF version |
boolean |
Query |
productType |
The type of the product |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/bundles
Example HTTP response
Response 200
{
"elements" : [ {
"components" : [ {
"description" : "string",
"fromVersion" : "string",
"id" : "string",
"imageType" : "One among: PATCH, INSTALL",
"releasedDate" : "string",
"toVersion" : "string",
"type" : "string",
"vendor" : "string"
} ],
"description" : "string",
"downloadStatus" : "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
"id" : "string",
"isCompliant" : true,
"isCumulative" : true,
"releasedDate" : "string",
"severity" : "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
"sizeMB" : 0.0,
"type" : "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
"vendor" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.3.3. Update software compatibility sets for Bundles
PATCH /v1/bundles/
Description
Update software compatibility sets for Bundles
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
bundleUpdateSpec |
Bundle Update Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
202 |
Accepted |
No Content |
400 |
Bad Request |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/bundles/
Request body
{
"bundleDownloadSpec" : {
"downloadNow" : true,
"scheduledTimestamp" : "string"
},
"compatibilitySetsFilePath" : "string"
}Example HTTP response
Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.3.4. getBundlesForSkipUpgrade
GET /v1/bundles/domains/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Query |
targetVersion |
Target domain VCF version |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/bundles/domains/string?targetVersion=string
Example HTTP response
Response 200
{
"elements" : [ {
"components" : [ {
"description" : "string",
"fromVersion" : "string",
"id" : "string",
"imageType" : "One among: PATCH, INSTALL",
"releasedDate" : "string",
"toVersion" : "string",
"type" : "string",
"vendor" : "string"
} ],
"description" : "string",
"downloadStatus" : "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
"id" : "string",
"isCompliant" : true,
"isCumulative" : true,
"releasedDate" : "string",
"severity" : "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
"sizeMB" : 0.0,
"type" : "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
"vendor" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.3.5. Get a Bundle
GET /v1/bundles/{id}
Description
Get a Bundle
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Bundle ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Bundle Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/bundles/string
Example HTTP response
Response 200
{
"components" : [ {
"description" : "string",
"fromVersion" : "string",
"id" : "string",
"imageType" : "One among: PATCH, INSTALL",
"releasedDate" : "string",
"toVersion" : "string",
"type" : "string",
"vendor" : "string"
} ],
"description" : "string",
"downloadStatus" : "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
"id" : "string",
"isCompliant" : true,
"isCumulative" : true,
"releasedDate" : "string",
"severity" : "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
"sizeMB" : 0.0,
"type" : "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
"vendor" : "string",
"version" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.3.6. Update a Bundle for downloading from depot
PATCH /v1/bundles/{id}
Description
Update a Bundle for scheduling/triggering download. Only one download can triggered for a Bundle.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Bundle ID |
string |
Body |
bundleUpdateSpec |
Bundle Update Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/bundles/string
Request body
{
"bundleDownloadSpec" : {
"downloadNow" : true,
"scheduledTimestamp" : "string"
},
"compatibilitySetsFilePath" : "string"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.4. CEIP
APIs for managing CEIP status
3.4.1. Get CEIP status
GET /v1/system/ceip
Description
Get CEIP status and instance id
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ceip
Example HTTP response
Response 200
{
"instanceId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
"status" : "One among: ENABLED, DISABLED, ENABLING, DISABLING, ENABLING_FAILED, DISABLING_FAILED"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.4.2. Opt-in or Opt-out of CEIP
PATCH /v1/system/ceip
Description
Opt-in or Opt-out of CEIP
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
ceipUpdateSpec |
Required action for CEIP. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
409 |
The request could not be completed due to a conflict with the current state |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ceip
Request body
{
"status" : "One among: ENABLE, DISABLE"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5. Certificates
APIs for managing Certificates
3.5.1. Get certificate authorities information
GET /v1/certificate-authorities
Description
Get certificate authorities information
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/certificate-authorities
Example HTTP response
Response 200
{
"elements" : [ {
"commonName" : "string",
"country" : "string",
"id" : "One among: OpenSSL, Microsoft",
"locality" : "string",
"organization" : "string",
"organizationUnit" : "string",
"serverUrl" : "string",
"state" : "string",
"templateName" : "string",
"username" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.2. Create a certificate authority
PUT /v1/certificate-authorities
Description
Creates a certificate authority. This is required to generate signed certificates by supporting CAs.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
certificateAuthorityCreationSpec |
certificateAuthorityCreationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/certificate-authorities
Request body
{
"microsoftCertificateAuthoritySpec" : {
"secret" : "string",
"serverUrl" : "string",
"templateName" : "string",
"username" : "string"
},
"openSSLCertificateAuthoritySpec" : {
"commonName" : "string",
"country" : "string",
"locality" : "string",
"organization" : "string",
"organizationUnit" : "string",
"state" : "string"
}
}Example HTTP response
Response 200
{ }Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.3. Configure existing certificate authority
PATCH /v1/certificate-authorities
Description
Configure existing certificate authority
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
certificateAuthoritySpec |
certificateAuthoritySpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad request |
|
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/certificate-authorities
Request body
{
"microsoftCertificateAuthoritySpec" : {
"secret" : "string",
"serverUrl" : "string",
"templateName" : "string",
"username" : "string"
},
"openSSLCertificateAuthoritySpec" : {
"commonName" : "string",
"country" : "string",
"locality" : "string",
"organization" : "string",
"organizationUnit" : "string",
"state" : "string"
}
}Example HTTP response
Response 200
{ }Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.4. Deletes CA configuration file
DELETE /v1/certificate-authorities/{caType}
Description
Deletes CA configuration file
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
caType |
The CA type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No contet |
object |
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/certificate-authorities/string
Example HTTP response
Response 200
{ }Response 204
{ }Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.5. Get certificate authority information
GET /v1/certificate-authorities/{id}
Description
Get certificate authority information
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
CA type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/certificate-authorities/string
Example HTTP response
Response 200
{
"commonName" : "string",
"country" : "string",
"id" : "One among: OpenSSL, Microsoft",
"locality" : "string",
"organization" : "string",
"organizationUnit" : "string",
"serverUrl" : "string",
"state" : "string",
"templateName" : "string",
"username" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.6. Get latest generated certificate(s) in a domain.
GET /v1/domains/{domainName}/certificates
Description
Get latest generated certificate(s) in a domain.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/certificates
Example HTTP response
Response 200
{
"elements" : [ {
"expirationStatus" : "One among: ACTIVE, ABOUT_TO_EXPIRE, EXPIRED",
"getCertificateError" : "string",
"isInstalled" : true,
"issuedBy" : "string",
"issuedTo" : "string",
"keySize" : "One among: 2048, 3072, 4096",
"notAfter" : "string",
"notBefore" : "string",
"numberOfDaysToExpire" : 0,
"pemEncoded" : "string",
"publicKey" : "string",
"publicKeyAlgorithm" : "One among: RSA",
"serialNumber" : "string",
"signatureAlgorithm" : "string",
"subject" : "string",
"subjectAlternativeName" : [ "string" ],
"thumbprint" : "string",
"thumbprintAlgorithm" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.7. Generate certificate(s) for the selected resource(s) in a domain
PUT /v1/domains/{domainName}/certificates
Description
Generate certificate(s) for the selected resource(s) in a domain. CA must be configured and CSR must be generated beforehand.
NOTE:
Supported certificate resource types for this operation are: VCENTER, NSXT_MANAGER, SDDC_MANAGER, VRSLCM, VXRAIL_MANAGER ..
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Body |
certificateGenerationSpec |
certificateGenerationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad request |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/certificates
Request body
{
"caType" : "One among: OpenSSL, Microsoft",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.8. Replace certificate(s) for the selected resource(s) in a domain
PATCH /v1/domains/{domainName}/certificates
Description
Replace certificate(s) for the selected resource(s) in a domain
NOTE:
Supported certificate resource types for this operation are: VCENTER, NSXT_MANAGER, SDDC_MANAGER, VRSLCM, VXRAIL_MANAGER ..
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Body |
certificateOperationSpec |
certificateOperationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad request |
|
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/certificates
Request body
{
"operationType" : "One among: INSTALL",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.9. Upload certificates to the certificate store
PUT /v1/domains/{domainName}/certificates/uploads
Description
Upload certificates to the certificate store
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
FormData |
file |
file |
file |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad request. |
|
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP response
Response 200
{ }Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.10. Get available CSR(s) in json format
GET /v1/domains/{domainName}/csrs
Description
Get available CSR(s) in json format
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/csrs
Example HTTP response
Response 200
{
"elements" : [ {
"csrEncodedContent" : "string",
"resource" : {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
}
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.11. Generate CSR(s)
PUT /v1/domains/{domainName}/csrs
Description
Generate CSR(s) for the selected resource(s) in the domain.
Warning:
Avoid using wildcard certificates. Instead, use subdomain-specific certificates that are rotated often. A compromised wildcard certificate can lead to security repercussions.
NOTE:
Supported certificate resource types for this operation are: VCENTER, NSXT_MANAGER, SDDC_MANAGER, VRSLCM, VXRAIL_MANAGER ..
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Body |
csrsGenerationSpec |
csrsGenerationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad request |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/csrs
Request body
{
"csrGenerationSpec" : {
"country" : "string",
"email" : "string",
"keyAlgorithm" : "One among: RSA",
"keySize" : "One among: 2048, 3072, 4096",
"locality" : "string",
"organization" : "string",
"organizationUnit" : "string",
"state" : "string"
},
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.12. Download available CSR(s) in tar.gz format
GET /v1/domains/{domainName}/csrs/downloads
Description
Download available CSR(s) in tar.gz format
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/v1/domains/string/csrs/downloads
Example HTTP response
Response 200
"Ynl0ZQ=="Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.5.13. View certificate of all the resources in a domain
GET /v1/domains/{domainName}/resource-certificates
Description
View detailed metadata about the certificate(s) of all the resources in a domain
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainName |
The domain name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/resource-certificates
Example HTTP response
Response 200
{
"elements" : [ {
"expirationStatus" : "One among: ACTIVE, ABOUT_TO_EXPIRE, EXPIRED",
"getCertificateError" : "string",
"isInstalled" : true,
"issuedBy" : "string",
"issuedTo" : "string",
"keySize" : "One among: 2048, 3072, 4096",
"notAfter" : "string",
"notBefore" : "string",
"numberOfDaysToExpire" : 0,
"pemEncoded" : "string",
"publicKey" : "string",
"publicKeyAlgorithm" : "One among: RSA",
"serialNumber" : "string",
"signatureAlgorithm" : "string",
"subject" : "string",
"subjectAlternativeName" : [ "string" ],
"thumbprint" : "string",
"thumbprintAlgorithm" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6. Clusters
APIs for managing Clusters
3.6.1. Create a Cluster and add to an existing Domain
POST /v1/clusters
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
clusterCreationSpec |
Cluster Creation Spec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters
Request body
{
"computeSpec" : {
"clusterSpecs" : [ {
"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" : true
}
},
"clusterImageId" : "string",
"datastoreSpec" : {
"nfsDatastoreSpecs" : [ {
"datastoreName" : "string",
"nasVolume" : {
"path" : "string",
"readOnly" : true,
"serverName" : [ "string" ],
"userTag" : "string"
}
} ],
"vmfsDatastoreSpec" : {
"fcSpec" : [ {
"datastoreName" : "string"
} ]
},
"vsanDatastoreSpec" : {
"datastoreName" : "string",
"dedupAndCompressionEnabled" : true,
"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" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"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" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
}
}
},
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
},
"skipThumbprintValidation" : true,
"vxRailDetails" : {
"adminCredentials" : {
"credentialType" : "One among: SSH",
"password" : "string",
"username" : "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"
}
} ],
"skipFailedHosts" : false
},
"domainId" : "string"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.2. Get the Clusters
GET /v1/clusters
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
isStretched |
isStretched |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters
Example HTTP response
Response 200
{
"elements" : [ {
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ],
"id" : "string",
"isDefault" : true,
"isStretched" : true,
"name" : "string",
"primaryDatastoreName" : "string",
"primaryDatastoreType" : "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.3. Validate the input spec for clusters operations
POST /v1/clusters/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
clusterCreationSpec |
Clusters Operation Spec Validation |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/validations
Request body
{
"computeSpec" : {
"clusterSpecs" : [ {
"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" : true
}
},
"clusterImageId" : "string",
"datastoreSpec" : {
"nfsDatastoreSpecs" : [ {
"datastoreName" : "string",
"nasVolume" : {
"path" : "string",
"readOnly" : true,
"serverName" : [ "string" ],
"userTag" : "string"
}
} ],
"vmfsDatastoreSpec" : {
"fcSpec" : [ {
"datastoreName" : "string"
} ]
},
"vsanDatastoreSpec" : {
"datastoreName" : "string",
"dedupAndCompressionEnabled" : true,
"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" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"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" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
}
}
},
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
},
"skipThumbprintValidation" : true,
"vxRailDetails" : {
"adminCredentials" : {
"credentialType" : "One among: SSH",
"password" : "string",
"username" : "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"
}
} ],
"skipFailedHosts" : false
},
"domainId" : "string"
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.4. Get the status of the validations for cluster deployment
GET /v1/clusters/validations/{id}
Description
Gets the status of given cluster create validation workflow by given validation id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster validation workflow id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.5. Get query response
GET /v1/clusters/{clusterId}/hosts/queries/{queryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clusterId |
Cluster ID |
string |
Path |
queryId |
Query ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
404 |
Query Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/hosts/queries/string
Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"bundleRepoDatastore" : "string",
"cluster" : {
"id" : "string"
},
"compatibleStorageType" : "string",
"cpu" : {
"cores" : 0,
"cpuCores" : [ {
"frequencyMHz" : 0.0,
"manufacturer" : "string",
"model" : "string"
} ],
"frequencyMHz" : 0.0,
"usedFrequencyMHz" : 0.0
},
"domain" : {
"id" : "string",
"name" : "string"
},
"esxiVersion" : "string",
"fqdn" : "string",
"hardwareModel" : "string",
"hardwareVendor" : "string",
"hybrid" : true,
"id" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
} ],
"isPrimary" : true,
"memory" : {
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"networkpool" : {
"id" : "string",
"name" : "string"
},
"physicalNics" : [ {
"deviceName" : "string",
"macAddress" : "string",
"speed" : 0
} ],
"serialNumber" : {
"present" : true
},
"sshThumbprint" : {
"present" : true
},
"sslThumbprint" : {
"present" : true
},
"status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage" : {
"disks" : [ {
"capacityMB" : 0.0,
"diskType" : "One among: HDD, FLASH",
"manufacturer" : "string",
"model" : "string"
} ],
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.6. Get the list of VDSes of a cluster.
GET /v1/clusters/{clusterId}/vdses
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clusterId |
Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Vds > array |
400 |
Bad Request |
|
404 |
Cluster Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/vdses
Example HTTP response
Response 200
[ {
"id" : "string",
"isUsedByNsxt" : true,
"mtu" : 0,
"name" : "string",
"niocBandwidthAllocations" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "One among: management, faultTolerance, vmotion, virtualMachine, iSCSI, nfs, hbr, vsan, vdp"
} ],
"portGroups" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"portBindingType" : "One among: STATIC, DYNAMIC, EPHEMERAL",
"standbyUplinks" : [ "string" ],
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK",
"vlanId" : 0
} ]
} ]Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.7. Get a Cluster
GET /v1/clusters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Cluster not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string
Example HTTP response
Response 200
{
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ],
"id" : "string",
"isDefault" : true,
"isStretched" : true,
"name" : "string",
"primaryDatastoreName" : "string",
"primaryDatastoreType" : "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.8. Delete a Cluster from a Domain if it has been previously initialized for deletion
DELETE /v1/clusters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.9. Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
PATCH /v1/clusters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Body |
clusterUpdateSpec |
Cluster Update Data |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
202 |
Accepted |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string
Request body
{
"clusterCompactionSpec" : {
"force" : true,
"forceByPassingSafeMinSize" : true,
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ]
},
"clusterExpansionSpec" : {
"forceHostAdditionInPresenceofDeadHosts" : true,
"hostSpecs" : [ {
"azName" : "string",
"hostName" : "string",
"hostNetworkSpec" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"uplink" : "string",
"vdsName" : "string"
} ]
},
"id" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"password" : "string",
"serialNumber" : "string",
"sshThumbprint" : "string",
"username" : "string"
} ],
"interRackExpansion" : true,
"skipThumbprintValidation" : true,
"vsanNetworkSpecs" : [ {
"vsanCidr" : "string",
"vsanGatewayIP" : "string"
} ],
"witnessSpec" : {
"fqdn" : "string",
"vsanCidr" : "string",
"vsanIp" : "string"
},
"witnessTrafficSharedWithVsanTraffic" : true
},
"clusterStretchSpec" : {
"hostSpecs" : [ {
"azName" : "string",
"hostName" : "string",
"hostNetworkSpec" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"uplink" : "string",
"vdsName" : "string"
} ]
},
"id" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"password" : "string",
"serialNumber" : "string",
"sshThumbprint" : "string",
"username" : "string"
} ],
"isEdgeClusterConfiguredForMultiAZ" : true,
"secondaryAzOverlayVlanId" : 0,
"vsanNetworkSpecs" : [ {
"vsanCidr" : "string",
"vsanGatewayIP" : "string"
} ],
"witnessSpec" : {
"fqdn" : "string",
"vsanCidr" : "string",
"vsanIp" : "string"
},
"witnessTrafficSharedWithVsanTraffic" : true
},
"clusterUnstretchSpec" : { },
"markForDeletion" : true,
"name" : "string",
"prepareForStretch" : true
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.10. Get all host criteria
GET /v1/clusters/{id}/hosts/criteria
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/hosts/criteria
Example HTTP response
Response 200
{
"elements" : [ {
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.6.11. Get a criterion to query for host
GET /v1/clusters/{id}/hosts/criteria/{name}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Path |
name |
Criteria Name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Criterion Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/hosts/criteria/string
Example HTTP response
Response 200
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.12. Post a host query
POST /v1/clusters/{id}/hosts/queries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Body |
hostCriterion |
hostCriterion |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/hosts/queries
Request body
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"bundleRepoDatastore" : "string",
"cluster" : {
"id" : "string"
},
"compatibleStorageType" : "string",
"cpu" : {
"cores" : 0,
"cpuCores" : [ {
"frequencyMHz" : 0.0,
"manufacturer" : "string",
"model" : "string"
} ],
"frequencyMHz" : 0.0,
"usedFrequencyMHz" : 0.0
},
"domain" : {
"id" : "string",
"name" : "string"
},
"esxiVersion" : "string",
"fqdn" : "string",
"hardwareModel" : "string",
"hardwareVendor" : "string",
"hybrid" : true,
"id" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
} ],
"isPrimary" : true,
"memory" : {
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"networkpool" : {
"id" : "string",
"name" : "string"
},
"physicalNics" : [ {
"deviceName" : "string",
"macAddress" : "string",
"speed" : 0
} ],
"serialNumber" : {
"present" : true
},
"sshThumbprint" : {
"present" : true
},
"sslThumbprint" : {
"present" : true
},
"status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage" : {
"disks" : [ {
"capacityMB" : 0.0,
"diskType" : "One among: HDD, FLASH",
"manufacturer" : "string",
"model" : "string"
} ],
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.13. Get Tags assigned to Cluster
GET /v1/clusters/{id}/tags
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/tags
Example HTTP response
Response 200
{
"elements" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.14. Assign Tags to Cluster
POST /v1/clusters/{id}/tags/attach
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Body |
tagsForObjectSpec |
tagsForObjectSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/tags/attach
Request body
{
"object_id" : {
"id" : "string",
"type" : "string"
},
"tag_ids" : [ "string" ]
}Example HTTP response
Response 200
{
"defaultErrorMessages" : [ "string" ],
"success" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.15. get Attachable Tags to Cluster
GET /v1/clusters/{id}/tags/attachable-tags
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/tags/attachable-tags
Example HTTP response
Response 200
{
"elements" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.16. Detach Tags From Cluster
POST /v1/clusters/{id}/tags/detach
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Body |
tagsForObjectSpec |
tagsForObjectSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/tags/detach
Request body
{
"object_id" : {
"id" : "string",
"type" : "string"
},
"tag_ids" : [ "string" ]
}Example HTTP response
Response 200
{
"defaultErrorMessages" : [ "string" ],
"success" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.17. Get Cluster Tag Manager Url
GET /v1/clusters/{id}/tags/tag-manager
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/tags/tag-manager
Example HTTP response
Response 200
{
"tagManagerUrl" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.18. Validate the input spec for operations on a cluster
POST /v1/clusters/{id}/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Body |
clusterUpdateSpec |
clusterUpdateSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/validations
Request body
{
"clusterCompactionSpec" : {
"force" : true,
"forceByPassingSafeMinSize" : true,
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ]
},
"clusterExpansionSpec" : {
"forceHostAdditionInPresenceofDeadHosts" : true,
"hostSpecs" : [ {
"azName" : "string",
"hostName" : "string",
"hostNetworkSpec" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"uplink" : "string",
"vdsName" : "string"
} ]
},
"id" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"password" : "string",
"serialNumber" : "string",
"sshThumbprint" : "string",
"username" : "string"
} ],
"interRackExpansion" : true,
"skipThumbprintValidation" : true,
"vsanNetworkSpecs" : [ {
"vsanCidr" : "string",
"vsanGatewayIP" : "string"
} ],
"witnessSpec" : {
"fqdn" : "string",
"vsanCidr" : "string",
"vsanIp" : "string"
},
"witnessTrafficSharedWithVsanTraffic" : true
},
"clusterStretchSpec" : {
"hostSpecs" : [ {
"azName" : "string",
"hostName" : "string",
"hostNetworkSpec" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"uplink" : "string",
"vdsName" : "string"
} ]
},
"id" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"password" : "string",
"serialNumber" : "string",
"sshThumbprint" : "string",
"username" : "string"
} ],
"isEdgeClusterConfiguredForMultiAZ" : true,
"secondaryAzOverlayVlanId" : 0,
"vsanNetworkSpecs" : [ {
"vsanCidr" : "string",
"vsanGatewayIP" : "string"
} ],
"witnessSpec" : {
"fqdn" : "string",
"vsanCidr" : "string",
"vsanIp" : "string"
},
"witnessTrafficSharedWithVsanTraffic" : true
},
"clusterUnstretchSpec" : { },
"markForDeletion" : true,
"name" : "string",
"prepareForStretch" : true
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.6.19. Get the status of the validations for cluster updates
GET /v1/clusters/{id}/validations/{validationId}
Description
Gets the status of given cluster updates validation workflow by given validation id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Cluster ID |
string |
Path |
validationId |
Cluster validation workflow id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/clusters/string/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7. Credentials
APIs for managing Credentials
3.7.1. Get the Credentials
GET /v1/credentials
Description
Get the Credentials
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
accountType |
Type of the account that needs to be fetched by filtering |
string |
Query |
domainName |
The name of the domain to which the resource belongs to (may be null in case there is no associated domain) |
string |
Query |
pageNumber |
The page number (must be a positive number), starts with 0 |
string |
Query |
pageSize |
The page size (must be a positive number, 0 as page size returns all records in one page |
string |
Query |
resourceIp |
The IP address of the resource |
string |
Query |
resourceName |
The name of the resource |
string |
Query |
resourceType |
The type of the resource. One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials
Example HTTP response
Response 200
{
"elements" : [ {
"accountType" : "One among: USER, SYSTEM, SERVICE",
"autoRotatePolicy" : {
"frequencyInDays" : 0,
"nextSchedule" : "string"
},
"creationTimestamp" : "string",
"credentialType" : "One among: SSO, SSH, API, FTP, AUDIT",
"id" : "string",
"modificationTimestamp" : "string",
"password" : "string",
"resource" : {
"domainName" : "string",
"resourceId" : "string",
"resourceIp" : "string",
"resourceName" : "string",
"resourceType" : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
},
"username" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.2. Update or rotate passwords for a list of resources
PATCH /v1/credentials
Description
Update passwords for given list of resources by supplying new passwords or rotate the passwords using system generated passwords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
credentialsUpdateSpec |
credentialsUpdateSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials
Request body
{
"autoRotatePolicy" : {
"enableAutoRotatePolicy" : true,
"frequencyInDays" : 0
},
"elements" : [ {
"credentials" : [ {
"accountType" : "One among: USER, SYSTEM, SERVICE",
"credentialType" : "One among: SSO, SSH, API, FTP, AUDIT",
"password" : "string",
"username" : "string"
} ],
"resourceId" : "string",
"resourceName" : "string",
"resourceType" : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
} ],
"operationType" : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.3. Fetch the credentials tasks
GET /v1/credentials/tasks
Description
Fetch all credentials tasks in reverse chronological order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
limit |
The number of elements to be returned in the result |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/tasks
Example HTTP response
Response 200
{
"elements" : [ {
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isAutoRotate" : true,
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"subTasks" : [ {
"creationTimestamp" : "string",
"credentialType" : "string",
"dependentSubTasks" : [ {
"creationTimestamp" : "string",
"credentialType" : "string",
"dependentSubTasks" : [ "..." ],
"description" : "string",
"entityType" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"name" : "string",
"newPassword" : "string",
"oldPassword" : "string",
"resourceName" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"username" : "string"
} ],
"description" : "string",
"entityType" : "string",
"errors" : [ "..." ],
"id" : "string",
"name" : "string",
"newPassword" : "string",
"oldPassword" : "string",
"resourceName" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"username" : "string"
} ],
"type" : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.4. Fetch a credentials task
GET /v1/credentials/tasks/{id}
Description
Fetch credentials task for a given ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The ID of the credentials task |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/tasks/string
Example HTTP response
Response 200
{
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isAutoRotate" : true,
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"subTasks" : [ {
"creationTimestamp" : "string",
"credentialType" : "string",
"dependentSubTasks" : [ {
"creationTimestamp" : "string",
"credentialType" : "string",
"dependentSubTasks" : [ "..." ],
"description" : "string",
"entityType" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"name" : "string",
"newPassword" : "string",
"oldPassword" : "string",
"resourceName" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"username" : "string"
} ],
"description" : "string",
"entityType" : "string",
"errors" : [ "..." ],
"id" : "string",
"name" : "string",
"newPassword" : "string",
"oldPassword" : "string",
"resourceName" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"username" : "string"
} ],
"type" : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.5. Cancel a failed credentials task for a given ID
DELETE /v1/credentials/tasks/{id}
Description
Cancel a failed credentials task for a given ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Task ID of the failed operation required to be cancelled |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/tasks/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 204
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.6. Retry a failed credentials task for a given ID
PATCH /v1/credentials/tasks/{id}
Description
Retry a failed credentials task for a given ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Task ID of the failed operation that is to be retried |
string |
Body |
credentialsUpdateSpec |
credentialsUpdateSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/tasks/string
Request body
{
"autoRotatePolicy" : {
"enableAutoRotatePolicy" : true,
"frequencyInDays" : 0
},
"elements" : [ {
"credentials" : [ {
"accountType" : "One among: USER, SYSTEM, SERVICE",
"credentialType" : "One among: SSO, SSH, API, FTP, AUDIT",
"password" : "string",
"username" : "string"
} ],
"resourceId" : "string",
"resourceName" : "string",
"resourceType" : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
} ],
"operationType" : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.7. Fetch resource credentials for a given credentials task ID
GET /v1/credentials/tasks/{id}/resource-credentials
Description
Fetch resource credentials for a given credentials task ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The ID of the credentials task |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ResourceCredentials > array |
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/tasks/string/resource-credentials
Example HTTP response
Response 200
[ {
"credentials" : [ {
"accountType" : "One among: USER, SYSTEM, SERVICE",
"credentialType" : "One among: SSO, SSH, API, FTP, AUDIT",
"password" : "string",
"username" : "string"
} ],
"resourceId" : "string",
"resourceName" : "string",
"resourceType" : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
} ]Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.8. Fetch details of a subtask for a given credentials task ID and sub-task ID.
GET /v1/credentials/tasks/{id}/subtasks/{subtaskId}
Description
Fetch details of a subtask for a given credentials task ID and sub-task ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The ID of the credentials task |
string |
Path |
subtaskId |
The ID of the credentials sub-task |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/tasks/string/subtasks/string
Example HTTP response
Response 200
{
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isAutoRotate" : true,
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"subTasks" : [ {
"creationTimestamp" : "string",
"credentialType" : "string",
"dependentSubTasks" : [ {
"creationTimestamp" : "string",
"credentialType" : "string",
"dependentSubTasks" : [ "..." ],
"description" : "string",
"entityType" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"name" : "string",
"newPassword" : "string",
"oldPassword" : "string",
"resourceName" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"username" : "string"
} ],
"description" : "string",
"entityType" : "string",
"errors" : [ "..." ],
"id" : "string",
"name" : "string",
"newPassword" : "string",
"oldPassword" : "string",
"resourceName" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
"username" : "string"
} ],
"type" : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.7.9. Get Credential for the given ID
GET /v1/credentials/{id}
Description
Get Credential for the given ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The ID of the credential |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/credentials/string
Example HTTP response
Response 200
{
"accountType" : "One among: USER, SYSTEM, SERVICE",
"autoRotatePolicy" : {
"frequencyInDays" : 0,
"nextSchedule" : "string"
},
"creationTimestamp" : "string",
"credentialType" : "One among: SSO, SSH, API, FTP, AUDIT",
"id" : "string",
"modificationTimestamp" : "string",
"password" : "string",
"resource" : {
"domainName" : "string",
"resourceId" : "string",
"resourceIp" : "string",
"resourceName" : "string",
"resourceType" : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
},
"username" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.8. DepotSettings
APIs for managing Depot Settings
3.8.1. Get Depot Settings
GET /v1/system/settings/depot
Description
Get the Depot Settings, In a fresh setup, this would be empty
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< DepotSettings > array |
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/settings/depot
Example HTTP response
Response 200
[ {
"dellEmcSupportAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
},
"vmwareAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
}
} ]Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.8.2. Update Depot Settings
PUT /v1/system/settings/depot
Description
Update Depot Settings. Depot Settings can be updated with VMware Depot Account
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
depotSettings |
Depot Settings |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/settings/depot
Request body
{
"dellEmcSupportAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
},
"vmwareAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
}
}Example HTTP response
Response 200
{
"dellEmcSupportAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
},
"vmwareAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
}
}Response 202
{
"dellEmcSupportAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
},
"vmwareAccount" : {
"message" : "string",
"password" : "string",
"status" : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
"username" : "string"
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9. Domains
APIs for managing Domains
3.9.1. Create a Domain
POST /v1/domains
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
domainCreationSpec |
Domain creation data |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains
Request body
{
"computeSpec" : {
"clusterSpecs" : [ {
"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" : true
}
},
"clusterImageId" : "string",
"datastoreSpec" : {
"nfsDatastoreSpecs" : [ {
"datastoreName" : "string",
"nasVolume" : {
"path" : "string",
"readOnly" : true,
"serverName" : [ "string" ],
"userTag" : "string"
}
} ],
"vmfsDatastoreSpec" : {
"fcSpec" : [ {
"datastoreName" : "string"
} ]
},
"vsanDatastoreSpec" : {
"datastoreName" : "string",
"dedupAndCompressionEnabled" : true,
"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" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"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" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
}
}
},
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
},
"skipThumbprintValidation" : true,
"vxRailDetails" : {
"adminCredentials" : {
"credentialType" : "One among: SSH",
"password" : "string",
"username" : "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"
}
} ],
"skipFailedHosts" : false
},
"domainName" : "string",
"nsxTSpec" : {
"formFactor" : "string",
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"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"
},
"vcenterSpec" : {
"datacenterName" : "string",
"name" : "string",
"networkDetailsSpec" : {
"dnsName" : "string",
"gateway" : "string",
"ipAddress" : "string",
"subnetMask" : "string"
},
"rootPassword" : "string",
"storageSize" : "One among:lstorage, xlstorage",
"vmSize" : "One among:xlarge, large, medium, small, tiny"
}
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.2. Get the Domains
GET /v1/domains
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
type |
The type of the domain |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains
Example HTTP response
Response 200
{
"elements" : [ {
"capacity" : {
"cpu" : {
"total" : {
"unit" : "Hz",
"value" : 0.0
},
"used" : {
"unit" : "Hz",
"value" : 0.0
}
},
"memory" : {
"total" : {
"unit" : "B",
"value" : 0.0
},
"used" : {
"unit" : "B",
"value" : 0.0
}
},
"storage" : {
"total" : {
"unit" : "B",
"value" : 0.0
},
"used" : {
"unit" : "B",
"value" : 0.0
}
}
},
"clusters" : [ {
"id" : "string"
} ],
"id" : "string",
"name" : "string",
"nsxtCluster" : {
"id" : "string",
"vip" : "string",
"vipFqdn" : "string"
},
"status" : "string",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"type" : "string",
"vcenters" : [ {
"fqdn" : "string",
"id" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.3. Validate the input spec for domains operations
POST /v1/domains/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
domainCreationSpec |
Domain Creation Spec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/validations
Request body
{
"computeSpec" : {
"clusterSpecs" : [ {
"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" : true
}
},
"clusterImageId" : "string",
"datastoreSpec" : {
"nfsDatastoreSpecs" : [ {
"datastoreName" : "string",
"nasVolume" : {
"path" : "string",
"readOnly" : true,
"serverName" : [ "string" ],
"userTag" : "string"
}
} ],
"vmfsDatastoreSpec" : {
"fcSpec" : [ {
"datastoreName" : "string"
} ]
},
"vsanDatastoreSpec" : {
"datastoreName" : "string",
"dedupAndCompressionEnabled" : true,
"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" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"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" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
}
}
},
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
},
"skipThumbprintValidation" : true,
"vxRailDetails" : {
"adminCredentials" : {
"credentialType" : "One among: SSH",
"password" : "string",
"username" : "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"
}
} ],
"skipFailedHosts" : false
},
"domainName" : "string",
"nsxTSpec" : {
"formFactor" : "string",
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"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"
},
"vcenterSpec" : {
"datacenterName" : "string",
"name" : "string",
"networkDetailsSpec" : {
"dnsName" : "string",
"gateway" : "string",
"ipAddress" : "string",
"subnetMask" : "string"
},
"rootPassword" : "string",
"storageSize" : "One among:lstorage, xlstorage",
"vmSize" : "One among:xlarge, large, medium, small, tiny"
}
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.4. Get the status of the validations for domain related operations
GET /v1/domains/validations/{id}
Description
Gets the status of given domain create validation workflow by given validation id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
VxRail Domain validation id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.5. Get all cluster criteria
GET /v1/domains/{domainId}/clusters/criteria
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/clusters/criteria
Example HTTP response
Response 200
{
"elements" : [ {
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.9.6. Get a criterion to query for cluster
GET /v1/domains/{domainId}/clusters/criteria/{name}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Path |
name |
Criteria Name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Criterion Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/clusters/criteria/string
Example HTTP response
Response 200
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.7. Post clusters query
POST /v1/domains/{domainId}/clusters/queries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Body |
clusterCriterion |
clusterCriterion |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/clusters/queries
Request body
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"
}Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ],
"id" : "string",
"isDefault" : true,
"isStretched" : true,
"name" : "string",
"primaryDatastoreName" : "string",
"primaryDatastoreType" : "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.8. Get clusters query response
GET /v1/domains/{domainId}/clusters/queries/{queryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Path |
queryId |
Query ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
404 |
Query Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/clusters/queries/string
Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ],
"id" : "string",
"isDefault" : true,
"isStretched" : true,
"name" : "string",
"primaryDatastoreName" : "string",
"primaryDatastoreType" : "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.9. Post a cluster query
POST /v1/domains/{domainId}/clusters/{clusterName}/queries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clusterName |
Cluster Name |
string |
Path |
domainId |
Domain ID |
string |
Body |
clusterCriterion |
clusterCriterion |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/clusters/string/queries
Request body
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"
}Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ],
"id" : "string",
"isDefault" : true,
"isStretched" : true,
"name" : "string",
"primaryDatastoreName" : "string",
"primaryDatastoreType" : "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.10. Get cluster query response
GET /v1/domains/{domainId}/clusters/{clusterName}/queries/{queryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clusterName |
Cluster Name |
string |
Path |
domainId |
Domain ID |
string |
Path |
queryId |
Query ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
404 |
Query Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/clusters/string/queries/string
Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"hosts" : [ {
"azName" : "string",
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"vmNics" : [ {
"isActive" : true,
"isAutoNegotiateSupported" : true,
"isInUse" : true,
"linkSpeedMB" : 0,
"name" : "string"
} ]
} ],
"id" : "string",
"isDefault" : true,
"isStretched" : true,
"name" : "string",
"primaryDatastoreName" : "string",
"primaryDatastoreType" : "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.11. Get a Domain
GET /v1/domains/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Domain not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string
Example HTTP response
Response 200
{
"capacity" : {
"cpu" : {
"total" : {
"unit" : "Hz",
"value" : 0.0
},
"used" : {
"unit" : "Hz",
"value" : 0.0
}
},
"memory" : {
"total" : {
"unit" : "B",
"value" : 0.0
},
"used" : {
"unit" : "B",
"value" : 0.0
}
},
"storage" : {
"total" : {
"unit" : "B",
"value" : 0.0
},
"used" : {
"unit" : "B",
"value" : 0.0
}
}
},
"clusters" : [ {
"id" : "string"
} ],
"id" : "string",
"name" : "string",
"nsxtCluster" : {
"id" : "string",
"vip" : "string",
"vipFqdn" : "string"
},
"status" : "string",
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"type" : "string",
"vcenters" : [ {
"fqdn" : "string",
"id" : "string"
} ]
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.12. Delete a Domain if it has been previously initialized for deletion
DELETE /v1/domains/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.13. Update a Domain
PATCH /v1/domains/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Body |
domainUpdateSpec |
Domain Update Data |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
202 |
Accepted |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string
Request body
{
"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" : true
}
},
"clusterImageId" : "string",
"datastoreSpec" : {
"nfsDatastoreSpecs" : [ {
"datastoreName" : "string",
"nasVolume" : {
"path" : "string",
"readOnly" : true,
"serverName" : [ "string" ],
"userTag" : "string"
}
} ],
"vmfsDatastoreSpec" : {
"fcSpec" : [ {
"datastoreName" : "string"
} ]
},
"vsanDatastoreSpec" : {
"datastoreName" : "string",
"dedupAndCompressionEnabled" : true,
"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" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"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" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
}
}
},
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
},
"skipThumbprintValidation" : true,
"vxRailDetails" : {
"adminCredentials" : {
"credentialType" : "One among: SSH",
"password" : "string",
"username" : "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" : true,
"name" : "string",
"nsxTSpec" : {
"formFactor" : "string",
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"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"
}
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.14. Get Endpoints of a Domain
GET /v1/domains/{id}/endpoints
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Domain not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/endpoints
Example HTTP response
Response 200
{
"elements" : [ {
"type" : "One among: PSC, VCENTER, NSX_MANAGER, NSX_T_MANAGER, VRLI, VRA, VROPS, WSA, VRSLCM",
"url" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.15. Get Tags assigned to Domain
GET /v1/domains/{id}/tags
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/tags
Example HTTP response
Response 200
{
"elements" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.16. Assign Tags to Domain
POST /v1/domains/{id}/tags/attach
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Body |
tagsForObjectSpec |
tagsForObjectSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/tags/attach
Request body
{
"object_id" : {
"id" : "string",
"type" : "string"
},
"tag_ids" : [ "string" ]
}Example HTTP response
Response 200
{
"defaultErrorMessages" : [ "string" ],
"success" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.17. get Attachable Tags to Domain
GET /v1/domains/{id}/tags/attachable-tags
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/tags/attachable-tags
Example HTTP response
Response 200
{
"elements" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.18. Detach Tags From Domain
POST /v1/domains/{id}/tags/detach
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Body |
tagsForObjectSpec |
tagsForObjectSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/tags/detach
Request body
{
"object_id" : {
"id" : "string",
"type" : "string"
},
"tag_ids" : [ "string" ]
}Example HTTP response
Response 200
{
"defaultErrorMessages" : [ "string" ],
"success" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.19. Get Domain Tag Manager Url
GET /v1/domains/{id}/tags/tag-manager
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/tags/tag-manager
Example HTTP response
Response 200
{
"tagManagerUrl" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.20. Validate the input spec for domain update operations
POST /v1/domains/{id}/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Domain ID |
string |
Body |
domainUpdateSpec |
Domain Update Spec Validation |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/validations
Request body
{
"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" : true
}
},
"clusterImageId" : "string",
"datastoreSpec" : {
"nfsDatastoreSpecs" : [ {
"datastoreName" : "string",
"nasVolume" : {
"path" : "string",
"readOnly" : true,
"serverName" : [ "string" ],
"userTag" : "string"
}
} ],
"vmfsDatastoreSpec" : {
"fcSpec" : [ {
"datastoreName" : "string"
} ]
},
"vsanDatastoreSpec" : {
"datastoreName" : "string",
"dedupAndCompressionEnabled" : true,
"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" : {
"vmNics" : [ {
"id" : "string",
"moveToNvds" : true,
"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" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
}
}
},
"vdsSpecs" : [ {
"isUsedByNsxt" : true,
"name" : "string",
"niocBandwidthAllocationSpecs" : [ {
"niocTrafficResourceAllocation" : {
"limit" : 0,
"reservation" : 0,
"sharesInfo" : {
"level" : "One among: low, normal, high, custom",
"shares" : 0
}
},
"type" : "string"
} ],
"portGroupSpecs" : [ {
"activeUplinks" : [ "string" ],
"name" : "string",
"transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
} ]
} ]
},
"skipThumbprintValidation" : true,
"vxRailDetails" : {
"adminCredentials" : {
"credentialType" : "One among: SSH",
"password" : "string",
"username" : "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" : true,
"name" : "string",
"nsxTSpec" : {
"formFactor" : "string",
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"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"
}
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.9.21. Get the status of the validations for domain related operations
GET /v1/domains/{id}/validations/{validationId}
Description
Gets the status of given domain update validation workflow by given validation id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
VxRail Domain ID |
string |
Path |
validationId |
VxRail Domain validation id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domains/string/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.10. FIPS Mode Details
APIs for getting FIPS mode details
3.10.1. Get VCF security configuration
GET /v1/system/security/fips
Description
Retrieve VCF security FIPS mode.
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/security/fips
Example HTTP response
Response 200
{
"enabled" : true
}3.11. Hosts
APIs for managing Hosts
3.11.1. Get the Hosts
GET /v1/hosts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
clusterId |
ID of the Cluster |
string |
Query |
datastoreName |
Name of the datastore |
string |
Query |
domainId |
ID of the Domain |
string |
Query |
networkpoolId |
ID of the Network pool |
string |
Query |
status |
Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE |
string |
Query |
storageType |
Type of the Storage.VMFS_FC |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts
Example HTTP response
Response 200
{
"elements" : [ {
"bundleRepoDatastore" : "string",
"cluster" : {
"id" : "string"
},
"compatibleStorageType" : "string",
"cpu" : {
"cores" : 0,
"cpuCores" : [ {
"frequencyMHz" : 0.0,
"manufacturer" : "string",
"model" : "string"
} ],
"frequencyMHz" : 0.0,
"usedFrequencyMHz" : 0.0
},
"domain" : {
"id" : "string",
"name" : "string"
},
"esxiVersion" : "string",
"fqdn" : "string",
"hardwareModel" : "string",
"hardwareVendor" : "string",
"hybrid" : true,
"id" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
} ],
"isPrimary" : true,
"memory" : {
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"networkpool" : {
"id" : "string",
"name" : "string"
},
"physicalNics" : [ {
"deviceName" : "string",
"macAddress" : "string",
"speed" : 0
} ],
"serialNumber" : {
"present" : true
},
"sshThumbprint" : {
"present" : true
},
"sslThumbprint" : {
"present" : true
},
"status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage" : {
"disks" : [ {
"capacityMB" : 0.0,
"diskType" : "One among: HDD, FLASH",
"manufacturer" : "string",
"model" : "string"
} ],
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.2. Get all criteria
GET /v1/hosts/criteria
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/criteria
Example HTTP response
Response 200
{
"elements" : [ {
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.11.3. Get a criterion
GET /v1/hosts/criteria/{name}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Criterion Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/criteria/string
Example HTTP response
Response 200
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.4. Post a query
POST /v1/hosts/queries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
hostCriterion |
hostCriterion |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/queries
Request body
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"bundleRepoDatastore" : "string",
"cluster" : {
"id" : "string"
},
"compatibleStorageType" : "string",
"cpu" : {
"cores" : 0,
"cpuCores" : [ {
"frequencyMHz" : 0.0,
"manufacturer" : "string",
"model" : "string"
} ],
"frequencyMHz" : 0.0,
"usedFrequencyMHz" : 0.0
},
"domain" : {
"id" : "string",
"name" : "string"
},
"esxiVersion" : "string",
"fqdn" : "string",
"hardwareModel" : "string",
"hardwareVendor" : "string",
"hybrid" : true,
"id" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
} ],
"isPrimary" : true,
"memory" : {
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"networkpool" : {
"id" : "string",
"name" : "string"
},
"physicalNics" : [ {
"deviceName" : "string",
"macAddress" : "string",
"speed" : 0
} ],
"serialNumber" : {
"present" : true
},
"sshThumbprint" : {
"present" : true
},
"sslThumbprint" : {
"present" : true
},
"status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage" : {
"disks" : [ {
"capacityMB" : 0.0,
"diskType" : "One among: HDD, FLASH",
"manufacturer" : "string",
"model" : "string"
} ],
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.5. Get query response
GET /v1/hosts/queries/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
404 |
Query Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/queries/string
Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"bundleRepoDatastore" : "string",
"cluster" : {
"id" : "string"
},
"compatibleStorageType" : "string",
"cpu" : {
"cores" : 0,
"cpuCores" : [ {
"frequencyMHz" : 0.0,
"manufacturer" : "string",
"model" : "string"
} ],
"frequencyMHz" : 0.0,
"usedFrequencyMHz" : 0.0
},
"domain" : {
"id" : "string",
"name" : "string"
},
"esxiVersion" : "string",
"fqdn" : "string",
"hardwareModel" : "string",
"hardwareVendor" : "string",
"hybrid" : true,
"id" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
} ],
"isPrimary" : true,
"memory" : {
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"networkpool" : {
"id" : "string",
"name" : "string"
},
"physicalNics" : [ {
"deviceName" : "string",
"macAddress" : "string",
"speed" : 0
} ],
"serialNumber" : {
"present" : true
},
"sshThumbprint" : {
"present" : true
},
"sslThumbprint" : {
"present" : true
},
"status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage" : {
"disks" : [ {
"capacityMB" : 0.0,
"diskType" : "One among: HDD, FLASH",
"manufacturer" : "string",
"model" : "string"
} ],
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.6. Get a Host
GET /v1/hosts/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
404 |
Host Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/string
Example HTTP response
Response 200
{
"bundleRepoDatastore" : "string",
"cluster" : {
"id" : "string"
},
"compatibleStorageType" : "string",
"cpu" : {
"cores" : 0,
"cpuCores" : [ {
"frequencyMHz" : 0.0,
"manufacturer" : "string",
"model" : "string"
} ],
"frequencyMHz" : 0.0,
"usedFrequencyMHz" : 0.0
},
"domain" : {
"id" : "string",
"name" : "string"
},
"esxiVersion" : "string",
"fqdn" : "string",
"hardwareModel" : "string",
"hardwareVendor" : "string",
"hybrid" : true,
"id" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
} ],
"isPrimary" : true,
"memory" : {
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"networkpool" : {
"id" : "string",
"name" : "string"
},
"physicalNics" : [ {
"deviceName" : "string",
"macAddress" : "string",
"speed" : 0
} ],
"serialNumber" : {
"present" : true
},
"sshThumbprint" : {
"present" : true
},
"sslThumbprint" : {
"present" : true
},
"status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage" : {
"disks" : [ {
"capacityMB" : 0.0,
"diskType" : "One among: HDD, FLASH",
"manufacturer" : "string",
"model" : "string"
} ],
"totalCapacityMB" : 0.0,
"usedCapacityMB" : 0.0
},
"tags" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.7. Get Tags assigned to Host
GET /v1/hosts/{id}/tags
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/string/tags
Example HTTP response
Response 200
{
"elements" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.8. Assign Tags to Host
POST /v1/hosts/{id}/tags/attach
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Body |
tagsForObjectSpec |
tagsForObjectSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/string/tags/attach
Request body
{
"object_id" : {
"id" : "string",
"type" : "string"
},
"tag_ids" : [ "string" ]
}Example HTTP response
Response 200
{
"defaultErrorMessages" : [ "string" ],
"success" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.9. get Attachable Tags to Host
GET /v1/hosts/{id}/tags/attachable-tags
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/string/tags/attachable-tags
Example HTTP response
Response 200
{
"elements" : [ {
"categoryId" : "string",
"categoryName" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.10. Detach Tags From Host
POST /v1/hosts/{id}/tags/detach
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Body |
tagsForObjectSpec |
tagsForObjectSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/string/tags/detach
Request body
{
"object_id" : {
"id" : "string",
"type" : "string"
},
"tag_ids" : [ "string" ]
}Example HTTP response
Response 200
{
"defaultErrorMessages" : [ "string" ],
"success" : true
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.11.11. Get Host Tag Manager Url
GET /v1/hosts/{id}/tags/tag-manager
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Host ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/hosts/string/tags/tag-manager
Example HTTP response
Response 200
{
"tagManagerUrl" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.12. License Keys
APIs for managing License Keys
3.12.1. Add a License Key
POST /v1/license-keys
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
licenseKey |
License key with other attributes |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/license-keys
Request body
{
"description" : "string",
"id" : "string",
"isUnlimited" : true,
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"licenseKeyUsage" : {
"licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
"remaining" : 0,
"total" : 0,
"used" : 0
},
"licenseKeyValidity" : {
"expiryDate" : "string",
"licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
},
"productType" : "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, WCP, HORIZON_VIEW"
}Example HTTP response
Response 200
{
"description" : "string",
"id" : "string",
"isUnlimited" : true,
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"licenseKeyUsage" : {
"licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
"remaining" : 0,
"total" : 0,
"used" : 0
},
"licenseKeyValidity" : {
"expiryDate" : "string",
"licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
},
"productType" : "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, WCP, HORIZON_VIEW"
}Response 201
{
"description" : "string",
"id" : "string",
"isUnlimited" : true,
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"licenseKeyUsage" : {
"licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
"remaining" : 0,
"total" : 0,
"used" : 0
},
"licenseKeyValidity" : {
"expiryDate" : "string",
"licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
},
"productType" : "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, WCP, HORIZON_VIEW"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.12.2. Get the License Keys
GET /v1/license-keys
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
licenseKeyStatus |
Status of a License Key |
< string > array(multi) |
Query |
productType |
Type of a Product |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successful |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/license-keys
Example HTTP response
Response 200
{
"elements" : [ {
"description" : "string",
"id" : "string",
"isUnlimited" : true,
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"licenseKeyUsage" : {
"licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
"remaining" : 0,
"total" : 0,
"used" : 0
},
"licenseKeyValidity" : {
"expiryDate" : "string",
"licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
},
"productType" : "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, WCP, HORIZON_VIEW"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.12.3. Get a License Key by key
GET /v1/license-keys/{key}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
key |
The 29 alpha numeric character license key with hyphens |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successful |
|
404 |
License key not found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/license-keys/string
Example HTTP response
Response 200
{
"description" : "string",
"id" : "string",
"isUnlimited" : true,
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"licenseKeyUsage" : {
"licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
"remaining" : 0,
"total" : 0,
"used" : 0
},
"licenseKeyValidity" : {
"expiryDate" : "string",
"licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
},
"productType" : "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, WCP, HORIZON_VIEW"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.12.4. Delete a License Key
DELETE /v1/license-keys/{key}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
key |
The 29 alpha numeric character license key with hyphens |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No content |
No Content |
404 |
License key not found |
No Content |
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/license-keys/string
Example HTTP response
Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.13. Manifests
APIs for managing LCM Manifests
3.13.1. Save/Load manifest
POST /v1/manifests
Description
Save/Load manifest. Make sure manifest is a valid one. If manifest already exists, it gets overridden.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
manifest |
manifest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
No Content |
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/manifests
Request body
{
"creationTime" : "string",
"publishedDate" : "string",
"recalledBundles" : [ {
"recalledBundleIds" : [ "string" ],
"replacementBundleIds" : [ "string" ],
"replacementBundleStatus" : "One among: NONE, PENDING, READY"
} ],
"releases" : [ {
"bom" : [ {
"additionalMetadata" : "string",
"name" : "string",
"publicName" : "string",
"releaseURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
},
"version" : "string"
} ],
"description" : "string",
"eol" : "string",
"isApplicable" : true,
"minCompatibleVcfVersion" : "string",
"notApplicableReason" : "string",
"patchBundles" : [ {
"bundleElements" : [ "string" ],
"bundleId" : "string",
"bundleType" : "string",
"cumulativeFromVcfVersion" : "string"
} ],
"product" : "string",
"releaseDate" : "string",
"sku" : [ {
"bom" : [ {
"additionalMetadata" : "string",
"name" : "string",
"publicName" : "string",
"releaseURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
},
"version" : "string"
} ],
"description" : "string",
"name" : "string",
"skuSpecificPatchBundles" : [ {
"bundleElements" : [ "string" ],
"bundleId" : "string",
"bundleType" : "string",
"cumulativeFromVcfVersion" : "string"
} ]
} ],
"updates" : [ {
"baseProductVersion" : "string",
"description" : "string",
"id" : "string",
"productName" : "string",
"releaseDate" : "string",
"releaseUpdateURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
}
} ],
"version" : "string"
} ],
"sequenceNumber" : 0,
"version" : 0
}Example HTTP response
Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.13.2. Get manifest
GET /v1/manifests
Description
Get manifest. There should be only one valid manifest in the System.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Manifest Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/manifests
Example HTTP response
Response 200
{
"creationTime" : "string",
"publishedDate" : "string",
"recalledBundles" : [ {
"recalledBundleIds" : [ "string" ],
"replacementBundleIds" : [ "string" ],
"replacementBundleStatus" : "One among: NONE, PENDING, READY"
} ],
"releases" : [ {
"bom" : [ {
"additionalMetadata" : "string",
"name" : "string",
"publicName" : "string",
"releaseURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
},
"version" : "string"
} ],
"description" : "string",
"eol" : "string",
"isApplicable" : true,
"minCompatibleVcfVersion" : "string",
"notApplicableReason" : "string",
"patchBundles" : [ {
"bundleElements" : [ "string" ],
"bundleId" : "string",
"bundleType" : "string",
"cumulativeFromVcfVersion" : "string"
} ],
"product" : "string",
"releaseDate" : "string",
"sku" : [ {
"bom" : [ {
"additionalMetadata" : "string",
"name" : "string",
"publicName" : "string",
"releaseURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
},
"version" : "string"
} ],
"description" : "string",
"name" : "string",
"skuSpecificPatchBundles" : [ {
"bundleElements" : [ "string" ],
"bundleId" : "string",
"bundleType" : "string",
"cumulativeFromVcfVersion" : "string"
} ]
} ],
"updates" : [ {
"baseProductVersion" : "string",
"description" : "string",
"id" : "string",
"productName" : "string",
"releaseDate" : "string",
"releaseUpdateURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
}
} ],
"version" : "string"
} ],
"sequenceNumber" : 0,
"version" : 0
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14. NSX-T Clusters
APIs for managing NSX-T Clusters
3.14.1. Get the NSX-T clusters
GET /v1/nsxt-clusters
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
isShareable |
filter NSX-T clusters which can be shared for domain creation |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters
Example HTTP response
Response 200
{
"elements" : [ {
"domains" : [ {
"id" : "string",
"name" : "string"
} ],
"id" : "string",
"isShareable" : true,
"isShared" : true,
"isVlcmCompatible" : true,
"nodes" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string"
} ],
"status" : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
"version" : "string",
"vip" : "string",
"vipFqdn" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14.2. Get all NSX-T criteria
GET /v1/nsxt-clusters/criteria
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/criteria
Example HTTP response
Response 200
{
"elements" : [ {
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "NSXT_CLUSTERS_WITH_STATUS"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.14.3. Get a NSX-T criterion
GET /v1/nsxt-clusters/criteria/{name}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Criterion Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/criteria/string
Example HTTP response
Response 200
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "NSXT_CLUSTERS_WITH_STATUS"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14.4. validateIpPool
POST /v1/nsxt-clusters/ip-address-pools/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
nsxtIpAddressPoolValidationSpec |
nsxtIpAddressPoolValidationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/ip-address-pools/validations
Request body
{
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
},
"nsxtClusterId" : "string"
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}3.14.5. getValidationResult
GET /v1/nsxt-clusters/ip-address-pools/validations/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/ip-address-pools/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}3.14.6. Post a query
POST /v1/nsxt-clusters/queries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
nsxtCriterion |
nsxtCriterion |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/queries
Request body
{
"arguments" : {
"string" : "string"
},
"description" : "string",
"name" : "NSXT_CLUSTERS_WITH_STATUS"
}Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"domains" : [ {
"id" : "string",
"name" : "string"
} ],
"id" : "string",
"isShareable" : true,
"isShared" : true,
"isVlcmCompatible" : true,
"nodes" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string"
} ],
"status" : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
"version" : "string",
"vip" : "string",
"vipFqdn" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 202
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"domains" : [ {
"id" : "string",
"name" : "string"
} ],
"id" : "string",
"isShareable" : true,
"isShared" : true,
"isVlcmCompatible" : true,
"nodes" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string"
} ],
"status" : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
"version" : "string",
"vip" : "string",
"vipFqdn" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14.7. Get NSX-T cluster query response
GET /v1/nsxt-clusters/queries/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
202 |
Accepted |
|
400 |
Bad Request |
|
404 |
Query Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/queries/string
Example HTTP response
Response 200
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"domains" : [ {
"id" : "string",
"name" : "string"
} ],
"id" : "string",
"isShareable" : true,
"isShared" : true,
"isVlcmCompatible" : true,
"nodes" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string"
} ],
"status" : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
"version" : "string",
"vip" : "string",
"vipFqdn" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 202
{
"queryInfo" : {
"completed" : true,
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"failure" : true,
"processing" : true,
"queryId" : "string",
"status" : "string"
},
"result" : {
"elements" : [ {
"domains" : [ {
"id" : "string",
"name" : "string"
} ],
"id" : "string",
"isShareable" : true,
"isShared" : true,
"isVlcmCompatible" : true,
"nodes" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string"
} ],
"status" : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
"version" : "string",
"vip" : "string",
"vipFqdn" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14.8. Get a NSX-T cluster
GET /v1/nsxt-clusters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
NSX-T cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
NSX-T cluster not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/string
Example HTTP response
Response 200
{
"domains" : [ {
"id" : "string",
"name" : "string"
} ],
"id" : "string",
"isShareable" : true,
"isShared" : true,
"isVlcmCompatible" : true,
"nodes" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string"
} ],
"status" : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
"version" : "string",
"vip" : "string",
"vipFqdn" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14.9. Get the NSX-T IP address pools
GET /v1/nsxt-clusters/{nsxt-cluster-id}/ip-address-pools
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
nsxt-cluster-id |
NSX-T cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
IP address pools not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/string/ip-address-pools
Example HTTP response
Response 200
{
"availableIpAddresses" : 0,
"blockSubnets" : [ {
"cidr" : "string",
"gatewayAssigned" : true,
"size" : 0
} ],
"description" : "string",
"name" : "string",
"staticSubnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ],
"totalIpAddresses" : 0
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.14.10. Get a NSX-T IP address pool
GET /v1/nsxt-clusters/{nsxt-cluster-id}/ip-address-pools/{name}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
IP address pool name |
string |
Path |
nsxt-cluster-id |
NSX-T cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
IP address pool not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/nsxt-clusters/string/ip-address-pools/string
Example HTTP response
Response 200
{
"availableIpAddresses" : 0,
"blockSubnets" : [ {
"cidr" : "string",
"gatewayAssigned" : true,
"size" : 0
} ],
"description" : "string",
"name" : "string",
"staticSubnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ],
"totalIpAddresses" : 0
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15. NsxTEdgeClusters
APIs for managing NSX-T Edge Clusters
3.15.1. Create an Edge Cluster
POST /v1/edge-clusters
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
edgeCreationSpec |
NSX-T Edge cluster creation data |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters
Request body
{
"asn" : 0,
"edgeAdminPassword" : "string",
"edgeAuditPassword" : "string",
"edgeClusterName" : "string",
"edgeClusterProfileSpec" : {
"bfdAllowedHop" : 0,
"bfdDeclareDeadMultiple" : 0,
"bfdProbeInterval" : 0,
"edgeClusterProfileName" : "string",
"standbyRelocationThreshold" : 0
},
"edgeClusterProfileType" : "One among: DEFAULT, CUSTOM",
"edgeClusterType" : "One among: NSX-T",
"edgeFormFactor" : "One among: XLARGE, LARGE, MEDIUM, SMALL",
"edgeNodeSpecs" : [ {
"clusterId" : "string",
"edgeNodeName" : "string",
"edgeTep1IP" : "string",
"edgeTep2IP" : "string",
"edgeTepGateway" : "string",
"edgeTepVlan" : 0,
"firstNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"interRackCluster" : true,
"managementGateway" : "string",
"managementIP" : "string",
"secondNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"uplinkNetwork" : [ {
"asnPeer" : 0,
"bgpPeerPassword" : "string",
"bgpPeers" : [ {
"asn" : 0,
"ip" : "string",
"password" : "string"
} ],
"peerIP" : "string",
"uplinkInterfaceIP" : "string",
"uplinkVlan" : 0
} ]
} ],
"edgeRootPassword" : "string",
"internalTransitSubnets" : [ "string" ],
"mtu" : 0,
"tier0Name" : "string",
"tier0RoutingType" : "One among: EBGP, STATIC",
"tier0ServicesHighAvailability" : "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
"tier1Name" : "string",
"transitSubnets" : [ "string" ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15.2. Get the Edge Clusters
GET /v1/edge-clusters
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
clusterId |
Pass an optional vSphere Cluster ID to fetch edge clusters associated with the vSphere Cluster |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters
Example HTTP response
Response 200
{
"elements" : [ {
"clusters" : [ {
"id" : "string"
} ],
"edgeNodes" : [ {
"hostName" : "string",
"id" : "string"
} ],
"id" : "string",
"name" : "string",
"nsxtCluster" : {
"id" : "string",
"vip" : "string",
"vipFqdn" : "string"
}
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15.3. Validate an Edge Cluster spec
POST /v1/edge-clusters/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
edgeCreationSpec |
NSX-T Edge cluster creation data to be validated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters/validations
Request body
{
"asn" : 0,
"edgeAdminPassword" : "string",
"edgeAuditPassword" : "string",
"edgeClusterName" : "string",
"edgeClusterProfileSpec" : {
"bfdAllowedHop" : 0,
"bfdDeclareDeadMultiple" : 0,
"bfdProbeInterval" : 0,
"edgeClusterProfileName" : "string",
"standbyRelocationThreshold" : 0
},
"edgeClusterProfileType" : "One among: DEFAULT, CUSTOM",
"edgeClusterType" : "One among: NSX-T",
"edgeFormFactor" : "One among: XLARGE, LARGE, MEDIUM, SMALL",
"edgeNodeSpecs" : [ {
"clusterId" : "string",
"edgeNodeName" : "string",
"edgeTep1IP" : "string",
"edgeTep2IP" : "string",
"edgeTepGateway" : "string",
"edgeTepVlan" : 0,
"firstNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"interRackCluster" : true,
"managementGateway" : "string",
"managementIP" : "string",
"secondNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"uplinkNetwork" : [ {
"asnPeer" : 0,
"bgpPeerPassword" : "string",
"bgpPeers" : [ {
"asn" : 0,
"ip" : "string",
"password" : "string"
} ],
"peerIP" : "string",
"uplinkInterfaceIP" : "string",
"uplinkVlan" : 0
} ]
} ],
"edgeRootPassword" : "string",
"internalTransitSubnets" : [ "string" ],
"mtu" : 0,
"tier0Name" : "string",
"tier0RoutingType" : "One among: EBGP, STATIC",
"tier0ServicesHighAvailability" : "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
"tier1Name" : "string",
"transitSubnets" : [ "string" ]
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 202
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15.4. Get the Edge Cluster spec validation
GET /v1/edge-clusters/validations/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The validation ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal server error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15.5. Get an Edge Cluster
GET /v1/edge-clusters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Edge Cluster ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Edge Cluster not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters/string
Example HTTP response
Response 200
{
"clusters" : [ {
"id" : "string"
} ],
"edgeNodes" : [ {
"hostName" : "string",
"id" : "string"
} ],
"id" : "string",
"name" : "string",
"nsxtCluster" : {
"id" : "string",
"vip" : "string",
"vipFqdn" : "string"
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15.6. Expand or Shrink an NSX-T Edge Cluster
PATCH /v1/edge-clusters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Edge Cluster ID |
string |
Body |
edgeClusterUpdateSpec |
NSX-T Edge cluster update specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
|
501 |
Not Implemented |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters/string
Request body
{
"edgeClusterExpansionSpec" : {
"additionalTier1Names" : [ "string" ],
"edgeNodeAdminPassword" : "string",
"edgeNodeAuditPassword" : "string",
"edgeNodeRootPassword" : "string",
"edgeNodeSpecs" : [ {
"clusterId" : "string",
"edgeNodeName" : "string",
"edgeTep1IP" : "string",
"edgeTep2IP" : "string",
"edgeTepGateway" : "string",
"edgeTepVlan" : 0,
"firstNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"interRackCluster" : true,
"managementGateway" : "string",
"managementIP" : "string",
"secondNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"uplinkNetwork" : [ {
"asnPeer" : 0,
"bgpPeerPassword" : "string",
"bgpPeers" : [ {
"asn" : 0,
"ip" : "string",
"password" : "string"
} ],
"peerIP" : "string",
"uplinkInterfaceIP" : "string",
"uplinkVlan" : 0
} ]
} ]
},
"edgeClusterShrinkageSpec" : {
"edgeNodeIds" : [ "string" ]
},
"operation" : "One among: EXPANSION, SHRINKAGE"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 501
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.15.7. Validate an NSX-T Edge Cluster update spec
POST /v1/edge-clusters/{id}/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
NSX-T Edge cluster id |
string |
Body |
edgeClusterUpdateSpec |
NSX-T Edge Cluster Update spec to be validated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/edge-clusters/string/validations
Request body
{
"edgeClusterExpansionSpec" : {
"additionalTier1Names" : [ "string" ],
"edgeNodeAdminPassword" : "string",
"edgeNodeAuditPassword" : "string",
"edgeNodeRootPassword" : "string",
"edgeNodeSpecs" : [ {
"clusterId" : "string",
"edgeNodeName" : "string",
"edgeTep1IP" : "string",
"edgeTep2IP" : "string",
"edgeTepGateway" : "string",
"edgeTepVlan" : 0,
"firstNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"interRackCluster" : true,
"managementGateway" : "string",
"managementIP" : "string",
"secondNsxVdsUplink" : "One among: uplink1, uplink2, uplink3, uplink4",
"uplinkNetwork" : [ {
"asnPeer" : 0,
"bgpPeerPassword" : "string",
"bgpPeers" : [ {
"asn" : 0,
"ip" : "string",
"password" : "string"
} ],
"peerIP" : "string",
"uplinkInterfaceIP" : "string",
"uplinkVlan" : 0
} ]
} ]
},
"edgeClusterShrinkageSpec" : {
"edgeNodeIds" : [ "string" ]
},
"operation" : "One among: EXPANSION, SHRINKAGE"
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 202
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.16. Releases
APIs for managing Releases
3.16.1. Get Releases.
GET /v1/releases
Description
Get all Releases, with option to get current release for a domain, get release by version or get future releases for a versionor get all the applicable target release.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
applicableForVersion |
Release version to get applicable releases |
string |
Query |
applicableForVxRailVersion |
Release VxRail version to get applicable releases |
string |
Query |
domainId |
Domain ID to get current release of the domain |
string |
Query |
getFutureReleases |
Get all future releases for a given domain |
boolean |
Query |
versionEq |
Release version to get its release |
string |
Query |
versionGt |
Release version to get its future releases |
string |
Query |
vxRailVersionEq |
Release VxRail version to get its release |
string |
Query |
vxRailVersionGt |
Release vxrail version to get its future releases |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Release not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/releases
Example HTTP response
Response 200
{
"elements" : [ {
"bom" : [ {
"additionalMetadata" : "string",
"name" : "string",
"publicName" : "string",
"releaseURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
},
"version" : "string"
} ],
"description" : "string",
"eol" : "string",
"isApplicable" : true,
"minCompatibleVcfVersion" : "string",
"notApplicableReason" : "string",
"patchBundles" : [ {
"bundleElements" : [ "string" ],
"bundleId" : "string",
"bundleType" : "string",
"cumulativeFromVcfVersion" : "string"
} ],
"product" : "string",
"releaseDate" : "string",
"sku" : [ {
"bom" : [ {
"additionalMetadata" : "string",
"name" : "string",
"publicName" : "string",
"releaseURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
},
"version" : "string"
} ],
"description" : "string",
"name" : "string",
"skuSpecificPatchBundles" : [ {
"bundleElements" : [ "string" ],
"bundleId" : "string",
"bundleType" : "string",
"cumulativeFromVcfVersion" : "string"
} ]
} ],
"updates" : [ {
"baseProductVersion" : "string",
"description" : "string",
"id" : "string",
"productName" : "string",
"releaseDate" : "string",
"releaseUpdateURL" : {
"authority" : "string",
"content" : "object",
"defaultPort" : 0,
"file" : "string",
"host" : "string",
"path" : "string",
"port" : 0,
"protocol" : "string",
"query" : "string",
"ref" : "string",
"userInfo" : "string"
}
} ],
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17. SDDC
APIs for managing SDDC. The /v1/sddcs APIs are available only on the Cloud Builder appliance.
3.17.1. Create SDDC
POST /v1/sddcs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
sddcSpec |
SDDC specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Success |
|
400 |
SDDC already exists, Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs
Request body
{
"ceipEnabled" : true,
"certificatesPassphrase" : "string",
"clusterSpec" : {
"clusterEvcMode" : "string",
"clusterName" : "string",
"hostFailuresToTolerate" : 0,
"hostProfileComplianceCheckHour" : 0,
"hostProfileComplianceCheckMinute" : 0,
"hosts" : [ "string" ],
"personalityName" : "string",
"resourcePoolSpecs" : [ {
"cpuLimit" : 0,
"cpuReservationExpandable" : true,
"cpuReservationMhz" : 0,
"cpuReservationPercentage" : 0,
"cpuSharesLevel" : "custom",
"cpuSharesValue" : 0,
"memoryLimit" : 0,
"memoryReservationExpandable" : true,
"memoryReservationMb" : 0,
"memoryReservationPercentage" : 0,
"memorySharesLevel" : "custom",
"memorySharesValue" : 0,
"name" : "string",
"type" : "management"
} ],
"vmFolders" : "One among:MANAGEMENT, NETWORKING, EDGENODES"
},
"dnsSpec" : {
"domain" : "vmware.com",
"nameserver" : "172.0.0.4",
"secondaryNameserver" : "172.0.0.5",
"subdomain" : "vcf.vmware.com"
},
"dvSwitchVersion" : "One among:6.5.0, 7.0.0, 7.0.2, 7.0.3",
"dvsSpecs" : [ {
"dvsName" : "string",
"isUsedByNsxt" : true,
"mtu" : 0,
"networks" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs",
"niocSpecs" : [ {
"trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
"value" : "string"
} ],
"vmnics" : [ "string" ]
} ],
"esxLicense" : "string",
"excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup, EBGP",
"fipsEnabled" : true,
"hostSpecs" : [ {
"association" : "string",
"credentials" : {
"password" : "string",
"username" : "root"
},
"hostname" : "esx-1",
"ipAddressPrivate" : {
"cidr" : "172.0.0.0/24",
"gateway" : "192.168.0.1",
"ipAddress" : "192.168.0.123",
"subnet" : "255.255.255.252"
},
"key" : "string",
"serverId" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vSwitch" : "string",
"vmknicSpecs" : [ {
"ipAddress" : "string",
"macAddress" : "string",
"portgroup" : "One among:VSAN, VMOTION, MANAGEMENT"
} ],
"vswitch" : "string"
} ],
"managementPoolName" : "string",
"networkSpecs" : [ {
"activeUplinks" : [ "string" ],
"excludeIpAddressRanges" : [ "string" ],
"excludeIpaddresses" : [ "string" ],
"gateway" : "string",
"includeIpAddress" : [ "string" ],
"includeIpAddressRanges" : [ {
"endIpAddress" : "192.168.0.128",
"startIpAddress" : "192.168.0.123"
} ],
"mtu" : "string",
"networkType" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type",
"portGroupKey" : "string",
"standbyUplinks" : [ "string" ],
"subnet" : "string",
"subnetMask" : "string",
"teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
"vlanId" : "string"
} ],
"nsxtSpec" : {
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
},
"logicalSegments" : [ {
"name" : "string",
"networkType" : "Oneamong:X_REGION"
} ],
"nsxtAdminPassword" : "string",
"nsxtAuditPassword" : "string",
"nsxtEdgeSpec" : {
"asn" : 0,
"bgpNeighbours" : [ {
"autonomousSystem" : 0,
"forwardingIp" : "192.168.0.123",
"holdDownTimeSeconds" : 0,
"keepAliveTimeSeconds" : 0,
"neighbourIp" : "192.168.0.123",
"password" : "string",
"protocolIp" : "192.168.0.123",
"weight" : 0
} ],
"edgeAdminPassword" : "string",
"edgeAuditPassword" : "string",
"edgeClusterName" : "string",
"edgeFormFactor" : "Oneamong:SMALL",
"edgeNodeSpecs" : [ {
"edgeNodeHostname" : "string",
"edgeNodeName" : "string",
"edgeVtep1Cidr" : "string",
"edgeVtep2Cidr" : "string",
"interfaces" : [ {
"interfaceCidr" : "string",
"name" : "string"
} ],
"managementCidr" : "string"
} ],
"edgeRootPassword" : "string",
"edgeServicesSpecs" : {
"tier0GatewayName" : "string",
"tier1GatewayName" : "string"
},
"tier0ServicesHighAvailability" : "string"
},
"nsxtLicense" : "string",
"nsxtManagerSize" : "One among:medium, large",
"nsxtManagers" : [ {
"hostname" : "string",
"ip" : "string"
} ],
"overLayTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
},
"rootLoginEnabledForNsxtManager" : true,
"rootNsxtManagerPassword" : "string",
"sshEnabledForNsxtManager" : true,
"transportVlanId" : 0,
"vip" : "string",
"vipFqdn" : "string",
"vlanTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
}
},
"ntpServers" : [ "string" ],
"pscSpecs" : [ {
"adminUserSsoPassword" : "string",
"pscId" : "string",
"pscSsoSpec" : {
"ssoDomain" : "string"
}
} ],
"remoteSiteSpec" : {
"pscAddress" : "string",
"sslThumbprint" : "string",
"vcCredentials" : {
"password" : "string",
"username" : "root"
}
},
"sddcId" : "sfo01-m01",
"sddcManagerSpec" : {
"hostname" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"localUserPassword" : "string",
"netmask" : "string",
"rootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"secondUserCredentials" : {
"password" : "string",
"username" : "root"
}
},
"securitySpec" : {
"esxiCertsMode" : "One among:Custom, VMCA",
"rootCaCerts" : [ {
"alias" : "string",
"certChain" : [ "string" ]
} ]
},
"shouldCleanupVsan" : false,
"skipEsxThumbprintValidation" : true,
"skipGatewayPingValidation" : true,
"taskName" : "workflowconfig/workflowspec-ems.json",
"vcenterSpec" : {
"licenseFile" : "string",
"rootVcenterPassword" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"storageSize" : "One among:lstorage, xlstorage",
"vcenterHostname" : "string",
"vcenterIp" : "string",
"vcenterNetmask" : "string",
"vmSize" : "One among:xlarge, large, medium, small, tiny"
},
"vsanSpec" : {
"datastoreName" : "string",
"hclFile" : "string",
"licenseFile" : "string",
"vsanDedup" : true,
"vsanName" : "string"
},
"vxManagerSpec" : {
"defaultAdminUserCredentials" : {
"password" : "string",
"username" : "root"
},
"defaultRootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vxManagerHostName" : "string"
}
}Example HTTP response
Response 200
{
"creationTimestamp" : "string",
"id" : "string",
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"sddcSubTasks" : [ {
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"localizableDescriptionPack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"processingStateDescription" : "string",
"processingStateName" : "string",
"sddcId" : "123e4567-e89b-42d3-a456-556642440000",
"status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp" : "string"
} ],
"status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}Response 202
{
"creationTimestamp" : "string",
"id" : "string",
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"sddcSubTasks" : [ {
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"localizableDescriptionPack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"processingStateDescription" : "string",
"processingStateName" : "string",
"sddcId" : "123e4567-e89b-42d3-a456-556642440000",
"status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp" : "string"
} ],
"status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.2. Retrieve all SDDCs
GET /v1/sddcs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Accepted |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs
Example HTTP response
Response 200
{
"elements" : [ {
"creationTimestamp" : "string",
"id" : "string",
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"sddcSubTasks" : [ {
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"localizableDescriptionPack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"processingStateDescription" : "string",
"processingStateName" : "string",
"sddcId" : "123e4567-e89b-42d3-a456-556642440000",
"status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp" : "string"
} ],
"status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.3. Get Bringup Info
GET /v1/sddcs/about
Description
GET Method to retrieve information about Bringup app
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
501 |
Not Implemented |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/about
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"status" : "string",
"version" : "string"
}3.17.4. Validate SDDC specification before creation
POST /v1/sddcs/validations
Description
SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
name |
Validation name |
enum (JSON_SPEC_VALIDATION, SECURE_PLATFORM_AUDIT, LICENSE_KEY_VALIDATION, TIME_SYNC_VALIDATION, NETWORK_IP_POOLS_VALIDATION, NETWORK_CONFIG_VALIDATION, NETWORK_CONNECTIVITY_VALIDATION, ESXI_VERSION_VALIDATION, ESXI_HOST_READINESS_VALIDATION, PASSWORDS_VALIDATION, HOST_IP_DNS_VALIDATION, CLOUDBUILDER_READY_VALIDATION, VSAN_AVAILABILITY_VALIDATION, NSXT_NETWORKS_VALIDATION, AVN_NETWORKS_VALIDATION, MANAGEMENT_NETWORKS_VALIDATION) |
Query |
redo |
redo |
boolean |
Body |
sddcSpec |
SDDC specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Accepted |
|
202 |
Success |
|
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/validations
Request body
{
"ceipEnabled" : true,
"certificatesPassphrase" : "string",
"clusterSpec" : {
"clusterEvcMode" : "string",
"clusterName" : "string",
"hostFailuresToTolerate" : 0,
"hostProfileComplianceCheckHour" : 0,
"hostProfileComplianceCheckMinute" : 0,
"hosts" : [ "string" ],
"personalityName" : "string",
"resourcePoolSpecs" : [ {
"cpuLimit" : 0,
"cpuReservationExpandable" : true,
"cpuReservationMhz" : 0,
"cpuReservationPercentage" : 0,
"cpuSharesLevel" : "custom",
"cpuSharesValue" : 0,
"memoryLimit" : 0,
"memoryReservationExpandable" : true,
"memoryReservationMb" : 0,
"memoryReservationPercentage" : 0,
"memorySharesLevel" : "custom",
"memorySharesValue" : 0,
"name" : "string",
"type" : "management"
} ],
"vmFolders" : "One among:MANAGEMENT, NETWORKING, EDGENODES"
},
"dnsSpec" : {
"domain" : "vmware.com",
"nameserver" : "172.0.0.4",
"secondaryNameserver" : "172.0.0.5",
"subdomain" : "vcf.vmware.com"
},
"dvSwitchVersion" : "One among:6.5.0, 7.0.0, 7.0.2, 7.0.3",
"dvsSpecs" : [ {
"dvsName" : "string",
"isUsedByNsxt" : true,
"mtu" : 0,
"networks" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs",
"niocSpecs" : [ {
"trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
"value" : "string"
} ],
"vmnics" : [ "string" ]
} ],
"esxLicense" : "string",
"excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup, EBGP",
"fipsEnabled" : true,
"hostSpecs" : [ {
"association" : "string",
"credentials" : {
"password" : "string",
"username" : "root"
},
"hostname" : "esx-1",
"ipAddressPrivate" : {
"cidr" : "172.0.0.0/24",
"gateway" : "192.168.0.1",
"ipAddress" : "192.168.0.123",
"subnet" : "255.255.255.252"
},
"key" : "string",
"serverId" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vSwitch" : "string",
"vmknicSpecs" : [ {
"ipAddress" : "string",
"macAddress" : "string",
"portgroup" : "One among:VSAN, VMOTION, MANAGEMENT"
} ],
"vswitch" : "string"
} ],
"managementPoolName" : "string",
"networkSpecs" : [ {
"activeUplinks" : [ "string" ],
"excludeIpAddressRanges" : [ "string" ],
"excludeIpaddresses" : [ "string" ],
"gateway" : "string",
"includeIpAddress" : [ "string" ],
"includeIpAddressRanges" : [ {
"endIpAddress" : "192.168.0.128",
"startIpAddress" : "192.168.0.123"
} ],
"mtu" : "string",
"networkType" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type",
"portGroupKey" : "string",
"standbyUplinks" : [ "string" ],
"subnet" : "string",
"subnetMask" : "string",
"teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
"vlanId" : "string"
} ],
"nsxtSpec" : {
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
},
"logicalSegments" : [ {
"name" : "string",
"networkType" : "Oneamong:X_REGION"
} ],
"nsxtAdminPassword" : "string",
"nsxtAuditPassword" : "string",
"nsxtEdgeSpec" : {
"asn" : 0,
"bgpNeighbours" : [ {
"autonomousSystem" : 0,
"forwardingIp" : "192.168.0.123",
"holdDownTimeSeconds" : 0,
"keepAliveTimeSeconds" : 0,
"neighbourIp" : "192.168.0.123",
"password" : "string",
"protocolIp" : "192.168.0.123",
"weight" : 0
} ],
"edgeAdminPassword" : "string",
"edgeAuditPassword" : "string",
"edgeClusterName" : "string",
"edgeFormFactor" : "Oneamong:SMALL",
"edgeNodeSpecs" : [ {
"edgeNodeHostname" : "string",
"edgeNodeName" : "string",
"edgeVtep1Cidr" : "string",
"edgeVtep2Cidr" : "string",
"interfaces" : [ {
"interfaceCidr" : "string",
"name" : "string"
} ],
"managementCidr" : "string"
} ],
"edgeRootPassword" : "string",
"edgeServicesSpecs" : {
"tier0GatewayName" : "string",
"tier1GatewayName" : "string"
},
"tier0ServicesHighAvailability" : "string"
},
"nsxtLicense" : "string",
"nsxtManagerSize" : "One among:medium, large",
"nsxtManagers" : [ {
"hostname" : "string",
"ip" : "string"
} ],
"overLayTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
},
"rootLoginEnabledForNsxtManager" : true,
"rootNsxtManagerPassword" : "string",
"sshEnabledForNsxtManager" : true,
"transportVlanId" : 0,
"vip" : "string",
"vipFqdn" : "string",
"vlanTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
}
},
"ntpServers" : [ "string" ],
"pscSpecs" : [ {
"adminUserSsoPassword" : "string",
"pscId" : "string",
"pscSsoSpec" : {
"ssoDomain" : "string"
}
} ],
"remoteSiteSpec" : {
"pscAddress" : "string",
"sslThumbprint" : "string",
"vcCredentials" : {
"password" : "string",
"username" : "root"
}
},
"sddcId" : "sfo01-m01",
"sddcManagerSpec" : {
"hostname" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"localUserPassword" : "string",
"netmask" : "string",
"rootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"secondUserCredentials" : {
"password" : "string",
"username" : "root"
}
},
"securitySpec" : {
"esxiCertsMode" : "One among:Custom, VMCA",
"rootCaCerts" : [ {
"alias" : "string",
"certChain" : [ "string" ]
} ]
},
"shouldCleanupVsan" : false,
"skipEsxThumbprintValidation" : true,
"skipGatewayPingValidation" : true,
"taskName" : "workflowconfig/workflowspec-ems.json",
"vcenterSpec" : {
"licenseFile" : "string",
"rootVcenterPassword" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"storageSize" : "One among:lstorage, xlstorage",
"vcenterHostname" : "string",
"vcenterIp" : "string",
"vcenterNetmask" : "string",
"vmSize" : "One among:xlarge, large, medium, small, tiny"
},
"vsanSpec" : {
"datastoreName" : "string",
"hclFile" : "string",
"licenseFile" : "string",
"vsanDedup" : true,
"vsanName" : "string"
},
"vxManagerSpec" : {
"defaultAdminUserCredentials" : {
"password" : "string",
"username" : "root"
},
"defaultRootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vxManagerHostName" : "string"
}
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 202
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.5. Get all SDDC specification validations
GET /v1/sddcs/validations
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Accepted |
< Validation > array |
404 |
Not Found |
|
500 |
Internal Server Error |
|
501 |
Not Implemented |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/validations
Example HTTP response
Response 200
[ {
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
} ]Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 501
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.6. Get SDDC specification validation status by ID
GET /v1/sddcs/validations/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
SDDC validation ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Accepted |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
Internal Server Error |
|
501 |
Not Implemented |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 501
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.7. Retry SDDC validation
PATCH /v1/sddcs/validations/{id}
Description
Retry a completed SDDC validation
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
SDDC validation ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Completed |
|
400 |
Bad Request |
No Content |
405 |
Method Not Allowed |
No Content |
500 |
Internal Server Error |
No Content |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/sddcs/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}3.17.8. Get validation report by ID
GET /v1/sddcs/validations/{validationId}/report
Description
Returns the bringup report for a validation. Reports are generated in PDF format.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
validationId |
Bringup validation ID |
string |
Query |
curClientTime |
Current client local time of the the report generation |
string |
Query |
startTime |
Start time of validation to be put in the report |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
500 |
Internal Server Error |
No Content |
501 |
Not Implemented |
No Content |
Consumes
-
application/json
Produces
-
application/pdf
Example HTTP request
Request path
/v1/sddcs/validations/string/report
Example HTTP response
Response 200
"string"3.17.9. Retrieve a SDDC
GET /v1/sddcs/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
SDDC ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/string
Example HTTP response
Response 200
{
"creationTimestamp" : "string",
"id" : "string",
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"sddcSubTasks" : [ {
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"localizableDescriptionPack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"processingStateDescription" : "string",
"processingStateName" : "string",
"sddcId" : "123e4567-e89b-42d3-a456-556642440000",
"status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp" : "string"
} ],
"status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.10. Retry failed SDDC creation
PATCH /v1/sddcs/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
SDDC ID |
string |
Body |
sddcSpec |
sddcSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
404 |
Not Found |
|
405 |
Not allowed |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/string
Request body
{
"ceipEnabled" : true,
"certificatesPassphrase" : "string",
"clusterSpec" : {
"clusterEvcMode" : "string",
"clusterName" : "string",
"hostFailuresToTolerate" : 0,
"hostProfileComplianceCheckHour" : 0,
"hostProfileComplianceCheckMinute" : 0,
"hosts" : [ "string" ],
"personalityName" : "string",
"resourcePoolSpecs" : [ {
"cpuLimit" : 0,
"cpuReservationExpandable" : true,
"cpuReservationMhz" : 0,
"cpuReservationPercentage" : 0,
"cpuSharesLevel" : "custom",
"cpuSharesValue" : 0,
"memoryLimit" : 0,
"memoryReservationExpandable" : true,
"memoryReservationMb" : 0,
"memoryReservationPercentage" : 0,
"memorySharesLevel" : "custom",
"memorySharesValue" : 0,
"name" : "string",
"type" : "management"
} ],
"vmFolders" : "One among:MANAGEMENT, NETWORKING, EDGENODES"
},
"dnsSpec" : {
"domain" : "vmware.com",
"nameserver" : "172.0.0.4",
"secondaryNameserver" : "172.0.0.5",
"subdomain" : "vcf.vmware.com"
},
"dvSwitchVersion" : "One among:6.5.0, 7.0.0, 7.0.2, 7.0.3",
"dvsSpecs" : [ {
"dvsName" : "string",
"isUsedByNsxt" : true,
"mtu" : 0,
"networks" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs",
"niocSpecs" : [ {
"trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
"value" : "string"
} ],
"vmnics" : [ "string" ]
} ],
"esxLicense" : "string",
"excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup, EBGP",
"fipsEnabled" : true,
"hostSpecs" : [ {
"association" : "string",
"credentials" : {
"password" : "string",
"username" : "root"
},
"hostname" : "esx-1",
"ipAddressPrivate" : {
"cidr" : "172.0.0.0/24",
"gateway" : "192.168.0.1",
"ipAddress" : "192.168.0.123",
"subnet" : "255.255.255.252"
},
"key" : "string",
"serverId" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vSwitch" : "string",
"vmknicSpecs" : [ {
"ipAddress" : "string",
"macAddress" : "string",
"portgroup" : "One among:VSAN, VMOTION, MANAGEMENT"
} ],
"vswitch" : "string"
} ],
"managementPoolName" : "string",
"networkSpecs" : [ {
"activeUplinks" : [ "string" ],
"excludeIpAddressRanges" : [ "string" ],
"excludeIpaddresses" : [ "string" ],
"gateway" : "string",
"includeIpAddress" : [ "string" ],
"includeIpAddressRanges" : [ {
"endIpAddress" : "192.168.0.128",
"startIpAddress" : "192.168.0.123"
} ],
"mtu" : "string",
"networkType" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type",
"portGroupKey" : "string",
"standbyUplinks" : [ "string" ],
"subnet" : "string",
"subnetMask" : "string",
"teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
"vlanId" : "string"
} ],
"nsxtSpec" : {
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
},
"logicalSegments" : [ {
"name" : "string",
"networkType" : "Oneamong:X_REGION"
} ],
"nsxtAdminPassword" : "string",
"nsxtAuditPassword" : "string",
"nsxtEdgeSpec" : {
"asn" : 0,
"bgpNeighbours" : [ {
"autonomousSystem" : 0,
"forwardingIp" : "192.168.0.123",
"holdDownTimeSeconds" : 0,
"keepAliveTimeSeconds" : 0,
"neighbourIp" : "192.168.0.123",
"password" : "string",
"protocolIp" : "192.168.0.123",
"weight" : 0
} ],
"edgeAdminPassword" : "string",
"edgeAuditPassword" : "string",
"edgeClusterName" : "string",
"edgeFormFactor" : "Oneamong:SMALL",
"edgeNodeSpecs" : [ {
"edgeNodeHostname" : "string",
"edgeNodeName" : "string",
"edgeVtep1Cidr" : "string",
"edgeVtep2Cidr" : "string",
"interfaces" : [ {
"interfaceCidr" : "string",
"name" : "string"
} ],
"managementCidr" : "string"
} ],
"edgeRootPassword" : "string",
"edgeServicesSpecs" : {
"tier0GatewayName" : "string",
"tier1GatewayName" : "string"
},
"tier0ServicesHighAvailability" : "string"
},
"nsxtLicense" : "string",
"nsxtManagerSize" : "One among:medium, large",
"nsxtManagers" : [ {
"hostname" : "string",
"ip" : "string"
} ],
"overLayTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
},
"rootLoginEnabledForNsxtManager" : true,
"rootNsxtManagerPassword" : "string",
"sshEnabledForNsxtManager" : true,
"transportVlanId" : 0,
"vip" : "string",
"vipFqdn" : "string",
"vlanTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
}
},
"ntpServers" : [ "string" ],
"pscSpecs" : [ {
"adminUserSsoPassword" : "string",
"pscId" : "string",
"pscSsoSpec" : {
"ssoDomain" : "string"
}
} ],
"remoteSiteSpec" : {
"pscAddress" : "string",
"sslThumbprint" : "string",
"vcCredentials" : {
"password" : "string",
"username" : "root"
}
},
"sddcId" : "sfo01-m01",
"sddcManagerSpec" : {
"hostname" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"localUserPassword" : "string",
"netmask" : "string",
"rootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"secondUserCredentials" : {
"password" : "string",
"username" : "root"
}
},
"securitySpec" : {
"esxiCertsMode" : "One among:Custom, VMCA",
"rootCaCerts" : [ {
"alias" : "string",
"certChain" : [ "string" ]
} ]
},
"shouldCleanupVsan" : false,
"skipEsxThumbprintValidation" : true,
"skipGatewayPingValidation" : true,
"taskName" : "workflowconfig/workflowspec-ems.json",
"vcenterSpec" : {
"licenseFile" : "string",
"rootVcenterPassword" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"storageSize" : "One among:lstorage, xlstorage",
"vcenterHostname" : "string",
"vcenterIp" : "string",
"vcenterNetmask" : "string",
"vmSize" : "One among:xlarge, large, medium, small, tiny"
},
"vsanSpec" : {
"datastoreName" : "string",
"hclFile" : "string",
"licenseFile" : "string",
"vsanDedup" : true,
"vsanName" : "string"
},
"vxManagerSpec" : {
"defaultAdminUserCredentials" : {
"password" : "string",
"username" : "root"
},
"defaultRootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vxManagerHostName" : "string"
}
}Example HTTP response
Response 200
{
"creationTimestamp" : "string",
"id" : "string",
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"sddcSubTasks" : [ {
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"localizableDescriptionPack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"processingStateDescription" : "string",
"processingStateName" : "string",
"sddcId" : "123e4567-e89b-42d3-a456-556642440000",
"status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp" : "string"
} ],
"status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}Response 202
{
"creationTimestamp" : "string",
"id" : "string",
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"sddcSubTasks" : [ {
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"localizableDescriptionPack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"localizableNamePack" : {
"arguments" : [ "string" ],
"component" : "string",
"message" : "string",
"messageKey" : "string"
},
"name" : "string",
"processingStateDescription" : "string",
"processingStateName" : "string",
"sddcId" : "123e4567-e89b-42d3-a456-556642440000",
"status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp" : "string"
} ],
"status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 405
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.17.11. Get SDDC report by ID
GET /v1/sddcs/{id}/detail-report
Description
Returns the bringup report. Reports are generated in PDF and CSV formats.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
id |
SDDC ID |
string |
|
Query |
format |
Supported bringup report formats - PDF,CSV |
enum (PDF, CSV) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
204 |
No content |
string |
500 |
Internal Server Error |
No Content |
501 |
Not Implemented |
No Content |
Consumes
-
application/json
Produces
-
application/pdf -
text/csv
Example HTTP request
Request path
/v1/sddcs/string/detail-report
3.17.12. Retrieve SDDC Manager VM details
GET /v1/sddcs/{id}/sddc-manager
Description
Retrieves the details of SDDC Manager VM
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
SDDC ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
501 |
Not Implemented |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddcs/string/sddc-manager
Example HTTP response
Response 200
{
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"version" : "string"
}3.17.13. Convert SDDC specification Json/Excel File
POST /v1/system/sddc-spec-converter
Description
SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
design |
Supported bringup designs - EMS,ems,VXRAIL,vxrail |
enum (EMS, ems, VXRAIL, vxrail) |
|
FormData |
specFile |
SDDC specification file which is either a JSON or xls file |
file |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Converting SDDC specification failed |
|
404 |
Not Found |
|
500 |
Internal Server Error |
|
501 |
Not Implemented |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP response
Response 200
{
"ceipEnabled" : true,
"certificatesPassphrase" : "string",
"clusterSpec" : {
"clusterEvcMode" : "string",
"clusterName" : "string",
"hostFailuresToTolerate" : 0,
"hostProfileComplianceCheckHour" : 0,
"hostProfileComplianceCheckMinute" : 0,
"hosts" : [ "string" ],
"personalityName" : "string",
"resourcePoolSpecs" : [ {
"cpuLimit" : 0,
"cpuReservationExpandable" : true,
"cpuReservationMhz" : 0,
"cpuReservationPercentage" : 0,
"cpuSharesLevel" : "custom",
"cpuSharesValue" : 0,
"memoryLimit" : 0,
"memoryReservationExpandable" : true,
"memoryReservationMb" : 0,
"memoryReservationPercentage" : 0,
"memorySharesLevel" : "custom",
"memorySharesValue" : 0,
"name" : "string",
"type" : "management"
} ],
"vmFolders" : "One among:MANAGEMENT, NETWORKING, EDGENODES"
},
"dnsSpec" : {
"domain" : "vmware.com",
"nameserver" : "172.0.0.4",
"secondaryNameserver" : "172.0.0.5",
"subdomain" : "vcf.vmware.com"
},
"dvSwitchVersion" : "One among:6.5.0, 7.0.0, 7.0.2, 7.0.3",
"dvsSpecs" : [ {
"dvsName" : "string",
"isUsedByNsxt" : true,
"mtu" : 0,
"networks" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs",
"niocSpecs" : [ {
"trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
"value" : "string"
} ],
"vmnics" : [ "string" ]
} ],
"esxLicense" : "string",
"excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup, EBGP",
"fipsEnabled" : true,
"hostSpecs" : [ {
"association" : "string",
"credentials" : {
"password" : "string",
"username" : "root"
},
"hostname" : "esx-1",
"ipAddressPrivate" : {
"cidr" : "172.0.0.0/24",
"gateway" : "192.168.0.1",
"ipAddress" : "192.168.0.123",
"subnet" : "255.255.255.252"
},
"key" : "string",
"serverId" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vSwitch" : "string",
"vmknicSpecs" : [ {
"ipAddress" : "string",
"macAddress" : "string",
"portgroup" : "One among:VSAN, VMOTION, MANAGEMENT"
} ],
"vswitch" : "string"
} ],
"managementPoolName" : "string",
"networkSpecs" : [ {
"activeUplinks" : [ "string" ],
"excludeIpAddressRanges" : [ "string" ],
"excludeIpaddresses" : [ "string" ],
"gateway" : "string",
"includeIpAddress" : [ "string" ],
"includeIpAddressRanges" : [ {
"endIpAddress" : "192.168.0.128",
"startIpAddress" : "192.168.0.123"
} ],
"mtu" : "string",
"networkType" : "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type",
"portGroupKey" : "string",
"standbyUplinks" : [ "string" ],
"subnet" : "string",
"subnetMask" : "string",
"teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
"vlanId" : "string"
} ],
"nsxtSpec" : {
"ipAddressPoolSpec" : {
"description" : "string",
"ignoreUnavailableNsxtCluster" : true,
"name" : "string",
"subnets" : [ {
"cidr" : "string",
"gateway" : "string",
"ipAddressPoolRanges" : [ {
"end" : "string",
"start" : "string"
} ]
} ]
},
"logicalSegments" : [ {
"name" : "string",
"networkType" : "Oneamong:X_REGION"
} ],
"nsxtAdminPassword" : "string",
"nsxtAuditPassword" : "string",
"nsxtEdgeSpec" : {
"asn" : 0,
"bgpNeighbours" : [ {
"autonomousSystem" : 0,
"forwardingIp" : "192.168.0.123",
"holdDownTimeSeconds" : 0,
"keepAliveTimeSeconds" : 0,
"neighbourIp" : "192.168.0.123",
"password" : "string",
"protocolIp" : "192.168.0.123",
"weight" : 0
} ],
"edgeAdminPassword" : "string",
"edgeAuditPassword" : "string",
"edgeClusterName" : "string",
"edgeFormFactor" : "Oneamong:SMALL",
"edgeNodeSpecs" : [ {
"edgeNodeHostname" : "string",
"edgeNodeName" : "string",
"edgeVtep1Cidr" : "string",
"edgeVtep2Cidr" : "string",
"interfaces" : [ {
"interfaceCidr" : "string",
"name" : "string"
} ],
"managementCidr" : "string"
} ],
"edgeRootPassword" : "string",
"edgeServicesSpecs" : {
"tier0GatewayName" : "string",
"tier1GatewayName" : "string"
},
"tier0ServicesHighAvailability" : "string"
},
"nsxtLicense" : "string",
"nsxtManagerSize" : "One among:medium, large",
"nsxtManagers" : [ {
"hostname" : "string",
"ip" : "string"
} ],
"overLayTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
},
"rootLoginEnabledForNsxtManager" : true,
"rootNsxtManagerPassword" : "string",
"sshEnabledForNsxtManager" : true,
"transportVlanId" : 0,
"vip" : "string",
"vipFqdn" : "string",
"vlanTransportZone" : {
"networkName" : "string",
"zoneName" : "string"
}
},
"ntpServers" : [ "string" ],
"pscSpecs" : [ {
"adminUserSsoPassword" : "string",
"pscId" : "string",
"pscSsoSpec" : {
"ssoDomain" : "string"
}
} ],
"remoteSiteSpec" : {
"pscAddress" : "string",
"sslThumbprint" : "string",
"vcCredentials" : {
"password" : "string",
"username" : "root"
}
},
"sddcId" : "sfo01-m01",
"sddcManagerSpec" : {
"hostname" : "string",
"ipAddress" : "string",
"licenseKey" : "string",
"localUserPassword" : "string",
"netmask" : "string",
"rootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"secondUserCredentials" : {
"password" : "string",
"username" : "root"
}
},
"securitySpec" : {
"esxiCertsMode" : "One among:Custom, VMCA",
"rootCaCerts" : [ {
"alias" : "string",
"certChain" : [ "string" ]
} ]
},
"shouldCleanupVsan" : false,
"skipEsxThumbprintValidation" : true,
"skipGatewayPingValidation" : true,
"taskName" : "workflowconfig/workflowspec-ems.json",
"vcenterSpec" : {
"licenseFile" : "string",
"rootVcenterPassword" : "string",
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"storageSize" : "One among:lstorage, xlstorage",
"vcenterHostname" : "string",
"vcenterIp" : "string",
"vcenterNetmask" : "string",
"vmSize" : "One among:xlarge, large, medium, small, tiny"
},
"vsanSpec" : {
"datastoreName" : "string",
"hclFile" : "string",
"licenseFile" : "string",
"vsanDedup" : true,
"vsanName" : "string"
},
"vxManagerSpec" : {
"defaultAdminUserCredentials" : {
"password" : "string",
"username" : "root"
},
"defaultRootUserCredentials" : {
"password" : "string",
"username" : "root"
},
"sshThumbprint" : "string",
"sslThumbprint" : "string",
"vxManagerHostName" : "string"
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 501
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18. SOS
APIs for managing SOS
3.18.1. Initiates Health Summary checks.
POST /v1/system/health-summary
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
healthsummaryspec |
healthsummaryspec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
409 |
Operation is in progress for Id {id}. Wait for the operation to complete. |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/health-summary
Request body
{
"healthChecks" : {
"certificateHealth" : true,
"composabilityHealth" : true,
"computeHealth" : true,
"connectivityHealth" : true,
"dnsHealth" : true,
"generalHealth" : true,
"hardwareCompatibilityHealth" : true,
"ntpHealth" : true,
"passwordHealth" : true,
"servicesHealth" : true,
"storageHealth" : true
},
"options" : {
"config" : {
"force" : true,
"skipKnownHostCheck" : true
},
"include" : {
"summaryReport" : true
}
},
"scope" : {
"domains" : [ {
"clusterNames" : [ "string" ],
"domainName" : "string"
} ],
"includeAllDomains" : true,
"includeFreeHosts" : true
}
}Example HTTP response
Response 200
{
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
}Response 202
{
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.2. Fetch All Health Summary Tasks.
GET /v1/system/health-summary
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/health-summary
Example HTTP response
Response 200
{
"elements" : [ {
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.3. Fetch the progress of a Health summary task.
GET /v1/system/health-summary/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The Health Summary Id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/health-summary/string
Example HTTP response
Response 200
{
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.4. Download Health Summary Bundle.
GET /v1/system/health-summary/{id}/data
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The Health Summary Id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
string (byte) |
400 |
Bad request! Invalid Headers or Data. Error: {error}. |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
404 |
Bundle not found or not available for download. Id:{id}. |
|
500 |
Something went wrong. Internal server error occurred. Error {error}. |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/v1/system/health-summary/string/data
Example HTTP response
Response 200
"Ynl0ZQ=="Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.5. Initiates Support bundle download
POST /v1/system/support-bundles
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
supportbundlespec |
supportbundlespec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
409 |
Operation is in progress for Id {id}. Wait for the operation to complete. |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/support-bundles
Request body
{
"logs" : {
"apiLogs" : true,
"esxLogs" : true,
"nsxLogs" : true,
"sddcManagerLogs" : true,
"systemDebugLogs" : true,
"vcLogs" : true,
"vmScreenshots" : true,
"vraLogs" : true,
"vrliLogs" : true,
"vropsLogs" : true,
"vrslcmLogs" : true,
"vxrailManagerLogs" : true,
"wcpLogs" : true
},
"options" : {
"config" : {
"force" : true,
"skipKnownHostCheck" : true
},
"include" : {
"healthCheck" : true,
"summaryReport" : true
}
},
"scope" : {
"domains" : [ {
"clusterNames" : [ "string" ],
"domainName" : "string"
} ],
"includeFreeHosts" : true
}
}Example HTTP response
Response 200
{
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
}Response 202
{
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.6. Fetch All Support bundle Tasks.
GET /v1/system/support-bundles
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/support-bundles
Example HTTP response
Response 200
{
"elements" : [ {
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.7. Fetch the progress of support bundle task.
GET /v1/system/support-bundles/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The Support Bundle ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/support-bundles/string
Example HTTP response
Response 200
{
"bundleAvailable" : "string",
"bundleName" : "string",
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"id" : "string",
"status" : "string"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.18.8. Download Support bundles.
GET /v1/system/support-bundles/{id}/data
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The Support Bundle ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
string (byte) |
400 |
Bad request! Invalid Headers or Data. Error: {error} |
|
401 |
Bad request! Authorization Header is missing or not in correct format. |
|
404 |
Bundle not found or not available for download. Id:{id} |
|
500 |
Something went wrong. Internal server error occurred. Error {error} |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/v1/system/support-bundles/string/data
Example HTTP response
Response 200
"Ynl0ZQ=="Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.19. SddcManagers
APIs for managing SDDC Managers
3.19.1. Get the SDDC Managers
GET /v1/sddc-managers
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddc-managers
Example HTTP response
Response 200
{
"elements" : [ {
"basicAuthDetails" : {
"status" : "One among: ENABLED, DISABLED",
"username" : "string"
},
"domain" : {
"id" : "string",
"name" : "string"
},
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.19.2. Get a SDDC Manager
GET /v1/sddc-managers/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Sddc Manager ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Sddc Manager not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sddc-managers/string
Example HTTP response
Response 200
{
"basicAuthDetails" : {
"status" : "One among: ENABLED, DISABLED",
"username" : "string"
},
"domain" : {
"id" : "string",
"name" : "string"
},
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"version" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.20. SystemPrechecks
APIs for managing System Prechecks
3.20.1. Precheck System
POST /v1/system/prechecks
Description
Perform precheck of resource(ex: Domain, Cluster). If only resource is specified, all resources/software components under it are included. If resource(Domain, Cluster etc) and specific resources/software components are provided, only those are included in precheck
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
precheckSpec |
Precheck System Spec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/prechecks
Request body
{
"bundleId" : "string",
"mode" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.20.2. Get Precheck Task by ID
GET /v1/system/prechecks/tasks/{id}
Description
Monitor the progress of precheck task by the precheck task ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Precheck Task ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Precheck Task Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/prechecks/tasks/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.21. Target Upgrade Version
APIs for managing domains target upgrade versions
3.21.1. Get target upgrade version for domain.
GET /v1/domainTargetVersion
Description
Get last selected upgrade version for the domain.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
domainId |
Domain ID to get target version of the domain |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Target version for this domain not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domainTargetVersion?domainId=string
Example HTTP response
Response 200
{
"domainId" : "string",
"version" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.21.2. Save/update target upgrade version for domain.
PUT /v1/domainTargetVersion
Description
Save/update last selected upgrade version for the domain.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
targetVersion |
targetVersion |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
No Content |
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/domainTargetVersion
Request body
{
"domainId" : "string",
"version" : "string"
}Example HTTP response
Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.22. Tasks
APIs for managing Tasks
3.22.1. Get the Tasks
GET /v1/tasks
Description
Get the Tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
completedAfter |
A time based filter to get tasks which are completed after the given timestamp. A task is completed if its status is 'Successsful' or 'Failed'. Time is in milliseconds. |
integer (int64) |
Query |
limit |
The number of elements to be returned in the result |
integer (int32) |
Query |
resourceId |
resourceId |
string |
Query |
resourceType |
resourceType |
string |
Query |
taskStatus |
taskStatus |
string |
Query |
taskType |
taskType |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Returns the list of tasks. |
|
500 |
Unexpected error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/tasks
Example HTTP response
Response 200
{
"elements" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.22.2. Get a Task
GET /v1/tasks/{id}
Description
Get a Task by ID, if it exists
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Task id to retrieve |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
A task object. |
|
404 |
Task not found |
|
500 |
Unexpected error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/tasks/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.22.3. Cancel a Task
DELETE /v1/tasks/{id}
Description
Cancel a Task by ID, if it exists
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Task id for cancelling |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Task was cancelled successfully. |
No Content |
404 |
Task not found |
|
409 |
Task can not be cancelled. Only a IN_PROGRESS task can be cancelled. |
|
500 |
Unexpected error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/tasks/string
Example HTTP response
Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.22.4. Retry a Task
PATCH /v1/tasks/{id}
Description
Retry a failed Task by ID, if it exists
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Task id retry |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Task was retried successfully. |
No Content |
404 |
Task not found |
|
409 |
Task can not be retried. Only a failed Task can be retried. |
|
500 |
Unexpected error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/tasks/string
Example HTTP response
Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.23. Tokens
APIs for managing Access and Refresh Token
3.23.1. Create Token Pair
POST /v1/tokens
Description
Creates access token and refresh token for user access
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
tokenCreationSpec |
tokenCreationSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/tokens
Request body
{
"apiKey" : "string",
"password" : "string",
"username" : "string"
}Example HTTP response
Response 200
{
"accessToken" : "string",
"refreshToken" : {
"id" : "string"
}
}Response 201
{
"accessToken" : "string",
"refreshToken" : {
"id" : "string"
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.23.2. Refresh Access Token
PATCH /v1/tokens/access-token/refresh
Description
Refresh the access token associated with the given refresh token
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
refreshToken |
refreshToken |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP response
Response 200
"string"Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.23.3. Invalidate Refresh Token
DELETE /v1/tokens/refresh-token
Description
Invalidate the provided refresh token
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
refreshToken |
refreshToken |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No content |
No Content |
Consumes
-
application/json
Produces
-
*/*
3.24. Trusted Certificates
APIs for managing Trusted Certificates
3.24.1. Add trusted certificate to the SDDC manager
POST /v1/sddc-manager/trusted-certificates
Description
Add trusted certificate to the SDDC manager
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
trustedCertificateSpec |
trustedCertificateSpec |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
400 |
Bad request |
|
409 |
Trusted certificate already exists |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/sddc-manager/trusted-certificates
Request body
{
"certificate" : "string",
"certificateUsageType" : "One among: TRUSTED_FOR_OUTBOUND, TRUSTED_FOR_INBOUND"
}Example HTTP response
Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 409
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.25. Upgradables
APIs for managing Upgradables
3.25.1. Get the Upgradables
GET /v1/system/upgradables
Description
Fetches the list of Upgradables in the System. Only one Upgradable becomes AVAILABLE for Upgrade. The Upgradables provides information that can be use for Precheck API and also in the actual Upgrade API call.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/upgradables
Example HTTP response
Response 200
{
"elements" : [ {
"bundleId" : "string",
"bundleType" : "string",
"resource" : {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
},
"softwareComponents" : [ {
"id" : "string",
"type" : "string"
} ],
"status" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.25.2. Get the Upgradables
GET /v1/upgradables/domains/{domainId}
Description
Fetches the list of Upgradables for a given domain. If a target version is provided, Upgradables that are required for given target version become Available. The Upgradables providesinformation that can be use for Precheck API and also in the actual Upgrade API call.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Query |
targetVersion |
Target Version to get Upgradables for a given Target Release |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Domain not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgradables/domains/string
Example HTTP response
Response 200
{
"elements" : [ {
"bundleId" : "string",
"bundleType" : "string",
"resource" : {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
},
"softwareComponents" : [ {
"id" : "string",
"type" : "string"
} ],
"status" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.25.3. Get registered and available HSM details along with Software details
GET /v1/upgradables/domains/{domainId}/clusters
Description
Fetches the list of available hardware support managers and configured hardware support managers for the give resource along with the hardware support packages and Software details.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Domain Not Found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgradables/domains/string/clusters
Example HTTP response
Response 200
{
"elements" : [ {
"availableHardwareSupportManagers" : [ {
"displayName" : "string",
"name" : "string",
"packages" : [ {
"name" : "string",
"version" : "string"
} ]
} ],
"configuredHardwareSupportManagers" : [ {
"displayName" : "string",
"name" : "string",
"pkg" : {
"name" : "string",
"version" : "string"
}
} ],
"primaryCluster" : true,
"resourceId" : "string",
"resourceType" : "CLUSTER",
"softwareInfo" : {
"addOn" : {
"displayName" : "string",
"displayVersion" : "string",
"name" : "DELL-sample-Addon",
"vendor" : "Dell",
"version" : "2.0-1"
},
"baseImage" : {
"details" : {
"displayName" : "7.0.0-0.0.30340198",
"displayVersion" : "string",
"releaseDate" : {
"calendarType" : "string",
"firstDayOfWeek" : 0,
"lenient" : true,
"minimalDaysInFirstWeek" : 0,
"time" : "1970-01-01T00:00:00Z",
"timeInMillis" : 0,
"timeZone" : {
"displayName" : "string",
"dstsavings" : 0,
"id" : "string",
"rawOffset" : 0
},
"weekDateSupported" : true,
"weekYear" : 0,
"weeksInWeekYear" : 0
}
},
"version" : "7.0.0-0.0.30340198"
},
"components" : {
"string" : "<<_componentinfo>>"
},
"hardwareSupport" : {
"packages" : {
"string" : "<<_hardwaresupportpackageinfo>>"
}
}
},
"vlcmEnabled" : true
} ]
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.25.4. Get NSXT upgradable resources
GET /v1/upgradables/domains/{domainId}/nsxt
Description
Get the list NSXT upgradable reosurce with resource metadata info
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
domainId |
Domain ID |
string |
Query |
bundleId |
bundle Id of the upgrade bundle applicable on the domain |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< NsxtResources > array |
404 |
Bundle not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgradables/domains/string/nsxt
Example HTTP response
Response 200
[ {
"bundleId" : "string",
"domainId" : "string",
"nsxtEdgeClusters" : [ {
"id" : "string",
"name" : "string",
"resourceHealth" : "string",
"upgradeStatus" : "string",
"version" : "string"
} ],
"nsxtHostClusters" : [ {
"availableHardwareSupportManagers" : [ {
"displayName" : "string",
"name" : "string",
"packages" : [ {
"name" : "string",
"version" : "string"
} ]
} ],
"configuredHardwareSupportManagers" : [ {
"displayName" : "string",
"name" : "string",
"pkg" : {
"name" : "string",
"version" : "string"
}
} ],
"domainId" : "string",
"id" : "string",
"name" : "string",
"primaryCluster" : true,
"resourceHealth" : "string",
"totalUnits" : 0,
"upgradeStatus" : "string",
"upgradedUnits" : 0,
"version" : "string",
"vlcmEnabled" : true
} ],
"nsxtManagerCluster" : {
"id" : "string",
"name" : "string",
"resourceHealth" : "string",
"upgradeStatus" : "string",
"version" : "string"
},
"nsxtUpgradeCoordinator" : {
"enabledOn" : "string",
"id" : "string",
"resourceHealth" : "string",
"upgradeStatus" : "string",
"version" : "string"
}
} ]Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.26. Upgrades
APIs for managing Upgrades
3.26.1. Perform Upgrade
POST /v1/upgrades
Description
Schedule/Trigger Upgrade of a Resource. Ex: Resource can be DOMAIN, CLUSTER, UNMANAGED_HOST etc. Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
upgradeSpec |
Upgrade Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
403 |
Operation not allowed |
|
424 |
Failed Dependency |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgrades
Request body
{
"bundleId" : "string",
"draftMode" : true,
"nsxtUpgradeUserInputSpecs" : [ {
"nsxtEdgeClusterUpgradeSpecs" : [ {
"edgeClusterId" : "string",
"edgeParallelUpgrade" : true
} ],
"nsxtHostClusterUpgradeSpecs" : [ {
"hostClusterId" : "string",
"hostParallelUpgrade" : true,
"liveUpgrade" : true
} ],
"nsxtId" : "string",
"nsxtUpgradeOptions" : {
"isEdgeClustersUpgradeParallel" : true,
"isEdgeOnlyUpgrade" : true,
"isHostClustersUpgradeParallel" : true
}
} ],
"parallelUpgrade" : true,
"resourceType" : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs" : [ {
"enableQuickboot" : true,
"personalitySpec" : {
"hardwareSupportSpecs" : [ {
"name" : "string",
"packageSpec" : {
"name" : "string",
"version" : "string"
}
} ],
"personalityId" : "string"
},
"resourceId" : "string",
"scheduledTimestamp" : "string",
"shutdownVms" : true,
"toVersion" : "string",
"upgradeNow" : true
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 424
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.26.2. Get Upgrades
GET /v1/upgrades
Description
Get Upgrades
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bundleId |
Bundle Id for the upgrade |
string |
Query |
status |
Status of the upgrades you want to retrieve |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Upgrade not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgrades
Example HTTP response
Response 200
{
"elements" : [ {
"bundleId" : "string",
"id" : "string",
"nsxtUpgradeUserInputSpec" : {
"nsxtEdgeClusterUpgradeSpecs" : [ {
"edgeClusterId" : "string",
"edgeParallelUpgrade" : true
} ],
"nsxtHostClusterUpgradeSpecs" : [ {
"hostClusterId" : "string",
"hostParallelUpgrade" : true,
"liveUpgrade" : true
} ],
"nsxtId" : "string",
"nsxtUpgradeOptions" : {
"isEdgeClustersUpgradeParallel" : true,
"isEdgeOnlyUpgrade" : true,
"isHostClustersUpgradeParallel" : true
}
},
"parallelUpgrade" : true,
"resourceType" : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs" : [ {
"enableQuickboot" : true,
"personalitySpec" : {
"hardwareSupportSpecs" : [ {
"name" : "string",
"packageSpec" : {
"name" : "string",
"version" : "string"
}
} ],
"personalityId" : "string"
},
"resourceId" : "string",
"scheduledTimestamp" : "string",
"shutdownVms" : true,
"toVersion" : "string",
"upgradeNow" : true
} ],
"status" : "string",
"taskId" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.26.3. Get Upgrade By Id
GET /v1/upgrades/{upgradeId}
Description
Get Upgrade By Id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
upgradeId |
upgradeId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Upgrade not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgrades/string
Example HTTP response
Response 200
{
"bundleId" : "string",
"id" : "string",
"nsxtUpgradeUserInputSpec" : {
"nsxtEdgeClusterUpgradeSpecs" : [ {
"edgeClusterId" : "string",
"edgeParallelUpgrade" : true
} ],
"nsxtHostClusterUpgradeSpecs" : [ {
"hostClusterId" : "string",
"hostParallelUpgrade" : true,
"liveUpgrade" : true
} ],
"nsxtId" : "string",
"nsxtUpgradeOptions" : {
"isEdgeClustersUpgradeParallel" : true,
"isEdgeOnlyUpgrade" : true,
"isHostClustersUpgradeParallel" : true
}
},
"parallelUpgrade" : true,
"resourceType" : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs" : [ {
"enableQuickboot" : true,
"personalitySpec" : {
"hardwareSupportSpecs" : [ {
"name" : "string",
"packageSpec" : {
"name" : "string",
"version" : "string"
}
} ],
"personalityId" : "string"
},
"resourceId" : "string",
"scheduledTimestamp" : "string",
"shutdownVms" : true,
"toVersion" : "string",
"upgradeNow" : true
} ],
"status" : "string",
"taskId" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.26.4. Commit/Reschedule Upgrade
PATCH /v1/upgrades/{upgradeId}
Description
Commit/Reschedule an existing upgrade. It moves the upgrade from DRAFT state to SCHEDULED state and/or changes the upgrade scheduled date/time.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
upgradeId |
upgradeId |
string |
Body |
upgradeCommitSpec |
Upgrade Commit/Reschedule Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Upgrade not found |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgrades/string
Request body
{
"scheduledTimestamp" : "string",
"upgradeNow" : true
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.26.5. performPrechecks
POST /v1/upgrades/{upgradeId}/prechecks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
upgradeId |
upgradeId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
403 |
Operation not allowed |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgrades/string/prechecks
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.26.6. getPrecheck
GET /v1/upgrades/{upgradeId}/prechecks/{precheckId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
precheckId |
precheckId |
string |
Path |
upgradeId |
upgradeId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
403 |
Operation not allowed |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/upgrades/string/prechecks/string
Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27. Users
APIs for managing Users
3.27.1. Get all roles
GET /v1/roles
Description
Get a list of all roles
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/roles
Example HTTP response
Response 200
{
"elements" : [ {
"description" : "string",
"id" : "string",
"name" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.2. Get all SSO domains
GET /v1/sso-domains
Description
Get a list of all SSO domains
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized Request |
|
403 |
Forbidden request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sso-domains
Example HTTP response
Response 200
{
"elements" : [ "string" ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 401
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.3. Get all entities of SSO domain
GET /v1/sso-domains/{sso-domain}/entities
Description
Get a list of all entities in the SSO domain
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
sso-domain |
SSO Domain Name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized Request |
|
403 |
Forbidden request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/sso-domains/string/entities
Example HTTP response
Response 200
{
"elements" : [ {
"id" : "string",
"name" : "string",
"type" : "One among: USER, GROUP"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 401
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 403
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.4. Add users
POST /v1/users
Description
Add list of users
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
users |
User data collection |
< User > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad request |
|
401 |
Unauthorized Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/users
Request body
[ {
"apiKey" : "string",
"creationTimestamp" : "string",
"domain" : "string",
"id" : "string",
"name" : "string",
"role" : {
"id" : "string"
},
"type" : "One among: USER, GROUP, SERVICE"
} ]Example HTTP response
Response 200
{
"elements" : [ {
"apiKey" : "string",
"creationTimestamp" : "string",
"domain" : "string",
"id" : "string",
"name" : "string",
"role" : {
"id" : "string"
},
"type" : "One among: USER, GROUP, SERVICE"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 201
{
"elements" : [ {
"apiKey" : "string",
"creationTimestamp" : "string",
"domain" : "string",
"id" : "string",
"name" : "string",
"role" : {
"id" : "string"
},
"type" : "One among: USER, GROUP, SERVICE"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.5. Get all Users
GET /v1/users
Description
Get a list of all users
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/users
Example HTTP response
Response 200
{
"elements" : [ {
"apiKey" : "string",
"creationTimestamp" : "string",
"domain" : "string",
"id" : "string",
"name" : "string",
"role" : {
"id" : "string"
},
"type" : "One among: USER, GROUP, SERVICE"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.6. Get local account details
GET /v1/users/local/admin
Description
Get information on the local account
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/users/local/admin
Example HTTP response
Response 200
{
"apiKey" : "string",
"creationTimestamp" : "string",
"domain" : "string",
"id" : "string",
"isConfigured" : true,
"name" : "string",
"role" : {
"id" : "string"
},
"type" : "One among: USER, GROUP, SERVICE"
}Response 400
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 401
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.7. Update password for local account
PATCH /v1/users/local/admin
Description
Update the password for local account only if the old password is correct, or if user configures the local account for the first time
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
locaUserPassword |
Local user password details |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No content |
No Content |
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/users/local/admin
Request body
{
"newPassword" : "string",
"oldPassword" : "string"
}Example HTTP response
Response 500
{
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"cause" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.27.8. getAllUiUsers
GET /v1/users/ui
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/users/ui
Example HTTP response
Response 200
{
"elements" : [ {
"apiKey" : "string",
"creationTimestamp" : "string",
"domain" : "string",
"id" : "string",
"name" : "string",
"role" : {
"id" : "string"
},
"type" : "One among: USER, GROUP, SERVICE"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.27.9. Delete a user
DELETE /v1/users/{id}
Description
Delete the user by the ID, if it exists
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
ID of the user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No content |
No Content |
404 |
User not found |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/users/string
Example HTTP response
Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.28. VcfServices
APIs for managing VCF Services
3.28.1. Get the VcfServices
GET /v1/vcf-services
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vcf-services
Example HTTP response
Response 200
{
"elements" : [ {
"id" : "string",
"name" : "string",
"status" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.28.2. Get a VcfService
GET /v1/vcf-services/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
VcfService ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
VcfService not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vcf-services/string
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"status" : "string",
"version" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.29. VersionAliasesForBundleComponentType
APIs for managing Version Alias Configuration
3.29.1. Get Version Alias Configuration
GET /v1/system/settings/version-aliases
Description
Get the Version Alias Configuration.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/settings/version-aliases
Example HTTP response
Response 200
{
"elements" : [ {
"bundleComponentType" : "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, ",
"versionAliases" : [ {
"aliases" : [ "string" ],
"version" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.29.2. Update Version Alias Configurations
PUT /v1/system/settings/version-aliases
Description
Update Version Alias Configurations.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
versionAliasesForBundleComponentTypeSpec |
Version Alias Configuration Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/settings/version-aliases
Request body
{
"forceUpdate" : true,
"targetVcfVersion" : "string",
"versionAliasesForBundleComponentTypes" : [ {
"bundleComponentType" : "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, ",
"versionAliases" : [ {
"aliases" : [ "string" ],
"version" : "string"
} ]
} ]
}Example HTTP response
Response 200
{
"elements" : [ {
"bundleComponentType" : "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, ",
"versionAliases" : [ {
"aliases" : [ "string" ],
"version" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.29.3. Delete Version Alias for a bundle component type
DELETE /v1/system/settings/version-aliases/{bundleComponentType}
Description
Delete Version Alias for a bundle component type.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
bundleComponentType |
Bundle Component Type |
enum (VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/settings/version-aliases/VCENTER
Example HTTP response
Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.29.4. Update Version Alias Configuration
PUT /v1/system/settings/version-aliases/{bundleComponentType}/{version}
Description
Update Version Alias Configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
bundleComponentType |
Bundle Component Type |
enum (VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE) |
Path |
version |
Version |
string |
Body |
aliasSpec |
Alias Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/settings/version-aliases/VCENTER/string
Request body
{
"aliases" : [ "string" ],
"forceUpdate" : true
}Example HTTP response
Response 200
{
"elements" : [ {
"bundleComponentType" : "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, ",
"versionAliases" : [ {
"aliases" : [ "string" ],
"version" : "string"
} ]
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.29.5. Delete Version Alias Configuration
DELETE /v1/system/settings/version-aliases/{bundleComponentType}/{version}
Description
Delete Version Alias Configuration by bundle component type, version, and aliases.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
bundleComponentType |
Bundle Component Type |
enum (VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE) |
Path |
version |
Version |
string |
Body |
aliasVersions |
List of alias versions |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
*/*
Example HTTP request
Request path
/v1/system/settings/version-aliases/VCENTER/string
Request body
[ "string" ]Example HTTP response
Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.30. VxRailManagers
APIs for managing VxRailManagers
3.30.1. Get VxRail Managers
GET /v1/vxrail-managers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
clusterId |
ID of the cluster |
string |
Query |
domainId |
ID of the domain |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vxrail-managers
Example HTTP response
Response 200
{
"elements" : [ {
"cluster" : {
"id" : "string"
},
"domain" : {
"id" : "string",
"name" : "string"
},
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string",
"status" : "string",
"vcenter" : {
"fqdn" : "string",
"id" : "string"
},
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.30.2. Get a VxRail Manager
GET /v1/vxrail-managers/{fqdn}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
fqdn |
fqdn |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
Resource not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vxrail-managers/string
Example HTTP response
Response 200
{
"cluster" : {
"id" : "string"
},
"domain" : {
"id" : "string",
"name" : "string"
},
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"name" : "string",
"status" : "string",
"vcenter" : {
"fqdn" : "string",
"id" : "string"
},
"version" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.31. WSA
APIs for managing Workspace ONE Access for vRealize
3.31.1. Get all existing Workspace ONE Access instances
GET /v1/wsas
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/wsas
Example HTTP response
Response 200
{
"elements" : [ {
"id" : "string",
"loadBalancerFqdn" : "wsa-lb.vrack.vsphere.local",
"loadBalancerIpAddress" : "10.0.0.15",
"nodes" : [ {
"fqdn" : "vrealize.node.vrack.vsphere.local",
"id" : "string",
"ipAddress" : "10.0.0.17",
"type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
} ],
"status" : "ACTIVE, ERROR",
"version" : "8.1.0-13036238"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.32. System
APIs for managing DNS & NTP configuration
3.32.1. Get the current DnsConfiguration
GET /v1/system/dns-configuration
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/dns-configuration
Example HTTP response
Response 200
{
"dnsServers" : [ {
"ipAddress" : "10.0.0.250",
"isPrimary" : true
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.2. Configure the Dns Server
PUT /v1/system/dns-configuration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
dnsConfiguration |
dnsConfiguration |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/dns-configuration
Request body
{
"dnsServers" : [ {
"ipAddress" : "10.0.0.250",
"isPrimary" : true
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.3. Validate DnsConfiguration input spec and system health before DNS configuration
POST /v1/system/dns-configuration/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
dnsConfiguration |
dnsConfiguration |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/dns-configuration/validations
Request body
{
"dnsServers" : [ {
"ipAddress" : "10.0.0.250",
"isPrimary" : true
} ]
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 202
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.4. Get the validations of the input dnsServers to configure new DNS server
GET /v1/system/dns-configuration/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
executionStatus |
executionStatus |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal server error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/dns-configuration/validations
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.5. Get the status of the validation of the input DnsConfiguration
GET /v1/system/dns-configuration/validations/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The validation ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal server error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/dns-configuration/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.6. Get the current NtpConfiguration
GET /v1/system/ntp-configuration
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ntp-configuration
Example HTTP response
Response 200
{
"ntpServers" : [ {
"ipAddress" : "10.0.0.250"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.7. Configure the Ntp Server
PUT /v1/system/ntp-configuration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
ntpConfiguration |
ntpConfiguration |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal server error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ntp-configuration
Request body
{
"ntpServers" : [ {
"ipAddress" : "10.0.0.250"
} ]
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.8. Validate NtpConfiguration input spec and system health before Ntp configuration
POST /v1/system/ntp-configuration/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
ntpConfiguration |
ntpConfiguration |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ntp-configuration/validations
Request body
{
"ntpServers" : [ {
"ipAddress" : "10.0.0.250"
} ]
}Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 202
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.9. Get the validations of the input ntpServers to configure new Ntp server
GET /v1/system/ntp-configuration/validations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
executionStatus |
executionStatus |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal server error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ntp-configuration/validations
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.32.10. Get the status of the validation of the input ntpServers to configure new Ntp server
GET /v1/system/ntp-configuration/validations/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
The validation ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal server error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/system/ntp-configuration/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.33. VCenters
APIs for managing vCenters
3.33.1. Get vCenters
GET /v1/vcenters
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
domainId |
ID of the domain |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vcenters
Example HTTP response
Response 200
{
"elements" : [ {
"domain" : {
"id" : "string",
"name" : "string"
},
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.33.2. Get a vCenter
GET /v1/vcenters/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
vCenter ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
404 |
vCenter not found |
|
500 |
InternalServerError |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vcenters/string
Example HTTP response
Response 200
{
"domain" : {
"id" : "string",
"name" : "string"
},
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"version" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.34. VRA
APIs for managing vRealize Automation
3.34.1. Get all existing vRealize Automation instances
GET /v1/vras
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vras
Example HTTP response
Response 200
{
"elements" : [ {
"id" : "string",
"loadBalancerFqdn" : "vra-lb.vrack.vsphere.local",
"loadBalancerIpAddress" : "10.0.0.15",
"nodes" : [ {
"fqdn" : "vrealize.node.vrack.vsphere.local",
"id" : "string",
"ipAddress" : "10.0.0.17",
"type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
} ],
"status" : "ACTIVE, ERROR",
"version" : "8.1.0-13036238"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.35. VRLI
APIs for managing vRealize Log Insight
3.35.1. Gets vRealize Log Insight integration status for workload domains
GET /v1/vrli/domains
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrli/domains
Example HTTP response
Response 200
{
"elements" : [ {
"domainId" : "string",
"status" : "ENABLED, DISABLED, IN_PROGRESS"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.35.2. Connects vRealize Log Insight with domain
PUT /v1/vrli/domains
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
domainIntegration |
Domain Integration Specification |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrli/domains
Request body
{
"domainId" : "string",
"status" : "ENABLED, DISABLED, IN_PROGRESS"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}3.35.3. Get all existing vRealize Log Insight instances
GET /v1/vrlis
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrlis
Example HTTP response
Response 200
{
"elements" : [ {
"id" : "string",
"loadBalancerFqdn" : "load-balancer.vrack.vsphere.local",
"loadBalancerIpAddress" : "10.0.0.15",
"nodes" : [ {
"fqdn" : "vrealize.node.vrack.vsphere.local",
"id" : "string",
"ipAddress" : "10.0.0.17",
"type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
} ],
"status" : "ACTIVE, ERROR",
"version" : "4.8.0-13036238"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.36. VROPs
APIs for managing vRealize Operations
3.36.1. Gets vRealize Operations integration status for workload domains
GET /v1/vrops/domains
Description
Retrieves the existing domains and their connection status with vRealize Operations.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrops/domains
Example HTTP response
Response 200
{
"elements" : [ {
"domainId" : "string",
"status" : "ENABLED, DISABLED, IN_PROGRESS"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.36.2. Connect/disconnect workload domains with vRealize Operations
PUT /v1/vrops/domains
Description
Connects/disconnects a workload domains with vRealize Operations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
domainIntegration |
Domain Integration Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrops/domains
Request body
{
"domainId" : "string",
"status" : "ENABLED, DISABLED, IN_PROGRESS"
}Example HTTP response
Response 200
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.36.3. Get all existing vRealize Operations instances
GET /v1/vropses
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vropses
Example HTTP response
Response 200
{
"elements" : [ {
"id" : "string",
"loadBalancerFqdn" : "string",
"loadBalancerIp" : "string",
"nodes" : [ {
"fqdn" : "vrealize.node.vrack.vsphere.local",
"id" : "string",
"ipAddress" : "10.0.0.17",
"password" : "string",
"status" : "ACTIVE",
"type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
"username" : "user"
} ],
"status" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.37. VRSLCM
APIs for managing vRealize Suite Lifecycle Manager
3.37.1. Get the existing vRealize Suite Lifecycle Manager
GET /v1/vrslcm
Description
Gets the complete information about the existing vRealize Suite Lifecycle Manager instance.
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcm
Example HTTP response
Response 200
{
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"status" : "string",
"version" : "string"
}3.37.2. Updates the version of VRSLCM in SDDC Manager inventory
PUT /v1/vrslcm
Description
Updates vRealize Suite Lifecycle Manager version in VCF inventory
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
vrslcmDto |
vrslcmDto |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED) |
400 |
Bad Request |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcm
Request body
{
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"status" : "string",
"version" : "string"
}Example HTTP response
Response 200
"100 CONTINUE"Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 405
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.37.3. Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment
DELETE /v1/vrslcm
Description
Triggers the vRealize Suite Lifecycle Manager rollback operation and returns an URL in the headers to track the operation status.
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcm
Example HTTP response
Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 405
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.37.4. Deploy vRealize Suite Lifecycle Manager
POST /v1/vrslcms
Description
Triggers the vRealize Suite Lifecycle Manager deployment operation and returns an URL in the headers to track the operation status.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
vrslcmPublicDeploymentSpec |
vRealize Suite Lifecycle Manager Deployment Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
|
400 |
Bad Request |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcms
Request body
{
"apiPassword" : "string",
"fqdn" : "vrslcm.vrack.vsphere.local",
"nsxtStandaloneTier1Ip" : "string",
"sshPassword" : "string"
}Example HTTP response
Response 202
{
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"id" : "string",
"isCancellable" : true,
"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" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"resources" : [ {
"fqdn" : "string",
"name" : "string",
"resourceId" : "string",
"sans" : [ "string" ],
"type" : "string"
} ],
"stages" : [ {
"completionTimestamp" : "string",
"creationTimestamp" : "string",
"description" : "string",
"errors" : [ "..." ],
"name" : "string",
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type" : "string"
} ],
"status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"subTasks" : [ "..." ],
"type" : "string"
} ],
"type" : "string"
} ],
"type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 405
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.37.5. Get all existing vRealize Suite Lifecycle Manager instances
GET /v1/vrslcms
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcms
Example HTTP response
Response 200
{
"elements" : [ {
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"status" : "string",
"version" : "string"
} ],
"pageMetadata" : {
"pageNumber" : 0,
"pageSize" : 0,
"totalElements" : 0,
"totalPages" : 0
}
}3.37.6. Validate the input specification for vRealize Suite Lifecycle Manager deployment
POST /v1/vrslcms/validations
Description
Triggers vRealize Suite Lifecycle Manager deployment specification validation workflow
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
vrslcmPublicDeploymentSpec |
vRealize Suite Lifecycle Manager Deployment Specification |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
|
400 |
Bad Request |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcms/validations
Request body
{
"apiPassword" : "string",
"fqdn" : "vrslcm.vrack.vsphere.local",
"nsxtStandaloneTier1Ip" : "string",
"sshPassword" : "string"
}Example HTTP response
Response 202
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.37.7. Get the status of the validations for vRealize Lifecycle Manager deployment
GET /v1/vrslcms/validations/{id}
Description
Gets the status of given vRealize Suite Lifecycle Manager validation workflow by given validation id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
vRealize validation id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcms/validations/string
Example HTTP response
Response 200
{
"additionalProperties" : {
"string" : "string"
},
"description" : "string",
"executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id" : "string",
"resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ {
"description" : "string",
"errorResponse" : {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
},
"nestedValidationChecks" : [ "..." ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ],
"resultStatus" : "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity" : "One among: WARNING, ERROR, INFO"
} ]
}Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}3.37.8. Update vRSLCM version by ID in SDDC Manager inventory
PUT /v1/vrslcms/{id}
Description
Updates Vrealize Suite Lifecycle Manager version
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
the ID of vRealize Suite Lifecycle Manager instance |
string |
Body |
vrslcmDto |
vrslcmDto |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED) |
400 |
Bad Request |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/v1/vrslcms/string
Request body
{
"fqdn" : "string",
"id" : "string",
"ipAddress" : "string",
"status" : "string",
"version" : "string"
}Example HTTP response
Response 200
"100 CONTINUE"Response 400
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 404
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 405
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}Response 500
{
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ {
"arguments" : [ "string" ],
"causes" : [ {
"message" : "string",
"type" : "string"
} ],
"context" : {
"string" : "string"
},
"errorCode" : "string",
"errorType" : "string",
"message" : "string",
"nestedErrors" : [ "..." ],
"referenceToken" : "string",
"remediationMessage" : "string"
} ],
"referenceToken" : "string",
"remediationMessage" : "string"
}