Failover Cluster Configurator Prepare Vcha Task

Failover Cluster Configurator Prepare Vcha Task

Prepares the vCenter appliance for a VCHA cluster deployment.

This preparation operation saves the network configuration of the cluster and configures the Active node to be cloned for a VCHA configuration. Prepares the VCHA Active node for ssh keys, vpostgres replication and related configuration file setup needed for a VCHA cluster. If the Active node Cluster network adapter does not exist the prepare operation will fail. No changes will be made if the cluster is already configured.

Required privileges: Global.VCServer

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/FailoverClusterConfigurator/{moId}/prepareVcha_Task
COPY
Path Parameters
string
moId
Required

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

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
prepareVchaRequestType of type(s) application/json
Required
{
    "networkSpec": {
        "_typeName": "string",
        "witnessNetworkSpec": {
            "_typeName": "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"
            }
        },
        "passiveNetworkSpec": {
            "_typeName": "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"
            }
        }
    }
}
networkSpec
Required

The VchaClusterNetworkSpec class contains network configuration information for a VCHA Cluster.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the progress of the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}