Outages API - V2

If you have a maintenance window or a scheduled outage for a device then you will likely want to suspend alerting for that device during that period.

NMIS has supported this for a long time, please refer to the NMIS Outages documentation for further information. 

It is also possible to manage Outages within the Administration console or API.

The v2 api has added support for Elements of node (either interface or other) , for example defining an outage on just a single interface on a node.  See Element Outages.

Public API for Outages "http[s]://server/en/omk/admin/api/v2/outages"

We can view Outages below using these endpoints - http[s]://server/en/omk/admin/api/v2/outages

API Routes

Each resource has a consistent set of operations

Authentication

All these methods require authentication.

POST http://server/en/omk/admin/login

Form data:

• username
• password

GET of /v2/outages for List

GET http[s]://server/en/omk/admin/api/v2/outages

If your GET call provides an Accept header indicating JSON, or if you use a .json suffix, eg /v2/outages.json as URI, then It will look for matching Outages and return their properties in the form of a JSON object, an array of Outages.

Successful Response

Unsuccessful Response

GET http://server/en/omk/admin/api/v2/outages

Returns a list of outages.

Response:

[  
    {
        "change_id": "005",
        "current": "current",
        "description": "005",
        "elements": [
            {
                "element_name": "lo",
                "node_name": "A.TEST"
            },
            {
                "element_name": "Vlan1",
                "node_name": "Switch-1"
            }
        ],
        "end": 1685541600,
        "frequency": "once",
        "id": "7a2011c7-2880-40ab-aa17-12a110cc1c23",
        "nodes": [],
        "options": {
            "nostats": 0
        },
        "start": 1685455200
    },
    {
        "change_id": "001",
        "current": null,
        "description": "001",
        "elements": [
            {
                "element_name": "Vlan1",
                "node_name": "Switch-2"
            }
        ],
        "end": "12:12",
        "frequency": "daily",
        "id": "1f7ea042-0aaa-46a7-b34b-f9314952ee6f",   
		"nodes": [
            "thor"
        ],
        "options": {
            "nostats": 0
        },
        "start": "11:11"
    }
 ]

GET of /v2/outages/<id> for Read

If your GET call provides an accept header indicating application/json or if you use /en/omk/admin/api/v2/outages/<id>.json as URI, then the Outage will be looked up and all properties will be returned in the form of a JSON object.

Successful Response

Unsuccessful Response

GET http://server/en/omk/admin/api/v2/outages/#ID

Ex. http://server/en/omk/admin/api/v2/outages/1f7ea042-0aaa-46a7-b34b-f9314952ee6f

Returns an outage.

Response:

{
        "change_id": "001",
        "current": null,
        "description": "001",
        "elements": [
            {
                "element_name": "Vlan1",
                "node_name": "Switch-2"
            }
        ],
        "end": "12:12",
        "frequency": "daily",
        "id": "1f7ea042-0aaa-46a7-b34b-f9314952ee6f",
        "nodes": [],
        "options": {
            "nostats": 0
        },
        "start": "11:11"
}

POST of /v2/outages/ for Create

Create an Outage by sending a pay-load JSON object and this will create an Outage on your system and send an appropriate response.

Successful Response

Unsuccessful Response

Create Outage
POST  http://server/en/omk/admin/api/v2/outages

Payload example:

Before opCharts 4.5.7 only Node outages are supported

{
    "change_id": "001",
    "current": "current",
    "description": "testing outage 1",
    "frequency": "once",
    "nodes":["Switch1","Switch-111"],
    "options": {
        "nostats": 0
    },
    "start": "11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03" 
} 

################################################################

From opCharts 4.5.7 onwards, Element Outages are supported

{
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "elements" : [
        {  "node_name": "Switch-1",
           "element_name" : "Vlan2"
        },
        {  "node_name": "Switch-2",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "start": "11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}

Return

Returns 200 if the outage was successfully created.

{
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "success": 1
}

PUT of /v2/outages/ for Update

Create an Outage by sending a pay-load JSON object and this will create an Outage on your system and receive an appropriate response.

Successful Response

Unsuccessful Response

Update Outage

PUT http://server/en/omk/admin/api/v2/outages/

Returns 200 if the outage was successfully updated.

Payload example:

{
	"id" : XXXXXXXXXXXXXXXXXXXXXX,
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "elements" : [
        {  "node_name": "Switch-1",
           "element_name" : "Vlan222"
        },
        {  "node_name": "Switch-2",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "start": "11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}

Return 

{
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "success": 1
}

DELETE of /v2/outages/<id> for Delete

Delete an Outage by sending a request with the Outage on your system and receive an appropriate response.

Successful Response

Unsuccessful Response

Delete Outage

DELETE http://server/en/omk/admin/api/v2/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4

Returns 200 if the outage was successfully removed.

Outages Properties

The following tables represents the properties of an Outage.

Limitations

API Endpoint

All requests are made under the following base URL:

  http[s]://server/omk/admin/v2/outages

Element Outages

When opEvents receives an event which contains a node and an element, it will use the internal NMIS API to check if the combination of node and element has a scheduled outage defined or not. Depending on the result an event property called "planned_outage" is set to "true" or "false".

• When a scheduled outage is defined including elements, it will be restricted to a single node but can include multiple elements.
  For example Node vmswitch1 has 4 interfaces out of 24 which will be impacted by an outage: GigabitEthernet1/10, GigabitEthernet1/11, GigabitEthernet1/12 , GigabitEthernet1/13.
  
  

  {
      "change_id": "ticket #1234",
      "description": "Planned outage",
      "elements" : [
          {  "node_name": "vmswitch1",
             "element_name" : "GigabitEthernet1/10"
          },
          {  "node_name": "vmswitch1",
             "element_name" : "GigabitEthernet1/11"
          },
          {  "node_name": "vmswitch1",
             "element_name" : "GigabitEthernet1/12"
          }, 
          {  "node_name": "vmswitch1",
             "element_name" : "GigabitEthernet1/13"
          }
      ],
      "start": "11-May-2023 23:21:03",
      "end": "15-May-2023 23:21:03"
  }