Vsan Performance Manager Vsan Perf Query Node Information

Query performance service related information about the node(s).

Always returns a list, but when run against the host the list is guaranteed to have length=1. If run against vCenter, information about all hosts in the cluster is retrieved. If information of one host can not be retrieved, there are 2 situations:

If the host is connected: it will throw "invalid Request", "method fault", "vsan fault" or other run time exception message.
If the host is not connected, it will throw "host is not in connected status" message.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfQueryNodeInformation

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 VsanPerformanceManager/{moId}.

string

release

Required

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

Request Body

VsanPerfQueryNodeInformationRequestType of type(s) application/json

Optional

{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

cluster

Optional

vSAN cluster. Ignored if called against host.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

[
    {
        "_typeName": "string",
        "version": "string",
        "hostname": "string",
        "error": {
            "_typeName": "string",
            "faultCause": {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            },
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        },
        "isCmmdsMaster": false,
        "isStatsMaster": false,
        "vsanMasterUuid": "string",
        "vsanNodeUuid": "string",
        "masterInfo": {
            "_typeName": "string",
            "secSinceLastStatsWrite": 0,
            "secSinceLastStatsCollect": 0,
            "statsIntervalSec": 0,
            "collectionFailureHostUuids": [
                "string"
            ],
            "renamedStatsDirectories": [
                "string"
            ],
            "statsDirectoryPercentFree": 0,
            "verboseMode": false,
            "verboseModeLastUpdate": "string"
        },
        "diagnosticMode": false
    }
]

array of object

Optional

Runtime information about the vSAN Performance service of a single vSAN host.

CMMDS master

The Cluster Monitoring, Membership, and Directory Service (CMMDS) of vSAN elects exactly one master node in every network partition. In a well formed cluster there is exactly one master, but when there are partition, each partition will have its own master. The master doesn't have any special user visible role, it is purely an internal state and any node can be master. The vSAN performance service uses the CMMDS Master node to establish its own notion of "Stats Master". Note though that to be "Stats master" it is not sufficient for a node to be CMMDS Master. The node must also have accessibility to the Stats DB object. Using this scheme guarantees that

The Stats Master is easily discoverable.
There is only ever one Stats Master in the cluster.

Stats master:

vSAN performance service is a distributed/clustered solution. Every host in a performance service enabled cluster is running a performance service instance. One host is elected to a master named as Stats Master. Stats Master is elected from CMMDS Master hosts only. The Stats Master is the only one writing to the DB. It periodically queries the performance service on the other members of the cluster, aggregates the results and persists them into the database. Stats Master is the host which can response APIs. Every request from front-end client will be handled by Stats Master.

500

Failure

Returns NotSupported of type(s) application/json

This response body class contains all of the following: RuntimeFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfQueryNodeInformation

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations