[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get NSX-T Upgrade Resources

Description

Get the list NSXT upgradable reosurce with resource metadata info

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/upgradables/domains/{domainId}/nsxt
Copy

Path Parameters

Path Parameters

string
domainId Required

Domain ID


Query Parameters

Query Parameters

string
bundleId Optional

bundle Id of the upgrade bundle applicable on the domain


Response

Response

Response Body

Response Body

200 OK returns array of NsxtResources of type(s) application/json
{
	"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": false,
			"resourceHealth": "string",
			"totalUnits": 0,
			"upgradeStatus": "string",
			"upgradedUnits": 0,
			"version": "string",
			"vlcmEnabled": false
		}
	],
	"nsxtManagerCluster": {
		"id": "string",
		"name": "string",
		"resourceHealth": "string",
		"upgradeStatus": "string",
		"version": "string"
	},
	"nsxtUpgradeCoordinator": {
		"enabledOn": "string",
		"id": "string",
		"resourceHealth": "string",
		"upgradeStatus": "string",
		"version": "string"
	}
}
string
bundleId Optional

Bundle id used to compute the upgradability


string
domainId Optional

Domain id associated with the NSX-T cluster


array of NsxtEdgeCluster
nsxtEdgeClusters Optional

List of edge clusters that are candidates for upgrade


array of NsxtHostCluster
nsxtHostClusters Optional

List of host clusters that are candidates for upgrade


nsxtManagerCluster Optional

Manager cluster that is a candidate for upgrade


nsxtUpgradeCoordinator Optional

Upgrade coordinator pertaining to the NSX-T instance

Errors

Errors

404

Bundle not found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/upgradables/domains/{domainId}/nsxt


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?