| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
*May not be presentMethods
Methods defined in this Managed Object |
---|
configureVcha_Task, createPassiveNode_Task, createWitnessNode_Task, deployVcha_Task, destroyVcha_Task, getVchaConfig, prepareVcha_Task |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
configSpec P | VchaClusterConfigSpec |
contains the configuration for the cluster
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the progress of the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
passiveDeploymentSpec P | PassiveNodeDeploymentSpec |
contains deployment specification for the
passive node
Since vSphere API 6.5 |
sourceVcSpec P | SourceNodeSpec |
contains specification for the source vCenter
server that is used to create Passive node
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the progress of the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
witnessDeploymentSpec P | NodeDeploymentSpec |
contains deployment specification for the
witness node
Since vSphere API 6.5 |
sourceVcSpec P | SourceNodeSpec |
contains specification for the source vCenter
server that is used to create Witness node
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the progress of the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
deploymentSpec P | VchaClusterDeploymentSpec |
contains the information needed to deploy and
configure a VCHA Cluster
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the progress of the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
Return Value
Type | Description |
---|---|
VchaClusterConfigInfo | Returns a data structure specifying configuration for Active, Passive and Witness node in the Cluster. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the FailoverClusterConfigurator used to make the method call. |
networkSpec P | VchaClusterNetworkSpec |
contains the information needed to prepare
a VCHA Cluster and configure networking.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the progress of the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |