Vcenter NamespaceManagement Software Supervisors Prechecks get

Vcenter NamespaceManagement Software Supervisors Prechecks get

Returns information about Supervisor upgrade pre-checks.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • The resource com.vmware.vcenter.namespace_management.supervisor.Supervisor referenced by the parameter supervisor requires System.Read.
Request
URI
GET
https://{api_host}/api/vcenter/namespace-management/software/supervisors/{supervisor}/prechecks
COPY
Path Parameters
string
supervisor
Required

Identifier for the Supervisor.

The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Request Body

Includes specification to fetch pre-check results for specific Supervisor upgrade version.

If set returns the pre-check results only for the specified target version. If missing or null returns the pre-check results for all the versions against which pre-checks ran.

Vcenter NamespaceManagement Software Supervisors Prechecks FilterSpec of type(s) application/json
Optional 
{
    "target_version": "string"
}
string
target_version
Optional

Supervisor upgrade version for which pre-check results should be queried.

This property was added in vSphere API 8.0.3.0.

If set, return the pre-check results only for the specified target version. If missing or null, return the pre-check results for all the Supervisor upgrade versions against which pre-checks have already been executed.

Authentication
This operation uses the following authentication methods.
Responses
200

Supervisor upgrade pre-check results.

"Vcenter NamespaceManagement Software Supervisors Prechecks Info Object"
array of object
precheck_results
Optional

Information about Supervisor upgrade pre-check results.

This property was added in vSphere API 8.0.3.0.

If missing or null, the Supervisor upgrade pre-checks did not run or upgrade is not available.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

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.


403

if the user does not have System.Read privilege.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

if Supervisor could not be located or pre-check results not found for Vcenter NamespaceManagement Software Supervisors Prechecks FilterSpec.target_version or pre-check results not found for any available upgrade version(s).

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
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 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.

string
error_type
Required

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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespace-management/software/supervisors/{supervisor}/prechecks
On This Page
Vcenter Namespace Management Operations
POST
Vcenter NamespaceManagement Software Supervisors Prechecks run
GET
Vcenter NamespaceManagement Software Supervisors Prechecks get