Failover Cluster Configurator Get Vcha Config

Failover Cluster Configurator Get Vcha Config

Returns the configuration information for each node that is part of the VCHA Cluster.

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/FailoverClusterConfigurator/{moId}/getVchaConfig
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.

Authentication
This operation uses the following authentication methods.
Responses
200

Returns a data structure specifying configuration for Active, Passive and Witness node in the Cluster.

Returns VchaClusterConfigInfo of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "failoverNodeInfo1": {
        "_typeName": "string",
        "clusterIpSettings": {
            "_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"
        },
        "failoverIp": {
            "_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"
        },
        "biosUuid": "string"
    },
    "failoverNodeInfo2": {
        "_typeName": "string",
        "clusterIpSettings": {
            "_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"
        },
        "failoverIp": {
            "_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"
        },
        "biosUuid": "string"
    },
    "witnessNodeInfo": {
        "_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"
        },
        "biosUuid": "string"
    },
    "state": "string"
}
FailoverNodeInfo
failoverNodeInfo1
Optional

Node configuration information for the VCHA Cluster

FailoverNodeInfo
failoverNodeInfo2
Optional

Node configuration information for the VCHA Cluster

WitnessNodeInfo
witnessNodeInfo
Optional

The WitnessNodeInfo class defines configuration information for the Witness node in the cluster

string
state
Required

Current state of VCHA Cluster.

VchaStateEnum lists all possible states. If the state is invalid or notConfigured, the other fields in this object will be unset.


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