Functional Tests:

• Status: |
• Logs: API | Daily Archive

Internal CI: Tester Role | Jobs API

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/O-X-L/ansible-opnsense.git

# stable/tested version:
ansible-galaxy collection install git+https://github.com/O-X-L/ansible-opnsense.git,25.7.8
## OR
ansible-galaxy collection install oxlorg.opnsense

See: Docs

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

Support the Open-Source projects that make these modules possible:

• Donate to OPNsense or Buy the Business-Edition
• Donate to the Ansible-Module Maintainers or Buy a Support-License

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

See also: Contributing

We try that the oxlorg.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.

As this project is unfunded we do not actively check for API-changes - if you find missing functionalities you need/want to have please report it!

Development States:

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

See: Feature Requests