Excluding Planned Maintenance Periods from Report Totals

Table of Contents

Planned maintenance periods

Learn how to exclude maintenance period data from the totals in a graph or table report by creating a maintenance period, assigning devices to it using names or a filter, and associating it with a report. As a result, data for devices in planned maintenance periods does not affect the report totals.

This feature is implemented by the EMC M&R Maintenance Manager module. The Maintenance Manager replaces the Outage Manager and Outage Detector that existed in previous M&R releases. In an upgrade situation, outages that were defined by the older Outage Manager are honored by Maintenance Manager.

Note Image
The previous Outage Detector feature that permitted a user to view and edit a list of maintenance periods is not supported by Maintenance Manager.

Back to Top

Creating a maintenance period

Procedure

  1. Click Administration.
  2. Select Modules > Maintenance Editor.
  3. Type a title for the maintenance period
  4. Select a start date and end date.
  5. Optionally, enter a comment.
    The comment will appear on the maintenance period when the maintenance period appears in a report. The following graphic illustrates a report with an associated maintenance period, which is indicated by yellow. Text from the Comment field is indicated by the small red box.
    report screen

    Text from comment field

  6. To keep the maintenance period out of report totals, leave the Use in report computation field blank
  7. Select the devices to which the maintenance period applies.
    Option Description
    Add with Filter Select from a list of devices that match the values specified in the Edit Mode settings Outages type and Outages property.
    Add by Name Enter the name of a device.
    The devices are displayed in the Objects list.
  8. Click Save.
Back to Top

Associating a maintenance period with a report

Procedure

  1. With a report displayed, click Edit Mode.
  2. Click the Report Configuration tab.
  3. Click Advanced Settings.
  4. In Dynamic Maintenance Period, select Maintenance from Events.
  5. Set the Outages type to the category set in the Maintenance Editor.
    dialog box fields

    Outages type and Outages property

  6. Set the Outages property to the property you will use for matching.

Example

Assume you have created a maintenance period with a category value of "device" and the objects "localhost" and "lglad118". You have a report in your tree, and on that node, you have the property "part" whose value is "localhost". If you were to set outage type to "device" and outage property to "part", then the "localhost" object from the maintenance period would be matched with the "part" property from the node, and the maintenance period would apply. The maintenance periods that match the values for outages type and the outages property will appear in this report.

Back to Top

Installing Maintenance Manager

Use this procedure to install Maintenance Manager.

Typically, the Maintenance Manager is installed automatically with other modules during normal installations. In certain upgrade situations, the Maintenance Manager is not installed. For example, if your existing installation did not include the Maintenance Manager, then an upgrade also would not include it.

Your site needs a license to use the Maintenance Manager. If you need a license, contact EMC Technical Support.

If you receive an error message after navigating to Administration > Modules > Maintenance Editor:

Note Image
If you do not have a license for Maintenance-Manager, contact EMC Technical Support.

Procedure

  1. Navigate to Administration > Centralized Management > Physical Overview > server_name.
  2. In the right pane, click the green Install button.
  3. On the Packages Installation screen:
    1. In the Categories list, select Block.
    2. In the Packages list, select generic-maintenance-manager-vx.x.x, where vx.x.x matches the EMC M&R installed version on the server.
    3. Click Launch at the bottom of the page.
  4. Provide an instance name for the component and click Install.
  5. Install each component as the UI presents them on the screen, clicking Install for each one.
  6. For the generic-maintenance-manager component, provide the following information on the installer command line when the prompts appear:
    Database Type 1
    Database hostname or IP address IP address of the Events Database server
    Database port [53306] typically use the default
    Database name [events] typically use the default
    Database username [apg] typically use the default
    Database password password for the apg user on the database
    Listener port [22666] typically use the default
  7. Type yes to start the installed services.
  8. When the installation completes, add the new resource to the Tomcat service, as follows:
    1. Navigate to Centralized Management > Miscellaneous > WebServers > Tomcat > Default-<servername>.
    2. Under Configuration Files, locate the APG.xml file.
    3. Make sure that the following line is present in the file. If not, then add it.
      <Resource name="outage/OUTAGE-MANAGER"
      factory="org.apache.naming.factory.BeanFactory"
      type="com.watch4net.apg.v2.gui.action.outage.OutageConnectionFactory"
      />
    4. Save the file.
    5. If you changed the file, restart the Tomcat service.
  9. Navigate to Administration > Modules > Maintenance Editor to use Maintenance Manager features.
Back to Top