> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Maintenance Period

> A Maintenance Period temporarily prevents GermainUX from collecting selected metrics and executing selected actions, including alerts.

Service
`Management`

Availability
2014.1 or later

> [card] [Configuration](#configuration)
>
> Open the maintenance settings

> [card] [Configure a Weekly Maintenance Period](#configure-a-weekly-maintenance-period)
>
> Recurring window example

> [card] [One-Time Maintenance Period](#one-time-maintenance-period)
>
> Single window setup

> [card] [Configuration Activation](#configuration-activation)
>
> Changes apply within minutes

## Overview

A Maintenance Period temporarily prevents GermainUX from collecting selected metrics and executing selected actions, including alerts.

Maintenance Periods are typically used during planned upgrades, deployments, or infrastructure work. They prevent expected downtime from:

* Triggering unnecessary alerts
* Executing automated remediation actions
* Affecting analytics, SLA calculations, or availability results

Maintenance Periods can run once or recur on a schedule.

## Configuration

Go to **Germain Workspace > Left Menu > System > Maintenance**.

![Maintenance Period: Configuration](https://mintcdn.com/germain-ux/S6CZjLTFu68xyZFG/images/main/maintenance-window/image-20260825-215108.png?fit=max\&auto=format\&n=S6CZjLTFu68xyZFG\&q=85\&s=10c19c7052359a3e42b03796a119b886)

| Workspace Field | Configuration Key | Description | Possible Values |
| - | - | - | - |
| **Name** | `name` | Unique name used to identify the Maintenance Period. | String |
| **Duration** | `duration` | Length of time the Maintenance Period remains active, in seconds. | Integer |
| **Recurring** | `recurring` | Determines whether the Maintenance Period runs once or follows a recurring schedule. | Boolean |
| **Schedule** | `schedule` | Specifies when the Maintenance Period begins. | Quartz CRON expression, including seconds |
| **Actions** | `actions` | Actions that must not execute while the Maintenance Period is active. | List of configured actions |

## Configure a Weekly Maintenance Period

The following example creates a one-hour Maintenance Period that begins every Sunday at 1:00 AM.

1. Go to **Germain Workspace > Left Menu > System > Maintenance**.

   ![Maintenance Period: Configure a Weekly Maintenance Period](https://mintcdn.com/germain-ux/S6CZjLTFu68xyZFG/images/main/maintenance-window/image2020-11-17_10-46-46.png?fit=max\&auto=format\&n=S6CZjLTFu68xyZFG\&q=85\&s=806b4cac7087c2bba61286e893e3fed9)
2. Click **+** to create a Maintenance Period.
3. Enter a descriptive name.
4. Set the duration to `3600` seconds.
5. Enable **Recurring**.
6. Configure the start time using either:
   * The **Basic** scheduling options, or
   * The **Advanced** CRON editor

     ![Maintenance Period: Configure a Weekly Maintenance Period, image 2](https://mintcdn.com/germain-ux/S6CZjLTFu68xyZFG/images/main/maintenance-window/image2020-11-17_10-48-23.png?fit=max\&auto=format\&n=S6CZjLTFu68xyZFG\&q=85\&s=27eecc61bd37e1a866bc62e95220a3e3)
7. Under **Actions**, select the actions that GermainUX should suppress during the Maintenance Period.

   ![Maintenance Period: Configure a Weekly Maintenance Period, image 3](https://mintcdn.com/germain-ux/S6CZjLTFu68xyZFG/images/main/maintenance-window/image2020-11-17_10-48-58.png?fit=max\&auto=format\&n=S6CZjLTFu68xyZFG\&q=85\&s=ffc2ace4e9a8d2cff804541863c5d05e)
8. Save the configuration.

Schedules use the Quartz CRON format, which includes seconds. See this [Quartz CRON expression reference](https://www.freeformatter.com/cron-expression-generator-quartz.html) for examples.

## One-Time Maintenance Period

To configure a Maintenance Period that runs only once:

**1. Create a new Maintenance Period**

**2. Disable Recurring**

**3. Configure its start time and duration**

**4. Select the actions to suppress**

**5. Save the configuration**

## Configuration Activation

New or updated Maintenance Period configurations are applied by GermainUX within approximately 60 seconds.

> [!NOTE]
>
> Any changes to new or existing maintenance periods are picked up by Germain within the next 60 seconds..

## Get Help

> [card] [Contact GermainUX Support](https://docs.germainux.com/main/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

> [card] Can't find what you need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.