vmware::appliance::update::PendingStub Class Reference

Remote stub implementation of the Pending API service. More...

Inherits vmware::appliance::update::Pending.

List of all members.

Public Member Functions
	PendingStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	PendingStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
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

Remote stub implementation of the Pending API service.

---

Constructor & Destructor Documentation

vmware::appliance::update::PendingStub::PendingStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::appliance::update::PendingStub::PendingStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

vmware.appliance.update.PendingTypes.Info vmware::appliance::update::PendingStub::Get

(

string

version

)

[inline]

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.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 .

Returns:

Update

Implements vmware::appliance::update::Pending.

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

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Update

Implements vmware::appliance::update::Pending.

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

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Update

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task<vmware.appliance.update.PendingTypes.Info> vmware::appliance::update::PendingStub::GetAsync

(

string

version

)

[inline]

Gets update information.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.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 .

Returns:

Update

Implements vmware::appliance::update::Pending.

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

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .

Implements vmware::appliance::update::Pending.

void vmware::appliance::update::PendingStub::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
	)		[inline]

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::update::Pending.

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

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task vmware::appliance::update::PendingStub::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
	)		[inline]

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::update::Pending.

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

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.NotFound	source is not found
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.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

Returns:

List of the update summaries

Implements vmware::appliance::update::Pending.

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

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.NotFound	source is not found
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.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
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

List of the update summaries

Implements vmware::appliance::update::Pending.

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

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.NotFound	source is not found
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.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
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

List of the update summaries

Implements vmware::appliance::update::Pending.

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

Checks if new updates are available.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.NotFound	source is not found
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.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

Returns:

List of the update summaries

Implements vmware::appliance::update::Pending.

vmware.appliance.update.PendingTypes.PrecheckResult vmware::appliance::update::PendingStub::Precheck

(

string

version

)

[inline]

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if this version is already installed
vmware.vapi.std.errors.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 .

Returns:

PrecheckResult

Implements vmware::appliance::update::Pending.

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

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

PrecheckResult

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task<vmware.appliance.update.PendingTypes.PrecheckResult> vmware::appliance::update::PendingStub::PrecheckAsync

(

string

version

)

[inline]

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if this version is already installed
vmware.vapi.std.errors.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 .

Returns:

PrecheckResult

Implements vmware::appliance::update::Pending.

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

Runs update precheck.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

PrecheckResult

Implements vmware::appliance::update::Pending.

void vmware::appliance::update::PendingStub::Stage

(

string

version

)

[inline]

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.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.AlreadyExists	the update is already staged
vmware.vapi.std.errors.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 .

Implements vmware::appliance::update::Pending.

void vmware::appliance::update::PendingStub::Stage	(	string	version,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.AlreadyExists	the update is already staged
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::update::Pending.

void vmware::appliance::update::PendingStub::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
	)		[inline]

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::update::Pending.

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

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .

Implements vmware::appliance::update::Pending.

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

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task vmware::appliance::update::PendingStub::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
	)		[inline]

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.Error	Generic error
vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task vmware::appliance::update::PendingStub::StageAsync	(	string	version,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.AlreadyExists	the update is already staged
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task vmware::appliance::update::PendingStub::StageAsync

(

string

version

)

[inline]

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.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.AlreadyExists	the update is already staged
vmware.vapi.std.errors.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 .

Implements vmware::appliance::update::Pending.

vmware.appliance.Notifications vmware::appliance::update::PendingStub::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
	)		[inline]

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Issues struct with the issues found during the validation

Implements vmware::appliance::update::Pending.

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

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .

Returns:

Issues struct with the issues found during the validation

Implements vmware::appliance::update::Pending.

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

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .

Returns:

Issues struct with the issues found during the validation

Implements vmware::appliance::update::Pending.

global::System.Threading.Tasks.Task<vmware.appliance.Notifications> vmware::appliance::update::PendingStub::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
	)		[inline]

Validates the user provided data before the update installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	Generic error
vmware.vapi.std.errors.Unauthenticated	session is not authenticated
vmware.vapi.std.errors.Unauthorized	session is not authorized to perform this operation
vmware.vapi.std.errors.NotFound	if the update is not found
vmware.vapi.std.errors.AlreadyInDesiredState	if the update of this version is already installed
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Issues struct with the issues found during the validation

Implements vmware::appliance::update::Pending.

---

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

• appliance/update/PendingStub.cs