pfsense_log_settings

> PFSENSE_LOG_SETTINGS    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_log_settings.py)

  Manage pfSense syslog settings

  * This module is maintained by The Ansible Community
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:
    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:
    description: the set of commands that would be pushed to the remote device (if pfSense had a CLI)
    returned: always
    type: list
    sample: ["update log_settings syslog set logformat='rfc5424', rotatecount='8'"]