Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README #25

Closed
wants to merge 1 commit into from
Closed

Update README #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ 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:
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:
```
Expand All @@ -54,45 +54,45 @@ Modules must run as root in order to make changes to the system. By default pfS
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](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_alias) for aliases
* [pfsensible.core.pfsense_authserver_ldap](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_authserver_ldap) for LDAP authentication servers
* [pfsensible.core.pfsense_ca](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_ca) for Certificate Authorities
* [pfsensible.core.pfsense_gateway](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_gateway) for routing gateways
* [pfsensible.core.pfsense_group](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_group) for groups
* [pfsensible.core.pfsense_interface](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_interface) for interfaces
* [pfsensible.core.pfsense_ipsec](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_ipsec) for ipsec tunnels and phase 1 options
* [pfsensible.core.pfsense_ipsec_proposal](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_ipsec_proposal) for ipsec proposals
* [pfsensible.core.pfsense_ipsec_p2](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_ipsec_p2) for ipsec tunnels phase 2 options
* [pfsensible.core.pfsense_log_settings](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_log_settings) for logging settings
* [pfsensible.core.pfsense_nat_outbound](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_nat_outbound) for outbound NAT rules
* [pfsensible.core.pfsense_nat_port_forward](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_nat_port_forward) for port forward NAT rules
* [pfsensible.core.pfsense_route](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_route) for routes
* [pfsensible.core.pfsense_rule](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_rule) for rules
* [pfsensible.core.pfsense_rule_separator](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_rule_separator) for rule separators
* [pfsensible.core.pfsense_setup](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_setup) for general setup
* [pfsensible.core.pfsense_user](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_user) for users
* [pfsensible.core.pfsense_vlan](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_vlan) for vlans
* [pfsensible.core.pfsense_alias](https://github.com/pfsensible/core/wiki/pfsensible.core.alias) for firewall aliases
* [pfsensible.core.pfsense_authserver_ldap](https://github.com/pfsensible/core/wiki/pfsensible.core.authserver_ldap) for LDAP authentication servers (configured in User Manager)
* [pfsensible.core.pfsense_ca](https://github.com/pfsensible/core/wiki/pfsensible.core.ca) for Certificate Authorities
* [pfsensible.core.pfsense_gateway](https://github.com/pfsensible/core/wiki/pfsensible.core.gateway) for routing gateways
* [pfsensible.core.pfsense_group](https://github.com/pfsensible/core/wiki/pfsensible.core.group) for interface groups
* [pfsensible.core.pfsense_interface](https://github.com/pfsensible/core/wiki/pfsensible.core.interface) for interfaces
* [pfsensible.core.pfsense_ipsec](https://github.com/pfsensible/core/wiki/pfsensible.core.ipsec) for IPsec tunnels and phase 1 options
* [pfsensible.core.pfsense_ipsec_proposal](https://github.com/pfsensible/core/wiki/pfsensible.core.ipsec_proposal) for IPsec phase 1 proposals
* [pfsensible.core.pfsense_ipsec_p2](https://github.com/pfsensible/core/wiki/pfsensible.core.ipsec_p2) for IPsec tunnel phase 2 proposals
* [pfsensible.core.pfsense_log_settings](https://github.com/pfsensible/core/wiki/pfsensible.core.log_settings) for logging settings
* [pfsensible.core.pfsense_nat_outbound](https://github.com/pfsensible/core/wiki/pfsensible.core.nat_outbound) for outbound NAT (SNAT) rules
* [pfsensible.core.pfsense_nat_port_forward](https://github.com/pfsensible/core/wiki/pfsensible.core.nat_port_forward) for port forwarding (DNAT) rules
* [pfsensible.core.pfsense_route](https://github.com/pfsensible/core/wiki/pfsensible.core.route) for routes
* [pfsensible.core.pfsense_rule](https://github.com/pfsensible/core/wiki/pfsensible.core.rule) for firewall rules
* [pfsensible.core.pfsense_rule_separator](https://github.com/pfsensible/core/wiki/pfsensible.core.rule_separator) for firewall rule separators
* [pfsensible.core.pfsense_setup](https://github.com/pfsensible/core/wiki/pfsensible.core.setup) for general setup
* [pfsensible.core.pfsense_user](https://github.com/pfsensible/core/wiki/pfsensible.core.user) for users
* [pfsensible.core.pfsense_vlan](https://github.com/pfsensible/core/wiki/pfsensible.core.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](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_aggregate) for aliases, rules, rule separators, interfaces and vlans
* [pfsensible.core.pfsense_ipsec_aggregate](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_ipsec_aggregate) for ipsec tunnels, phases 1, phases 2 and proposals
* [pfsensible.core.pfsense_aggregate](https://github.com/pfsensible/core/wiki/pfsensible.core.aggregate) for firewall aliases, rules, and rule separators, plus interfaces and VLANs
* [pfsensible.core.pfsense_ipsec_aggregate](https://github.com/pfsensible/core/wiki/pfsensible.core.ipsec_aggregate) for IPsec tunnels, proposals, and phase1/2 options

## Third party modules
These modules allow you to manage installed packages:

* [pfsensible.core.pfsense_haproxy_backend](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_haproxy_backend) for haproxy backends
* [pfsensible.core.pfsense_haproxy_backend_server](https://github.com/pfsensible/core/wiki/pfsensible.core.pfsense_haproxy_backend_server) for haproxy backends servers
* [pfsensible.core.pfsense_haproxy_backend](https://github.com/pfsensible/core/wiki/pfsensible.core.haproxy_backend) for HAProxy backends
* [pfsensible.core.pfsense_haproxy_backend_server](https://github.com/pfsensible/core/wiki/pfsensible.core.haproxy_backend_server) for HAProxy backend 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.
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.
Expand Down