com.vmware.appliance.update

Interface Pending

All Superinterfaces:

PendingTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PendingStub

public interface Pending
extends com.vmware.vapi.bindings.Service, PendingTypes

The Pending interface provides methods to manipulate pending updates. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.update.PendingTypes

PendingTypes.Info, PendingTypes.PrecheckResult, PendingTypes.Question, PendingTypes.SourceType, PendingTypes.UpgradeableComponent

Field Summary

Fields inherited from interface com.vmware.appliance.update.PendingTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PendingTypes.Info	get(java.lang.String version, java.lang.String component) Gets update information.
void	get(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.Info> asyncCallback) Gets update information.
void	get(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Gets update information.
PendingTypes.Info	get(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Gets update information.
void	install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component) Starts operation of installing the appliance update.
void	install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Starts operation of installing the appliance update.
void	install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts operation of installing the appliance update.
void	install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts operation of installing the appliance update.
java.util.List<Summary>	list(PendingTypes.SourceType sourceType, java.lang.String url, java.lang.Boolean enableListMajorUpgradeVersions) Checks if there are any eligible updates.
void	list(PendingTypes.SourceType sourceType, java.lang.String url, java.lang.Boolean enableListMajorUpgradeVersions, com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Summary>> asyncCallback) Checks if there are any eligible updates.
void	list(PendingTypes.SourceType sourceType, java.lang.String url, java.lang.Boolean enableListMajorUpgradeVersions, com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Summary>> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Checks if there are any eligible updates.
java.util.List<Summary>	list(PendingTypes.SourceType sourceType, java.lang.String url, java.lang.Boolean enableListMajorUpgradeVersions, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Checks if there are any eligible updates.
java.util.List<PendingTypes.UpgradeableComponent>	listUpgradeableComponents(java.lang.String version) List of all upgradeable components eligible for update within specified version.
void	listUpgradeableComponents(java.lang.String version, com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<PendingTypes.UpgradeableComponent>> asyncCallback) List of all upgradeable components eligible for update within specified version.
void	listUpgradeableComponents(java.lang.String version, com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<PendingTypes.UpgradeableComponent>> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List of all upgradeable components eligible for update within specified version.
java.util.List<PendingTypes.UpgradeableComponent>	listUpgradeableComponents(java.lang.String version, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List of all upgradeable components eligible for update within specified version.
PendingTypes.PrecheckResult	precheck(java.lang.String version, java.lang.String component) Runs update precheck.
void	precheck(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.PrecheckResult> asyncCallback) Runs update precheck.
void	precheck(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.PrecheckResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Runs update precheck.
PendingTypes.PrecheckResult	precheck(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Runs update precheck.
void	rollback() Starts the update rollback operation such that the vCenter is reverted to a state before update installation.
void	rollback(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Starts the update rollback operation such that the vCenter is reverted to a state before update installation.
void	rollback(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts the update rollback operation such that the vCenter is reverted to a state before update installation.
void	rollback(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts the update rollback operation such that the vCenter is reverted to a state before update installation.
void	stage(java.lang.String version, java.lang.String component) Starts staging the appliance update.
void	stage(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Starts staging the appliance update.
void	stage(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts staging the appliance update.
void	stage(java.lang.String version, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts staging the appliance update.
void	stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component) Starts operation of installing the appliance update.
void	stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Starts operation of installing the appliance update.
void	stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts operation of installing the appliance update.
void	stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Starts operation of installing the appliance update.
Notifications	validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component) Validates the user provided data before the update installation.
void	validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<Notifications> asyncCallback) Validates the user provided data before the update installation.
void	validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<Notifications> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Validates the user provided data before the update installation.
Notifications	validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Validates the user provided data before the update installation.

Method Detail

list

java.util.List<Summary> list(PendingTypes.SourceType sourceType,
                             java.lang.String url,
                             java.lang.Boolean enableListMajorUpgradeVersions)

Checks if there are any eligible updates. This method was added in vSphere API 6.7.

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

Parameters:

sourceType - type of the source

url - specific URL to check at If null then URL is taken from the policy settings

enableListMajorUpgradeVersions - checks and lists if there are eligible major version upgrades available. Possible values are true and false when set to true it allows listing of across version upgrade When not specified lists only minor updates available

Returns:

List of the update summaries

Throws:

Error - Generic error

NotFound - source is not found

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

list

java.util.List<Summary> list(PendingTypes.SourceType sourceType,
                             java.lang.String url,
                             java.lang.Boolean enableListMajorUpgradeVersions,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Checks if there are any eligible updates. This method was added in vSphere API 6.7.

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:

sourceType - type of the source

url - specific URL to check at If null then URL is taken from the policy settings

enableListMajorUpgradeVersions - checks and lists if there are eligible major version upgrades available. Possible values are true and false when set to true it allows listing of across version upgrade When not specified lists only minor updates available

invocationConfig - Configuration for the method invocation.

Returns:

List of the update summaries

Throws:

Error - Generic error

NotFound - source is not found

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

list

void list(PendingTypes.SourceType sourceType,
          java.lang.String url,
          java.lang.Boolean enableListMajorUpgradeVersions,
          com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Summary>> asyncCallback)

Checks if there are any eligible updates. This method was added in vSphere API 6.7.

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

Invocation Result:
List of the update summaries

Operation Errors:
Error - Generic error
NotFound - source is not found
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

sourceType - type of the source

url - specific URL to check at If null then URL is taken from the policy settings

enableListMajorUpgradeVersions - checks and lists if there are eligible major version upgrades available. Possible values are true and false when set to true it allows listing of across version upgrade When not specified lists only minor updates available

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

list

void list(PendingTypes.SourceType sourceType,
          java.lang.String url,
          java.lang.Boolean enableListMajorUpgradeVersions,
          com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Summary>> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Checks if there are any eligible updates. This method was added in vSphere API 6.7.

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:
List of the update summaries

Operation Errors:
Error - Generic error
NotFound - source is not found
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

sourceType - type of the source

url - specific URL to check at If null then URL is taken from the policy settings

enableListMajorUpgradeVersions - checks and lists if there are eligible major version upgrades available. Possible values are true and false when set to true it allows listing of across version upgrade When not specified lists only minor updates available

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

invocationConfig - Configuration for the method invocation.

get

PendingTypes.Info get(java.lang.String version,
                      java.lang.String component)

Gets update information. This method was added in vSphere API 6.7.

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

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

Returns:

Update

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - the update is not found

AlreadyInDesiredState - if the update of this version is already installed

get

PendingTypes.Info get(java.lang.String version,
                      java.lang.String component,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Gets update information. This method was added in vSphere API 6.7.

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:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

invocationConfig - Configuration for the method invocation.

Returns:

Update

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - the update is not found

AlreadyInDesiredState - if the update of this version is already installed

get

void get(java.lang.String version,
         java.lang.String component,
         com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.Info> asyncCallback)

Gets update information. This method was added in vSphere API 6.7.

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

Invocation Result:
Update

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - the update is not found
AlreadyInDesiredState - if the update of this version is already installed

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

get

void get(java.lang.String version,
         java.lang.String component,
         com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.Info> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Gets update information. This method was added in vSphere API 6.7.

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:
Update

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - the update is not found
AlreadyInDesiredState - if the update of this version is already installed

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

invocationConfig - Configuration for the method invocation.

listUpgradeableComponents

java.util.List<PendingTypes.UpgradeableComponent> listUpgradeableComponents(java.lang.String version)

List of all upgradeable components eligible for update within specified version. An upgradeable component can be upgraded to new version individually without upgrading the whole vCenter to it. This method was added in vSphere API 8.0.0.1.

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

Parameters:

version - specific version to check eligible updates The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

Returns:

List of the upgradeable component info

Throws:

Error - Generic error

NotFound - source is not found

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

listUpgradeableComponents

java.util.List<PendingTypes.UpgradeableComponent> listUpgradeableComponents(java.lang.String version,
                                                                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List of all upgradeable components eligible for update within specified version. An upgradeable component can be upgraded to new version individually without upgrading the whole vCenter to it. This method was added in vSphere API 8.0.0.1.

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:

version - specific version to check eligible updates The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

invocationConfig - Configuration for the method invocation.

Returns:

List of the upgradeable component info

Throws:

Error - Generic error

NotFound - source is not found

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

listUpgradeableComponents

void listUpgradeableComponents(java.lang.String version,
                               com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<PendingTypes.UpgradeableComponent>> asyncCallback)

List of all upgradeable components eligible for update within specified version. An upgradeable component can be upgraded to new version individually without upgrading the whole vCenter to it. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
List of the upgradeable component info

Operation Errors:
Error - Generic error
NotFound - source is not found
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

version - specific version to check eligible updates The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

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

listUpgradeableComponents

void listUpgradeableComponents(java.lang.String version,
                               com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<PendingTypes.UpgradeableComponent>> asyncCallback,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List of all upgradeable components eligible for update within specified version. An upgradeable component can be upgraded to new version individually without upgrading the whole vCenter to it. This method was added in vSphere API 8.0.0.1.

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:
List of the upgradeable component info

Operation Errors:
Error - Generic error
NotFound - source is not found
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

version - specific version to check eligible updates The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

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

invocationConfig - Configuration for the method invocation.

precheck

PendingTypes.PrecheckResult precheck(java.lang.String version,
                                     java.lang.String component)

Runs update precheck. This method was added in vSphere API 6.7.

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

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

Returns:

PrecheckResult

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - the update is not found

AlreadyInDesiredState - if this version is already installed

NotAllowedInCurrentState - if another operation is in progress

precheck

PendingTypes.PrecheckResult precheck(java.lang.String version,
                                     java.lang.String component,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Runs update precheck. This method was added in vSphere API 6.7.

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:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

invocationConfig - Configuration for the method invocation.

Returns:

PrecheckResult

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - the update is not found

AlreadyInDesiredState - if this version is already installed

NotAllowedInCurrentState - if another operation is in progress

precheck

void precheck(java.lang.String version,
              java.lang.String component,
              com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.PrecheckResult> asyncCallback)

Runs update precheck. This method was added in vSphere API 6.7.

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

Invocation Result:
PrecheckResult

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - the update is not found
AlreadyInDesiredState - if this version is already installed
NotAllowedInCurrentState - if another operation is in progress

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

precheck

void precheck(java.lang.String version,
              java.lang.String component,
              com.vmware.vapi.bindings.client.AsyncCallback<PendingTypes.PrecheckResult> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Runs update precheck. This method was added in vSphere API 6.7.

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:
PrecheckResult

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - the update is not found
AlreadyInDesiredState - if this version is already installed
NotAllowedInCurrentState - if another operation is in progress

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

invocationConfig - Configuration for the method invocation.

stage

void stage(java.lang.String version,
           java.lang.String component)

Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - the update is not found

AlreadyInDesiredState - if the update of this version is already installed

AlreadyExists - the update is already staged

NotAllowedInCurrentState - if appliance update state prevents staging

stage

void stage(java.lang.String version,
           java.lang.String component,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - the update is not found

AlreadyInDesiredState - if the update of this version is already installed

AlreadyExists - the update is already staged

NotAllowedInCurrentState - if appliance update state prevents staging

stage

void stage(java.lang.String version,
           java.lang.String component,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - the update is not found
AlreadyInDesiredState - if the update of this version is already installed
AlreadyExists - the update is already staged
NotAllowedInCurrentState - if appliance update state prevents staging

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

stage

void stage(java.lang.String version,
           java.lang.String component,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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 - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - the update is not found
AlreadyInDesiredState - if the update of this version is already installed
AlreadyExists - the update is already staged
NotAllowedInCurrentState - if appliance update state prevents staging

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

invocationConfig - Configuration for the method invocation.

validate

Notifications validate(java.lang.String version,
                       java.util.Map<java.lang.String,java.lang.String> userData,
                       java.lang.String component)

Validates the user provided data before the update installation. This method was added in vSphere API 6.7.

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

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

Returns:

Issues struct with the issues found during the validation

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if the update is not found

AlreadyInDesiredState - if the update of this version is already installed

NotAllowedInCurrentState - if appliance update state prevents running an check

validate

Notifications validate(java.lang.String version,
                       java.util.Map<java.lang.String,java.lang.String> userData,
                       java.lang.String component,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Validates the user provided data before the update installation. This method was added in vSphere API 6.7.

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:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

invocationConfig - Configuration for the method invocation.

Returns:

Issues struct with the issues found during the validation

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if the update is not found

AlreadyInDesiredState - if the update of this version is already installed

NotAllowedInCurrentState - if appliance update state prevents running an check

validate

void validate(java.lang.String version,
              java.util.Map<java.lang.String,java.lang.String> userData,
              java.lang.String component,
              com.vmware.vapi.bindings.client.AsyncCallback<Notifications> asyncCallback)

Validates the user provided data before the update installation. This method was added in vSphere API 6.7.

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

Invocation Result:
Issues struct with the issues found during the validation

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if the update is not found
AlreadyInDesiredState - if the update of this version is already installed
NotAllowedInCurrentState - if appliance update state prevents running an check

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

validate

void validate(java.lang.String version,
              java.util.Map<java.lang.String,java.lang.String> userData,
              java.lang.String component,
              com.vmware.vapi.bindings.client.AsyncCallback<Notifications> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Validates the user provided data before the update installation. This method was added in vSphere API 6.7.

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:
Issues struct with the issues found during the validation

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if the update is not found
AlreadyInDesiredState - if the update of this version is already installed
NotAllowedInCurrentState - if appliance update state prevents running an check

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

invocationConfig - Configuration for the method invocation.

install

void install(java.lang.String version,
             java.util.Map<java.lang.String,java.lang.String> userData,
             java.lang.String component)

Starts operation of installing the appliance update. Will fail is the update is not staged. This method was added in vSphere API 6.7.

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

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

Throws:

Error - Generic error

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if the update is not found

AlreadyInDesiredState - if the update of this version is already installed

NotAllowedInCurrentState - if appliance update state prevents running an update or not staged

install

void install(java.lang.String version,
             java.util.Map<java.lang.String,java.lang.String> userData,
             java.lang.String component,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts operation of installing the appliance update. Will fail is the update is not staged. This method was added in vSphere API 6.7.

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:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if the update is not found

AlreadyInDesiredState - if the update of this version is already installed

NotAllowedInCurrentState - if appliance update state prevents running an update or not staged

install

void install(java.lang.String version,
             java.util.Map<java.lang.String,java.lang.String> userData,
             java.lang.String component,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Starts operation of installing the appliance update. Will fail is the update is not staged. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if the update is not found
AlreadyInDesiredState - if the update of this version is already installed
NotAllowedInCurrentState - if appliance update state prevents running an update or not staged

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

install

void install(java.lang.String version,
             java.util.Map<java.lang.String,java.lang.String> userData,
             java.lang.String component,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts operation of installing the appliance update. Will fail is the update is not staged. This method was added in vSphere API 6.7.

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 - Generic error
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if the update is not found
AlreadyInDesiredState - if the update of this version is already installed
NotAllowedInCurrentState - if appliance update state prevents running an update or not staged

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - Name of the upgradeable component. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

invocationConfig - Configuration for the method invocation.

stageAndInstall

void stageAndInstall(java.lang.String version,
                     java.util.Map<java.lang.String,java.lang.String> userData,
                     java.lang.String component)

Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - upgradeable component to be staged and installed. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

Throws:

Error - Generic error

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if the update is not found

AlreadyInDesiredState - if the update of this version is already installed

NotAllowedInCurrentState - if appliance update state prevents running an update

stageAndInstall

void stageAndInstall(java.lang.String version,
                     java.util.Map<java.lang.String,java.lang.String> userData,
                     java.lang.String component,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - upgradeable component to be staged and installed. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if the update is not found

AlreadyInDesiredState - if the update of this version is already installed

NotAllowedInCurrentState - if appliance update state prevents running an update

stageAndInstall

void stageAndInstall(java.lang.String version,
                     java.util.Map<java.lang.String,java.lang.String> userData,
                     java.lang.String component,
                     com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if the update is not found
AlreadyInDesiredState - if the update of this version is already installed
NotAllowedInCurrentState - if appliance update state prevents running an update

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - upgradeable component to be staged and installed. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

stageAndInstall

void stageAndInstall(java.lang.String version,
                     java.util.Map<java.lang.String,java.lang.String> userData,
                     java.lang.String component,
                     com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL. This method was added in vSphere API 6.7.

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 - Generic error
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if the update is not found
AlreadyInDesiredState - if the update of this version is already installed
NotAllowedInCurrentState - if appliance update state prevents running an update

Parameters:

version - Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.

userData - map of user provided data with IDs The key in the parameter Map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.

component - upgradeable component to be staged and installed. This parameter was added in vSphere API 8.0.0.1. This parameter is optional because it was added in a newer version than its parent node.

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

invocationConfig - Configuration for the method invocation.

rollback

void rollback()

Starts the update rollback operation such that the vCenter is reverted to a state before update installation. It will remove any changes done by update-install operation on the vCenter.

Caution: This operation will perform a reboot of appliance.

. This method was added in vSphere API 6.7.

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

Throws:

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if there is no valid snapshot present on the vCenter

Error - Generic error

NotAllowedInCurrentState - if appliance update state prevents running a rollback operation

rollback

void rollback(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts the update rollback operation such that the vCenter is reverted to a state before update installation. It will remove any changes done by update-install operation on the vCenter.

Caution: This operation will perform a reboot of appliance.

. This method was added in vSphere API 6.7.

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:

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

NotFound - if there is no valid snapshot present on the vCenter

Error - Generic error

NotAllowedInCurrentState - if appliance update state prevents running a rollback operation

rollback

void rollback(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Starts the update rollback operation such that the vCenter is reverted to a state before update installation. It will remove any changes done by update-install operation on the vCenter.

Caution: This operation will perform a reboot of appliance.

. This method was added in vSphere API 6.7.

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

Operation Errors:
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if there is no valid snapshot present on the vCenter
Error - Generic error
NotAllowedInCurrentState - if appliance update state prevents running a rollback operation

Parameters:

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

rollback

void rollback(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Starts the update rollback operation such that the vCenter is reverted to a state before update installation. It will remove any changes done by update-install operation on the vCenter.

Caution: This operation will perform a reboot of appliance.

. This method was added in vSphere API 6.7.

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:
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation
NotFound - if there is no valid snapshot present on the vCenter
Error - Generic error
NotAllowedInCurrentState - if appliance update state prevents running a rollback operation

Parameters:

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

invocationConfig - Configuration for the method invocation.