File: imudp-name-appendport.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 (65 lines) | stat: -rw-r--r-- 1,615 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
.. _param-imudp-name-appendport:
.. _imudp.parameter.input.name-appendport:

Name.appendPort
===============

.. index::
   single: imudp; Name.appendPort
   single: Name.appendPort

.. summary-start

Appends listener port number to ``inputname``.

.. summary-end

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

:Name: Name.appendPort
:Scope: input
:Type: boolean
:Default: input=off
:Required?: no
:Introduced: 7.3.9

Description
-----------
Appends the port to the ``inputname`` property. Note that when no ``name`` is
specified, the default of ``imudp`` is used and the port is appended to that
default. So, for example, a listener port of 514 in that case will lead to an
``inputname`` of ``imudp514``. The ability to append a port is most useful when
multiple ports are defined for a single input and each of the ``inputname``
values shall be unique. Note that there currently is no differentiation between
IPv4/v6 listeners on the same port.

Examples:

.. code-block:: rsyslog

   module(load="imudp")
   input(type="imudp" port=["10514","10515","10516"]
         name="udp" name.appendPort="on")

.. code-block:: rsyslog

   module(load="imudp")
   input(type="imudp" port=["10514","10515","10516"]
         name="" name.appendPort="on")

Input usage
-----------
.. _param-imudp-input-name-appendport:
.. _imudp.parameter.input.name-appendport-usage:

.. code-block:: rsyslog

   input(type="imudp" Name.appendPort="...")

Notes
-----
- Earlier documentation described the type as ``binary``; this maps to boolean.

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