HEX

File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/states/__pycache__/syslog_ng.cpython-310.pyc
o

�N�g��@s`dZddlZe�e�Zd
dd�Zddd�Z																dd	d
�Zdd�ZdS)a�
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
:mod:`syslog_ng.reloaded <salt.states.syslog_ng.reloaded>`,
:mod:`syslog_ng.stopped <salt.states.syslog_ng.stopped>`,
and :mod:`syslog_ng.started <salt.states.syslog_ng.started>` functions.
If the service module is available on the computers, users should use that.

Users can generate syslog-ng configuration with
:mod:`syslog_ng.config <salt.states.syslog_ng.config>` function.
For more information see :ref:`syslog-ng state usage <syslog-ng-sate-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
�NTcCstd|||�S)z�
    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
    zsyslog_ng.config�Z__salt__)�name�config�write�r�I/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/syslog_ng.pyr4s	rcC�td|�S)z
    Kills syslog-ng.
    zsyslog_ng.stopr�rrrr�stopped@�r
FcOsntddid|�d|�d|�d|�d|�d|�d|�d	|�d
|�d|	�d|
�d
|�d|�d|
�d|�d|��S)z�
    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.
    zsyslog_ng.startr�user�group�chroot�caps�no_caps�pidfile�enable_core�fd_limit�verbose�debug�trace�yydebug�persist_file�control�worker_threadsNrr)rrr
rrrrrrrrrrrrr�args�kwargsrrr�startedGsB��������	�
���
����rcCr)z
    Reloads syslog-ng.
    zsyslog_ng.reloadrr	rrr�reloadedurr)T)N)NNNNNFNFNFFFFNNN)	�__doc__�logging�	getLogger�__name__�logrr
rrrrrr�<module>s..



�.