MonitoringUpdated July 3, 2026

Interlink Maintenance Windows

guideinterlinkmaintenance-windowsmonitoringalert-suppressionapichange-management

Maintenance Windows - Interlink

Why Maintenace Windows are Important

Maintenance windows are important because they provide advanced notice for users when a service may be down due to maintenance and prevent alert systems from needlessly notifying systems administrators. It's important to utilize maintenance windows at all levels of the monitoring stack to ensure all alerts are suppressed.

When you should use Maintenance Windows

Maintenance windows should be used in advance of any routine maintenance to ensure the best possible service for users and least amount of unnecessary alerts for administrators.

How to Access Application

To gain access to Interlink ensure Monitoring_ReadOnly (prod) and Monitoring_Development (test) are added to your primary MSID.
Upon receiving access, you will be able to log in to prod and test with your primary MSID credentials

Maintenance Records with API

This documentation regarding Interlink Maintenance Manager API was created based on the Sharepoint Monitoring page. Additional information including a training video can be found here.

API Key Fields

There are several key fields necessary to creating a maintenance window.

gpname
- Group name
- Defaults to "ASI"
- Is a short application or team name
rdname
- Record name
- The application or server name which requires event suppression
change
- Required
- ServiceNow change record that contains
sdate
- start date
- format YYYY/MM/DD HH:MM:SS
edate
- end date
- format YYYY/MM/DD HH:MM:SS
action
- CLOSE - (recommended) Closes or suppresses ALL ACTIVE events matching the event suppression criteria (including related ServiceNow notifications), state of all events will be CLOSED during the maintenance window
The following settings are available but not recommended except in specific cases
- HIDE - Hides ALL events matching the event suppression criteria from Event Dashboard during the maintenance window, state of all events will be ACTIVE
- HIDENEW - Hides ONLY new events that occur during the duration of the maintenance window, state of new events will be ACTIVE
- HIDECLOSE - Hides ALL events matching the event suppression criteria from Event Dashboard during the maintenance window, state of all events will be CLOSED
- CLOSENEW - Closes or suppresses ONLY the latest ACTIVE events that occur during the maintenance window (including ServiceNow notifications), state of new events during window will be CLOSED. ACTIVE events prior to the window will remain ACTIVE
etype
- AUTO

API How to Create your Maintenance Record

Endpoints 1 TEST: Test 2 PROD: Prod
Method: POST
Headers - Context-Type: application/x-www.form-urlencoded
data-urlencode - 1 Key: action

2 Value: <payload> see examples below

Sample payload to suppress events from multiple servers

<NR>
  <gpname>ASI</gpname>
  <rdname>Test_mm_record_</rdname>
  <change>CHG0000120</change>
  <sdate>2021/12/22 22:00:00</sdate>
  <edate>2021/12/22 22:10:00</edate>
  <action>CLOSE</action>
  <etype>AUTO</etype>
  <selector>
    <sel>{s1}</sel>
    <sel>_domain eq nw6s-ply-con02</sel>
    <sel>{s2}</sel>
    <sel>_domain eq nw6s-ply-con03</sel>
    <sel>{s3}</sel>
    <sel>_domain eq nw6s-ply-con04</sel>
  </selector>
  <startedby>puppet</startedby>
</NR>

Sample payload to suppress an event based on application name

<NR>
  <gpname>ASI</gpname>
  <rdname>Test_Server_Patching</rdname>
  <change>CHG0000100</change>
  <sdate>2021/07/25 22:00:00</sdate>
  <edate>2021/07/25 23:00:00</edate>
  <action>CLOSE</action>
  <etype>AUTO</etype>
  <selector>
    <sel>{s1}</sel>
    <sel>_application eq Test_App</sel>
    <sel>{s1}</sel>
  </selector>
  <startedby>puppet</startedby>
</NR>

Sample payload to suppress an event based on server name AND application name

<NR>
  <gpname>ASI</gpname>
  <rdname>Test_Server_Patching</rdname>
  <change>CHG0000100</change>
  <sdate>2021/07/25 22:00:00</sdate>
  <edate>2021/07/25 23:00:00</edate>
  <action>CLOSE</action>
  <etype>AUTO</etype>
  <selector>
    <sel>{s1}</sel>
      <sel>_domain eq apsrt4334</sel>
      <sel>AND</sel>
      <sel>_application eq CIRRUS/sel>
  <sel>{s1}</sel>
  </selector>
  <startedby>puppet</startedby>
</NR>

Sample payload to suppress an event based on server name and text contains CPU is in error

<NR>
  <gpname>ASI</gpname>
  <rdname>Test_Server_Patching</rdname>
  <change>CHG0000100</change>
  <sdate>2021/07/25 22:00:00</sdate>
  <edate>2021/07/25 23:00:00</edate>
  <action>CLOSE</action>
  <etype>AUTO</etype>
  <selector>
    <sel>{s1}</sel>
    <sel>_domain eq apsrt4334</sel>
    <sel>{s2}</sel>
    <sel>text eq %CPU is in error%</sel>
  </selector>
  <startedby>puppet</startedby>
</NR>

How to Update an existing Maintenance Record

action=<AR>
  <gpname>ASI</gpname>
  <rdname>Server_Patching</rdname>
  <edate>2021/07/25 16:10:00</edate>
  <sdate>2021/07/25 14:00:00</sdate>
  <duration></duration>
  <alterby>user ms id</alterby>
</AR>

How to Stop or Remove a Maintenance Record

action=<SR>
  <gpname>ASI</gpname>
  <rdname>record_name</rdname>
  <stoppedby>user_ms_id</stoppedby>
</SR>

How to view your Maintenance Windows

Records by Group

Endpoints: 1 TEST: Test 2 PROD: Prod
Method: GET
Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups>
  <group name="ASI">
    <active>
      <record>
        <rdname>TestAgain</rdname>
        <change>0</change>
      </record>
    </active>
    <waiting />
  </group>
  <group name="ASI_Test">
    <active>
      <record>
        <rdname>Policy_Test_9</rdname>
        <change>CHG1234567</change>
      </record>
    </active>
    <waiting />
  </group>
</groups>

Records by Group Name and Record Name

Endpoints: 1 TEST: Test 2 PROD: Prod
Me2hod: GET
Header: Content-Type: application/x-www-form-urlencoded
Parameters: 1 GroupName (required) 2 RecordName (required)
Example:

Suppose we want record "TestAgain" from the group "ASI"

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record>
  <gpname>ASI</gpname>
  <rdname>TestAgain</rdname>
  <class>BLACKOUT</class>
  <status>ACTIVE</status>
  <action>HIDE</action>
  <stype>MANUAL</stype>
  <etype>MANUAL</etype>
  <sdate>2021/07/23 10:22:06.114</sdate>
  <edate></edate>
  <selname>User initiated</selname>
  <selgroup>N/A</selgroup>
  <selector>alertId == '0000045651'</selector>
  <startedon>2021/07/23 10:22:06.114</startedon>
  <startedby>[email protected]:0.0</startedby>
  <endat></endat>
  <change>0</change>
</record>

Maintenance Records with UI

This documentation regarding Interlink Maintenance Manager UI was created based on the Sharepoint Monitoring page. Additional information including a training video can be found here.

UI Key Fields

Record Name
- Application or Server Name
- Unique
- Can't be blank
- Letters, Numbers, Underscores only (no spaces)
Created By
- MSID of creator
- Auto populated
Change Record
- ServiceNow change record containing CIs
- Can't be blank
- If no change record exists, enter unique name
Action
- CLOSE - (recommended) Closes or suppresses ALL ACTIVE events matching the event suppression criteria (including related ServiceNow notifications), state of all events will be CLOSED during the maintenance window
The following settings are available but not recommended except in specific cases
- HIDE - Hides ALL events matching the event suppression criteria from Event Dashboard during the maintenance window, state of all events will be ACTIVE
- HIDENEW - Hides ONLY new events that occur during the duration of the maintenance window, state of new events will be ACTIVE
- HIDECLOSE - Hides ALL events matching the event suppression criteria from Event Dashboard during the maintenance window, state of all events will be CLOSED
- CLOSENEW - Closes or suppresses ONLY the latest ACTIVE events that occur during the maintenance window (including ServiceNow notifications), state of new events during window will be CLOSED. ACTIVE events prior to the window will remain ACTIVE
Start Time
End Time
Suppression criteria
- Event suppression
- Usually application or server name

UI How to Create your Maintenance Record

Login with your primary MSID to Interlink here and navigate to a dashboard.
Click the Maintenance Manager button (this will leave fields empty) OR right-click an event and select Maintenance Generator (this will pre-populate fields).
Fill in the fields and click send to submit.
The bottom field will prompt you to select a connection and establish rules based on the alert types you wish to suppress.

NOTES

This should be used to suppress monitoring events NOT to remove them. Typically dates should be less than 1 week and if you are trying to remove monitoring events you should be removing them from the source not supressing them.
Set up you interlink user profile by navigating to your username at the top
Timezone should be set to central

How to View, Update, or Remove your Maintenance Windows

Load the Maintenance Manager dashboard
On the left panel expand "ASI" or the group of the record you would like to view
Select "Active" to see the active maintenance records
Select the record you would like to view/edit/remove

To View a Record

Select the "i" icon to display the parameters selected when the record was created.

To Update a Record

NOTE: Only the dates can be updated and start date can only be updated if the window has yet to start.

Select the "pencil" icon to edit the record.
Make your changes
Click the "checkmark" icon to save the record

To Remove a Record

Click the "trash can" icon
You will receive a prompt making sure you really want to remove the record.