# omusrmsg: notify users

Module Name: | omusrmsg
Author: | Rainer Gerhards <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

type | default | mandatory | `obsolete legacy` directive
--- | --- | --- | ---
string | none | yes | none

The name of the users to send data to.

#### Template

type | default | mandatory | `obsolete legacy` directive
--- | --- | --- | ---
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

    action(type="omusrmsg" users="*")

See also

Help with configuring/using `Rsyslog`:

- Mailing list - best route for general questions
- GitHub: rsyslog source project - detailed questions, reporting issues that are believed to be bugs with `Rsyslog`
- Stack Exchange (View, Ask) - experimental support from rsyslog community

See also

Contributing to `Rsyslog`:

- Source project: rsyslog project README.
- Documentation: rsyslog-doc project README

Copyright 2008-2020 Rainer Gerhards (Großrinderfeld), and Others.