File: omfile-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 (67 lines) | stat: -rw-r--r-- 1,374 bytes parent folder | download
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
.. _param-omfile-template:
.. _omfile.parameter.module.template:

Template
========

.. index::
   single: omfile; Template
   single: Template

.. summary-start

Sets the template to be used for this action.

.. summary-end

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

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

Description
-----------

Sets the template to be used for this action.

When set on the module, the value becomes the default for actions.

Module usage
------------

.. _param-omfile-module-template:
.. _omfile.parameter.module.template-usage:
.. code-block:: rsyslog

   module(load="builtin:omfile" Template="...")

Action usage
------------

.. _param-omfile-action-template:
.. _omfile.parameter.action.template:
.. code-block:: rsyslog

   action(type="omfile" Template="...")

Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Historic names/directives for compatibility. Do not use in new configs.

.. _omfile.parameter.legacy.actionfiledefaulttemplate:

- $ActionFileDefaultTemplate — maps to Template (status: legacy)

.. index::
   single: omfile; $ActionFileDefaultTemplate
   single: $ActionFileDefaultTemplate

See also
--------

See also :doc:`../../configuration/modules/omfile`.