Skip navigation
Currently Being Moderated

7.3 Maintenance Windows

VERSION 4  Click to view document history
Created on: Oct 11, 2011 5:00 PM by Zenoss API - Last Modified:  Oct 11, 2011 5:17 PM by Zenoss API

 3. Maintenance Windows

Maintenance windows allow scheduled production state changes of a device or all devices in a system, group, or location. You might want to set up a maintenance window, for example, to prevent alerts and warnings while you perform configuration changes or reboot a device.

Note

In lieu of setting up a maintenance window, you can change the production state for a device manually at the time you want to make changes.

When the maintenance window starts, the production state of the device is set to the value of Start Production State (Maintenance). When the maintenance window closes, the production state of the device reverts to the value of Stop Production State (the state the device was in prior to maintenance).

 3.1. Maintenance Window Events

When a maintenance window starts, an event is created with the following information:

  • depuid - zenactions | Monitor | MaintenanceWindowName | TargetOrganizerOrDevice

  • prodState - StartProductionState

  • severity - Info

  • summary/message - Maintenance window starting MaintenanceWindow for Target

  • eventClass - /Status/Update

  • eventClassKey - mw_change

  • maintenance_devices - Target

  • maintenance_window - MaintenanceWindow

When a maintenance window stops, an event is created with the following information:

  • severity - Clear

  • summary/message - Maintenance window stopping MaintenanceWindow for Target

  • prodState - -99 (meaning "unknown.")

Maintenance window events auto-clear, meaning that stop events clear start events.

 3.2. Creating and Using Maintenance Windows

You can create a maintenance window for an individual device or group of devices in the devices hierarchy.

 3.2.1. Create a Maintenance Window for a Single Device

To create a maintenance window for a device:

  1. Click a device name in the devices list.

    The device Overview page appears.

  2. In the left panel, select Administration.

  3. In the Maintenance Windows area, select Add Maint Window from (Action menu).

    The Add Maintenance Window dialog appears.

  4. Enter a name for the maintenance window, and then click OK.

    The newly defined maintenance window appears in the list.

  5. Click the name in the list to show the maintenance window status page.

  6. Define the attributes for the maintenance window:

    • Name - Name of the maintenance window.

    • Enabled - Select True to make the maintenance window active, or False to de-activate it.

    • Start - Specify a date and time for the window to become active.

    • Duration - Specify the length of time for the window to be in effect.

    • Start Production State - Define the production state for the window when the maintenance period begins.

    • Stop Production State - Shows the production state that will be in effect when the maintenance period ends.

  7. Click Save.

 3.2.2. Create a Maintenance Window for a Group of Devices

To create a maintenance window for a group of devices:

  1. Select a group of devices from the devices hierarchy or devices list.

  2. Click Details.

  3. In the left panel, select Administration

  4. In the Maintenance Windows area, select Add Maint Window from (Action menu).

    The Add Maintenance Window dialog appears.

  5. Enter a name for the maintenance window, and then click OK.

    The newly defined maintenance window appears in the list.

  6. Click the name in the list to show the maintenance window status page.

  7. Define the attributes for the maintenance window:

    • Name - Name of the maintenance window.

    • Enabled - Select True to make the maintenance window active, or False to de-activate it.

    • Start - Specify a date and time for the window to become active.

    • Duration - Specify the length of time for the window to be in effect.

    • Start Production State - Define the production state for the window when the maintenance period begins.

    • Stop Production State - Shows the production state that will be in effect when the maintenance period ends.

  8. Click Save.

Comments (0)