Versions Compared

Old Version 6

changes.mady.by.user Arihant Bansal

Saved on

compared with

New Version 7

changes.mady.by.user Arihant Bansal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following tables represents theproperties of an Outage.


Property

Description

Example

id

A globally unique Outage ID

"63576103ad794974594a1f11"
change_id
The name of the Enterprise Service. This is used for identifying the Enterprise Service"John Test"currentA long description of the Enterprise Service

Insert any reference number if required in the change id field

ticket #12345"
currentIf the outage is current or scheduled/future outage"current/null"
descriptionLong description of an Outage"This is a test
Enterprise Service
outage"
description
frequency
The name of the node that is created and/or used to store the status and events for the Enterprise Service."john_test_ES"frequencyHow frequently the status of the Enterprise Service is recalculated.60start

The time that these status metrics were last recalculated. The metrics are updated with a frequency of frequency seconds.

1682489067endThe Overall Status can be Up, Degraded or Down. The Overall Status of the Enterprise Service is calculated from the worst of the Node State, Interface State and Service State."Down"nodesIf any Interface is marked Down, the Interface State is marked Down, otherwise it is Normal."Normal"elementA decimal number between 0 (bad) and 100 (good) inclusive representing the status of the interfaces in the Enterprise Service. 
The Interface Status is calculated from the status events for the Interfaces by aggregating all the Interface-related status event levels and averaging them out to a value from 0% to 100%.100

one of 'once', 'daily', 'weekly' or 'monthly'



start

date and time of outage start and end


 e.g. 2017-10-31T03:04:26+0000
enddate and time of outage start and end e.g. 2017-10-31T03:04:26+0000



nodesList of nodes for which Outages is defined[ 'Switch-1','Switch-2' ]
elementList of elements from nodes for which Outages are defined.

 [ {

  "element_name": "Vlan2",
  "node_name": "Switch-1"
}, {

   "element_name": "regex:^Vlan.*?$",
   "node_name": "Switch-2"
} ]

optionsoptional key=values to adjust NMIS' behaviour during an outageo
optionsA status level categorizing the interface_status, into traffic light colours.
"Normal"




Limitations

API Endpoint

All requests are made under the following base URL:

...