...
If you have a maintenance window or a scheduled outage for a device then you will likely want to suspend Event alerting for that device during that period.
...
Code Block |
---|
Before opCharts 4.5.78, 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.78 onwards, Node Outages and 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" } |
...
Property | Description | Example |
| 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 |
current | If the outage is current or scheduled/future outage. IS THIS 'current' for scheduled or null for future. | current |
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 outage start. For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC | 2023-10-31T17:00:00+0000 |
end | date 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 |
nodes | List of nodes for which Outages are defined. At least one of nodes or elements must be specified. | [ 'Switch-1','Switch-2' ] |
element elements | List of elements from of nodes for which Outages are defined. The element must be defined to match the element in events which may occur in 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", "element_name": "iregex:^Vlan.*?$", [ { "node_name": "Switch-1" "element_name": "regex:^Vlan.*?$", |
options | optional key=values to adjust NMIS behaviour during an outage DOCUMENT THE KEYS AND VALUES | "Normal" |
...