vmware::vcenter::vcha::cluster::Active Interface Reference

The Active interface provides methods to get information related to the active vCenter High Availability (VCHA) node. More...

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

List of all members.

Public Member Functions
vmware.vcenter.vcha.cluster.ActiveTypes.Info	Get (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_)
	Retrieves information about the active node of a VCHA cluster.
vmware.vcenter.vcha.cluster.ActiveTypes.Info	Get (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves information about the active node of a VCHA cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.cluster.ActiveTypes.Info >	GetAsync (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_)
	Retrieves information about the active node of a VCHA cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.vcha.cluster.ActiveTypes.Info >	GetAsync (vmware.vcenter.vcha.CredentialsSpec vcSpec, bool?partial_, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves information about the active node of a VCHA cluster.

---

Detailed Description

The Active interface provides methods to get information related to the active vCenter High Availability (VCHA) node.

This interface was added in vSphere API 6.7.1.

---

Member Function Documentation

vmware.vcenter.vcha.cluster.ActiveTypes.Info vmware::vcenter::vcha::cluster::Active::Get	(	vmware.vcenter.vcha.CredentialsSpec	vcSpec,
		bool?	partial_
	)

Retrieves information about the active node 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 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. 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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
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.Error	If the management interface IP address assignment is not static.
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 Information about the VCHA network and placement of the active node.

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

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

Retrieves information about the active node 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 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. 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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
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.Error	If the management interface IP address assignment is not static.
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 Information about the VCHA network and placement of the active node.

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

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

Retrieves information about the active node 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 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. 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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
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.Error	If the management interface IP address assignment is not static.
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 Information about the VCHA network and placement of the active node.

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

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

Retrieves information about the active node 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 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. 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 vmware.vcenter.vcha.CertificateInfo .
vmware.vapi.std.errors.InvalidElementConfiguration	If the active node is on more than one datastore.
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.Error	If the management interface IP address assignment is not static.
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 Information about the VCHA network and placement of the active node.

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

---

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

• Active.cs