vmware::vcenter::vcha::cluster::Witness Interface Reference

The Witness interface provides methods to validate a witness's placement configuration and redeploy the witness node in a vCenter High Availability (VCHA) cluster. More...

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

List of all members.

Public Member Functions
vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult	Check (vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec spec)
	Validates the specified witness node's placement configuration.
vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult	Check (vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Validates the specified witness node's placement configuration.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult >	CheckAsync (vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec spec)
	Validates the specified witness node's placement configuration.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult >	CheckAsync (vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Validates the specified witness node's placement configuration.
string	Redeploy_Task (vmware.vcenter.vcha.cluster.WitnessTypes.RedeploySpec spec)
	Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.
string	Redeploy_Task (vmware.vcenter.vcha.cluster.WitnessTypes.RedeploySpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

---

Detailed Description

The Witness interface provides methods to validate a witness's placement configuration and redeploy the witness node in a vCenter High Availability (VCHA) cluster.

This interface was added in vSphere API 6.7.1.

---

Member Function Documentation

vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult vmware::vcenter::vcha::cluster::Witness::Check

(

vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec

spec

)

Validates the specified witness node's placement configuration.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authentincating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.InvalidArgument	If the specified resource spec is deemed invalid for the clone operation.
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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.NotFound	If the active virtual machine is not managed by the specified vCenter server for the active node.
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
vmware.vapi.std.errors.NotAllowedInCurrentState	If the clone operation is not allowed in the current state of the system.
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:

spec	Contains the witness node's placement specification.

Returns:

CheckResult structure containing errors and warnings.

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

vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult vmware::vcenter::vcha::cluster::Witness::Check	(	vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Validates the specified witness node's placement configuration.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authentincating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.InvalidArgument	If the specified resource spec is deemed invalid for the clone operation.
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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.NotFound	If the active virtual machine is not managed by the specified vCenter server for the active node.
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
vmware.vapi.std.errors.NotAllowedInCurrentState	If the clone operation is not allowed in the current state of the system.
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:

spec	Contains the witness node's placement specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

CheckResult structure containing errors and warnings.

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

global::System.Threading.Tasks.Task<vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult> vmware::vcenter::vcha::cluster::Witness::CheckAsync	(	vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Validates the specified witness node's placement configuration.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authentincating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.InvalidArgument	If the specified resource spec is deemed invalid for the clone operation.
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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.NotFound	If the active virtual machine is not managed by the specified vCenter server for the active node.
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
vmware.vapi.std.errors.NotAllowedInCurrentState	If the clone operation is not allowed in the current state of the system.
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:

spec	Contains the witness node's placement specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

CheckResult structure containing errors and warnings.

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

global::System.Threading.Tasks.Task<vmware.vcenter.vcha.cluster.WitnessTypes.CheckResult> vmware::vcenter::vcha::cluster::Witness::CheckAsync

(

vmware.vcenter.vcha.cluster.WitnessTypes.CheckSpec

spec

)

Validates the specified witness node's placement configuration.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the credentials provided for authentincating with the active node's management vCenter server are invalid.
vmware.vapi.std.errors.InvalidArgument	If the specified resource spec is deemed invalid for the clone operation.
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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.NotFound	If the active virtual machine is not managed by the specified vCenter server for the active node.
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
vmware.vapi.std.errors.NotAllowedInCurrentState	If the clone operation is not allowed in the current state of the system.
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:

spec	Contains the witness node's placement specification.

Returns:

CheckResult structure containing errors and warnings.

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

string vmware::vcenter::vcha::cluster::Witness::Redeploy_Task	(	vmware.vcenter.vcha.cluster.WitnessTypes.RedeploySpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

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 authentincating 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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

spec	Contains the witness node's redeploy specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

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

string vmware::vcenter::vcha::cluster::Witness::Redeploy_Task

(

vmware.vcenter.vcha.cluster.WitnessTypes.RedeploySpec

spec

)

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

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 authentincating 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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.Error	If any other error occurs.

Parameters:

spec	Contains the witness node's redeploy specification.

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

---

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

• Witness.cs