vmware::vcenter::deployment::Upgrade Interface Reference

The Upgrade interface provides methods to configure the upgrade of this appliance from an existing vCenter appliance. More...

Inherited by vmware::vcenter::deployment::UpgradeStub.

List of all members.

Public Member Functions
vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec	Get ()
	Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec	Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
global::System.Threading.Tasks.Task < vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec >	GetAsync ()
	Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
global::System.Threading.Tasks.Task < vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec >	GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
vmware.vcenter.deployment.CheckInfo	Check (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec)
	Run sanity checks using the UpgradeSpec parameters passed.
vmware.vcenter.deployment.CheckInfo	Check (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Run sanity checks using the UpgradeSpec parameters passed.
global::System.Threading.Tasks.Task < vmware.vcenter.deployment.CheckInfo >	CheckAsync (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec)
	Run sanity checks using the UpgradeSpec parameters passed.
global::System.Threading.Tasks.Task < vmware.vcenter.deployment.CheckInfo >	CheckAsync (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Run sanity checks using the UpgradeSpec parameters passed.
void	Start (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec)
	Start the appliance installation.
void	Start (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Start the appliance installation.
global::System.Threading.Tasks.Task	StartAsync (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec)
	Start the appliance installation.
global::System.Threading.Tasks.Task	StartAsync (vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Start the appliance installation.
void	Cancel ()
	Cancel the appliance upgrade that is in progress.
void	Cancel (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Cancel the appliance upgrade that is in progress.
global::System.Threading.Tasks.Task	CancelAsync ()
	Cancel the appliance upgrade that is in progress.
global::System.Threading.Tasks.Task	CancelAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Cancel the appliance upgrade that is in progress.

---

Detailed Description

The Upgrade interface provides methods to configure the upgrade of this appliance from an existing vCenter appliance.

This interface was added in vSphere API 6.7.

---

Member Function Documentation

void vmware::vcenter::deployment::Upgrade::Cancel

(

)

Cancel the appliance upgrade that is in progress.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Implemented in vmware::vcenter::deployment::UpgradeStub.

void vmware::vcenter::deployment::Upgrade::Cancel	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Cancel the appliance upgrade that is in progress.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::Upgrade::CancelAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Cancel the appliance upgrade that is in progress.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::Upgrade::CancelAsync

(

)

Cancel the appliance upgrade that is in progress.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Implemented in vmware::vcenter::deployment::UpgradeStub.

vmware.vcenter.deployment.CheckInfo vmware::vcenter::deployment::Upgrade::Check	(	vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Run sanity checks using the UpgradeSpec parameters passed.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to run sanity check on.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::UpgradeStub.

vmware.vcenter.deployment.CheckInfo vmware::vcenter::deployment::Upgrade::Check

(

vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec

spec

)

Run sanity checks using the UpgradeSpec parameters passed.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to run sanity check on.

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.CheckInfo> vmware::vcenter::deployment::Upgrade::CheckAsync	(	vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Run sanity checks using the UpgradeSpec parameters passed.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to run sanity check on.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.CheckInfo> vmware::vcenter::deployment::Upgrade::CheckAsync

(

vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec

spec

)

Run sanity checks using the UpgradeSpec parameters passed.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to run sanity check on.

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::UpgradeStub.

vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec vmware::vcenter::deployment::Upgrade::Get

(

)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if appliance is not in UPGRADE_PROGRESS state.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

Implemented in vmware::vcenter::deployment::UpgradeStub.

vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec vmware::vcenter::deployment::Upgrade::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if appliance is not in UPGRADE_PROGRESS state.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec> vmware::vcenter::deployment::Upgrade::GetAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if appliance is not in UPGRADE_PROGRESS state.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec> vmware::vcenter::deployment::Upgrade::GetAsync

(

)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotAllowedInCurrentState	if appliance is not in UPGRADE_PROGRESS state.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

Implemented in vmware::vcenter::deployment::UpgradeStub.

void vmware::vcenter::deployment::Upgrade::Start

(

vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec

spec

)

Start the appliance installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to configure the appliance upgrade.

Implemented in vmware::vcenter::deployment::UpgradeStub.

void vmware::vcenter::deployment::Upgrade::Start	(	vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Start the appliance installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to configure the appliance upgrade.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::Upgrade::StartAsync	(	vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Start the appliance installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to configure the appliance upgrade.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::deployment::UpgradeStub.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::Upgrade::StartAsync

(

vmware.vcenter.deployment.UpgradeTypes.UpgradeSpec

spec

)

Start the appliance installation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.Unauthenticated	if source credentials are not valid.
vmware.vapi.std.errors.Unauthenticated	if source container credentials are not valid.
vmware.vapi.std.errors.InvalidArgument	if passed arguments are invalid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the appliance is not in INITIALIZED state.

Parameters:

spec	UpgradeSpec parameters to configure the appliance upgrade.

Implemented in vmware::vcenter::deployment::UpgradeStub.

---

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

• Upgrade.cs