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.

RateLimit.Interval¶

type	default	mandatory	`obsolete legacy` directive
integer	0	no	none

The rate-limiting interval in seconds. A value of 0 turns off rate-limiting. Set it together with ratelimit.burst to control how many messages can be forwarded per interval.

RateLimit.Burst¶

type	default	mandatory	`obsolete legacy` directive
integer	200	no	none

Maximum number of messages that can be emitted within the ratelimit.interval. This setting is only relevant if ratelimit.interval is not 0.

RateLimit.Name¶

Default: none

Type: string

Description:

Sets the name of the rate limit to use. This allows multiple actions to share the same rate limiting configuration (and state). The name refers to a global rate limit object defined in the configuration.

Note: This parameter is mutually exclusive with ratelimit.interval and ratelimit.burst. If ratelimit.name is specified, local per-action limits cannot be defined and any attempt to do so will result in an error (and the named rate limit will be used).

Added in version 8.2602.0.

Examples¶

Write emergency messages to all users¶

The following command writes emergency messages to all users

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

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project