Health Update Manager Post Health Updates

Health Update Manager Post Health Updates

Report a change in health status.

Required privileges: HealthUpdateProvider.Update

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

string
release
Required

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


Request Body
PostHealthUpdatesRequestType of type(s) application/json
Required
{
    "providerId": "string",
    "updates": [
        {
            "_typeName": "string",
            "entity": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "healthUpdateInfoId": "string",
            "id": "string",
            "status": "string",
            "remediation": "string"
        }
    ]
}
string
providerId
Required

The provider id.

updates
Optional

The changes in health states.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

NotFound: If no provider with this id is registered.

NotSupported: If the http session user does not match the user who registered the provider, or if the http session cannot be retrieved.

InvalidArgument: - If an unknown HealthUpdate id is given. - If updates list contains a HealthUpdate for a host which is not monitored by the specified provider. - If updates list contains multiple HealthUpdates with the same id. - If an existing HealthUpdate id is used in the given updates. - If there is a HealthUpdate with green status and non-empty remediation. - If there is a HealthUpdate with gray status.

Returns NotFound of type(s) application/json
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}