summaryrefslogtreecommitdiffstats
path: root/source/configuration/input.rst
blob: 3e214d1333f7f50ba38e9fae39799937e7ac2eb5 (plain)
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
Input
=====

.. index:: ! input
.. _cfgobj_input:

The ``input`` object, as its name suggests, describes message input sources.
Without input, no processing happens at all, because no messages enter the
rsyslog system.
Inputs are implemented via :doc:`input modules <modules/idx_input>`.

The input object has different parameters:

-  those that apply to all input and are generally available for
   all inputs. These are documented below.
-  input-specific parameters. These are specific to a certain type of
   input. They are documented by the :doc:`input module <modules/idx_input>`
   in question.

General Input Parameters
------------------------

Note: parameter names are case-insensitive.

.. function::  type <type-string>

   *Mandatory*

   The ``<type-string>`` is a string identifying the input module as given
   it each module's documentation. For example, the
   :doc:`UDP syslog input <modules/imudp>` is named "imudp".