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
70
71
72
73
74
75
|
.. _param-imdiag-serverrun:
.. _imdiag.parameter.input.serverrun:
ServerRun
=========
.. index::
single: imdiag; ServerRun
single: ServerRun
.. summary-start
Creates the imdiag TCP listener on the specified port (``0`` selects an
ephemeral port).
.. summary-end
This parameter applies to :doc:`../../configuration/modules/imdiag`.
:Name: ServerRun
:Scope: input
:Type: integer (port)
:Default: input=none
:Required?: yes
:Introduced: at least 5.x, possibly earlier
Description
-----------
Starts the diagnostic control listener. The value is the TCP port number to
bind. Specify ``0`` to request an ephemeral port from the operating system.
The chosen port is recorded in the file specified by the mandatory
:ref:`ListenPortFileName <param-imdiag-listenportfilename>` parameter.
imdiag always uses the plain TCP (``ptcp``) :doc:`network stream driver
<../../concepts/netstrm_drvr>`. As a result, parameters that normally tune
stream driver authentication or permitted peers are accepted for
compatibility but have no effect in current releases.
This includes:
* :ref:`param-imdiag-serverstreamdrivermode`
* :ref:`param-imdiag-serverstreamdriverauthmode`
* :ref:`param-imdiag-serverstreamdriverpermittedpeer`
imdiag supports only a single listener. Attempting to configure ``ServerRun``
more than once logs an error and the additional configuration is ignored. Set
module-level parameters such as :ref:`MaxSessions <param-imdiag-maxsessions>`
before invoking ``ServerRun``.
Input usage
-----------
.. _param-imdiag-input-serverrun:
.. _imdiag.parameter.input.serverrun-usage:
.. code-block:: rsyslog
module(load="imdiag" maxSessions="20")
input(type="imdiag"
listenPortFileName="/var/run/rsyslog/imdiag.port"
serverRun="0")
Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Historic names/directives for compatibility. Do not use in new configs.
.. _imdiag.parameter.legacy.imdiagserverrun:
- $IMDiagServerRun — maps to ServerRun (status: legacy)
.. index::
single: imdiag; $IMDiagServerRun
single: $IMDiagServerRun
See also
--------
See also :doc:`../../configuration/modules/imdiag`.
|
