vmware::vcenter::deployment::Install Interface Reference

The Install interface provides methods to configure the installation of the appliance. More...

Inherited by vmware::vcenter::deployment::InstallStub.

List of all members.

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

---

Detailed Description

The Install interface provides methods to configure the installation of the appliance.

This interface was added in vSphere API 6.7.

---

Member Function Documentation

void vmware::vcenter::deployment::Install::Cancel

(

)

Cancel the appliance installation 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::InstallStub.

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

Cancel the appliance installation 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::InstallStub.

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

Cancel the appliance installation 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::InstallStub.

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

(

)

Cancel the appliance installation 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::InstallStub.

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

Run sanity checks using the InstallSpec 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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to run sanity check with.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::InstallStub.

vmware.vcenter.deployment.CheckInfo vmware::vcenter::deployment::Install::Check

(

vmware.vcenter.deployment.InstallTypes.InstallSpec

spec

)

Run sanity checks using the InstallSpec 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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to run sanity check with.

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::InstallStub.

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

Run sanity checks using the InstallSpec 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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to run sanity check with.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::InstallStub.

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

(

vmware.vcenter.deployment.InstallTypes.InstallSpec

spec

)

Run sanity checks using the InstallSpec 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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to run sanity check with.

Returns:

CheckInfo containing the check results.

Implemented in vmware::vcenter::deployment::InstallStub.

vmware.vcenter.deployment.InstallTypes.InstallSpec vmware::vcenter::deployment::Install::Get

(

)

Get the parameters used to configure the ongoing 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.NotAllowedInCurrentState	if appliance is not in INSTALL_PROGRESS state.

Returns:

InstallSpec parameters being used to configure appliance install.

Implemented in vmware::vcenter::deployment::InstallStub.

vmware.vcenter.deployment.InstallTypes.InstallSpec vmware::vcenter::deployment::Install::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get the parameters used to configure the ongoing 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.NotAllowedInCurrentState	if appliance is not in INSTALL_PROGRESS state.

Returns:

InstallSpec parameters being used to configure appliance install.

Implemented in vmware::vcenter::deployment::InstallStub.

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

Get the parameters used to configure the ongoing 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.NotAllowedInCurrentState	if appliance is not in INSTALL_PROGRESS state.

Returns:

InstallSpec parameters being used to configure appliance install.

Implemented in vmware::vcenter::deployment::InstallStub.

global::System.Threading.Tasks.Task<vmware.vcenter.deployment.InstallTypes.InstallSpec> vmware::vcenter::deployment::Install::GetAsync

(

)

Get the parameters used to configure the ongoing 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.NotAllowedInCurrentState	if appliance is not in INSTALL_PROGRESS state.

Returns:

InstallSpec parameters being used to configure appliance install.

Implemented in vmware::vcenter::deployment::InstallStub.

void vmware::vcenter::deployment::Install::Start

(

vmware.vcenter.deployment.InstallTypes.InstallSpec

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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to configure the appliance install.

Implemented in vmware::vcenter::deployment::InstallStub.

void vmware::vcenter::deployment::Install::Start	(	vmware.vcenter.deployment.InstallTypes.InstallSpec	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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to configure the appliance install.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::deployment::InstallStub.

global::System.Threading.Tasks.Task vmware::vcenter::deployment::Install::StartAsync	(	vmware.vcenter.deployment.InstallTypes.InstallSpec	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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to configure the appliance install.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::deployment::InstallStub.

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

(

vmware.vcenter.deployment.InstallTypes.InstallSpec

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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
vmware.vapi.std.errors.Unauthenticated	if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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	InstallSpec parameters to configure the appliance install.

Implemented in vmware::vcenter::deployment::InstallStub.

---

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

• Install.cs