Vcenter NamespaceManagement Software Supervisors Versions checkCompatibility
Evaluates the compatibility of the specified Supervisor version with the current infrastructure (vCenter, ESX, and NSX). If the Supervisor version is compatible, it checks the feature compatibility.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
Namespaces.Upgrade.
Identifier of the Supervisor version.
The parameter must be an identifier for the resource type: SupervisorVersion.
Specification to compute the compatibility for the provided Supervisor version.
If missing or null, the compatibility check of ESX hosts will be omitted.
List of Zones for which the compatibility of Supervisor version is being checked.
This property was added in vSphere API 9.0.0.0.
If missing or null, the field Vcenter NamespaceManagement Software Supervisors Versions CheckCompatibilitySpec.cluster or Vcenter NamespaceManagement Software Supervisors Versions CheckCompatibilitySpec.supervisor should be specified.
Compatibility status of Supervisor version with provided ClusterID, SupervisorID or Zones along with the list of capabilities and their statuses.
"Vcenter NamespaceManagement Software Supervisors Versions CompatibilityInfo Object"Identifier for the Supervisor version.
This property was added in vSphere API 9.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: SupervisorVersion. When operations return a value of this schema as a response, the property will be an identifier for the resource type: SupervisorVersion.
Name of the Supervisor release.
This property was added in vSphere API 9.0.0.0.
Description of the Supervisor release.
This property was added in vSphere API 9.0.0.0.
Date of Supervisor release.
This property was added in vSphere API 9.0.0.0.
Details of Supervisor release.
This property was added in vSphere API 9.0.0.0.
Details about the source of Supervisor image.
This property was added in vSphere API 9.0.0.0.
Indicates the compatibility of Supervisor Vcenter NamespaceManagement Software Supervisors Versions CompatibilityInfo.version with the current infrastructure(vCenter, ESX and NSX).
For more information see: Vcenter NamespaceManagement Software Supervisors Versions Compatibility.
This property was added in vSphere API 9.0.0.0.
If the compatibility status of Supervisor Vcenter NamespaceManagement Software Supervisors Versions CompatibilityInfo.version is Vcenter NamespaceManagement Software Supervisors Versions Compatibility.INCOMPATIBLE, the field Vcenter NamespaceManagement Software Supervisors Versions CompatibilityInfo.incompatibility_reasons represents the list of reasons for incompatibility.
This property was added in vSphere API 9.0.0.0.
If missing or null, the Supervisor image is compatible with current infrastructure.
Represents the list of capabilities offered with the Supervisor Vcenter NamespaceManagement Software Supervisors Versions CompatibilityInfo.version.
This property was added in vSphere API 9.0.0.0.
If missing or null, the Supervisor image is incompatible with current infrastructure. Hence, we don't compute capabilities.
if spec is populated with multiple fields(Cluster ID, Supervisor ID & Zones).
"Vapi Std Errors InvalidArgument Object"if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have Namespaces.Manage privilege.
"Vapi Std Errors Unauthorized Object"if version does not exist.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"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.
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 Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespace-management/software/supervisors/versions/{version}?action=check-compatibility