The Cluster interface provides methods to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster. More...

Inherited by vmware::vcenter::vcha::ClusterStub.

Public Member Functions
string	Deploy_Task (vmware.vcenter.vcha.ClusterTypes.DeploySpec spec)
	Prepares, clones, and configures a VCHA cluster.
string	Deploy_Task (vmware.vcenter.vcha.ClusterTypes.DeploySpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Prepares, clones, and configures a VCHA cluster.
string	Failover_Task (bool planned)
	Initiates failover from the active vCenter node to the passive node.
string	Failover_Task (bool planned, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Initiates failover from the active vCenter node to the passive node.
vmware.vcenter.vcha.ClusterTypes.Info	Get (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_)
	Retrieves the status of a VCHA cluster.
vmware.vcenter.vcha.ClusterTypes.Info	Get (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves the status of a VCHA cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.ClusterTypes.Info >	GetAsync (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_)
	Retrieves the status of a VCHA cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.ClusterTypes.Info >	GetAsync (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves the status of a VCHA cluster.
string	Undeploy_Task (vmware.vcenter.vcha.ClusterTypes.UndeploySpec spec)
	Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance.
string	Undeploy_Task (vmware.vcenter.vcha.ClusterTypes.UndeploySpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance.

Detailed Description

The Cluster interface provides methods to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster.

This interface was added in vSphere API 6.7.1.

Member Function Documentation

string vmware::vcenter::vcha::Cluster::Deploy_Task ( vmware.vcenter.vcha.ClusterTypes.DeploySpec spec )

Prepares, clones, and configures a VCHA cluster.

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.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
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.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

spec	Contains the deploy specification for all three nodes of a VCHA cluster.

Implemented in vmware::vcenter::vcha::ClusterStub.

string vmware::vcenter::vcha::Cluster::Deploy_Task	(	vmware.vcenter.vcha.ClusterTypes.DeploySpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Prepares, clones, and configures a VCHA cluster.

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.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
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.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

spec	Contains the deploy specification for all three nodes of a VCHA cluster.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vcha::ClusterStub.

string vmware::vcenter::vcha::Cluster::Failover_Task	(	bool	planned,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Initiates failover from the active vCenter node to the passive node.

For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover.

For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss.

A failover is allowed only in the following cases:

Cluster's mode is enabled and all cluster members are present.
Cluster's mode is maintenance and all cluster members are present.

. 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:

planned	If false, a failover is initiated immediately and may result in data loss. If true, a failover is initated after the Active node flushes its state to Passive and there is no data loss.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vcha::ClusterStub.

string vmware::vcenter::vcha::Cluster::Failover_Task ( bool planned )

Initiates failover from the active vCenter node to the passive node.

For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover.

For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss.

A failover is allowed only in the following cases:

Cluster's mode is enabled and all cluster members are present.
Cluster's mode is maintenance and all cluster members are present.

. 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:

planned If false, a failover is initiated immediately and may result in data loss. If true, a failover is initated after the Active node flushes its state to Passive and there is no data loss.

Implemented in vmware::vcenter::vcha::ClusterStub.

vmware.vcenter.vcha.ClusterTypes.Info vmware::vcenter::vcha::Cluster::Get	(	vmware.vcenter.vcha.CredentialsSpec	vcSpec,
		bool?	partial_
	)

Retrieves the status of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. If partial_ is false or unset, then the operation execution requires the Global.VCServer privilege. If partial_ is true, then the operation execution requires the System.Read privilege.
vmware.vapi.std.errors.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

vcSpec	Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
partial_	If true, then return only the information that does not require connecting to the Active vCenter Server. If false or unset, then return all the information. If null, then return all the information.

Returns:: Info structure containing the VCHA configuration and health information.

Implemented in vmware::vcenter::vcha::ClusterStub.

vmware.vcenter.vcha.ClusterTypes.Info vmware::vcenter::vcha::Cluster::Get	(	vmware.vcenter.vcha.CredentialsSpec	vcSpec,
		bool?	partial_,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Retrieves the status of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. If partial_ is false or unset, then the operation execution requires the Global.VCServer privilege. If partial_ is true, then the operation execution requires the System.Read privilege.
vmware.vapi.std.errors.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

vcSpec	Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
partial_	If true, then return only the information that does not require connecting to the Active vCenter Server. If false or unset, then return all the information. If null, then return all the information.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Info structure containing the VCHA configuration and health information.

Implemented in vmware::vcenter::vcha::ClusterStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vcha.ClusterTypes.Info> vmware::vcenter::vcha::Cluster::GetAsync	(	vmware.vcenter.vcha.CredentialsSpec	vcSpec,
		bool?	partial_
	)

Retrieves the status of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. If partial_ is false or unset, then the operation execution requires the Global.VCServer privilege. If partial_ is true, then the operation execution requires the System.Read privilege.
vmware.vapi.std.errors.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

vcSpec	Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
partial_	If true, then return only the information that does not require connecting to the Active vCenter Server. If false or unset, then return all the information. If null, then return all the information.

Returns:: Info structure containing the VCHA configuration and health information.

Implemented in vmware::vcenter::vcha::ClusterStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vcha.ClusterTypes.Info> vmware::vcenter::vcha::Cluster::GetAsync	(	vmware.vcenter.vcha.CredentialsSpec	vcSpec,
		bool?	partial_,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Retrieves the status of a VCHA cluster.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.Unauthorized	If the user has insufficient privilege to perform the operation. If partial_ is false or unset, then the operation execution requires the Global.VCServer privilege. If partial_ is true, then the operation execution requires the System.Read privilege.
vmware.vapi.std.errors.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

vcSpec	Contains active node's management vCenter server credentials. If null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
partial_	If true, then return only the information that does not require connecting to the Active vCenter Server. If false or unset, then return all the information. If null, then return all the information.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Info structure containing the VCHA configuration and health information.

Implemented in vmware::vcenter::vcha::ClusterStub.

string vmware::vcenter::vcha::Cluster::Undeploy_Task	(	vmware.vcenter.vcha.ClusterTypes.UndeploySpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance.

Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed.

If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.. 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.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.NotFound	If the passive virtual machine is not managed by the specified vCenter server.
vmware.vapi.std.errors.NotFound	If the witness virtual machine is not managed by the specified vCenter server.
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.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

spec	Contains the undeploy specification for a VCHA cluster.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vcha::ClusterStub.

string vmware::vcenter::vcha::Cluster::Undeploy_Task ( vmware.vcenter.vcha.ClusterTypes.UndeploySpec spec )

Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance.

Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed.

If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.. 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.InvalidArgument	If the credentials provided for authenticating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.NotFound	If the passive virtual machine is not managed by the specified vCenter server.
vmware.vapi.std.errors.NotFound	If the witness virtual machine is not managed by the specified vCenter server.
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.UnverifiedPeer	If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains all the fields defined in CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

spec	Contains the undeploy specification for a VCHA cluster.

Implemented in vmware::vcenter::vcha::ClusterStub.

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

vcha/Cluster.cs

Public Member Functions

Detailed Description

Member Function Documentation