...
Now, it is also possible to manage Outages within the Administration console or API.
The v3 api has added support for "ELEMENT OUTAGES" and this is not backward compatible with v2 api. If you make a v2 api call, it will not return any outages that are "ELEMENT OUTAGES".
See ALL ABOUT ELEMENT OUTAGES
Public API for Outages "http[s]://server/en/omk/admin/api/v3/outages"
We can view Enterprise Services Outages below using these endpoints - http[s]://server/en/omk/admin/api/v3/outages
...
Create an Outage by sending a pay-load JSON object and This this will create an Outage on your system and receive send an appropriate response.
Successful Response
...
| Code Block |
|---|
{
"id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
"success": 1
} |
PUT of /v3/outages/<id> for
...
Update
Create an Outage by sending a pay-load JSON object and This this will create an Outage on your system and receive an appropriate response.
...
Property | Description | Example | |
| A globally unique Outage ID "63576103ad794974594a1f11" | 0ea7644e-b6fa-4fa2-9b33-a86b79db21a4 | |
change_id | Insert any reference number if required in the change id field | ticket #12345" | |
current | If the outage is current or scheduled/future outage. IS THIS 'currrent' for scheduled or null for future. | current"current/null" | |
description | Long description of an Outage | "This is a test outage" | |
frequency | one of 'once', 'daily', 'weekly' or 'monthly' | once | |
start | date and time of date and time of outage start and end. See XYZ for description of allowed values. | 2023 e.g. 2017-10-31T03:0400:2600+0000 | |
end | date and time of outage start and end | date and time of outage end. See XYZ for description of allowed values. | 2023 e.g. 2017-10-31T03:0430:2600+0000 |
nodes | List of nodes for which Outages is defined. IS THIS MANDATORY? | [ 'Switch-1','Switch-2' ] | |
element | List of elements from nodes for which Outages are defined. IS THIS MANDATORY? DOCUMENT REGEX OR SEE LINK CAN I DO NODE REGEX? | [ { "element_name": "Vlan2", "element_name": "regex:^Vlan.*?$", | |
options | optional key=values to adjust NMIS 'behaviour during an outageooutage DOCUMENT THE KEYS AND VALUES | "Normal" | |
Limitations
API Endpoint
...