vmware::vcenter::vcha::cluster::Mode Interface Reference

The Mode interface provides methods to manage the operating mode of a vCenter High Availability Cluster (VCHA Cluster). More...

Inherited by vmware::vcenter::vcha::cluster::ModeStub.

List of all members.

Public Member Functions
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

The Mode interface provides methods to manage the operating mode of a vCenter High Availability Cluster (VCHA Cluster).

This interface was added in vSphere API 6.7.1.

---

Member Function Documentation

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

(

)

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.

Implemented in vmware::vcenter::vcha::cluster::ModeStub.

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

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.

Implemented in vmware::vcenter::vcha::cluster::ModeStub.

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

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.

Implemented in vmware::vcenter::vcha::cluster::ModeStub.

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

(

)

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.

Implemented in vmware::vcenter::vcha::cluster::ModeStub.

string vmware::vcenter::vcha::cluster::Mode::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.

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

Implemented in vmware::vcenter::vcha::cluster::ModeStub.

string vmware::vcenter::vcha::cluster::Mode::Set_Task

(

vmware.vcenter.vcha.cluster.ModeTypes.ClusterMode

mode

)

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.

Implemented in vmware::vcenter::vcha::cluster::ModeStub.

---

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

• Mode.cs