iLO 4 REST API Data Model (EventService Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki
See Resource Map for more details.
This is the schema definition for the Event Service. It represents the properties for the service itself and has links to the actual list of subscriptions.
"EventService" defines the following properties:
This property is a member of EventService
This is the number of attempts an event posting is retried before the subscription is terminated.
JSON type:
Integer
This property is a member of EventService
This represents the number of seconds between retry attempts for sending any given Event
JSON type:
Integer
This property is a member of EventService
This represents the number of seconds between retry attempts for sending any given Event
JSON type:
Integer
This property is a member of EventService
This represents the default number of events the service should queue.
JSON type:
Integer
greater than or equal to 0.
This property is a member of EventService
This represents the default number of minutes until an event is expired.
JSON type:
Integer
greater than or equal to 1.
This property is a member of EventService
The default number of TTLUnits until this listener destination subscription expires. It may be renewed prior to expire to reset the Time to Live counter. The value 999999 is reserved to mean a perpetual subscription.
JSON type:
Integer
from 0 to 999999.
This property is a member of EventService
The default time unit used to measure the subscription time of this listener destination. This is the units for TTLCount and is used to express the subscription lifetime of the listener destination.
JSON type:
String containing one of the following supported values:
This property is a member of [EventService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EventService-Resource-Type)#eventservice-resource-type)
"seconds" "minutes" "days"
This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This indicates the known state of the resource, such as if it is enabled.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This property indicates what the service will do to an event subscription after the number of delivery retry attempts has been exhausted.
JSON type:
String containing one of the following supported values:
"Remove"
"Disable"
"Ignore"
This property is a member of [EventService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(EventService-Resource-Type)#eventservice-resource-type)
This is the minimum amount of time after the failed events that the service will wait before doing the SubscriptionRemovalAction.
JSON type:
Integer
Causes iLO 4 to submit a test event to any subscribed event recievers.
"EventType" must be one of the following value(s):
"StatusChange" "ResourceUpdated" "ResourceAdded" "ResourceRemoved" "Alert""EventID" must be one of the following value(s):
| "<string>" |
"EventTimestamp" must be one of the following value(s):
| "<date-time>" |
"Severity" must be one of the following value(s):
| "OK" |
| "Warning" |
| "Critical" |
"Message" must be one of the following value(s):
| "<string>" |
"MessageID" must be one of the following value(s):
| "<string>" |
"MessageArgs" must be one of the following value(s):
| An array of string values |
"OriginOfCondition" must be one of the following value(s):
| "<string>" |
HTTP POST to resource with request JSON:
{
"Action": "SubmitTestEvent",
"EventType": "StatusChange",
"EventID": "<string>",
"EventTimestamp": "<date-time>",
"Severity": "OK",
"Message": "<string>",
"MessageID": "<string>",
"MessageArgs": [<"string">],
"OriginOfCondition": "<string>"}