Skip to main content
Actions

Maintenance mode

How the Maintenance mode action puts a device into maintenance or clears it, and what gets paused.

Maintenance mode puts the run's device into maintenance or clears it again. It is the same maintenance mode you can set directly on the device page, which is handy, for example, to avoid alerts during an update. The device doesn't need to be online.

Configuration fields

FieldTypeRequiredDefaultDescription
ModeselectionYesSet maintenance modeSet maintenance mode or Clear maintenance mode. The other fields only appear for Set maintenance mode
Duration (minutes)numberYes60How long maintenance lasts, starting when the step runs. With 0, it stays active until it is cleared. Negative values are not allowed
Pause during maintenance: AlertsswitchNoonFailing checks on the device open no new alerts. Recovery notifications for alerts that are already open still go out, and so do notification steps in automations
Pause during maintenance: ChecksswitchNoonPauses checks on the device
Pause during maintenance: AutomationsswitchNoonSkips scheduled automations on the device
Pause during maintenance: DeploymentsswitchNooffPauses third-party software deployments
Pause during maintenance: PatchesswitchNooffPauses the installation of operating-system updates and patches

None of the fields support variables.

Platform support

The action runs in octoja and works the same on every operating system.

Outputs

OutputDescription
actionset or cleared

For a finite duration, the step result in Run history also shows activeUntil. That is the end of maintenance in UTC, for example 2026-01-15 18:00:00Z.

Result behaviour

Set maintenance mode starts maintenance right away. If maintenance is already set directly on the device, it is replaced, even if it came from an earlier run. The device page then shows the Maintenance mode active banner. If the step runs again, the duration starts over.

Clear maintenance mode removes this device maintenance. It also succeeds when no maintenance is active. Maintenance windows from configuration packages or other sources stay in place, so the device can still be in maintenance.

Pausing Automations only holds back scheduled runs on the device. The current run carries on with its remaining steps, and runs you start by hand work as usual.

If a later Clear maintenance mode step might never be reached, for example because an earlier step fails and stops the workflow, pick a finite duration so maintenance ends on its own. If device is offline has no effect on this action.

Test run and Test step really change the device's maintenance mode.

See also: Create an automation · Maintenance mode and maintenance windows · Device Statuses