Skip to content
CA App Synthetic Monitor
Documentation powered by DocOps

Schedule Maintenance

Last update September 19, 2018

You can tell ASM when your services are down for scheduled maintenance. ASM then does not return false service availability errors. When services are scheduled for maintenance, ASM monitoring stations still run the checks. In the monitor log, the check is recorded with the result in maintenance. Create a maintenance window which includes the time windows of scheduled maintenance and the group of affected monitors.

Create a Maintenance Window

You can schedule one-off and regular recurring maintenance periods which affect one or more monitors in a maintenance window. Create the maintenance window with a name. Add time windows that specify when the maintenance is ongoing. Add the monitors that are affected.

Follow these steps:

  1. In the ASM Dashboard select Tools, Maintenance, Create New Maintenance Window.
  2. Provide a name for the maintenance window.
  3. Add one or more time windows. Specify when the maintenance is ongoing.
  4. From the list of monitors, select all monitors that are affected by this maintenance.
  5. Select Submit.
    The Maintenance window is saved and appears in the Scheduled Maintenance section of the page.

Add, Remove, or Edit Time Windows in a Maintenance Window

Make changes to when the maintenance is scheduled by adding, removing, or modifying existing time windows in the maintenance window.

Add a time window

Follow these steps:

  1. In Settings, select Maintenance.
  2. Select the title of the maintenance window and select the Edit icon.
  3. In the time window section, select the + symbol.
  4. Complete the fields with the details of the new maintenance session.

The details are automatically saved and registered with your dashboard.

Edit a Time window

Follow these steps:

  1. In Settings, select Maintenance
  2. Select the title of the maintenance window and select the Edit icon.
  3. Highlight the time window to change and select the Edit icon.
  4. Make changes as required in the details fields.

 The details are automatically saved and registered with your dashboard.

Remove a Time Window

Follow these steps:

  1. In Settings, select Maintenance
  2. Select the title of the maintenance window and select the Edit icon.
  3. Highlight the time window to change and select the Trash icon.

Add or Remove Monitors from a Maintenance Window

You can change the settings of any Maintenance Window.

Follow these steps:

  1. In Settings, select Maintenance
  2. Select the title of the maintenance window and select the Edit icon.
    Monitors registered in this maintenance window appear in the Scheduled section. Monitors that can be added to this maintenance window appear in the Available section.
  3. To add monitors to the window, highlight the required monitors in the Available section and select the + icon.
  4. To remove monitors, highlight the required monitors in the Scheduled section and select the trash icon.

Edits are automatically saved and registered with your dashboard.

Schedule Maintenance for an Individual Monitor

You can add an individual monitor to a maintenance window in Monitor Settings.

Follow these steps:

  1. In Monitors, select the cog icon next to the required monitor.
  2. Scroll down to the Maintenance setting, open the drop-down, and select the name of the maintenance window to add this monitor to.
  3. Select Save.

The monitor is added to the maintenance list.

Remove a Maintenance Window

To remove a maintenance window, in Settings select Maintenance. Highlight the maintenance window to remove and select the trash icon.

Immediate Maintenance

You can immediately put a monitor into maintenance immediately with the monitor settings.

Follow these steps:

  1. In Settings, Monitors, select the title of the monitor you want to schedule for maintenance.
  2. Select More Options and scroll down to the Maintenance Section.
  3. Expand the Immediate Maintenance drop-down and select the duration of the maintenance period.
  4. Select Save.

The monitor is immediately placed in maintenance status. The monitor is returned to active status automatically at the end of the period.

Set Maintenance with API

You can use a Public API call to set a simple maintenance window. With the API, you can specify when the maintenance period starts and the duration of the period. For more information, see: API Reference


Was this helpful?

Please log in to post comments.

  1. Dorian Robinson
    2019-03-04 03:27

    Create a Maintenance Window You can schedule one-off and regular recurring maintenance periods which affect one or more monitors in a maintenance window. Create the maintenance window with a name. Add time windows that specify when the maintenance is ongoing. Add the monitors that are affected.

    Follow these steps:

    "In the ASM Dashboard select Tools, Maintenance, Create New Maintenance Window".

    I have this option under Monitors >Maintenance in my ASM version.

    1. Joshua Lajciak
      2019-03-05 03:16

      Hi Dorian,

      Thank you for your comment, we'll make sure this gets into the documentation.

      Josh