HP OneView REST API Reference

alerts
alerts.html[10/17/2013 10:35:10 AM]
Updated: October 16, 2013 3:55
MDT
API Specifications Create Read Update Delete
/rest/alerts GET DELETE
/rest/alerts/AlertChangeLog/{id} DELETE
/rest/alerts/schema GET
/rest/alerts/{id} GET PUT DELETE
Resource Model
AlertResourceV2
AlertResourceCollectionV2
HP OneView REST API Reference
alerts
The alert resource is used to inform end users about issues with resources managed by the appliance, including the
appliance itself. An alert represents an event for a given resource that typically originates from the resource. An example
event would be: an SNMP trap received from a server's Integrated Lights-Out (iLO) management processor. The appliance
will treat these as raw events, which can be filtered and/or correlated by the appliance and presented to the end user as
alerts. External tools and resource managers can also create events; see the events API documentation for details. There
are two main types of alerts: Health alerts and Life cycle alerts. Health alerts indicate the health status of a resource. Life
cycle alerts are created as a result of some activity on a resource, such as powering on or off a server or inserting a blade
server in an enclosure. The system will automatically set the severity of a life cycle alert to OK. Alerts have different levels
of severity that indicate how serious a problem is. Usually alerts have the same severity as their underlying source events,
but in some cases analysis can result in higher or lower severities, depending on factors such as redundancy, configuration
or the environment. The system will automatically clear alerts with OK severity. The alert resource manager provides REST
APIs to retrieve, update and delete alerts. A PUT API is included to allow the user to update some attributes of an alert,
including alertState, alertUrgency, assignedToUser, and the notes. Users cannot directly create an alert. An alert can only
be created by POSTing an event, which causes the event service to create a user-facing alert. Users can delete user-
added AlertChangeLog items (alert notes) using the provided API. Users cannot delete alert notes added by the system.
URI: /rest/alerts
Method API
DELETE Deletes all alerts based on the filtering parameters passed in. If no filtering parameters are
defined, then all alerts will be deleted. This operation returns a task resource URI in the
"Location" attribute of the response header. The user can monitor the progress of the delete
operation using this task resource URI.
Parameter Attributes Description
force Optional If set to true, the operation completes even if there are network
connectivity issues or resource errors. The default is false.
query Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.
If the query is supported, the following is the way it works. A general
query string that narrows the list of resources returned by a multi-
resource GET (read) request and DELETE (delete) request. The
default is no query (all resources are returned). One advantage
query has over filter is that it can have embedded ORs. A
single query parameter can do what would take multiple
parameters or multiple GET requests using filter. Use query for
more complex queries.