vmware::vcenter::vcha::cluster::ModeStub Class Reference

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

Inherits vmware::vcenter::vcha::cluster::Mode.

List of all members.

Public Member Functions
	ModeStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	ModeStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.vcenter.vcha.cluster.ModeTypes.Info	Get ()
	Retrieves the current mode of a VCHA cluster.
vmware.vcenter.vcha.cluster.ModeTypes.Info	Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves the current mode of a VCHA cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.cluster.ModeTypes.Info >	GetAsync ()
	Retrieves the current mode of a VCHA cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.cluster.ModeTypes.Info >	GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves the current mode of a VCHA cluster.
string	Set_Task (vmware.vcenter.vcha.cluster.ModeTypes.ClusterMode mode)
	Manipulates the mode of a VCHA Cluster.
string	Set_Task (vmware.vcenter.vcha.cluster.ModeTypes.ClusterMode mode, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Manipulates the mode of a VCHA Cluster.

---

Detailed Description

Remote stub implementation of the Mode API service.

---

Constructor & Destructor Documentation

vmware::vcenter::vcha::cluster::ModeStub::ModeStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::vcenter::vcha::cluster::ModeStub::ModeStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

vmware.vcenter.vcha.cluster.ModeTypes.Info vmware::vcenter::vcha::cluster::ModeStub::Get

(

)

[inline]

Retrieves the current mode of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	If the VCHA cluster is not configured.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
vmware.vapi.std.errors.Error	If any other error occurs.

Returns:

Info structure containing the mode of the the VCHA cluster.

Implements vmware::vcenter::vcha::cluster::Mode.

vmware.vcenter.vcha.cluster.ModeTypes.Info vmware::vcenter::vcha::cluster::ModeStub::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Retrieves the current mode of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	If the VCHA cluster is not configured.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
vmware.vapi.std.errors.Error	If any other error occurs.

Returns:

Info structure containing the mode of the the VCHA cluster.

Implements vmware::vcenter::vcha::cluster::Mode.

global::System.Threading.Tasks.Task<vmware.vcenter.vcha.cluster.ModeTypes.Info> vmware::vcenter::vcha::cluster::ModeStub::GetAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Retrieves the current mode of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	If the VCHA cluster is not configured.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
vmware.vapi.std.errors.Error	If any other error occurs.

Returns:

Info structure containing the mode of the the VCHA cluster.

Implements vmware::vcenter::vcha::cluster::Mode.

global::System.Threading.Tasks.Task<vmware.vcenter.vcha.cluster.ModeTypes.Info> vmware::vcenter::vcha::cluster::ModeStub::GetAsync

(

)

[inline]

Retrieves the current mode of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	If the VCHA cluster is not configured.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
vmware.vapi.std.errors.Error	If any other error occurs.

Returns:

Info structure containing the mode of the the VCHA cluster.

Implements vmware::vcenter::vcha::cluster::Mode.

string vmware::vcenter::vcha::cluster::ModeStub::Set_Task	(	vmware.vcenter.vcha.cluster.ModeTypes.ClusterMode	mode,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Manipulates the mode of a VCHA Cluster.

Following mode transitions are allowed: enabled -> disabled - Allowed only in healthy and degraded states. enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.. This method was added in vSphere API 6.7.1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

mode	Clustermode to change the VCHA cluster mode to.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::vcenter::vcha::cluster::Mode.

string vmware::vcenter::vcha::cluster::ModeStub::Set_Task

(

vmware.vcenter.vcha.cluster.ModeTypes.ClusterMode

mode

)

[inline]

Manipulates the mode of a VCHA Cluster.

Following mode transitions are allowed: enabled -> disabled - Allowed only in healthy and degraded states. enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.. This method was added in vSphere API 6.7.1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

mode	Clustermode to change the VCHA cluster mode to.

Implements vmware::vcenter::vcha::cluster::Mode.

---

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

• ModeStub.cs