Get Nsx Deployment Compatibility Internal

Gets the compatibility information between the currently installed NSX version and the current vCenter Server version. This operation is executed against data bundled in vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request

URI

GET

https://{api_host}/api/vcenter/nsx/deployment/compatibility

COPY

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

Info contains the compatibility information.

Returns Nsx_Deployment_Compatibility_Info of type(s) application/json

{
    "latest_supported_version": "string",
    "supported_versions": [
        "string"
    ],
    "compatibility_state": "string"
}

string

latest_supported_version

Required

The latest supported NSX major version on vCenter Server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

array of string

supported_versions

Optional

List of NSX binary versions which are compatible with current vCenter server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Only set if supported versions are available.

Nsx_Deployment_Compatibility_State

compatibility_state

Optional

The Compatibility.State enumerated type defines the possible compatibility states between the installed NSX version and current vCenter server version. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
UP_TO_DATE : State when installed NSX major version is up-to date. However, there could be patches or updates available which have not been applied on the system. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
UPGRADE_REQUIRED : State when installed NSX version is behind the latest compatible NSX version for current vCenter server version. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
URGENT_UPGRADE_REQUIRED : State when NSX version installed is two or more versions behind the latest compatible NSX version for current vCenter server version. In this state, to upgrade the vCenter further NSX must be upgraded first. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

401

com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "localized": "string"
        }
    ],
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

500

com.vmware.vapi.std.errors.error : if there is some unknown internal error. The accompanying error message will give more details about the error.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "localized": "string"
        }
    ],
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "localized": "string"
        }
    ],
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional