OpenManage Enterprise 3.10 RESTful API Guide

PDF

POST method for event subscriptions

This method adds event subscriptions to the telemetry reports.

Description

Adds event subscriptions to the telemetry reports.

NOTE:A maximum of eight combined subscribers and SSE sessions is allowed. If the maximum number is met, additional subscriber and SSE session are not allowed and an error is displayed. To see the current number of subscribers and SSE sessions, use the GET method for /redfish/v1/EventService/Subscriptions.

NOTE:A subscriber added to the collection must be accessible in the network and running. Upon receiving events, it must send back a response immediately. If any of these criteria is not met, the subscriber and other subscribers may face disruption in receiving events.

Privilege

APPLIANCE SETUP

HTTP response codes

201

License Required

OME - Modular Advanced

Event subscription for telemetry metric reports

{
  "Context": "<CONTEXT_INFO>",
  "Destination": "https://<DESTINATION_INFO>",
  "EventFormatType": "MetricReport",
  "Protocol": "Redfish"
}

Example response body

{
  "Context": "100.64.25.205:443 subscription for MetricReports",
  "Destination": "https://100.64.25.205:443",
  "EventFormatType": "MetricReport",
  "Protocol": "Redfish"
}

Event subscription for alerts

{
  "Context": "<CONTEXT_INFO>",
  "Destination": "https://<DESTINATION_INFO>",
  "EventFormatType": "Event",
  "Protocol": "Redfish"
}

Example response body

{
  "Context": "100.64.25.205:443 subscription for Alerts",
  "Destination": "https://100.64.25.205:443",
  "EventFormatType": "Event",
  "Protocol": "Redfish"
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
EventFormatType	MetricReport—Indicates a subscription for telemetry metric reports. Event—Indicates a subscription for alert event stream.
CONTEXT_INFO	A client-supplied context that remains with the connection through the lifetime of the connection.
DESTINATION_INFO	A URI to the destination where the events are sent. For HTTP or HTTPS, the URI is consistent with RFC3986. NOTE:Only HTTPS is supported.