com.vmware.vcenter.namespace_management.software.supervisors

Interface Prechecks

All Superinterfaces:

PrechecksTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PrechecksStub

public interface Prechecks
extends com.vmware.vapi.bindings.Service, PrechecksTypes

The Prechecks interface provides methods to perform Supervisor upgrade pre-checks. This interface was added in vSphere API 8.0.3.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.software.supervisors.PrechecksTypes

PrechecksTypes.FilterSpec, PrechecksTypes.Info, PrechecksTypes.PrecheckResult, PrechecksTypes.PrecheckSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.software.supervisors.PrechecksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PrechecksTypes.Info	get(java.lang.String supervisor, PrechecksTypes.FilterSpec filter) Returns information about Supervisor upgrade pre-checks.
void	get(java.lang.String supervisor, PrechecksTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<PrechecksTypes.Info> asyncCallback) Returns information about Supervisor upgrade pre-checks.
void	get(java.lang.String supervisor, PrechecksTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<PrechecksTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about Supervisor upgrade pre-checks.
PrechecksTypes.Info	get(java.lang.String supervisor, PrechecksTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about Supervisor upgrade pre-checks.
void	run(java.lang.String supervisor, PrechecksTypes.PrecheckSpec spec) Run Supervisor upgrade pre-checks.
void	run(java.lang.String supervisor, PrechecksTypes.PrecheckSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Run Supervisor upgrade pre-checks.
void	run(java.lang.String supervisor, PrechecksTypes.PrecheckSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Run Supervisor upgrade pre-checks.
void	run(java.lang.String supervisor, PrechecksTypes.PrecheckSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Run Supervisor upgrade pre-checks.

Method Detail

run

void run(java.lang.String supervisor,
         PrechecksTypes.PrecheckSpec spec)

Run Supervisor upgrade pre-checks. This operation will initiate Supervisor upgrade pre-checks for a specific target version. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

supervisor - Identifier for the supervisor on which upgraded pre-checks are run. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specification for running Supervisor upgrade pre-checks.

Throws:

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

Unsupported - if upgrade is not available for the Supervisor.

NotAllowedInCurrentState - if Supervisor upgrade is in progress.

NotFound - if Supervisor could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Upgrade privilege.

InvalidArgument - if the com.vmware.vcenter.namespace_management.software.supervisors.Prechecks#PrecheckSpec contains invalid details.

run

void run(java.lang.String supervisor,
         PrechecksTypes.PrecheckSpec spec,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Run Supervisor upgrade pre-checks. This operation will initiate Supervisor upgrade pre-checks for a specific target version. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

supervisor - Identifier for the supervisor on which upgraded pre-checks are run. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specification for running Supervisor upgrade pre-checks.

invocationConfig - Configuration for the method invocation.

Throws:

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

Unsupported - if upgrade is not available for the Supervisor.

NotAllowedInCurrentState - if Supervisor upgrade is in progress.

NotFound - if Supervisor could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Upgrade privilege.

InvalidArgument - if the com.vmware.vcenter.namespace_management.software.supervisors.Prechecks#PrecheckSpec contains invalid details.

run

void run(java.lang.String supervisor,
         PrechecksTypes.PrecheckSpec spec,
         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Run Supervisor upgrade pre-checks. This operation will initiate Supervisor upgrade pre-checks for a specific target version. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unsupported - if upgrade is not available for the Supervisor.
NotAllowedInCurrentState - if Supervisor upgrade is in progress.
NotFound - if Supervisor could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Upgrade privilege.
InvalidArgument - if the com.vmware.vcenter.namespace_management.software.supervisors.Prechecks#PrecheckSpec contains invalid details.

Parameters:

supervisor - Identifier for the supervisor on which upgraded pre-checks are run. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specification for running Supervisor upgrade pre-checks.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

run

void run(java.lang.String supervisor,
         PrechecksTypes.PrecheckSpec spec,
         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Run Supervisor upgrade pre-checks. This operation will initiate Supervisor upgrade pre-checks for a specific target version. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unsupported - if upgrade is not available for the Supervisor.
NotAllowedInCurrentState - if Supervisor upgrade is in progress.
NotFound - if Supervisor could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Upgrade privilege.
InvalidArgument - if the com.vmware.vcenter.namespace_management.software.supervisors.Prechecks#PrecheckSpec contains invalid details.

Parameters:

supervisor - Identifier for the supervisor on which upgraded pre-checks are run. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specification for running Supervisor upgrade pre-checks.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

PrechecksTypes.Info get(java.lang.String supervisor,
                        PrechecksTypes.FilterSpec filter)

Returns information about Supervisor upgrade pre-checks. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

filter - 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 null returns the pre-check results for all the versions against which pre-checks ran.

Returns:

Supervisor upgrade pre-check results.

Throws:

NotFound - if Supervisor could not be located or pre-check results not found for PrechecksTypes.FilterSpec.getTargetVersion() or pre-check results not found for any available upgrade version(s).

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

PrechecksTypes.Info get(java.lang.String supervisor,
                        PrechecksTypes.FilterSpec filter,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about Supervisor upgrade pre-checks. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

filter - 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 null returns the pre-check results for all the versions against which pre-checks ran.

invocationConfig - Configuration for the method invocation.

Returns:

Supervisor upgrade pre-check results.

Throws:

NotFound - if Supervisor could not be located or pre-check results not found for PrechecksTypes.FilterSpec.getTargetVersion() or pre-check results not found for any available upgrade version(s).

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

void get(java.lang.String supervisor,
         PrechecksTypes.FilterSpec filter,
         com.vmware.vapi.bindings.client.AsyncCallback<PrechecksTypes.Info> asyncCallback)

Returns information about Supervisor upgrade pre-checks. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Supervisor upgrade pre-check results.

Operation Errors:
NotFound - if Supervisor could not be located or pre-check results not found for PrechecksTypes.FilterSpec.getTargetVersion() or pre-check results not found for any available upgrade version(s).
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

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

filter - 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 null returns the pre-check results for all the versions against which pre-checks ran.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String supervisor,
         PrechecksTypes.FilterSpec filter,
         com.vmware.vapi.bindings.client.AsyncCallback<PrechecksTypes.Info> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about Supervisor upgrade pre-checks. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Supervisor upgrade pre-check results.

Operation Errors:
NotFound - if Supervisor could not be located or pre-check results not found for PrechecksTypes.FilterSpec.getTargetVersion() or pre-check results not found for any available upgrade version(s).
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

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

filter - 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 null returns the pre-check results for all the versions against which pre-checks ran.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.