File: message-protocol-version.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 (44 lines) | stat: -rw-r--r-- 1,101 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
.. _prop-message-protocol-version:
.. _properties.message.protocol-version:

protocol-version
================

.. index::
   single: properties; protocol-version
   single: protocol-version

.. summary-start

Carries the VERSION header field defined by RFC 5424 Section 6.2.2.

.. summary-end

This property belongs to the **Message Properties** group.

:Name: protocol-version
:Category: Message Properties
:Type: string

Description
-----------
Contains the RFC 5424 Section 6.2.2 ``VERSION`` header field that signals
which syslog message format the sender used. RFC 5424 assigns ``1`` to
the standard defined in the specification and reserves future numbers
for later revisions. When rsyslog consumes data without a native syslog
header, this property reflects the configured or inferred version value
for that input, commonly ``1``.

Usage
-----
.. _properties.message.protocol-version-usage:

.. code-block:: rsyslog

   template(name="example" type="list") {
       property(name="protocol-version")
   }

See also
--------
See :doc:`../../configuration/properties` for the category overview.