pfsense_setup

pfsensible.core.pfsense_setup

        Manage pfSense general setup

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- authmode
        Authentication Server ('Local Database' means local
        (Default)), use name of configured ldap or radius server
        default: null
        type: str

- dashboardavailablewidgetspanel
        Show the Available Widgets panel on the Dashboard.
        default: null
        type: bool

- dashboardcolumns
        Dashboard columns
        default: null
        type: int

- disablealiaspopupdetail
        If selected, the details in alias popups will not be shown,
        just the alias description (e.g. in Firewall Rules).
        default: null
        type: bool

- dns_addresses
        DNS IP addresses, separated by space
        default: null
        type: str

- dns_gateways
        DNS gateways, separated by space. You can use none for empty
        values.
        default: null
        type: str

- dns_hostnames
        DNS hostnames, separated by space. You can use none for empty
        values.
        default: null
        type: str

- dnsallowoverride
        Allow DNS server list to be overridden by DHCP/PPP on WAN
        default: null
        type: bool

- dnslocalhost
        Do not use the DNS Forwarder/DNS Resolver as a DNS server for
        the firewall. "" Use local DNS (127.0.0.1), fall back to
        remote DNS servers (Default) "local" Use local DNS (127.0.0),
        ignore remote DNS servers "remote" Use remote DNS server,
        ignore local DNS true will be mapped to "remote" false will be
        mapped to ""
        choices: ['', local, remote, 'true', 'false']
        default: null
        type: str

- domain
        Domain name of the firewall host
        default: null
        type: str

- hostname
        Hostname of the firewall host, without domain part
        default: null
        type: str

- interfacessort
        If selected, lists of interfaces will be sorted by
        description, otherwise they are listed wan,lan,optn...
        default: null
        type: bool

- language
        Language for the webConfigurator.
        choices: [bs, de_DE, en_US, es, es_AR, fr, ko, nb, nl, pl, pt_PT, pt_BR, ru, zh_CN, zh_Hans_CN,
          zh_HK, zh_TW]
        default: null
        type: str

- logincss
        Color for the login page
        default: null
        type: str

- loginshowhost
        Show hostname on login banner
        default: null
        type: bool

- requirestatefilter
        This option requires a filter to be entered before the states
        are displayed.
        default: null
        type: bool

- roworderdragging
        Disables dragging rows to allow selecting and copying row
        contents and avoid accidental changes.
        default: null
        type: bool

- session_timeout
        Time in minutes to expire idle management sessions. The
        default is 4 hours (240 minutes). Use 0 to never expire
        sessions. NOTE: This is a security risk!
        default: null
        type: int

- shellauth
        Use Authentication Server for Shell Authentication (pfsense-CE
        >=2.5.0, pfsense-PLUS >=21.2). Default is false.
        default: null
        type: bool

- statusmonitoringsettingspanel
        Show the Settings panel in Status Monitoring.
        default: null
        type: bool

- systemlogsfilterpanel
        Show the Log Filter panel in System Logs.
        default: null
        type: bool

- systemlogsmanagelogpanel
        Show the Manage Log panel in System Logs.
        default: null
        type: bool

- timeservers
        Time servers, separated by space
        default: null
        type: str

- timezone
        Select a geographic region name (Continent/Location) to
        determine the timezone for the firewall.
        default: null
        type: str

- webguicss
        Choose an alternative css file (if installed) to change the
        appearance of the webConfigurator.
        default: null
        type: str

- webguifixedmenu
        When enabled, menu remains visible at top of page
        default: null
        type: bool

- webguihostnamemenu
        Replaces the Help menu title in the Navbar with the system
        hostname or FQDN.
        choices: [nohost, hostonly, fqdn]
        default: null
        type: str

- webguileftcolumnhyper
        If selected, clicking a label in the left column will
        select/toggle the first item of the group.
        default: null
        type: bool


AUTHOR: Frederic Bor (@f-bor)

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

EXAMPLES:

- name: setup hostname and domain
  pfsense_setup:
    hostname: acme
    domain: corp.com

- name: setup theme
  pfsense_setup:
    webguicss: pfSense-dark

- name: timezone and language
  pfsense_setup:
    timezone: Europe/Paris
    language: fr


RETURN VALUES:
- commands
        the set of commands that would be pushed to the remote device
        (if pfSense had a CLI)
        returned: always
        sample: ['update setup general set hostname=''acme'', domain=''corp.com''']
        type: list