Vasa Provider Query Active Alarm

Query for the currently active alarms known to this VASA provider.

Provider is expected to return Red and Yellow types of alarms only. No Green alarms should be included in the result for this API.

Required privileges: StorageViews.View

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/sms/VasaProvider/{moId}/QueryActiveAlarm

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

string

release

Required

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

Request Body

QueryActiveAlarmRequestType of type(s) application/json

Required

"QueryActiveAlarmRequestType Object"

alarmFilter

Optional

Filter criteria for the alarm state.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

AlarmResult containing all (or requested) active alarm objects owned by the VASA provider.

This response body class contains all of the following: AlarmResult

{
    "0": "A",
    "1": "l",
    "2": "a",
    "3": "r",
    "4": "m",
    "5": "R",
    "6": "e",
    "7": "s",
    "8": "u",
    "9": "l",
    "10": "t",
    "11": " ",
    "12": "O",
    "13": "b",
    "14": "j",
    "15": "e",
    "16": "c",
    "17": "t"
}

500

InvalidArgument: if invalid input is provided.

NotImplemented: if the provider does not implement this function.

NotFound: if the specified entity does not exist.

ProviderBusy: if the provider is busy and cannot process the request.

InactiveProvider: if the provider is inactive for the specified entity.

ProviderUnavailable: if the provider is temporarily unavailable.

QueryExecutionFault: if an error is encountered while processing the query request.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: InlineMethodFault0

"MethodFault Object"

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>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/sms/VasaProvider/{moId}/QueryActiveAlarm

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Monitoring Service Operations

POST

Vasa Provider Failover Replication Group Task