configuration objects — rsyslog 8.2502.0 documentation

# configuration objects

Note

Configuration object parameters are case-insensitive.

## Common Parameters

### config.enabled

New in version 8.33.0.

All configuration objects have a `config.enabled` parameter. For auto-generated configs, it is useful to have the ability to disable some config constructs even though they may be specified inside the config. This can be done via the `config.enabled` parameter. If set to `on` or not specified, the construct will be used, if set to any other value, it will be ignored. This can be used together with the backtick functionality to enable or disable parts of the configuration from either a file or environment variable.

Example:

Let’s say we want to conditionally load a module. Environment variable `LOAD_IMPTCP` will be either unset or `off` . Then we can use this config construct:

     module(load="imptcp"
         config.enabled=`echo $LOAD_IMPTCP`)

If the variable is set to `off`, the module will not be loaded.

## Objects

### action()

The action object is the primary means of describing actions to be carried out.

### global()

This is used to set global configuration parameters. For details, please see the rsyslog global configuration object.

### input()

The input object is the primary means of describing inputs, which are used to gather messages for rsyslog processing.

### module()

The module object is used to load plugins.

### parser()

The parser object is used to define custom parser objects.

### timezone()

The timezone object is used to define timezone settings.

### include()

The include object is use to include configuration snippets stored elsewhere into the configuration.

See also

Help with configuring/using `Rsyslog`:

- Mailing list - best route for general questions

- GitHub: rsyslog source project - detailed questions, reporting issues that are believed to be bugs with `Rsyslog`

See also

Contributing to `Rsyslog`:

- Source project: rsyslog project README.

- Documentation: rsyslog-doc project README

Copyright 2008-2023 Rainer Gerhards (Großrinderfeld), and Others.