# salt.states.syslog_ng

## State module for syslog_ng

maintainer:

  Tibor Benke <btibi@sch.bme.hu>

maturity:

  new

depends:

  cmd, ps, syslog_ng

platform:

  all

Users can generate syslog-ng configuration files from YAML format or use

  plain ones and reload, start, or stop their syslog-ng by using this module.

### Details

The service module is not available on all system, so this module includes `syslog_ng.reloaded`, `syslog_ng.stopped`, and `syslog_ng.started` functions. If the service module is available on the computers, users should use that.

Users can generate syslog-ng configuration with `syslog_ng.config` function. For more information see syslog-ng state usage.

### Syslog-ng configuration file format

The syntax of a configuration snippet in syslog-ng.conf:

> > object_type object_id {<options>};

These constructions are also called statements. There are options inside of them:

> > option(parameter1, parameter2); option2(parameter1, parameter2);

You can find more information about syslog-ng's configuration syntax in the Syslog-ng Admin guide: http://www.balabit.com/sites/default/files/documents/syslog-ng-ose-3.5-guides/en/syslog-ng-ose-v3.5-guide-admin/html-single/index.html#syslog-ng.conf.5

salt.states.syslog_ng.config(name, config, write=True)

  Builds syslog-ng configuration.

  name : the id of the Salt document config : the parsed YAML code write : if True, it writes the config into the configuration file, otherwise just returns it

salt.states.syslog_ng.reloaded(name)

  Reloads syslog-ng.

salt.states.syslog_ng.started(name=None, user=None, group=None, chroot=None, caps=None, no_caps=False, pidfile=None, enable_core=False, fd_limit=None, verbose=False, debug=False, trace=False, yydebug=False, persist_file=None, control=None, worker_threads=None, *args, **kwargs)

  Ensures, that syslog-ng is started via the given parameters.

  Users shouldn't use this function, if the service module is available on their system.

salt.states.syslog_ng.stopped(name=None)

  Kills syslog-ng.