Ansible Collection - ansibleguy.opnsense

Functional Test Logs: Short, Full

Requirements

The httpx python module is used for API communications!

python3 -m pip install --upgrade httpx

Then - install the collection itself:

# latest version:
ansible-galaxy collection install git+https://github.com/ansibleguy/collection_opnsense.git

# stable/tested version:
ansible-galaxy collection install git+https://github.com/ansibleguy/collection_opnsense.git,1.2.11
## OR
ansible-galaxy collection install ansibleguy.opnsense

Usage

See: Docs

If you DO NOT want to use Ansible - this fork provides you with a raw Python3 interface.

Advertisement

• Need professional support using Ansible or OPNSense? Contact us:

  E-Mail: contact@oxl.at

  Tel: +43 3115 40 900 0

  Web: EN | DE

  Language: German or English

• You want a simple Ansible GUI?

  Check-out this Ansible WebUI

• It was a lot of work (100+ hours) to get those modules working.

  If you are happy with the functionality they provide: please consider donating a few bucks

Contribute

Feel free to contribute to this project using pull-requests, issues and discussions!

See also: Contributing

Version Support

The ansibleguy.opnsense modules always support the latest version of OPNSense.

If an API changed, the current module-implementation might fail for firewalls running an older firmware.

Modules

Development States:

not implemented => development => testing => unstable (practical testing) => stable

Implemented

Roadmap

See: Feature Requests