File: omprog-template.rst

package info (click to toggle)
rsyslog 8.2512.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,464 kB
  • sloc: ansic: 123,809; sh: 42,109; makefile: 5,962; javascript: 1,842; python: 1,222; lex: 607; yacc: 193; perl: 162; sql: 103; tcl: 9; ruby: 2
file content (42 lines) | stat: -rw-r--r-- 859 bytes parent folder | download | duplicates (2)
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
.. _param-omprog-template:
.. _omprog.parameter.action.template:

template
========

.. index::
   single: omprog; template
   single: template

.. summary-start

Sets the template for formatting messages sent to the program.

.. summary-end

This parameter applies to :doc:`../../configuration/modules/omprog`.

:Name: template
:Scope: action
:Type: word
:Default: action=RSYSLOG_FileFormat
:Required?: no
:Introduced: at least 5.x, possibly earlier

Description
-----------
Name of the :doc:`template <../../configuration/templates>` to use to format the log messages
passed to the external program.

Action usage
------------
.. _param-omprog-action-template:
.. _omprog.parameter.action.template-usage:

.. code-block:: rsyslog

   action(type="omprog" template="RSYSLOG_FileFormat")

See also
--------
See also :doc:`../../configuration/modules/omprog`.