pfsense_log_settings

pfsensible.core.pfsense_log_settings

        Manage pfSense syslog settings

ADDED IN: version 0.4.2 of pfsensible.core

OPTIONS (= is mandatory):

- auth
        Include General Authentication Events
        default: null
        type: bool

- dhcp
        Include DHCP Events (DHCP Daemon, DHCP Relay, DHCP Client)
        default: null
        type: bool

- disablelocallogging
        Disable writing log files to the local disk
        default: null
        type: bool

- dpinger
        Include Gateway Monitor Events
        default: null
        type: bool

- enable
        Enable Remote logging
        default: null
        type: bool

- filterdescriptions
        Where to show rule descriptions
        choices: [0, 1, 2]
        default: null
        type: int

- hostapd
        Wireless Events (hostapd)
        default: null
        type: bool

- ipproto
        IP Protocol
        choices: [ipv4, ipv6]
        default: null
        type: str

- logall
        Log Everything
        default: null
        type: bool

- logcompressiontype
        The type of compression to use when rotating log files
        choices: [bzip2, gzip, xz, zstd, none]
        default: null
        type: str

- logfilesize
        Log Rotation Size (Bytes)
        default: null
        type: int

- logfilter
        Include Firewall Events
        default: null
        type: bool

- logformat
        Log Message Format
        choices: [rfc3164, rfc5424]
        default: null
        type: str

- nentries
        GUI Log Entries
        default: null
        type: int

- nologbogons
        Don't log packets blocked by 'Block Bogon Networks' rules
        default: null
        type: bool

- nologdefaultblock
        Don't log packets that are blocked by the implicit default
        block rule.
        default: null
        type: bool

- nologdefaultpass
        Don't log packets that are allowed by the implicit default
        pass rule.
        default: null
        type: bool

- nolognginx
        Don't log errors from the web server process
        default: null
        type: bool

- nologprivatenets
        Don't log packets blocked by 'Block Private Networks' rules
        default: null
        type: bool

- ntpd
        Include Network Time Protocol Events (NTP Daemon, NTP Client)
        default: null
        type: bool

- portalauth
        Include Captive Portal Events
        default: null
        type: bool

- ppp
        Include PPP Events (PPPoE WAN Client, L2TP WAN Client, PPTP
        WAN Client)
        default: null
        type: bool

- rawfilter
        Show raw filter logs
        default: null
        type: bool

- remoteserver
        First Remote log server (IP Address or Hostname/FQDN)
        default: null
        type: str

- remoteserver2
        Second Remote log server (IP Address or Hostname/FQDN)
        default: null
        type: str

- remoteserver3
        Third Remote log server (IP Address or Hostname/FQDN)
        default: null
        type: str

- resolver
        Include DNS Events (Resolver/unbound, Forwarder/dnsmasq,
        filterdns)
        default: null
        type: bool

- reverse
        Show log entries in reverse order (newest entries on top)
        default: null
        type: bool

- rotatecount
        The number of log files to keep before the oldest copy is
        removed on rotation
        default: null
        type: int

- routing
        Include Routing Daemon Events (RADVD, UPnP, RIP, OSPF, BGP)
        default: null
        type: bool

- sourceip
        Source Address
        default: null
        type: str

- system
        Include System Events
        default: null
        type: bool

- vpn
        Include VPN Events (IPsec, OpenVPN, L2TP, PPPoE Server)
        default: null
        type: bool


AUTHOR: Jan Wenzel (@coffeelover)

METADATA:
  metadata_version: '1.1'
  status:
  - preview
  supported_by: community

EXAMPLES:

- name: setup remote syslog
  pfsense_log_settings:
    enable: true
    remoteserver: syslog.example.com
    disablelocallogging: true
    logall: true

- name: always log default pass traffic
  pfsense_log_settings:
    nologdefaultpass: false


RETURN VALUES:
- commands
        the set of commands that would be pushed to the remote device
        (if pfSense had a CLI)
        returned: always
        sample: ['update log_settings syslog set logformat=''rfc5424'', rotatecount=''8''']
        type: list