File: mmexternal-binary.rst

package info (click to toggle)
rsyslog 8.2512.0-3
  • 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 (49 lines) | stat: -rw-r--r-- 948 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
.. _param-mmexternal-binary:
.. _mmexternal.parameter.input.binary:

binary
======

.. index::
   single: mmexternal; binary
   single: binary

.. summary-start

Specifies the external message modification plugin executable that
mmexternal invokes.

.. summary-end

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

:Name: binary
:Scope: input
:Type: string
:Default: none
:Required?: yes
:Introduced: 8.3.0

Description
-----------
The name of the external message modification plugin to be called. This can
be a full path name. Command-line arguments for the executable can also be
included in the string.

Input usage
-----------
.. _param-mmexternal-input-binary:
.. _mmexternal.parameter.input.binary-usage:

.. code-block:: rsyslog

   module(load="mmexternal")

   action(
       type="mmexternal"
       binary="/path/to/mmexternal.py"
   )

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