README.md

ansible-pfsense / pfsensible.core

This is a set of modules to allow you to configure pfSense firewalls with ansible.

NOTE: Changes with pfsensible.core 0.4.0

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.

Installation using ansible galaxy

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). We have renamed the collection 'pfsensible.core' for galaxy distribution. 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

Configuration

Current ansible (2.9) python discovery should detect the installed python. If not, you can set in your playbook or hosts vars:

pfSense >= 2.4.5:

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.

Modules

The following modules are currently available:

• pfsensible.core.pfsense_alias for aliases
• pfsensible.core.pfsense_authserver_ldap for LDAP authentication servers
• pfsensible.core.pfsense_ca for Certificate Authorities
• pfsensible.core.pfsense_gateway for routing gateways
• pfsensible.core.pfsense_group for groups
• pfsensible.core.pfsense_interface for interfaces
• pfsensible.core.pfsense_ipsec for ipsec tunnels and phase 1 options
• pfsensible.core.pfsense_ipsec_proposal for ipsec proposals
• pfsensible.core.pfsense_ipsec_p2 for ipsec tunnels phase 2 options
• pfsensible.core.pfsense_log_settings for logging settings
• pfsensible.core.pfsense_nat_outbound for outbound NAT rules
• pfsensible.core.pfsense_nat_port_forward for port forward NAT rules
• pfsensible.core.pfsense_route for routes
• pfsensible.core.pfsense_rule for rules
• pfsensible.core.pfsense_rule_separator for rule separators
• pfsensible.core.pfsense_setup for general setup
• pfsensible.core.pfsense_user for users
• pfsensible.core.pfsense_vlan for vlans

Bulk modules

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:

• pfsensible.core.pfsense_aggregate for aliases, rules, rule separators, interfaces and vlans
• pfsensible.core.pfsense_ipsec_aggregate for ipsec tunnels, phases 1, phases 2 and proposals

Third party modules

These modules allow you to manage installed packages:

• pfsensible.core.pfsense_haproxy_backend for haproxy backends
• pfsensible.core.pfsense_haproxy_backend_server for haproxy backends servers

Operation

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.

License

GPLv3.0 or later