Versions Compared

Key

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

...

The v2 api has added support for "ELEMENT OUTAGES"Elements of node (either interface or other) , for example defining an outage on just a single interface on a node.  See ALL ABOUT ELEMENT OUTAGES.

...

Property

Description

Example

id

A globally unique Outage ID

0ea7644e-b6fa-4fa2-9b33-a86b79db21a4
change_id

Insert any reference number if required in the change id field

ticket #12345
currentIf the outage is current or scheduled/future outage. IS THIS 'current' for scheduled or null for future.current
descriptionLong description of an OutageThis is a test outage
frequencyone of 'once', 'daily', 'weekly' or 'monthly'once



start

date and time of outage start.

For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC
For Create and Update see Supported Time Formats for description of allowed values 

 2023-10-31T17:00:00+0000
enddate and time of outage end.
For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC
For Create and Update see Supported Time Formats for description of allowed values 
 31 May 2023 03:30 pm



nodesList of nodes for which Outages is defined. At least one of nodes or elements must be specified.[ 'Switch-1','Switch-2' ]
element

List of elements from nodes for which Outages are defined.

DOCUMENT REGEX OR SEE LINK

CAN I DO NODE REGEX?

HOW DO WE HANDLE OTHER TYPES OF ELEMENTS

element_name must be either a string or a regex pattern ( regex:pattern  or iregex:pattern as shown in examples)

element_name can be either interface name or other.

 [ {

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

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


 [ {

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

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

options

optional key=values to adjust NMIS behaviour during an outage 

DOCUMENT THE KEYS AND VALUES

"Normal"



...