REST API - get

vcenter nsx deployment compatibility: get

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:

HTTP request

GET https://{server}/api/vcenter/nsx/deployment/compatibility

Response:

HTTP Status Code: 200

Response Body Structure:

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

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Info contains the compatibility information.
-.latest_supported_version	string	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.
-.supported_versions	string[]	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. Optional. Only set if supported versions are available.
-.compatibility_state	string	The compatibility state between currently installed NSX version and current vCenter server version. 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. Optional. Only set if NSX is installed.

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the user can not be authenticated.
500	error	if there is some unknown internal error. The accompanying error message will give more details about the error.