blob: ec009561a795e3ae90cbab351a2a1205c02f8d6a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
**********************
omusrmsg: notify users
**********************
=========================== ===========================================================================
**Module Name:** **omusrmsg**
**Author:** `Rainer Gerhards <https://rainer.gerhards.net/>`_ <rgerhards@adiscon.com>
=========================== ===========================================================================
Purpose
=======
This module permits to send log messages to the user terminal. This is a
built-in module so it doesn't need to be loaded.
Configuration Parameters
========================
.. note::
Parameter names are case-insensitive.
Action Parameters
-----------------
Users
^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"string", "none", "yes", "none"
The name of the users to send data to.
Template
^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "WallFmt/StdUsrMsgFmt", "no", "none"
Template to user for the message. Default is WallFmt when parameter users is
"*" and StdUsrMsgFmt otherwise.
Examples
========
Write emergency messages to all users
-------------------------------------
The following command writes emergency messages to all users
.. code-block:: none
action(type="omusrmsg" users="*")
|
