io7m | single-page | multi-page | Idstore User Manual 3.0.0-SNAPSHOT
7.2.22. mail-test
Previous
7.2. Admin Shell Command Reference
Up
7.2.24. self
Next

# 7.2.23. maintenance-mode

- 7.2.23.1. Name
- 7.2.23.2. Description
- 7.2.23.3. Example

## 7.2.23.1. Name

1
maintenance-mode - Enable/disable maintenance mode.

## 7.2.23.2. Description

1
The maintenance-mode command enables or disables maintenance mode.

### 7.2.23.2.2. Parameters

Parameter | Type | Cardinality | Default | Description
--- | --- | --- | --- | ---
--set | String | [0, 1] |  | The message to display to users announcing maintenance mode.
--unset | String | [0, 1] |  | Unset maintenance mode. The string argument is ignored.

## 7.2.23.3. Example

### 7.2.23.3.1. Example

    [idstore]# maintenance-mode --set 'We are performing maintenance. Normal service will resume shortly.'
    Server is in maintenance mode with message "We are performing maintenance. Normal service will resume shortly."

    [idstore]# maintenance-mode --unset Ignored
    Server is now actively serving requests.

7.2.22. mail-test
Previous
7.2. Admin Shell Command Reference
Up
7.2.24. self
Next
io7m | single-page | multi-page | Idstore User Manual 3.0.0-SNAPSHOT