Skip to content

Commit

Permalink
change module states
Browse files Browse the repository at this point in the history
  • Loading branch information
@ansibleguy
ansibleguy committed Aug 31, 2024
1 parent 5420c82 commit 628f4b7
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 26 deletions.
29 changes: 11 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,6 @@ 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.

See also: [Firmware-Upgrade using ansibleguy.opnsense.system](https://opnsense.ansibleguy.net/en/latest/modules/system.html#examples)


**WARNING**:

> The next few OPNSense releases might contain [API changes](https://github.com/ansibleguy/collection_opnsense/issues/51) that might impact/break the functionality of some modules.
----


Expand All @@ -91,18 +84,18 @@ not implemented => development => [testing](https://github.com/ansibleguy/collec
| **Alias** | ansibleguy.opnsense.alias | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/alias.html) | stable |
| **Alias** | ansibleguy.opnsense.alias_multi | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/alias_multi.html) | stable |
| **Alias** | ansibleguy.opnsense.alias_purge | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/alias_multi.html#ansibleguy-opnsense-alias-purge) | unstable |
| **Rules** | ansibleguy.opnsense.rule | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/rule.html) | unstable |
| **Rules** | ansibleguy.opnsense.rule_multi | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/rule_multi.html) | unstable |
| **Rules** | ansibleguy.opnsense.rule | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/rule.html) | stable |
| **Rules** | ansibleguy.opnsense.rule_multi | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/rule_multi.html) | stable |
| **Rules** | ansibleguy.opnsense.rule_purge | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/rule_multi.html#ansibleguy-opnsense-rule-purge) | unstable |
| **Rule Groups** | ansibleguy.opnsense.rule_interface_group | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/rule_interface_group.html#ansibleguy-opnsense-rule-interface-group) | unstable |
| **Savepoints** | ansibleguy.opnsense.savepoint | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/savepoint.html) | unstable |
| **Savepoints** | ansibleguy.opnsense.savepoint | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/savepoint.html) | stable |
| **Packages** | ansibleguy.opnsense.package | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/package.html) | stable |
| **System** | ansibleguy.opnsense.system | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/system.html) | stable |
| **Cron-Jobs** | ansibleguy.opnsense.cron | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/cron.html) | stable |
| **Routes** | ansibleguy.opnsense.route | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/routing.html) | stable |
| **Gateways** | ansibleguy.opnsense.gateway | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/routing.html) | unstable |
| **DNS** | ansibleguy.opnsense.unbound_general | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/unbound_general.html) | stable |
| **DNS** | ansibleguy.opnsense.unbound_acl | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/unbound_acl.html) | unstable |
| **DNS** | ansibleguy.opnsense.unbound_acl | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/unbound_acl.html) | stable |
| **DNS** | ansibleguy.opnsense.unbound_forward | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/unbound_forwarding.html) | stable |
| **DNS** | ansibleguy.opnsense.unbound_dot | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/unbound_dot.html) | stable |
| **DNS** | ansibleguy.opnsense.unbound_host | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/unbound_host.html) | stable |
Expand All @@ -116,7 +109,7 @@ not implemented => development => [testing](https://github.com/ansibleguy/collec
| **IPSec** | ansibleguy.opnsense.ipsec_child | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ipsec.html) | stable |
| **IPSec** | ansibleguy.opnsense.ipsec_vti | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ipsec.html) | stable |
| **IPSec** | ansibleguy.opnsense.ipsec_cert | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ipsec.html) | stable |
| **IPSec** | ansibleguy.opnsense.ipsec_psk | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ipsec.html) | unstable |
| **IPSec** | ansibleguy.opnsense.ipsec_psk | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ipsec.html) | stable |
| **Traffic Shaper** | ansibleguy.opnsense.shaper_pipe | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/shaper.html) | stable |
| **Traffic Shaper** | ansibleguy.opnsense.shaper_queue | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/shaper.html) | stable |
| **Traffic Shaper** | ansibleguy.opnsense.shaper_rule | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/shaper.html) | stable |
Expand All @@ -130,7 +123,7 @@ not implemented => development => [testing](https://github.com/ansibleguy/collec
| **Interfaces** | ansibleguy.opnsense.interface_vlan | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/interface.html) | stable |
| **Interfaces** | ansibleguy.opnsense.interface_vxlan | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/interface.html) | stable |
| **Interfaces** | ansibleguy.opnsense.interface_vip | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/interface.html) | stable |
| **NAT** | ansibleguy.opnsense.source_nat, ansibleguy.opnsense.snat | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/source_nat.html) | unstable |
| **NAT** | ansibleguy.opnsense.source_nat, ansibleguy.opnsense.snat | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/source_nat.html) | stable |
| **Dynamic Routing** | ansibleguy.opnsense.frr_diagnostic | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/frr_diagnostic.html) | stable |
| **Dynamic Routing** | ansibleguy.opnsense.frr_general | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/frr_general.html) | stable |
| **Dynamic Routing** | ansibleguy.opnsense.frr_bfd_general | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/frr_bfd.html#ansibleguy-opnsense-frr-bfd-general) | stable |
Expand Down Expand Up @@ -173,11 +166,11 @@ not implemented => development => [testing](https://github.com/ansibleguy/collec
| **IDS/IPS** | ansibleguy.opnsense.ids_user_rule | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ids.html#id6) | stable |
| **IDS/IPS** | ansibleguy.opnsense.ids_policy | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ids.html#id7) | stable |
| **IDS/IPS** | ansibleguy.opnsense.ids_policy_rule | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/ids.html#id8) | stable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_client | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | unstable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_server | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | unstable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_static_key | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | unstable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_status | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | unstable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_client_override | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | unstable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_client | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | stable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_server | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | stable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_static_key | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | stable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_status | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | stable |
| **OpenVPN** | ansibleguy.opnsense.openvpn_client_override | [Docs](https://opnsense.ansibleguy.net/en/latest/modules/openvpn.html) | stable |


### Roadmap
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/ids.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Intrusion Prevention System
===========================

**STATE**: unstable
**STATE**: stable

**TESTS**: `ansibleguy.opnsense.ids_general <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/ids_general.yml>`_ |
`ansibleguy.opnsense.ids_action <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/ids_action.yml>`_ |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/openvpn.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
OpenVPN
=======

**STATE**: unstable
**STATE**: stable

**TESTS**: `ansibleguy.opnsense.openvpn_client <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/openvpn_client.yml>`_ |
`ansibleguy.opnsense.openvpn_server <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/openvpn_server.yml>`_ |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/rule.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rule
====

**STATE**: unstable
**STATE**: stable

**TESTS**: `Playbook <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/rule.yml>`_

Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/rule_interface_group.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Definition
:widths: 15 10 10 10 10 45

"name","string","true","\-","ifname","Name of the interface group. Only texts containing letters, digits and underscores with a maximum length of 15 characters are allowed and the name may not end with a digit."
"members","list","false","ints, interfaces","Member interfaces - you must provide the network port as shown in 'Interfaces - Assignments - Network port"
"members","list","false","\-","ints, interfaces","Member interfaces - you must provide the network port as shown in 'Interfaces - Assignments - Network port"
"gui_group","boolean","false","true","\-","Grouping these members in the interfaces menu section"
"sequence","int","false","0","seq","Sequence used in sorting the groups"
"description","string","false","\-","desc","Optional description"
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/rule_multi.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rule - Mass Management
======================

**STATE**: unstable
**STATE**: stable

**TESTS**: `rule_multi <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/rule_multi.yml>`_ |
`rule_purge <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/rule_multi.yml>`_
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/savepoint.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Firewall Savepoint
==================

**STATE**: unstable
**STATE**: stable

**TESTS**: `Playbook <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/savepoint.yml>`_

Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/source_nat.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Source NAT
==========

**STATE**: unstable
**STATE**: stable

**TESTS**: `Playbook <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/source_nat.yml>`_

Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/unbound_acl.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
DNS - Unbound - ACL
===================

**STATE**: unstable
**STATE**: stable

**TESTS**: `Playbook <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/unbound_acl.yml>`_

Expand Down

0 comments on commit 628f4b7

Please sign in to comment.