|
3 | 3 | Message of the day (MOTD) |
4 | 4 | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
5 | 5 |
|
6 | | -Displays a configured `message of the day` at the top of the Ceph Dashboard. |
| 6 | +Displays a configured "message of the day" (MOTD) at the top of the Ceph |
| 7 | +Dashboard. |
7 | 8 |
|
8 | | -The importance of a MOTD can be configured by its severity, which is |
9 | | -`info`, `warning` or `danger`. The MOTD can expire after a given time, |
| 9 | +The importance of an MOTD can be configured by its severity, which is |
| 10 | +``info``, ``warning`` or ``danger``. The MOTD can expire after a given time, |
10 | 11 | this means it will not be displayed in the UI anymore. Use the following |
11 | | -syntax to specify the expiration time: `Ns|m|h|d|w` for seconds, minutes, |
12 | | -hours, days and weeks. If the MOTD should expire after 2 hours, use `2h` |
13 | | -or `5w` for 5 weeks. Use `0` to configure a MOTD that does not expire. |
| 12 | +syntax to specify the expiration time: ``Ns|m|h|d|w``, where ``N`` is an |
| 13 | +integer followed by seconds, minutes, hours, days and weeks. If the MOTD |
| 14 | +should expire after 2 hours, use ``2h`` or ``5w`` for 5 weeks. Use ``0`` to |
| 15 | +configure a MOTD that does not expire. |
14 | 16 |
|
15 | 17 | To configure a MOTD, run the following command: |
16 | 18 |
|
17 | | -.. prompt:: bash $ |
| 19 | +.. prompt:: bash # |
18 | 20 |
|
19 | 21 | ceph dashboard motd set <severity:info|warning|danger> <expires> <message> |
20 | 22 |
|
21 | 23 | To show the configured MOTD: |
22 | 24 |
|
23 | | -.. prompt:: bash $ |
| 25 | +.. prompt:: bash # |
24 | 26 |
|
25 | 27 | ceph dashboard motd get |
26 | 28 |
|
27 | 29 | To clear the configured MOTD run: |
28 | 30 |
|
29 | | -.. prompt:: bash $ |
| 31 | +.. prompt:: bash # |
30 | 32 |
|
31 | 33 | ceph dashboard motd clear |
32 | 34 |
|
33 | | -A MOTD with a `info` or `warning` severity can be closed by the user. The |
34 | | -`info` MOTD is not displayed anymore until the local storage cookies are |
35 | | -cleared or a new MOTD with a different severity is displayed. A MOTD with |
36 | | -a 'warning' severity will be displayed again in a new session. |
| 35 | +A MOTD with a severity of ``info`` or ``warning`` can be closed by the user. |
| 36 | +The ``info`` MOTD is not displayed until the local storage cookies are |
| 37 | +cleared or a new MOTD with a different severity is displayed. A MOTD with a |
| 38 | +``warning`` severity will be displayed again in a new session. |
0 commit comments