Failover Cluster Configurator Create Witness Node Task

Failover Cluster Configurator Create Witness Node Task

Creates a Witness node in a degraded VCHA Cluster with node location information and pre-existing VCHA Cluster configuration from the Active node.

Required privileges: Global.VCServer

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/FailoverClusterConfigurator/{moId}/createWitnessNode_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
createWitnessNodeRequestType of type(s) application/json
Required 
{
    "witnessDeploymentSpec": {
        "esxHost": {
            "type": "string",
            "value": "string"
        },
        "datastore": {
            "type": "string",
            "value": "string"
        },
        "publicNetworkPortGroup": {
            "type": "string",
            "value": "string"
        },
        "clusterNetworkPortGroup": {
            "type": "string",
            "value": "string"
        },
        "folder": {
            "type": "string",
            "value": "string"
        },
        "resourcePool": {
            "type": "string",
            "value": "string"
        },
        "managementVc": {
            "instanceUuid": "string",
            "url": "string",
            "credential": {
                "_typeName": "string"
            },
            "sslThumbprint": "string"
        },
        "nodeName": "string",
        "ipSettings": {
            "ip": {
                "_typeName": "string"
            },
            "subnetMask": "string",
            "gateway": [
                "string"
            ],
            "ipV6Spec": {
                "ip": [
                    {
                        "_typeName": "string"
                    }
                ],
                "gateway": [
                    "string"
                ]
            },
            "dnsServerList": [
                "string"
            ],
            "dnsDomain": "string",
            "primaryWINS": "string",
            "secondaryWINS": "string",
            "netBIOS": "string"
        }
    },
    "sourceVcSpec": {
        "managementVc": {
            "instanceUuid": "string",
            "url": "string",
            "credential": {
                "_typeName": "string"
            },
            "sslThumbprint": "string"
        },
        "activeVc": {
            "type": "string",
            "value": "string"
        }
    }
}
NodeDeploymentSpec
witnessDeploymentSpec
Required

The NodeDeploymentSpec class defines location specification of the nodes the VCHA Cluster along with Management vCenter Server information that manages node VM.

SourceNodeSpec
sourceVcSpec
Required

The SourceNodeSpec class defines specification of the source node that is used to initiate the configuration or deployment for VCHA.

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

On This Page
Failover Cluster Configurator Operations
POST
Failover Cluster Configurator Configure Vcha Task
POST
Failover Cluster Configurator Create Passive Node Task
POST
Failover Cluster Configurator Create Witness Node Task
POST
Failover Cluster Configurator Deploy Vcha Task
POST
Failover Cluster Configurator Destroy Vcha Task
GET
Failover Cluster Configurator Get Disabled Configure Method
POST
Failover Cluster Configurator Get Vcha Config
POST
Failover Cluster Configurator Prepare Vcha Task