Get Nsx Upgrade Resources

Get Nsx Upgrade Resources

Get the list NSX upgradable reosurce with resource metadata info

Request
URI
GET
https://{api_host}/v1/upgradables/domains/{domainId}/nsxt
COPY
Path Parameters
string
domainId
Required

Domain ID

Query Parameters
string
bundleId
Optional

bundle Id of the upgrade bundle applicable on the domain

Responses
200

Ok

Returns NsxtResources of type(s) application/json 
{
    "nsxtHostClusters": [
        {
            "id": "string",
            "name": "string",
            "upgradeStatus": "string",
            "resourceHealth": "string",
            "upgradedUnits": 0,
            "totalUnits": 0,
            "domainId": "string",
            "version": "string",
            "primaryCluster": false,
            "vLcmEnabled": false,
            "configuredHardwareSupportManagers": [
                {
                    "name": "string",
                    "displayName": "string",
                    "pkg": {
                        "name": "string",
                        "version": "string"
                    }
                }
            ],
            "availableHardwareSupportManagers": [
                {
                    "name": "string",
                    "displayName": "string",
                    "packages": [
                        {
                            "name": "string",
                            "version": "string"
                        }
                    ]
                }
            ],
            "nsxtComponentId": "string"
        }
    ],
    "nsxtEdgeClusters": [
        {
            "id": "string",
            "name": "string",
            "upgradeStatus": "string",
            "resourceHealth": "string",
            "version": "string"
        }
    ],
    "nsxtManagerCluster": {
        "id": "string",
        "name": "string",
        "upgradeStatus": "string",
        "resourceHealth": "string",
        "version": "string"
    },
    "nsxtUpgradeCoordinator": {
        "id": "string",
        "upgradeStatus": "string",
        "resourceHealth": "string",
        "version": "string",
        "enabledOn": "string"
    },
    "bundleId": "string",
    "domainId": "string"
}
array of object
nsxtHostClusters
Optional

List of host clusters that are candidates for upgrade

array of object
nsxtEdgeClusters
Optional

List of edge clusters that are candidates for upgrade

object
nsxtManagerCluster
Optional

Nsx Manager Cluster Upgrade Resource

object
nsxtUpgradeCoordinator
Optional

NSX Upgrade coordinator Upgrade Resource

string
bundleId
Optional

Bundle id used to compute the upgradability

string
domainId
Optional

Domain id associated with the NSX cluster


404

Bundle Not Found

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/upgradables/domains/{domainId}/nsxt
On This Page
Upgradables Operations
GET
Get Upgradables By Domain
GET
Get Nsx Upgrade Resources
GET
Get Upgradables Clusters
GET
Get Upgradables