Get Nsx Upgrade Resources

Get the list NSX upgradable reosurce with resource metadata info

Request

URI

GET

https://sfo-vcf01.rainpole.io/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

Returns 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 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

nsxtManagerCluster

Optional

Nsx Manager Cluster Upgrade Resource

NsxtUpgradeCoordinator

nsxtUpgradeCoordinator

Optional

NSX Upgrade coordinator Upgrade Resource

404

Bundle not found

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

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.

string

remediationMessage

Optional

The localized remediation error message

500

Internal Server Error

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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