com.vmware.vcenter.namespace_management.supervisors

Interface SupervisorServices

All Superinterfaces:

com.vmware.vapi.bindings.Service, SupervisorServicesTypes

All Known Implementing Classes:

SupervisorServicesStub

public interface SupervisorServices
extends com.vmware.vapi.bindings.Service, SupervisorServicesTypes

The SupervisorServices interface provides methods to install and manage running instances of Supervisor Services on a Supervisor cluster. Existing methods under ClusterSupervisorServices will be migrated to this interface. 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.supervisors.SupervisorServicesTypes

SupervisorServicesTypes.Message, SupervisorServicesTypes.PrecheckResult, SupervisorServicesTypes.PrecheckSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SupervisorServicesTypes.PrecheckResult	getPrecheckResult(java.lang.String supervisor, java.lang.String supervisorService, java.lang.String targetVersion) Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor.
void	getPrecheckResult(java.lang.String supervisor, java.lang.String supervisorService, java.lang.String targetVersion, com.vmware.vapi.bindings.client.AsyncCallback<SupervisorServicesTypes.PrecheckResult> asyncCallback) Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor.
void	getPrecheckResult(java.lang.String supervisor, java.lang.String supervisorService, java.lang.String targetVersion, com.vmware.vapi.bindings.client.AsyncCallback<SupervisorServicesTypes.PrecheckResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor.
SupervisorServicesTypes.PrecheckResult	getPrecheckResult(java.lang.String supervisor, java.lang.String supervisorService, java.lang.String targetVersion, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor.
java.lang.String	precheck(java.lang.String supervisor, java.lang.String supervisorService, SupervisorServicesTypes.PrecheckSpec spec) Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor.
void	precheck(java.lang.String supervisor, java.lang.String supervisorService, SupervisorServicesTypes.PrecheckSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor.
void	precheck(java.lang.String supervisor, java.lang.String supervisorService, SupervisorServicesTypes.PrecheckSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor.
java.lang.String	precheck(java.lang.String supervisor, java.lang.String supervisorService, SupervisorServicesTypes.PrecheckSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor.

Method Detail

precheck

java.lang.String precheck(java.lang.String supervisor,
                          java.lang.String supervisorService,
                          SupervisorServicesTypes.PrecheckSpec spec)

Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor. For example, if a Supervisor is running version 1.0 of a service, use this API with a target version of 2.0 to know if the service version 2.0 is also compatible with this Supervisor. The pre-check result can be fetched asynchronously by getPrecheckResult(java.lang.String, java.lang.String, java.lang.String) method. 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 to initiate the pre-check. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

supervisorService - Identifier of the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service pre-check.

Returns:

The task identifier for the precheck operation. The return value will be an identifier for the resource type: com.vmware.cis.task.

Throws:

InvalidArgument - if spec contains any errors.

NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or the version defined in spec could not be located.

NotAllowedInCurrentState - if the Supervisor is configuring or being removed.

Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.

Error - for any other error.

precheck

java.lang.String precheck(java.lang.String supervisor,
                          java.lang.String supervisorService,
                          SupervisorServicesTypes.PrecheckSpec spec,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor. For example, if a Supervisor is running version 1.0 of a service, use this API with a target version of 2.0 to know if the service version 2.0 is also compatible with this Supervisor. The pre-check result can be fetched asynchronously by getPrecheckResult(java.lang.String, java.lang.String, java.lang.String) method. 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 to initiate the pre-check. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

supervisorService - Identifier of the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service pre-check.

invocationConfig - Configuration for the method invocation.

Returns:

The task identifier for the precheck operation. The return value will be an identifier for the resource type: com.vmware.cis.task.

Throws:

InvalidArgument - if spec contains any errors.

NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or the version defined in spec could not be located.

NotAllowedInCurrentState - if the Supervisor is configuring or being removed.

Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.

Error - for any other error.

precheck

void precheck(java.lang.String supervisor,
              java.lang.String supervisorService,
              SupervisorServicesTypes.PrecheckSpec spec,
              com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor. For example, if a Supervisor is running version 1.0 of a service, use this API with a target version of 2.0 to know if the service version 2.0 is also compatible with this Supervisor. The pre-check result can be fetched asynchronously by getPrecheckResult(java.lang.String, java.lang.String, java.lang.String) method. 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:
The task identifier for the precheck operation. The return value will be an identifier for the resource type: com.vmware.cis.task.

Operation Errors:
InvalidArgument - if spec contains any errors.
NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or the version defined in spec could not be located.
NotAllowedInCurrentState - if the Supervisor is configuring or being removed.
Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.
Error - for any other error.

Parameters:

supervisor - Identifier for the Supervisor on which to initiate the pre-check. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

supervisorService - Identifier of the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service pre-check.

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

precheck

void precheck(java.lang.String supervisor,
              java.lang.String supervisorService,
              SupervisorServicesTypes.PrecheckSpec spec,
              com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor. For example, if a Supervisor is running version 1.0 of a service, use this API with a target version of 2.0 to know if the service version 2.0 is also compatible with this Supervisor. The pre-check result can be fetched asynchronously by getPrecheckResult(java.lang.String, java.lang.String, java.lang.String) method. 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:
The task identifier for the precheck operation. The return value will be an identifier for the resource type: com.vmware.cis.task.

Operation Errors:
InvalidArgument - if spec contains any errors.
NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or the version defined in spec could not be located.
NotAllowedInCurrentState - if the Supervisor is configuring or being removed.
Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.
Error - for any other error.

Parameters:

supervisor - Identifier for the Supervisor on which to initiate the pre-check. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

supervisorService - Identifier of the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

spec - Specification for the Supervisor Service pre-check.

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

invocationConfig - Configuration for the method invocation.

getPrecheckResult

SupervisorServicesTypes.PrecheckResult getPrecheckResult(java.lang.String supervisor,
                                                         java.lang.String supervisorService,
                                                         java.lang.String targetVersion)

Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor. If the Supervisor Service on the Supervisor has been installed, upgraded or deleted since the last precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method, the stale result will be purged and the user should re-initiate a precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method. 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.

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

targetVersion - Identifier for the target version to run the pre-check with. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.

Returns:

The result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for the Supervisor Service version on the Supervisor.

Throws:

NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or version with the ID targetVersion could not be located or there is no valid pre-check result available.

Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.

Error - for any other error.

getPrecheckResult

SupervisorServicesTypes.PrecheckResult getPrecheckResult(java.lang.String supervisor,
                                                         java.lang.String supervisorService,
                                                         java.lang.String targetVersion,
                                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor. If the Supervisor Service on the Supervisor has been installed, upgraded or deleted since the last precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method, the stale result will be purged and the user should re-initiate a precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method. 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.

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

targetVersion - Identifier for the target version to run the pre-check with. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.

invocationConfig - Configuration for the method invocation.

Returns:

The result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for the Supervisor Service version on the Supervisor.

Throws:

NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or version with the ID targetVersion could not be located or there is no valid pre-check result available.

Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.

Error - for any other error.

getPrecheckResult

void getPrecheckResult(java.lang.String supervisor,
                       java.lang.String supervisorService,
                       java.lang.String targetVersion,
                       com.vmware.vapi.bindings.client.AsyncCallback<SupervisorServicesTypes.PrecheckResult> asyncCallback)

Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor. If the Supervisor Service on the Supervisor has been installed, upgraded or deleted since the last precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method, the stale result will be purged and the user should re-initiate a precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method. 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:
The result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for the Supervisor Service version on the Supervisor.

Operation Errors:
NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or version with the ID targetVersion could not be located or there is no valid pre-check result available.
Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.
Error - for any other error.

Parameters:

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

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

targetVersion - Identifier for the target version to run the pre-check with. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.

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

getPrecheckResult

void getPrecheckResult(java.lang.String supervisor,
                       java.lang.String supervisorService,
                       java.lang.String targetVersion,
                       com.vmware.vapi.bindings.client.AsyncCallback<SupervisorServicesTypes.PrecheckResult> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for a specific Supervisor Service version on a Supervisor. If the Supervisor Service on the Supervisor has been installed, upgraded or deleted since the last precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method, the stale result will be purged and the user should re-initiate a precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method. 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:
The result of the last valid precheck(java.lang.String, java.lang.String, com.vmware.vcenter.namespace_management.supervisors.SupervisorServicesTypes.PrecheckSpec) method for the Supervisor Service version on the Supervisor.

Operation Errors:
NotFound - if Supervisor with the ID supervisor or Supervisor Service with the ID supervisorService or version with the ID targetVersion could not be located or there is no valid pre-check result available.
Unsupported - if the Supervisor doesn't support Supervisor Service or Supervisor Service precheck.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the SupervisorServices.Install privilege on the specified Supervisor.
Error - for any other error.

Parameters:

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

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

targetVersion - Identifier for the target version to run the pre-check with. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.

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

invocationConfig - Configuration for the method invocation.