Resource Pool Get Triggered Alarm State

A set of alarm states for alarms triggered by this entity or by its descendants.

Triggered alarms are propagated up the inventory hierarchy so that a user can readily tell when a descendant has triggered an alarm. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.

Required privileges: System.View

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/ResourcePool/{moId}/triggeredAlarmState

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case ResourcePool/{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.

Session

Responses

200

Returns Array of AlarmState of type(s) application/json

[
    {
        "_typeName": "string",
        "key": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "alarm": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "overallStatus": "string",
        "time": "string",
        "acknowledged": false,
        "acknowledgedByUser": "string",
        "acknowledgedTime": "string",
        "eventKey": 0,
        "disabled": false
    }
]

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Resource Pool Operations

POST

Resource Pool Create Child VM Task

POST

Resource Pool Create Resource Pool

POST

Resource Pool Create V App