Vsan Phone Home System Query Vsan Cloud Health Status

QueryVsanCloudHealthStatus returns a VsanCloudHealthStatus object with various states of the vSAN CEIP Collector Agent.

When checking for internet connectivity, a connection to https://vcsa.vmware.com/ will be attempted with timeout of 10 seconds.

Required privileges: Global.Diagnostics

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanPhoneHomeSystem/{moId}/QueryVsanCloudHealthStatus

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

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

vim.vsan.VsanCloudHealthStatus

{
    "_typeName": "string",
    "collectorRunning": false,
    "lastSentTimestamp": "string",
    "internetConnectivity": false
}

500

Failure

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_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"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/vsan/VsanPhoneHomeSystem/{moId}/QueryVsanCloudHealthStatus

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Phone Home System Query Vsan Cloud Health Status

POST