SevOne logo
You must be logged into the NMS to search.

Table of Contents (Start)

Maintenance Windows

The Maintenance Window Manager enables you to view, create, edit, and delete proactive and retroactive device-level maintenance windows.

To access the Maintenance Window Manager from the navigation bar, click the Administration menu and select Maintenance Windows.

In order to use the Maintenance Window Manager, you will need to have the page permission Maintenance Window Configuration enabled (go to Administration -> Access Configuration -> User Role Manager).

images/download/attachments/33030307/maintenanceWindows.png

The following information is available for all maintenance windows. To view information for completed maintenance windows or other time ranges, use the Filter panel (see Apply a Filter below). You can sort on the Name, Start Time, End Time, and Notes columns.

  • Name - The name you give to a maintenance window when you configure it.

  • Maintenance Type - The type of maintenance being performed.

  • Applies To - What the maintenance applies to (for example, Devices).

  • Start Time - The maintenance window start time.

  • End Time - The maintenance window end time.

  • Maintenance Window Actions - The action(s) that the maintenance window performs.

  • Notes - Any additional information that you add when configuring the maintenance window.

  • Actions - Select images/download/attachments/33030307/icon_wrench_blueBackground.png to edit a maintenance window or images/download/attachments/33030307/icon_trash_blueBackground.png delete a maintenance window. You can also right-click on a row and choose the option Edit, to edit the maintenance window or Delete, to delete the maintenance window.

    When you delete a maintenance window, it will be permanently removed from the system. All functions referencing the maintenance window, including overlays on graphs, will also be removed from the system.

You can also add a UUID column to view the UUIDs for maintenance windows. To do so, perform the following steps:

  1. Hover over any of the existing columns and click images/download/attachments/33030307/icon_whiteDownArrowBlueBackground.png .

  2. Select Columns.

  3. Select the check box for UUID.

Create/Edit Maintenance Windows

Perform the following steps to create or edit a maintenance window. The only required fields for a maintenance window are Name, Start Time, and End Time.

Device Maintenance Window

Allows you to select from a list of available devices.

  1. Click Add Device Maintenance Window to display the pop-up to create a new maintenance window for one or more devices. To edit an existing maintenance window, click images/download/attachments/33030307/icon_wrench_blueBackground.png under Actions. For a maintenance window that is already in progress, you can edit only the Name, Note, and End Time fields.

  2. In the Name field, enter a name for the maintenance window.

  3. In the Note field, enter any additional information that you would like to include.

  4. Click the Start Time field and select a start date and time for the maintenance window. Click Save. If you specify a start time in the past, the Actions options below will be unavailable.

  5. Click the End Time field and select an end date and time for the maintenance window. The maintenance window must last at least three minutes. Click Save.

  6. Click the Devices drop-down and select one or more devices to apply the maintenance window to.

  7. Next to Actions, select the check box for one or more of the following options. These options are disabled for retroactive maintenance windows.

    • Suppress alert emails and traps during the maintenance window - to trigger alerts without sending email notifications or traps.

    • Distinguish alerts within the maintenance window - to tag alerts in a maintenance window and cap the Severity level at Info. Tagged alerts are used to distinguish between normal alerts and maintenance alerts in the SevOne NMS Alert Summary and in Alerts reports. Tagged alerts will include the prefix Maintenance Window in their name. This option is selected by default.

    • Exclude data from TopN and Group Metrics aggregations during the maintenance window - to exclude data during the maintenance window from TopN and Group Metrics aggregation calculations.

    • Exclude data from baselines during the maintenance window - to exclude data during the maintenance window from baseline calculations.

  8. Click Create to create a new maintenance window or Save to save changes to an existing maintenance window.

Device Group Maintenance Window

Allows you to select a device group with contains one or more devices. When an instance of Device Group maintenance window becomes active, it converts to Device maintenance window and lists all the devices that are contained in the device group selected.

  1. Click Add Device Group Maintenance Window to display the pop-up to create a new maintenance window for a device group. To edit an existing maintenance window, click images/download/attachments/33030307/icon_wrench_blueBackground.png under Actions. For a maintenance window that is already in progress, you can edit only the Name, Note, and End Time fields.

  2. In the Name field, enter a name for the maintenance window.

  3. In the Note field, enter any additional information that you would like to include.

  4. Click the Start Time field and select a start date and time for the maintenance window. Click Save. If you specify a start time in the past, the Actions options below will be unavailable.

  5. Click the End Time field and select an end date and time for the maintenance window. The maintenance window must last at least three minutes. Click Save.

  6. Click the Device Group drop-down and select a device group to apply the maintenance window to. Only one device group can be selected.

    When an instance of the maintenance window becomes active, field Device Group converts to Devices and it lists all the devices that belong to the chosen Device Group.

    If the membership of the Device Group changes while the instance of the maintenance window is active, the change will not impact the instance already in progress (active). A snapshot of Device Group membership at the start time is maintained until the end time. Dynamic changes to the Device Group membership when maintenance window is active, can be rectified ad-hoc by administrators using the retroactive maintenance windows feature.

  7. Next to Actions, select the check box for one or more of the following options. These options are disabled for retroactive maintenance windows.

    • Suppress alert emails and traps during the maintenance window - to trigger alerts without sending email notifications or traps.

    • Distinguish alerts within the maintenance window - to tag alerts in a maintenance window and cap the Severity level at Info. Tagged alerts are used to distinguish between normal alerts and maintenance alerts in the SevOne NMS Alert Summary and in Alerts reports. Tagged alerts will include the prefix Maintenance Window in their name. This option is selected by default.

    • Exclude data from TopN and Group Metrics aggregations during the maintenance window - to exclude data during the maintenance window from TopN and Group Metrics aggregation calculations.

    • Exclude data from baselines during the maintenance window - to exclude data during the maintenance window from baseline calculations.

  8. Click Create to create a new maintenance window or Save to save changes to an existing maintenance window.

Apply a Filter

Perform the following steps to filter which maintenance windows display in the Maintenance Windows section.

Filtering applies to Devices only and cannot be done on Device Groups.

  1. In the Filter section, click images/download/attachments/33030307/icon_displayFilterOptions.png to display filter options.

  2. Under Search, click the Devices drop-down and select one or more devices to display maintenance windows for.

  3. Under Time, select one of the following options:

    • Active & future windows - to display active maintenance windows and future maintenance windows.

    • Active windows - to display only active maintenance windows.

    • Future windows - to display only future maintenance windows.

    • Completed windows - to display only completed maintenance windows.

    • Start time between Beginning of range and End of range - to display maintenance windows within the range you specify. When you select this option, a calendar pop-up appears, enabling you to specify the start date and time as well as the end date and time.

  4. Click Apply Filter to apply the filter.

Configure Maintenance Windows through REST API

In order to use SevOne's RESTful API, you must have a valid account in SevOne NMS.

images/download/attachments/33030307/restApi.png

Access Maintenance Windows Endpoints

  1. Perform the following actions to sign in:

    1. Go to http://<PAS hostname or IP address>/api/docs/ (for example, http://10.129.12.61/api/docs/).

    2. Click on Authentication to view Authentication operations.

    3. Under Authentication, click on POST.

    4. Under Parameters, all the way to the right, locate the Model Schema field. Click on the field to copy its content to the user field.

    5. On the left side of the Parameters section, locate the user field. After "name":, replace string with a SevOne NMS user name. Make sure to enter it within the quotes.

    6. After "password":, replace string with the corresponding SevOne NMS password. Make sure to enter it within the quotes.

    7. At the bottom of the POST section, click the Try it out! button.

    8. Scroll down to the Response Body field. You should see a long alphanumeric string after <token>. This is the token that you need. Double-click the token to select it. Then copy it.

    9. In the upper right corner of the SevOne API Documentation page, locate the Explore Api Keys... field. Paste the token into this field. You should now have permissions to perform operations.

  2. Click on Maintenance Windows to view Maintenance Window Handler operations.

  3. Continue to the Operations section to perform specific operations related to maintenance windows.

Operations

The available operations allow you to create, update, and delete maintenance windows. You can also view information about existing maintenance windows. A description of each operation appears on the right side of the page. Additional documentation appears for each item below when you click the Model tab under Response Class (Status 200).

Create Maintenance Windows

Perform the following actions to create maintenance windows for devices.

  1. Click on POST /api/v1/maintenancewindows to create a maintenance window for one or more devices.

  2. On the right side of the page, click on the Model Schema field to copy its content to the maintenanceWindowDto field.

  3. The following settings can be configured:

    • actions - The action(s) to apply to the maintenance window. Options include the following:

      When creating a maintenance window with a start date in the past, do not provide input for any of the actions below. Actions are not available for retroactive maintenance windows.

      • SUPPRESS_ALERT_NOTIFICATIONS - to trigger alerts without sending traps or email notifications.

      • CATEGORIZE_ALERTS - to tag alerts in a maintenance window and cap the Severity level at Info. Tagged alerts are used to distinguish between normal alerts and maintenance alerts in the SevOne NMS Alert Summary and in Alerts reports. Tagged alerts will include the prefix Maintenance Window in their name.

      • EXCLUDE_DATA_FROM_AGGREGATION - to exclude data during the maintenance window from TopN and Group Metrics aggregation calculations.

      • EXCLUDE_DATA_FROM_BASELINES - to exclude data during the maintenance window from baseline calculations.

    • deviceIds - The device(s) that the maintenance window applies to. Provide one or more device IDs and separate device IDs using a comma. Use the REST API to get device IDs for the devices that the maintenance window applies to.

    • maintenanceType - The type of maintenance. Currently the only option here is PLANNED.

    • name - The name you give to the maintenance window. The default is set to string, which means you will need to give the maintenance window a name. Otherwise, the name will appear as string in the SevOne NMS Maintenance Window Manager.

    • notes - Additional information that you would like to include. To leave this blank, delete string from the line "notes": "string". Otherwise, the text string will apper under Notes in the SevOne NMS Maintenance Window Manager.

    • scheduleInstance - The time range of the maintenance window. The default format is UNIX timestamp in milliseconds (for example, 1498177530000). Times can also be expressed using ISO 8601 format. You can specify the format in the Date-Format header (under Parameters). The specified time must be UTC, and the maintenance window must last at least three minutes.

      • beginDateTime - The date and time that the maintenance window should start.

      • endDateTime - The date and time that the maintenance window should end. The maintenance window must last at least three minutes.

  4. After configuring the maintenance window, click Try it out! at the bottom of the section.

View Maintenance Windows

Perform the steps below to view information for maintenance windows.

View All Maintenance Windows

  1. Click on GET /api/v1/maintenancewindows.

  2. At the bottom of the section, click Try it out!.

  3. See the Response Body field for information about existing maintenance windows. totalElements indicates the total number of maintenance windows. Scroll down to view specific information about each maintenance window, including the maintenance window ID.

View a Maintenance Window Using an ID

  1. You will need the ID for the maintenance window that you want to view information for. You can get IDs for existing maintenance windows by performing the steps above (View All Maintenance Windows). Copy the ID for the maintenance window you would like to view (for example, 20f3db94-9577-4ceb-92cd-b988d66fcaaf).

  2. Click on GET /api/v1/maintenancewindows/{id}.

  3. Under Parameter, in the id field, paste the ID for the maintenance window you would like to view information for.

  4. Click Try it out!.

  5. See the Response Body field for information about that maintenance window.

View Maintenance Windows Using a Filter

  1. Click on POST /api/v1/maintenancewindows/filter.

  2. On the right side of the page, click on the Model Schema field to copy its content to the filter field.

  3. Provide input for actions, deviceIds, etc., depending on how you would like to filter results.

    Filter parameters support inexact matches:

    • name - will match any maintenance window containing the specified substring.

    • actions - will match a maintenance window if it contains any of the specified actions.

    • beginDateTime/endDateTime - will match any maintenance window overlapping the specified period.

    • deviceIds - will match a maintenance window if it contains any of the specified devices.

  4. Click Try it out!.

  5. See the Response Body field for results.

Edit Maintenance Windows

  1. You will need the ID for the maintenance window that you want to edit. You can get IDs for existing maintenance windows by performing the steps above (View All Maintenance Windows). Copy the ID for the maintenance window you would like to edit (for example, 20f3db94-9577-4ceb-92cd-b988d66fcaaf). For a maintenance window that is already in progress, you can edit only the name, notes, and endDateTime fields. If the maintenance window has already ended, you can edit only the name and notes fields.

  2. Click on PUT /api/v1/maintenancewindows/{id}.

  3. Under Parameter, in the id field, paste the ID for the maintenance window you would like to edit.

  4. On the right side of the page, click on the Model Schema field to copy its content to the maintenanceWindowDto field.

  5. In the maintenanceWindowDto field, provide input for any information you would like to modify. Make sure to provide input for all fields, including fields that you aren't modifying. If you omit any fields, the data for those fields will be deleted.

  6. Click Try it out!.

Delete Maintenance Windows

  1. You will need the ID for the maintenance window that you want to delete. You can get IDs for existing maintenance windows by performing the steps above (View All Maintenance Windows). Copy the ID for the maintenance window you would like to delete (for example, 20f3db94-9577-4ceb-92cd-b988d66fcaaf).

  2. Click on DELETE /api/v1/maintenancewindows/{id}.

  3. Under Parameter, in the id field, paste the ID for the maintenance window you would like to delete.

  4. Click Try it out!.

Alert Scenarios

Alert processing does not stop during a scheduled maintenance window when you select the check box for Distinguish alerts within the maintenance window. Instead, alerts that trigger during a scheduled maintenance window are annotated differently than normal alerts. Whether an alert is or is not classified as occurring within a maintenance window is based on the timestamp indicating when the alert conditions trigger. This classification is not based on timestamps associated with collected data samples. The difference between the timestamp of the final collected sample that triggered the alert and the evaluation time of the alert should be small (within one or two poll intervals). This behavior is consistent with the check box option Suppress alert emails and traps during the maintenance window.

The following table describes the expected system behavior for different alert scenarios, based on the timing of the alert trigger.

Alert Trigger Timing Relative to Maintenance Window

System Behavior

Alert triggers before a maintenance window and stops triggering before a maintenance window.

Alert is annotated normally according to the alert policy.

Alert triggers after a maintenance window ends.

Alert is annotated normally according to the alert policy.

Alert triggers before a maintenance window begins and stops triggering during a maintenance window.

Alert is divided into two distinct alert entries. One alert entry corresponds to the time outside the maintenance window. The other corresponds to the time inside the maintenance window. The alert entry associated with the time outside the maintenance window is annotated normally according to the alert policy. The entry associated to the maintenance window is annotated with a message prepended to its Notes field and has its severity downgraded so that it can be excluded from outage metrics calculations.

Alert triggers during a maintenance window and stops triggering after a maintenance window.

Alert is divided into two distinct alert entries. One alert entry corresponds to the time outside the maintenance window. The other corresponds to the time inside the maintenance window. The alert entry associated with the time outside the maintenance window is annotated normally according to the alert policy. The entry associated to the maintenance window is annotated with a message prepended to its Notes field and has its severity downgraded so that it can be excluded from outage metrics calculations.

Alert triggers during a maintenance window and stops triggering within the same maintenance window.

Alert is annotated with a message prepended to its Notes field and has its severity downgraded so that it can be excluded from outage metrics calculations.

Alert triggers prior to a maintenance window, continues to trigger during the maintenance window, and stops triggering after the maintenance window has ended.

Alert is divided into three distinct alert entries. One alert entry corresponds to the time prior to the maintenance window. Another entry corresponds to the time inside the maintenance window. The final entry corresponds to the time after the maintenance window. The alert entries associated with the time outside the maintenance window are annotated normally according to the alert policy. The entry associated to the maintenance window is annotated with a message prepended to its Notes field and has its severity downgraded so that it can be excluded from outage metrics calculations.

Created with Scroll Wiki HTML Exporter for Confluence.