yadro.tatlin_uni.tatlin_sp_syslog module – Configure SP syslog client settings

Note

This module is part of the yadro.tatlin_uni collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install yadro.tatlin_uni.

To use it in a playbook, specify: yadro.tatlin_uni.tatlin_sp_syslog.

New in version 1.0.0: of yadro.tatlin_uni

Synopsis

• This module is intended to configure parameters of sending events to external syslog server

• Supports check mode

Parameters

Parameter	Comments
connection dictionary / required	connection describes Tatlin Storage Processor (SP) connection configuration. Only session connection supported. Authorization is executed automatically with corresponding endpoint. ‘auth/login’ by default. Client receives x-auth-token and uses it for following requests.
base_url string / required	Tatlin REST API entrypoint.
password string	Tatlin user password.
timeout integer	Tatlin REST API request timeout. Default: 60
username string	Tatlin username to login.
validate_certs boolean	Responsible for SSL certificates validation. If set to False certificates won’t validated. Choices: no yes ← (default)
recipients list / elements=dictionary	List of parameters of external syslog servers If state is present, at least one recipient is required. Also all parameters of recipients are required
address string / required	Syslog server`s address in format IP or FQDN
audit boolean	Enable sending audit messages Choices: no yes
facility integer	Facility level of syslog messages
port string	Syslog server`s port
protocol string	Transport or cryptographic protocol Choices: tcp udp tls
severity string	Severity level of syslog messages Choices: critical warning info
state string	present sets passed syslog recipients absent deletes passed syslog recipients in recipients If no recipients were passed with absent, all recipients will be removed Choices: present ← (default) absent

Examples

---
- name: Set Syslog recipients
  yadro.tatlin_uni.tatlin_sp_syslog:
    connection: "{{ connection }}"
    recipients:
      - address: 127.0.0.1
        port: 514
        protocol: udp
        facility: 10
        severity: critical
        audit: false
      - address: example.com
        port: 601
        protocol: tls
        facility: 15
        severity: warning
        audit: true
    state: present

- name: Remove recipient by address
  yadro.tatlin_uni.tatlin_sp_syslog:
    connection: "{{ connection }}"
    recipients:
      - address: 127.0.0.1
    state: absent

- name: Remove recipient by address and port
  yadro.tatlin_uni.tatlin_sp_syslog:
    connection: "{{ connection }}"
    recipients:
      - address: 127.0.0.1
        port: 514
    state: absent

- name: Reset config
  yadro.tatlin_uni.tatlin_sp_syslog:
    connection: "{{ connection }}"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
error string	Error details if raised Returned: on error
msg string	Operation status message Returned: always

Authors

• Sergey Kovalev (@kvlvs)

Collection links

Issue Tracker Repository (Sources)