VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::appliance::update::Pending Interface Reference

The Pending interface provides methods to manipulate pending updates. More...

Inherited by vmware::appliance::update::PendingStub.

List of all members.

Public Member Functions

global::System.Collections.Generic.List
< vmware.appliance.update.Summary
List (vmware.appliance.update.PendingTypes.SourceType sourceType, string url)
 Checks if new updates are available.
global::System.Collections.Generic.List
< vmware.appliance.update.Summary
List (vmware.appliance.update.PendingTypes.SourceType sourceType, string url, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Checks if new updates are available.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.appliance.update.Summary > > 
ListAsync (vmware.appliance.update.PendingTypes.SourceType sourceType, string url)
 Checks if new updates are available.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.appliance.update.Summary > > 
ListAsync (vmware.appliance.update.PendingTypes.SourceType sourceType, string url, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Checks if new updates are available.
vmware.appliance.update.PendingTypes.Info Get (string version)
 Gets update information.
vmware.appliance.update.PendingTypes.Info Get (string version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Gets update information.
global::System.Threading.Tasks.Task
< vmware.appliance.update.PendingTypes.Info
GetAsync (string version)
 Gets update information.
global::System.Threading.Tasks.Task
< vmware.appliance.update.PendingTypes.Info
GetAsync (string version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Gets update information.
vmware.appliance.update.PendingTypes.PrecheckResult Precheck (string version)
 Runs update precheck.
vmware.appliance.update.PendingTypes.PrecheckResult Precheck (string version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Runs update precheck.
global::System.Threading.Tasks.Task
< vmware.appliance.update.PendingTypes.PrecheckResult
PrecheckAsync (string version)
 Runs update precheck.
global::System.Threading.Tasks.Task
< vmware.appliance.update.PendingTypes.PrecheckResult
PrecheckAsync (string version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Runs update precheck.
void Stage (string version)
 Starts staging the appliance update.
void Stage (string version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Starts staging the appliance update.
global::System.Threading.Tasks.Task StageAsync (string version)
 Starts staging the appliance update.
global::System.Threading.Tasks.Task StageAsync (string version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Starts staging the appliance update.
vmware.appliance.Notifications Validate (string version, global::System.Collections.Generic.Dictionary< string, string > userData)
 Validates the user provided data before the update installation.
vmware.appliance.Notifications Validate (string version, global::System.Collections.Generic.Dictionary< string, string > userData, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Validates the user provided data before the update installation.
global::System.Threading.Tasks.Task
< vmware.appliance.Notifications
ValidateAsync (string version, global::System.Collections.Generic.Dictionary< string, string > userData)
 Validates the user provided data before the update installation.
global::System.Threading.Tasks.Task
< vmware.appliance.Notifications
ValidateAsync (string version, global::System.Collections.Generic.Dictionary< string, string > userData, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Validates the user provided data before the update installation.
void Install (string version, global::System.Collections.Generic.Dictionary< string, string > userData)
 Starts operation of installing the appliance update.
void Install (string version, global::System.Collections.Generic.Dictionary< string, string > userData, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Starts operation of installing the appliance update.
global::System.Threading.Tasks.Task InstallAsync (string version, global::System.Collections.Generic.Dictionary< string, string > userData)
 Starts operation of installing the appliance update.
global::System.Threading.Tasks.Task InstallAsync (string version, global::System.Collections.Generic.Dictionary< string, string > userData, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Starts operation of installing the appliance update.
void StageAndInstall (string version, global::System.Collections.Generic.Dictionary< string, string > userData)
 Starts operation of installing the appliance update.
void StageAndInstall (string version, global::System.Collections.Generic.Dictionary< string, string > userData, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Starts operation of installing the appliance update.
global::System.Threading.Tasks.Task StageAndInstallAsync (string version, global::System.Collections.Generic.Dictionary< string, string > userData)
 Starts operation of installing the appliance update.
global::System.Threading.Tasks.Task StageAndInstallAsync (string version, global::System.Collections.Generic.Dictionary< string, string > userData, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Starts operation of installing the appliance update.

Detailed Description

The Pending interface provides methods to manipulate pending updates.

This interface was added in vSphere API 6.7.


Member Function Documentation

vmware.appliance.update.PendingTypes.Info vmware::appliance::update::Pending::Get ( string  version)

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
Returns:
Update

Implemented in vmware::appliance::update::PendingStub.

vmware.appliance.update.PendingTypes.Info vmware::appliance::update::Pending::Get ( string  version,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Update

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<vmware.appliance.update.PendingTypes.Info> vmware::appliance::update::Pending::GetAsync ( string  version,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Update

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<vmware.appliance.update.PendingTypes.Info> vmware::appliance::update::Pending::GetAsync ( string  version)

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
Returns:
Update

Implemented in vmware::appliance::update::PendingStub.

void vmware::appliance::update::Pending::Install ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData 
)

Starts operation of installing the appliance update.

Will fail is the update is not staged. This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update or not staged
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .

Implemented in vmware::appliance::update::PendingStub.

void vmware::appliance::update::Pending::Install ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update or not staged
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task vmware::appliance::update::Pending::InstallAsync ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData 
)

Starts operation of installing the appliance update.

Will fail is the update is not staged. This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update or not staged
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task vmware::appliance::update::Pending::InstallAsync ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update or not staged
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::update::PendingStub.

global::System.Collections.Generic.List<vmware.appliance.update.Summary> vmware::appliance::update::Pending::List ( vmware.appliance.update.PendingTypes.SourceType  sourceType,
string  url 
)

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.NotFoundsource is not found
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
Parameters:
sourceTypetype of the source
urlspecific URL to check at If null then URL is taken from the policy settings
Returns:
List of the update summaries

Implemented in vmware::appliance::update::PendingStub.

global::System.Collections.Generic.List<vmware.appliance.update.Summary> vmware::appliance::update::Pending::List ( vmware.appliance.update.PendingTypes.SourceType  sourceType,
string  url,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.NotFoundsource is not found
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
Parameters:
sourceTypetype of the source
urlspecific URL to check at If null then URL is taken from the policy settings
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
List of the update summaries

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.update.Summary> > vmware::appliance::update::Pending::ListAsync ( vmware.appliance.update.PendingTypes.SourceType  sourceType,
string  url,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.NotFoundsource is not found
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
Parameters:
sourceTypetype of the source
urlspecific URL to check at If null then URL is taken from the policy settings
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
List of the update summaries

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.update.Summary> > vmware::appliance::update::Pending::ListAsync ( vmware.appliance.update.PendingTypes.SourceType  sourceType,
string  url 
)

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.NotFoundsource is not found
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
Parameters:
sourceTypetype of the source
urlspecific URL to check at If null then URL is taken from the policy settings
Returns:
List of the update summaries

Implemented in vmware::appliance::update::PendingStub.

vmware.appliance.update.PendingTypes.PrecheckResult vmware::appliance::update::Pending::Precheck ( string  version)

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif another operation is in progress
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
Returns:
PrecheckResult

Implemented in vmware::appliance::update::PendingStub.

vmware.appliance.update.PendingTypes.PrecheckResult vmware::appliance::update::Pending::Precheck ( string  version,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif another operation is in progress
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
PrecheckResult

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<vmware.appliance.update.PendingTypes.PrecheckResult> vmware::appliance::update::Pending::PrecheckAsync ( string  version)

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif another operation is in progress
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
Returns:
PrecheckResult

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<vmware.appliance.update.PendingTypes.PrecheckResult> vmware::appliance::update::Pending::PrecheckAsync ( string  version,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif another operation is in progress
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
PrecheckResult

Implemented in vmware::appliance::update::PendingStub.

void vmware::appliance::update::Pending::Stage ( string  version)

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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.AlreadyExiststhe update is already staged
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents staging
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .

Implemented in vmware::appliance::update::PendingStub.

void vmware::appliance::update::Pending::Stage ( string  version,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.AlreadyExiststhe update is already staged
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents staging
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::update::PendingStub.

void vmware::appliance::update::Pending::StageAndInstall ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::update::PendingStub.

void vmware::appliance::update::Pending::StageAndInstall ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData 
)

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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task vmware::appliance::update::Pending::StageAndInstallAsync ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData 
)

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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task vmware::appliance::update::Pending::StageAndInstallAsync ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an update
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task vmware::appliance::update::Pending::StageAsync ( string  version,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.AlreadyExiststhe update is already staged
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents staging
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task vmware::appliance::update::Pending::StageAsync ( string  version)

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.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundthe update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.AlreadyExiststhe update is already staged
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents staging
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .

Implemented in vmware::appliance::update::PendingStub.

vmware.appliance.Notifications vmware::appliance::update::Pending::Validate ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an check
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Issues struct with the issues found during the validation

Implemented in vmware::appliance::update::PendingStub.

vmware.appliance.Notifications vmware::appliance::update::Pending::Validate ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData 
)

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an check
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
Returns:
Issues struct with the issues found during the validation

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<vmware.appliance.Notifications> vmware::appliance::update::Pending::ValidateAsync ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData 
)

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an check
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
Returns:
Issues struct with the issues found during the validation

Implemented in vmware::appliance::update::PendingStub.

global::System.Threading.Tasks.Task<vmware.appliance.Notifications> vmware::appliance::update::Pending::ValidateAsync ( string  version,
global::System.Collections.Generic.Dictionary< string, string >  userData,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
vmware.vapi.std.errors.Unauthenticatedsession is not authenticated
vmware.vapi.std.errors.Unauthorizedsession is not authorized to perform this operation
vmware.vapi.std.errors.NotFoundif the update is not found
vmware.vapi.std.errors.AlreadyInDesiredStateif the update of this version is already installed
vmware.vapi.std.errors.NotAllowedInCurrentStateif appliance update state prevents running an check
Parameters:
versionUpdate version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending .
userDatamap 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 .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Issues struct with the issues found during the validation

Implemented in vmware::appliance::update::PendingStub.


The documentation for this interface was generated from the following file: