This is a set of modules to allow you to configure pfSense firewalls with ansible.
With pfsensible.core 0.4.0 we have stopped stripping the pfsense_ prefix from the module names. This caused conflicts with other modules (like the ansible core 'setup' module). You can use the 'collections' keyword in your playbooks and roles to simplify the module names instead.
Ansible Galaxy (as of version 2.9) now has an option for collections. A collection is a distribution format for delivering all type of Ansible content (not just roles as it was before). To install:
ansible-galaxy collection install pfsensible.core
Optionally, you can specify the path of the collection installation with the -p
option.
ansible-galaxy collection install pfsensible.core -p ./collections
Additionally, you can set the collections_paths
option in your ansible.cfg
file to automatically designate install locations.
# ansible.cfg
[defaults]
collections_paths=collections
Python discovery in ansible 2.9 and 2.10 will only detect Python up to version 3.7, ansible 2.11 will detect 3.8. If Python discovery fails, you can set ansible_python_interpreter in your playbook or hosts vars:
pfSense >= 2.5.2:
ansible_python_interpreter: /usr/local/bin/python3.8
pfSense >= 2.4.5, < 2.5.2:
ansible_python_interpreter: /usr/local/bin/python3.7
pfSense < 2.4.5:
ansible_python_interpreter: /usr/local/bin/python2.7
Modules must run as root in order to make changes to the system. By default pfSense does not have sudo capability so become
will not work. You can install it with:
- name: "Install packages"
package:
name:
- pfSense-pkg-sudo
state: present
and then configure sudo so that your user has permission to use sudo.
The following modules are currently available:
These modules allow you to make important changes at once and, using the purge parameters, to keep the targets configuration strictly synchronized with your playbooks:
These modules allow you to manage installed packages:
Modules in the collection work by editing /cf/conf/config.xml
using xml.etree.ElementTree, then
calling the appropriate PHP update function via the pfSense PHP developer shell.
Some formatting is lost, and CDATA items are converted to normal entries, but so far no problems with that have been noted.
GPLv3.0 or later