Fortinet black logo

User Guide

Maintenance Schedules

24.2.0
Copy Link
Copy Doc ID af1daa65-c273-11ec-9fd1-fa163e15d75b:494399
Download PDF

Maintenance Schedules

From time to time, you will need to perform routine tasks on your infrastructure that will render it unreachable or cause it to operate outside of the norm - upgrades, maintenance, etc. For that reason, we provide Maintenance Schedules - finite periods where you can instruct FortiMonitor's monitoring of your infrastructure to behave and react in special ways.

Creating custom Maintenance Schedules

Maintenance Schedules page

Each of the options below will open the same Create Maintenance Period drawer.

From the Maintenance Schedules page

  1. From the navigation menu, select Maintenance, then select Schedule & History.

  2. In the top left corner, select Add Maintenance.

From the Instance Details page

  1. Navigate to any instance in your account.

  2. Select Add Maintenance.

  3. Select Custom. The Immediate Maintenance options are discussed below.

From an instance group

  1. Navigate to an instance group in your account.

  2. Towards the top right, there's a block for Maintenance. Click the Add Maintenance button.

  3. Select Custom. The Immediate Maintenance options are discussed below.

Configure a Maintenance period

When configuring Maintenance, you can control the general handling of the maintenance period, the timing, and the scope of your infrastructure which it covers.

General configuration options

Field/Option

Description

Maintenance Period Name

The Maintenance Period name is displayed throughout the FortiMonitor control panel and can be anything of your choosing

Start Time

The Start Time is the time at which the Maintenance Period should commence. If the Maintenance Period will be recurring (see Timing), it will always start at this specific time of day.

Timing

Length of time, in minutes, that the Maintenance Period will last.

  • Duration (mins) – If the Maintenance Period is recurring, it will last this long each time.

  • Ending at – The Maintenance Period will end at this date and time.

Description

A helpful way to communicate what the Maintenance Period covers and why it's being used.

Monitoring

The options under Monitoring dictate how FortiMonitor monitors the specific infrastructure covered by the Maintenance.

  • Continue monitoring but don't create incidents –All monitoring for the instances covered by the Maintenance Period will continue - however, incidents will not be created, regardless of the monitoring data collected.

  • Continue monitoring & creating incidents but don't send alerts – All monitoring for the instances covered by the Maintenance Period will continue and incidents will be created accordingly - however, no alerts will be sent for any detected incidents.

  • Continue monitoring, creating incidents, and sending alerts – Things will operate as normal - however, an Alert Timeline override must be selected to be used for alerting.

Options

  • Show maintenance indicator in public reports – If checked, we'll show a Maintenance badge in your FortiMonitor Status pages if you're using them.

  • End applicable outages when the period begins – If checked, any active incidents that are present when maintenance begins will be force-closed.

  • Apply to sub-tenants – (Multi-tenant users only) If checked, the maintenance will also be applied to sub-tenants. Enabling the option will also restrict you to applying maintenance by tag.

Timing configuration options

By default, Maintenance is a one-time event. However, if you have recurring maintenance, you can use the recurring event option. Select the recurring option will present a set of scheduling controls similar to what you'd see in Gmail or Outlook.

Option

Description

Every n days

Beginning on the day of your Maintenance start date, Maintenance will occur every n days from that point.

Every n weeks

Beginning on the day of your Maintenance start date, Maintenance will occur on the selected days of the week, every n number of weeks. For example, use 1 for every week, 2 for every other week.

Every n months on the nth day of the month

Every n number of months, on the date of the month that coincides with the date of your Start Date. For example, entering a start date of May 1st every 1 month will schedule Maintenance on the first day of every month.

Every n months on the nth day of the week of the month

Every month, Maintenance will be created on the n day of the nth week. For example, setting a start date of May 1, 2019, which is the first Tuesday of May, will schedule Maintenance for the first Tuesday of every month.

Recurrence end date

The recurring maintenance will end on this date.

Adjust for daylight savings

Select a timezone if you want maintenance schedules to adapt to the timezone's daylight savings schedule.

This option is used to adjust maintenance schedule start times based on the beginning and end of daylight savings time in the specified timezone.

Scope configuration options

Option

Description

Impacted Instances

  • By Name – Utilizing the infrastructure tree, you can select the specific instances which will be part of the Maintenance Period.

  • By Group – Utilizing the infrastructure tree, you can select the group(s) which will be part of the Maintenance Period. When the Maintenance Period begins, we'll check each selected group for contained instances; instances present at that time will be placed under maintenance

  • By Tag – Using the tag selector, enter the instance tags you'd like to select instances by. By default, all the tags you enter must be present on the instance at the time of maintenance creation. However, if you switch it to Match Any, only one of the tags must be present on the instance.
    If you edit an instance and add a tag that is being used as a maintenance selector for an active Maintenance Period, we'll put it under maintenance accordingly. Additionally, when adding an instance that matches the tags used in an active maintenance, the instance is automatically put under maintenance as well.

  • By Metrics – You can select the metrics which will be part of the Maintenance Period. Any metrics that you select will be put under maintenance. Monitoring will continue as usual for metrics that were not selected.

Impacted metrics

  • All – All metrics will be included in this maintenance schedule.

  • Selected – Only metrics that you add will be included in this maintenance schedule.

Immediate Maintenance

If you do not need to customize your Maintenance Period, you can invoke immediate maintenance from any instance or group.

  1. On the right side of the page, locate the Maintenance block.

  2. Click Add Maintenance.

  3. Select your desired duration.

Maintenance will begin immediately for your instance or group. Monitoring data will continue to report, but alerts will not be sent if an incident is identified.

Extend a Maintenance Schedule

To extend a maintenance period, perform the following:

  1. Navigate to any instance in your account.

  2. In the Details section of the page, locate the Maintenance block.

  3. Click the 3-dot menu and choose the duration of the extension.

End an existing maintenance

To end an existing maintenance, perform the following:

  1. Navigate to the instance.

  2. In the Details section of the page, locate the Maintenance block.

  3. Click the 3-dot menu of the active maintenance that you want to end then select End Maintenance.

Maintenance Schedules

From time to time, you will need to perform routine tasks on your infrastructure that will render it unreachable or cause it to operate outside of the norm - upgrades, maintenance, etc. For that reason, we provide Maintenance Schedules - finite periods where you can instruct FortiMonitor's monitoring of your infrastructure to behave and react in special ways.

Creating custom Maintenance Schedules

Maintenance Schedules page

Each of the options below will open the same Create Maintenance Period drawer.

From the Maintenance Schedules page

  1. From the navigation menu, select Maintenance, then select Schedule & History.

  2. In the top left corner, select Add Maintenance.

From the Instance Details page

  1. Navigate to any instance in your account.

  2. Select Add Maintenance.

  3. Select Custom. The Immediate Maintenance options are discussed below.

From an instance group

  1. Navigate to an instance group in your account.

  2. Towards the top right, there's a block for Maintenance. Click the Add Maintenance button.

  3. Select Custom. The Immediate Maintenance options are discussed below.

Configure a Maintenance period

When configuring Maintenance, you can control the general handling of the maintenance period, the timing, and the scope of your infrastructure which it covers.

General configuration options

Field/Option

Description

Maintenance Period Name

The Maintenance Period name is displayed throughout the FortiMonitor control panel and can be anything of your choosing

Start Time

The Start Time is the time at which the Maintenance Period should commence. If the Maintenance Period will be recurring (see Timing), it will always start at this specific time of day.

Timing

Length of time, in minutes, that the Maintenance Period will last.

  • Duration (mins) – If the Maintenance Period is recurring, it will last this long each time.

  • Ending at – The Maintenance Period will end at this date and time.

Description

A helpful way to communicate what the Maintenance Period covers and why it's being used.

Monitoring

The options under Monitoring dictate how FortiMonitor monitors the specific infrastructure covered by the Maintenance.

  • Continue monitoring but don't create incidents –All monitoring for the instances covered by the Maintenance Period will continue - however, incidents will not be created, regardless of the monitoring data collected.

  • Continue monitoring & creating incidents but don't send alerts – All monitoring for the instances covered by the Maintenance Period will continue and incidents will be created accordingly - however, no alerts will be sent for any detected incidents.

  • Continue monitoring, creating incidents, and sending alerts – Things will operate as normal - however, an Alert Timeline override must be selected to be used for alerting.

Options

  • Show maintenance indicator in public reports – If checked, we'll show a Maintenance badge in your FortiMonitor Status pages if you're using them.

  • End applicable outages when the period begins – If checked, any active incidents that are present when maintenance begins will be force-closed.

  • Apply to sub-tenants – (Multi-tenant users only) If checked, the maintenance will also be applied to sub-tenants. Enabling the option will also restrict you to applying maintenance by tag.

Timing configuration options

By default, Maintenance is a one-time event. However, if you have recurring maintenance, you can use the recurring event option. Select the recurring option will present a set of scheduling controls similar to what you'd see in Gmail or Outlook.

Option

Description

Every n days

Beginning on the day of your Maintenance start date, Maintenance will occur every n days from that point.

Every n weeks

Beginning on the day of your Maintenance start date, Maintenance will occur on the selected days of the week, every n number of weeks. For example, use 1 for every week, 2 for every other week.

Every n months on the nth day of the month

Every n number of months, on the date of the month that coincides with the date of your Start Date. For example, entering a start date of May 1st every 1 month will schedule Maintenance on the first day of every month.

Every n months on the nth day of the week of the month

Every month, Maintenance will be created on the n day of the nth week. For example, setting a start date of May 1, 2019, which is the first Tuesday of May, will schedule Maintenance for the first Tuesday of every month.

Recurrence end date

The recurring maintenance will end on this date.

Adjust for daylight savings

Select a timezone if you want maintenance schedules to adapt to the timezone's daylight savings schedule.

This option is used to adjust maintenance schedule start times based on the beginning and end of daylight savings time in the specified timezone.

Scope configuration options

Option

Description

Impacted Instances

  • By Name – Utilizing the infrastructure tree, you can select the specific instances which will be part of the Maintenance Period.

  • By Group – Utilizing the infrastructure tree, you can select the group(s) which will be part of the Maintenance Period. When the Maintenance Period begins, we'll check each selected group for contained instances; instances present at that time will be placed under maintenance

  • By Tag – Using the tag selector, enter the instance tags you'd like to select instances by. By default, all the tags you enter must be present on the instance at the time of maintenance creation. However, if you switch it to Match Any, only one of the tags must be present on the instance.
    If you edit an instance and add a tag that is being used as a maintenance selector for an active Maintenance Period, we'll put it under maintenance accordingly. Additionally, when adding an instance that matches the tags used in an active maintenance, the instance is automatically put under maintenance as well.

  • By Metrics – You can select the metrics which will be part of the Maintenance Period. Any metrics that you select will be put under maintenance. Monitoring will continue as usual for metrics that were not selected.

Impacted metrics

  • All – All metrics will be included in this maintenance schedule.

  • Selected – Only metrics that you add will be included in this maintenance schedule.

Immediate Maintenance

If you do not need to customize your Maintenance Period, you can invoke immediate maintenance from any instance or group.

  1. On the right side of the page, locate the Maintenance block.

  2. Click Add Maintenance.

  3. Select your desired duration.

Maintenance will begin immediately for your instance or group. Monitoring data will continue to report, but alerts will not be sent if an incident is identified.

Extend a Maintenance Schedule

To extend a maintenance period, perform the following:

  1. Navigate to any instance in your account.

  2. In the Details section of the page, locate the Maintenance block.

  3. Click the 3-dot menu and choose the duration of the extension.

End an existing maintenance

To end an existing maintenance, perform the following:

  1. Navigate to the instance.

  2. In the Details section of the page, locate the Maintenance block.

  3. Click the 3-dot menu of the active maintenance that you want to end then select End Maintenance.