consul/website/source/docs/commands/maint.html.markdown.erb

---
layout: "docs"
page_title: "Commands: Maint"
sidebar_current: "docs-commands-maint"
description: >
  The `maint` command provides control of both service and node maintenance mode
---

# Consul Maint

Command: `consul maint`

The `maint` command provides control of service maintenance mode.
Using the command, it is possible to mark a service provided by a node or all the services on the
node as a whole as "under maintenance". In this mode of operation, the service
 will not appear in DNS query results, or API results. This effectively
takes the service out of the pool of available "healthy" nodes of a service.

Under the hood, maintenance mode is activated by registering a health check in
critical status against a service, and deactivated by deregistering the
health check.

## Usage

Usage: `consul maint [options]`

#### API Options

<%= partial "docs/commands/http_api_options_client" %>

#### Command Options

* `-enable` - Enable maintenance mode on all services on a node. If
  combined with the `-service` flag, we operate on a specific service ID.

* `-disable` - Disable maintenance mode on all services on a node. If
  combined with the `-service` flag, we operate on a specific service ID.

* `-reason` - An optional reason for placing the service into
  maintenance mode. If provided, this reason will be visible in the newly-
  registered critical check's "Notes" field.

* `-service` - An optional service ID to control maintenance mode for a given service. By
  providing this flag, the `-enable` and `-disable` flags functionality is
  modified to operate on the given service ID.

## List mode

If neither `-enable` nor `-disable` are passed, the `maint` command will
switch to "list mode", displaying any current maintenances. This may return
blank if nothing is currently under maintenance. The output will look like:

```
$ consul maint
Node:
  Name:   node1.local
  Reason: This node is broken.

Service:
  ID:     redis
  Reason: Redis is currently offline.
```