Plomosits Pfsense Collection

This repository contains the plomosits.pfsense Ansible Collection.

Inspired by pfsensible.core project, I'm working on a collection that does not require any prerequisites on the pfsense target.

Tested with ansible-core >=2.14 releases and the current development version of ansible-core and pfsense >=2.7.2.

Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed.

Please check the included content on the Ansible Galaxy page for this collection.

The version of the collection is aligned to the version of pfsense. The idea behind is to support different releases of pfsense. So if you have using pfsense v2.7.2 you can use this collection with the same version or version below.

ansible-galaxy collection install plomosits.pfsense:==X.Y.Z

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:

collections:
  - name: plomosits.pfsense
    version: X.Y.Z

See Ansible Using collections for more details.

# inventory.yaml
firewalls:
  hosts:
    pfsense:
      ansible_host: 192.168.1.1
      ansible_user: admin
      ansible_password: pfsense
      
      ansible_connection: httpapi
      ansible_network_os: plomosits.pfsense.pfsense
      ansible_httpapi_port: 443
      ansible_httpapi_use_ssl: yes
      ansible_httpapi_validate_certs: no

# playbooks/reboot.yaml
- name: pfSense Reboot
  hosts: all
  gather_facts: false

  collections:
    - plomosits.pfsense

  tasks:
    - name: Reboot
      pfsense_reboot:
        mode: reboot

ansible-playbook -i inventory.yaml playbooks/reboot.yaml

The following modules are currently available:

• plomosits.pfsense.pfsense_factory_defaults
• plomosits.pfsense.pfsense_reboot
• plomosits.pfsense.pfsense_setup_wizard

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Collections Checklist
• Ansible Community code of conduct
• The Bullhorn (the Ansible Contributor newsletter)
• News for Maintainers

GNU General Public License v3.0 or later.

See LICENSE to see the full text.