File: imtcp-streamdriver-authmode.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 (69 lines) | stat: -rw-r--r-- 1,761 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
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
68
69
.. _param-imtcp-streamdriver-authmode:
.. _imtcp.parameter.module.streamdriver-authmode:
.. _imtcp.parameter.input.streamdriver-authmode:

StreamDriver.AuthMode
=====================

.. index::
   single: imtcp; StreamDriver.AuthMode
   single: StreamDriver.AuthMode

.. summary-start

Sets stream driver authentication mode.

.. summary-end

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

:Name: StreamDriver.AuthMode
:Scope: module, input
:Type: string (see :doc:`../../rainerscript/constant_strings`)
:Default: module=none, input=module parameter
:Required?: no
:Introduced: at least 5.x, possibly earlier

Description
-----------
Sets stream driver authentication mode. Possible values and meaning
depend on the :doc:`network stream driver <../../concepts/netstrm_drvr>`.
used.

The same-named input parameter can override this module setting.


Module usage
------------
.. _param-imtcp-module-streamdriver-authmode:
.. _imtcp.parameter.module.streamdriver-authmode-usage:

.. code-block:: rsyslog

   module(load="imtcp" streamDriver.authMode="...")

Input usage
-----------
.. _param-imtcp-input-streamdriver-authmode:
.. _imtcp.parameter.input.streamdriver-authmode-usage:

.. code-block:: rsyslog

   input(type="imtcp" port="514" streamDriver.authMode="...")

Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Historic names/directives for compatibility. Do not use in new configs.

.. _imtcp.parameter.legacy.inputtcpserverstreamdriverauthmode:

- $InputTCPServerStreamDriverAuthMode — maps to StreamDriver.AuthMode (status: legacy)

.. index::
   single: imtcp; $InputTCPServerStreamDriverAuthMode
   single: $InputTCPServerStreamDriverAuthMode

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