Failover Cluster Configurator Deploy Vcha Task
Deploys and Configures VCHA on the local vCenter as a single API.
This deployment operation automatically provisions and creates a Passive and a Witness node followed by configuring each node such that a 3 node VCHA Cluster is formed. After configuration, the VCHA Cluster is enabled on a best effort basis, but if this operation does not succeed, setClusterMode_Task must be called to enable it. State replication or failover is not allowed until the VCHA Cluster is enabled. The current vCenter Server continues to serve client requests during and after the deployment. If the activeVcNetworkConfig spec if filled in, the cluster network will be created and configured. No changes will be made if the cluster network is already configured.
Required privileges: Global.VCServer
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case FailoverClusterConfigurator/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Show optional properties
{
"deploymentSpec": {
"passiveDeploymentSpec": {},
"witnessDeploymentSpec": {
"folder": {},
"nodeName": "string",
"ipSettings": {
"ip": {}
}
},
"activeVcSpec": {
"managementVc": {
"instanceUuid": "string",
"url": "string",
"credential": {}
},
"activeVc": {}
}
}
}{
"deploymentSpec": {
"_typeName": "string",
"passiveDeploymentSpec": {
"_typeName": "string",
"esxHost": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"datastore": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"publicNetworkPortGroup": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"clusterNetworkPortGroup": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"folder": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"resourcePool": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"managementVc": {
"_typeName": "string",
"instanceUuid": "string",
"url": "string",
"credential": {
"_typeName": "string"
},
"sslThumbprint": "string"
},
"nodeName": "string",
"ipSettings": {
"_typeName": "string",
"ip": {
"_typeName": "string"
},
"subnetMask": "string",
"gateway": [
"string"
],
"ipV6Spec": {
"_typeName": "string",
"ip": [
{
"_typeName": "string"
}
],
"gateway": [
"string"
]
},
"dnsServerList": [
"string"
],
"dnsDomain": "string",
"primaryWINS": "string",
"secondaryWINS": "string",
"netBIOS": "string"
},
"failoverIpSettings": {
"_typeName": "string",
"ip": {
"_typeName": "string"
},
"subnetMask": "string",
"gateway": [
"string"
],
"ipV6Spec": {
"_typeName": "string",
"ip": [
{
"_typeName": "string"
}
],
"gateway": [
"string"
]
},
"dnsServerList": [
"string"
],
"dnsDomain": "string",
"primaryWINS": "string",
"secondaryWINS": "string",
"netBIOS": "string"
}
},
"witnessDeploymentSpec": {
"_typeName": "string",
"esxHost": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"datastore": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"publicNetworkPortGroup": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"clusterNetworkPortGroup": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"folder": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"resourcePool": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"managementVc": {
"_typeName": "string",
"instanceUuid": "string",
"url": "string",
"credential": {
"_typeName": "string"
},
"sslThumbprint": "string"
},
"nodeName": "string",
"ipSettings": {
"_typeName": "string",
"ip": {
"_typeName": "string"
},
"subnetMask": "string",
"gateway": [
"string"
],
"ipV6Spec": {
"_typeName": "string",
"ip": [
{
"_typeName": "string"
}
],
"gateway": [
"string"
]
},
"dnsServerList": [
"string"
],
"dnsDomain": "string",
"primaryWINS": "string",
"secondaryWINS": "string",
"netBIOS": "string"
}
},
"activeVcSpec": {
"_typeName": "string",
"managementVc": {
"_typeName": "string",
"instanceUuid": "string",
"url": "string",
"credential": {
"_typeName": "string"
},
"sslThumbprint": "string"
},
"activeVc": {
"_typeName": "string",
"type": "string",
"value": "string"
}
},
"activeVcNetworkConfig": {
"_typeName": "string",
"networkPortGroup": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"ipSettings": {
"_typeName": "string",
"ip": {
"_typeName": "string"
},
"subnetMask": "string",
"gateway": [
"string"
],
"ipV6Spec": {
"_typeName": "string",
"ip": [
{
"_typeName": "string"
}
],
"gateway": [
"string"
]
},
"dnsServerList": [
"string"
],
"dnsDomain": "string",
"primaryWINS": "string",
"secondaryWINS": "string",
"netBIOS": "string"
}
}
}
}The VchaClusterDeploymentSpec class contains deployment information for creating and configuring a VCHA Cluster.
This method returns a Task object with which to monitor the progress of the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}