diff --git a/docs/source/modules/2_list.rst b/docs/source/modules/2_list.rst index 02e2011f..c8908ed1 100644 --- a/docs/source/modules/2_list.rst +++ b/docs/source/modules/2_list.rst @@ -10,6 +10,13 @@ **TESTS**: Used in multiple ones +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Info **** @@ -25,6 +32,8 @@ In most cases the returned type of this module ist a list of dictionaries. .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/2_reload.rst b/docs/source/modules/2_reload.rst index 1515e6fa..02ba06ae 100644 --- a/docs/source/modules/2_reload.rst +++ b/docs/source/modules/2_reload.rst @@ -10,6 +10,13 @@ **TESTS**: `Playbook `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Info **** @@ -30,6 +37,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/acmeclient.rst b/docs/source/modules/acmeclient.rst index 7d1cc3d3..88918e1a 100644 --- a/docs/source/modules/acmeclient.rst +++ b/docs/source/modules/acmeclient.rst @@ -23,6 +23,8 @@ Contribution Thanks to `@jiuka `_ for developing these modules! +---- + Prerequisites ************* diff --git a/docs/source/modules/alias.rst b/docs/source/modules/alias.rst index 743b2e10..9bea0dff 100644 --- a/docs/source/modules/alias.rst +++ b/docs/source/modules/alias.rst @@ -16,6 +16,12 @@ Alias This module allows you to manage single aliases. +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Info **** @@ -24,7 +30,6 @@ For more detailed information on what alias types are supported - see `the docum To use GeoIP alias types - you need to configure a source for it first. See: `documentation `_ - Mass-Manage =========== @@ -47,6 +52,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/alias_multi.rst b/docs/source/modules/alias_multi.rst index cea4ddd2..24690490 100644 --- a/docs/source/modules/alias_multi.rst +++ b/docs/source/modules/alias_multi.rst @@ -19,6 +19,13 @@ This module allows you to manage multiple aliases. It is faster than the 'alias' module as it reduces the needed api/http calls. +Contribution +************ + +Thanks to `@Rath `_ for developing these modules! + +---- + Info **** @@ -68,6 +75,8 @@ ansibleguy.opnsense.alias_purge "fail_all","boolean","false","false","fail","Fail module if single alias fails to be purged" "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- + Examples ******** diff --git a/docs/source/modules/bind.rst b/docs/source/modules/bind.rst index 257bb4a2..ac346f68 100644 --- a/docs/source/modules/bind.rst +++ b/docs/source/modules/bind.rst @@ -20,11 +20,18 @@ DNS - BIND **Service Docs**: `Bind `_ +Contribution +************ + +Thanks to `@Rath `_ for developing these modules! + Sponsoring ********** Thanks to `@telmich `_ for sponsoring the development of these modules! +---- + Prerequisites ************* @@ -169,6 +176,8 @@ ansibleguy.opnsense.bind_record_multi "output_info","boolean","false","false","info","Enable to show some information on processing at runtime. Will be hidden if the tasks 'no_log' parameter is set to 'true'." "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- + Info **** @@ -216,6 +225,7 @@ But the default behaviour is that you can only delete all of them at once. If a change is needed, you will have to run the module using 'state=absent' first and then re-create all the records. +---- Examples ******** diff --git a/docs/source/modules/cron.rst b/docs/source/modules/cron.rst index 70a9ebcb..8610d43a 100644 --- a/docs/source/modules/cron.rst +++ b/docs/source/modules/cron.rst @@ -12,6 +12,12 @@ Cron Jobs **API Docs**: `Core - Cron `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Definition ********** @@ -33,11 +39,14 @@ Definition .. include:: ../_include/param_basic.rst +---- + Usage ***** To add custom cron-job scripts - see: `OPNSense Documentation `_ | `OPNSense Forum `_ +---- Examples ******** diff --git a/docs/source/modules/dhcp.rst b/docs/source/modules/dhcp.rst index c71fe70c..bf825954 100644 --- a/docs/source/modules/dhcp.rst +++ b/docs/source/modules/dhcp.rst @@ -20,7 +20,7 @@ DHCP Contribution ************ -Thanks to `@KalleDK `_, `@superstes `_ and `@woelfle `_ for developing these modules! +Thanks to `@KalleDK `_, `@Rath `_ and `@woelfle `_ for developing these modules! ---- diff --git a/docs/source/modules/dhcrelay_destination.rst b/docs/source/modules/dhcrelay_destination.rst index 477f8684..b83d32b4 100644 --- a/docs/source/modules/dhcrelay_destination.rst +++ b/docs/source/modules/dhcrelay_destination.rst @@ -19,6 +19,8 @@ Contribution Thanks to `@jiuka `_ for developing this module! +---- + Definition ********** @@ -32,6 +34,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Info **** @@ -39,6 +43,8 @@ This module manages DHCRelay destinations. A destination can contain multiple IP Note: You can also use the shortform module name: :code:`ansibleguy.opnsense.dhcrelay_dst` +---- + Examples ******** diff --git a/docs/source/modules/dhcrelay_relay.rst b/docs/source/modules/dhcrelay_relay.rst index 520a8417..ed58eb94 100644 --- a/docs/source/modules/dhcrelay_relay.rst +++ b/docs/source/modules/dhcrelay_relay.rst @@ -19,6 +19,8 @@ Contribution Thanks to `@jiuka `_ for developing this module! +---- + Definition ********** @@ -34,6 +36,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Info **** @@ -41,6 +45,8 @@ This module manages DHCRelay relays. Each interface can be assigned a single rel Note: You can also use the shortform module name: :code:`ansibleguy.opnsense.dhcrelay` +---- + Examples ******** diff --git a/docs/source/modules/frr_bfd.md b/docs/source/modules/frr_bfd.md index 7e90f6ac..4881365e 100644 --- a/docs/source/modules/frr_bfd.md +++ b/docs/source/modules/frr_bfd.md @@ -10,10 +10,16 @@ **FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing these modules! + ## Sponsoring Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules! +---- + ## Prerequisites You need to install the FRR plugin: diff --git a/docs/source/modules/frr_bgp.md b/docs/source/modules/frr_bgp.md index 784b4a2b..fccc867f 100644 --- a/docs/source/modules/frr_bgp.md +++ b/docs/source/modules/frr_bgp.md @@ -15,10 +15,16 @@ **FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing these modules! + ## Sponsoring Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules! +---- + ## Prerequisites You need to install the FRR plugin: @@ -28,6 +34,7 @@ os-frr You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html). +---- ## Definition @@ -123,6 +130,7 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic | as_pattern | string | false for state changes, else true | - | as | The AS pattern you want to match, regexp allowed (e.g. .$ or _1$). It's not validated so please be careful! | | reload | boolean | false | true | - | If the running config should be reloaded on change - this will take some time. You might want to reload it 'manually' after all changes are done => using the [reload module](https://opnsense.ansibleguy.net/modules/2_reload.html). | +---- ## Examples diff --git a/docs/source/modules/frr_diagnostic.md b/docs/source/modules/frr_diagnostic.md index 969ea9d5..47f424fb 100644 --- a/docs/source/modules/frr_diagnostic.md +++ b/docs/source/modules/frr_diagnostic.md @@ -10,9 +10,15 @@ **FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing this module! + ## Sponsoring -Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules! +Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of this module! + +---- ## Prerequisites @@ -23,6 +29,8 @@ os-frr You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html). +---- + ## Definition For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic.html) @@ -33,6 +41,8 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic |:------------|:----------------|:---------|:----------------------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | target | string | true | - | - | What information to query. One of: 'bgpneighbors', 'bgproute', 'bgproute4', 'bgproute6', 'bgpsummary', 'generalroute', 'generalroute4', 'generalroute6', 'generalrunningconfig', 'ospfdatabase', 'ospfinterface', 'ospfneighbor', 'ospfoverview', 'ospfroute', 'ospfv3database', 'ospfv3interface', 'ospfv3neighbor', 'ospfv3overview', 'ospfv3route' | +---- + ## Examples ### ansibleguy.opnsense.frr_diagnostic diff --git a/docs/source/modules/frr_general.md b/docs/source/modules/frr_general.md index 5365a4f8..0d1726ad 100644 --- a/docs/source/modules/frr_general.md +++ b/docs/source/modules/frr_general.md @@ -10,6 +10,16 @@ **FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing this module! + +## Sponsoring + +Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of this module! + +---- + ## Prerequisites You need to install the FRR plugin: @@ -19,6 +29,8 @@ os-frr You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html). +---- + ## Definition For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic.html) @@ -34,6 +46,7 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic | carp | bool | false | false | carp_failover | Will activate the routing service only on the primary device | | snmp_agentx | bool | false | false | - | En- or disable support for Net-SNMP AgentX | +---- ## Examples diff --git a/docs/source/modules/frr_ospf.md b/docs/source/modules/frr_ospf.md index 819fc0cf..2fb9c64a 100644 --- a/docs/source/modules/frr_ospf.md +++ b/docs/source/modules/frr_ospf.md @@ -17,10 +17,16 @@ **FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing these modules! + ## Sponsoring Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules! +---- + ## Prerequisites You need to install the FRR plugin: @@ -30,6 +36,7 @@ os-frr You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html). +---- ## Definition @@ -141,6 +148,9 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic | network_type | string | false | - | nw_type | One of: 'broadcast', 'point-to-point' | | reload | boolean | false | true | - | If the running config should be reloaded on change - this will take some time. You might want to reload it 'manually' after all changes are done => using the [reload module](https://opnsense.ansibleguy.net/modules/2_reload.html). | + +---- + ## Examples ### OSPF (_IPv4_) diff --git a/docs/source/modules/frr_rip.md b/docs/source/modules/frr_rip.md index 6738195d..8b60207b 100644 --- a/docs/source/modules/frr_rip.md +++ b/docs/source/modules/frr_rip.md @@ -10,9 +10,15 @@ **FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing this module! + ## Sponsoring -Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules! +Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of this module! + +---- ## Prerequisites @@ -23,6 +29,8 @@ os-frr You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html). +---- + ## Definition For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic.html) @@ -37,6 +45,7 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic | networks | list | false | - | nets | Enter your networks in CIDR notation | | | redistribute | list | false | - | - | Select other routing sources, which should be redistributed to the other nodes. One or more of: 'bgp', 'ospf', 'connected', 'kernel', 'static' | | +---- ## Examples diff --git a/docs/source/modules/ids.rst b/docs/source/modules/ids.rst index 66d75a6c..ec28fc37 100644 --- a/docs/source/modules/ids.rst +++ b/docs/source/modules/ids.rst @@ -20,6 +20,12 @@ Intrusion Prevention System **Service Docs**: `Intrusion Prevention System `_ +Contribution +************ + +Thanks to `@Rath `_ for developing these modules! + +---- Definition ********** @@ -136,6 +142,7 @@ ansibleguy.opnsense.ids_policy_rule "enabled","boolean","false","true","\-","En- or disable the rule" "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- Info **** @@ -144,6 +151,8 @@ Info The :code:`list` module will not return all details of the existing entries `as the current implementation does not scale well `_. +---- + Examples ******** diff --git a/docs/source/modules/interface.rst b/docs/source/modules/interface.rst index 7d3cf31b..e4e716f9 100644 --- a/docs/source/modules/interface.rst +++ b/docs/source/modules/interface.rst @@ -62,7 +62,11 @@ This module manages GRE Tunnel configuration that can be found in the WEB-UI men Contribution ************ -Thanks to `@jiuka `_ for developing the :code:`interface_loopback` and :code:`interface_gre` module! +Thanks to `@jiuka `_ for developing the :code:`interface_loopback` and :code:`interface_gre` modules! + +Thanks to `@Rath `_ for developing the other modules! + +---- Definition ********** @@ -169,6 +173,7 @@ ansibleguy.opnsense.interface_gre "tunnel_remote_net","integer","false","32","\-","Netmask `ipv4` or prefix `ipv6` to use for this tunnel " "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- Examples ******** diff --git a/docs/source/modules/ipsec.rst b/docs/source/modules/ipsec.rst index d3cfce39..11b55e0c 100644 --- a/docs/source/modules/ipsec.rst +++ b/docs/source/modules/ipsec.rst @@ -25,6 +25,9 @@ Contribution Thanks to `@atammy-narmi `_ for developing the :code:`ipsec_psk` module! +Thanks to `@Rath `_ for developing the other modules! + +---- Definition ********** @@ -157,6 +160,7 @@ ansibleguy.opnsense.ipsec_psk "psk","string","true","\-","key, secret","\-" "type","string","false","\-","kind","One of: 'PSK', 'EAP'" +---- Usage ***** @@ -177,6 +181,7 @@ You may want to use '**ansible-vault**' to **encrypt** your 'private_key' conten # or encrypt the private_key file beforehand (might be easier) ansible-vault encrypt /path/to/private/key/file.pem +---- Examples ******** diff --git a/docs/source/modules/monit.md b/docs/source/modules/monit.md index 5498b6c5..b9806a82 100644 --- a/docs/source/modules/monit.md +++ b/docs/source/modules/monit.md @@ -8,6 +8,12 @@ **Service Docs**: [Monit](https://docs.opnsense.org/manual/monit.html) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing these modules! + +---- + ## Info For mail alerts to work: @@ -64,6 +70,7 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic | polltime | string | false | - | - | Set the service poll time. Either as a number of cycles 'NUMBER CYCLES' or Cron-style '* 8-19 * * 1-5' | | description | string | false | - | - | | +---- ## Examples diff --git a/docs/source/modules/nat_one_to_one.rst b/docs/source/modules/nat_one_to_one.rst index b9bfb56f..a2978ef6 100644 --- a/docs/source/modules/nat_one_to_one.rst +++ b/docs/source/modules/nat_one_to_one.rst @@ -65,6 +65,8 @@ Usage To add One-to-One NAT rules - see: `OPNSense Documentation `_ +---- + Examples ******** diff --git a/docs/source/modules/nat_source.rst b/docs/source/modules/nat_source.rst index c55b9eee..9aa72649 100644 --- a/docs/source/modules/nat_source.rst +++ b/docs/source/modules/nat_source.rst @@ -14,6 +14,13 @@ NAT Source **Service Docs**: `Outbound NAT `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Limitations *********** @@ -97,6 +104,7 @@ It is **recommended** to use/set **unique identifiers** like 'description' to ma You could also use the UUID of existing rules as ID - but you would have to pull (*list*) and configure those 'manually'. +---- Examples ******** diff --git a/docs/source/modules/nginx.rst b/docs/source/modules/nginx.rst index 51b0c9b4..1a3c41c5 100644 --- a/docs/source/modules/nginx.rst +++ b/docs/source/modules/nginx.rst @@ -19,6 +19,8 @@ Contribution Thanks to `@atammy-narmi `_ for developing these modules! +---- + Prerequisites ************* @@ -65,12 +67,15 @@ ansibleguy.opnsense.nginx_upstream_server "state","string","false","present","\-","Choice of 'present' or 'absent'." "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- Usage ***** Enabling the nginx configured services. +---- + Examples ******** diff --git a/docs/source/modules/openvpn.rst b/docs/source/modules/openvpn.rst index d9c86e73..39216a19 100644 --- a/docs/source/modules/openvpn.rst +++ b/docs/source/modules/openvpn.rst @@ -18,6 +18,13 @@ OpenVPN **Service Docs**: `OpenVPN `_ +Contribution +************ + +Thanks to `@Rath `_ for developing these modules! + +---- + Info **** diff --git a/docs/source/modules/package.rst b/docs/source/modules/package.rst index 5cbe6bf3..d01f1d0d 100644 --- a/docs/source/modules/package.rst +++ b/docs/source/modules/package.rst @@ -14,6 +14,12 @@ Package **Service Docs**: `Plugins `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Info **** @@ -42,6 +48,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/postfix.rst b/docs/source/modules/postfix.rst index f5ddc282..ceb80bbf 100644 --- a/docs/source/modules/postfix.rst +++ b/docs/source/modules/postfix.rst @@ -28,6 +28,8 @@ Contribution Thanks to `@jiuka `_ for developing these modules! +---- + Prerequisites ************* diff --git a/docs/source/modules/route.rst b/docs/source/modules/route.rst index c6fbb0bd..45007540 100644 --- a/docs/source/modules/route.rst +++ b/docs/source/modules/route.rst @@ -31,6 +31,9 @@ Contribution Thanks to `@kdhlab `_ for developing the :code:`gateway` module! +Thanks to `@Rath `_ for developing the :code:`route` module! + +---- Definition ********** @@ -80,6 +83,8 @@ ansibleguy.opnsense.gateway "match_fields","list of strings","false","['name', 'gateway']","\-","Fields that are used to match configured gateways with the running config - if any of those fields are changed, the module will think it's a new gateway, possible options: ['name', 'gateway', 'description']" "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- + Usage ***** @@ -93,6 +98,7 @@ The default behaviour is that a route is matched by its 'gateway' and 'network'. However - it is **recommended** to use/set 'description' as **unique identifier** if many routes are used. +---- Examples ******** diff --git a/docs/source/modules/rule.rst b/docs/source/modules/rule.rst index bd624052..04f5fb8a 100644 --- a/docs/source/modules/rule.rst +++ b/docs/source/modules/rule.rst @@ -14,6 +14,13 @@ Rule **Service Docs**: `Rules `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Limitations *********** @@ -33,9 +40,17 @@ This plugin has some limitations you need to know of: * per example see menu: 'Interface - Assignments - Interface ID (in brackets)' * this brings problems if the interface-names are not the same on both nodes when using HA-setups +---- + Info **** +Tips +==== + +* If you want to reference :code:`This firewall` - you need to use :code:`(self)` instead. + + Savepoint ========= @@ -86,6 +101,7 @@ Definition .. include:: ../_include/param_basic.rst +---- Usage ***** @@ -100,6 +116,8 @@ It is **recommended** to use/set **unique identifiers** like 'description' to ma You could also use the UUID of existing rules as ID - but you would have to pull (*list*) and configure those 'manually'. +---- + Examples ******** diff --git a/docs/source/modules/rule_interface_group.rst b/docs/source/modules/rule_interface_group.rst index c032d0c4..fc0a9517 100644 --- a/docs/source/modules/rule_interface_group.rst +++ b/docs/source/modules/rule_interface_group.rst @@ -19,6 +19,8 @@ Contribution Thanks to `@jiuka `_ for developing this module! +---- + Definition ********** @@ -34,6 +36,7 @@ Definition .. include:: ../_include/param_basic.rst +---- Examples ******** diff --git a/docs/source/modules/rule_multi.rst b/docs/source/modules/rule_multi.rst index 6d848633..bd87074f 100644 --- a/docs/source/modules/rule_multi.rst +++ b/docs/source/modules/rule_multi.rst @@ -15,6 +15,13 @@ Rule - Mass Management **Service Docs**: `Rules `_ +Contribution +************ + +Thanks to `@Rath `_ for developing these modules! + +---- + Info **** @@ -27,6 +34,8 @@ Multi - To ensure valid configuration - the attributes of each rule get verified using ansible's built-in verifier +---- + Definition ********** @@ -69,6 +78,8 @@ ansibleguy.opnsense.rule_purge "force_all","boolean","false","false","\-","'If set to true and neither rules, nor filters are provided - all rules will be purged" "fail_all","boolean","false","false","fail","Fail module if single rule fails to be purged" +---- + Usage ***** @@ -79,6 +90,7 @@ You could either invoke this module: - once for all rules - once per logical grouping of rules +---- Examples ******** diff --git a/docs/source/modules/savepoint.rst b/docs/source/modules/savepoint.rst index 25902cdb..314d74db 100644 --- a/docs/source/modules/savepoint.rst +++ b/docs/source/modules/savepoint.rst @@ -14,6 +14,12 @@ Firewall Savepoint **API Docs**: `Core - Firewall `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Info **** @@ -30,6 +36,8 @@ It currently just works with the 'Firewall' plugin: - :ref:`ansibleguy.opnsense.nat_source ` - :ref:`ansibleguy.opnsense.nat_one_to_one ` +---- + Definition ********** @@ -44,6 +52,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/service.rst b/docs/source/modules/service.rst index d59acd56..ad0def09 100644 --- a/docs/source/modules/service.rst +++ b/docs/source/modules/service.rst @@ -10,6 +10,13 @@ Service **TESTS**: `Playbook `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Info **** @@ -27,6 +34,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/shaper.md b/docs/source/modules/shaper.md index a884b230..4c39da04 100644 --- a/docs/source/modules/shaper.md +++ b/docs/source/modules/shaper.md @@ -10,6 +10,12 @@ **Service Docs**: [Traffic Shaping](https://docs.opnsense.org/manual/shaping.html) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing these modules! + +---- + ## Info The description is used to match the configured entries with the existing ones. It must be unique! @@ -19,6 +25,7 @@ Interfaces for 'shaper_rules' must be provided as used in the network config (_p * per example see menu: 'Interface - Assignments - Interface ID (in brackets)' * this brings problems if the interface-names are not the same on both nodes when using HA-setups +---- ## Definition @@ -88,6 +95,7 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic | reload | boolean | false | true | - | If the running config should be reloaded on change - this will take some time. You might want to reload it 'manually' after all changes are done => using the [reload module](https://opnsense.ansibleguy.net/modules/2_reload.html). | | reset | boolean | false | false | flush | Can be used instead of 'reload'. If the running config should be flushed and reloaded on change - this will take some time. This might have impact on other services using the same technology underneath (such as Captive portal). You might want to reload it 'manually' after all changes are done => using the [service module](https://opnsense.ansibleguy.net/modules/service.html) (_action 'restart'_). | +---- ## Examples diff --git a/docs/source/modules/syslog.rst b/docs/source/modules/syslog.rst index d17ac47f..c5e9ba61 100644 --- a/docs/source/modules/syslog.rst +++ b/docs/source/modules/syslog.rst @@ -12,6 +12,12 @@ Syslog **API Docs**: `Core - Syslog `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Definition ********** @@ -32,6 +38,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/system.rst b/docs/source/modules/system.rst index 6ccd3a04..7e06a252 100644 --- a/docs/source/modules/system.rst +++ b/docs/source/modules/system.rst @@ -12,6 +12,12 @@ System **API Docs**: `Core - Firmware `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- .. warning:: @@ -36,6 +42,7 @@ Definition .. include:: ../_include/param_basic.rst +---- Examples ******** diff --git a/docs/source/modules/unbound_acl.rst b/docs/source/modules/unbound_acl.rst index f8e253a1..01bf8152 100644 --- a/docs/source/modules/unbound_acl.rst +++ b/docs/source/modules/unbound_acl.rst @@ -19,6 +19,8 @@ Contribution Thanks to `@gjdoornink `_ for developing this module! +---- + Info **** @@ -32,6 +34,8 @@ The configured lists are matched by its unique file-name. You may also need to increase the module :code:`timeout`. +---- + Definition ********** @@ -47,6 +51,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Examples ******** diff --git a/docs/source/modules/unbound_dnsbl.rst b/docs/source/modules/unbound_dnsbl.rst index add1d60c..a13a1f67 100644 --- a/docs/source/modules/unbound_dnsbl.rst +++ b/docs/source/modules/unbound_dnsbl.rst @@ -19,6 +19,8 @@ Contribution Thanks to `@jiuka `_ for developing this module! +---- + Definition ********** @@ -43,11 +45,15 @@ Definition .. include:: ../_include/param_basic.rst +---- + Usage ***** Manage Unbound DNS blocklists and exceptions. +---- + Examples ******** diff --git a/docs/source/modules/unbound_dot.rst b/docs/source/modules/unbound_dot.rst index 4b709995..351ca60c 100644 --- a/docs/source/modules/unbound_dot.rst +++ b/docs/source/modules/unbound_dot.rst @@ -14,6 +14,12 @@ DNS - Unbound - DNS-over-TLS **Service Docs**: `Unbound `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Definition ********** @@ -30,6 +36,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Info **** @@ -43,6 +51,8 @@ This module manages DNS-over-TLS configuration that can be found in the WEB-UI m You may also need to increase the module :code:`timeout`. +---- + Examples ******** diff --git a/docs/source/modules/unbound_forwarding.rst b/docs/source/modules/unbound_forwarding.rst index 63203c79..fb587942 100644 --- a/docs/source/modules/unbound_forwarding.rst +++ b/docs/source/modules/unbound_forwarding.rst @@ -14,6 +14,12 @@ DNS - Unbound - Forwarding **Service Docs**: `Unbound `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- Definition ********** @@ -30,6 +36,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Info **** @@ -43,6 +51,8 @@ This module manages DNS-Forwardings that can be found in the WEB-UI menu: 'Servi You may also need to increase the module :code:`timeout`. +---- + Examples ******** diff --git a/docs/source/modules/unbound_general.md b/docs/source/modules/unbound_general.md index 0de3db23..1b04f97d 100644 --- a/docs/source/modules/unbound_general.md +++ b/docs/source/modules/unbound_general.md @@ -12,6 +12,8 @@ Thanks to [@gjdoornink](https://github.com/gjdoornink) for developing this module! +---- + ## Info **WARNING:** Unbound service actions like :code:`reload` can take long. Please be aware of the **possible downtime**! @@ -19,6 +21,7 @@ Thanks to [@gjdoornink](https://github.com/gjdoornink) for developing this modul You may also need to increase the module `timeout`. +---- ## Definition @@ -47,6 +50,8 @@ For basic parameters see: [Basics](https://github.com/ansibleguy/collection_opns | wpad | bool | false | false | - | En- or disable to automatically add CNAME records for the WPAD host of all configured domains as well as overrides for TXT records for domains | | reload | boolean | false | true | - | If the running config should be reloaded on change - this will take some time. For mass-managing items you might want to reload it 'manually' after all changes are done => using the [reload module](https://github.com/ansibleguy/collection_opnsense/blob/latest/docs/use_reload.md). | +---- + ## Examples ### ansibleguy.opnsense.unbound_general diff --git a/docs/source/modules/unbound_host.rst b/docs/source/modules/unbound_host.rst index 8c105854..e1e59a74 100644 --- a/docs/source/modules/unbound_host.rst +++ b/docs/source/modules/unbound_host.rst @@ -14,6 +14,13 @@ DNS - Unbound - Host Override **Service Docs**: `Unbound `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Definition ********** @@ -33,6 +40,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Info **** @@ -50,6 +59,8 @@ Keep in mind that all resource record types (i.e. A, AAAA, MX, etc. records) of You may also need to increase the module :code:`timeout`. +---- + Usage ***** @@ -65,6 +76,8 @@ However - it is **recommended** to use/set 'description' as **unique identifier* .. include:: ../_include/unbound_mass.rst +---- + Examples ******** diff --git a/docs/source/modules/unbound_host_alias.rst b/docs/source/modules/unbound_host_alias.rst index 7682cfc6..84d7f170 100644 --- a/docs/source/modules/unbound_host_alias.rst +++ b/docs/source/modules/unbound_host_alias.rst @@ -14,6 +14,13 @@ DNS - Unbound - Host Alias **Service Docs**: `Unbound `_ +Contribution +************ + +Thanks to `@Rath `_ for developing this module! + +---- + Definition ********** @@ -30,6 +37,8 @@ Definition .. include:: ../_include/param_basic.rst +---- + Info **** @@ -47,6 +56,8 @@ Keep in mind that all resource record types (i.e. A, AAAA, MX, etc. records) of You may also need to increase the module :code:`timeout`. +---- + Usage ***** @@ -62,6 +73,8 @@ However - it is **recommended** to use/set 'description' as **unique identifier* .. include:: ../_include/unbound_mass.rst +---- + Examples ******** diff --git a/docs/source/modules/webproxy.rst b/docs/source/modules/webproxy.rst index 55a09d85..d063477e 100644 --- a/docs/source/modules/webproxy.rst +++ b/docs/source/modules/webproxy.rst @@ -27,6 +27,14 @@ Web Proxy `Caching Proxy `_ | `Web Proxy/Filter `_ +Contribution +************ + +Thanks to `@Rath `_ for developing these modules! + +---- + + Prerequisites ************* @@ -131,6 +139,7 @@ ansibleguy.opnsense.webproxy_pac_rule This module manages the Proxy-Auto-Config Rule entries that can be found in the WEB-UI menu: 'Services - Web Proxy - Administration - Proxy Auto-Config - Rules (*DropDown*)' (*URL 'ui/proxy#subtab_pac_rules'*) +---- Definition ********** @@ -373,6 +382,7 @@ ansibleguy.opnsense.webproxy_pac_rule "enabled","boolean","false","true","\-","En- or disable the rule" "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst +---- Examples ******** diff --git a/docs/source/modules/wireguard.md b/docs/source/modules/wireguard.md index 909ce4d3..714d4f5c 100644 --- a/docs/source/modules/wireguard.md +++ b/docs/source/modules/wireguard.md @@ -11,6 +11,12 @@ **Service Docs**: [WireGuard - Site to Site](https://docs.opnsense.org/manual/how-tos/wireguard-s2s.html) | [WireGuard - Client to Site](https://docs.opnsense.org/manual/how-tos/wireguard-client.html) +## Contribution + +Thanks to [@Rath](https://github.com/superstes) for developing these modules! + +---- + ## Definition For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic.html) @@ -55,11 +61,13 @@ Will return the information seen at the `VPN - Wireguard - Diagnostics` page |:----------|:--------|:---------|:--------------|:---------------------------------------------------------------------------------------------------|:------------------------------------------------| | enabled | boolean | false | true | - | Used to enable or disable the wireguard service | +---- ## Usage To make a dynamic WireGuard endpoint to re-connect you may want to create a [gateway monitoring (_dpinger_)](https://docs.opnsense.org/manual/gateways.html#settings) targeting the remote tunnel-address. +---- ## Examples diff --git a/galaxy.yml b/galaxy.yml index 27d46b79..7680537b 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -19,6 +19,6 @@ tags: dependencies: {} repository: 'https://github.com/ansibleguy/collection_opnsense' documentation: 'https://opnsense.ansibleguy.net' -homepage: 'https://www.o-x-l.com' +homepage: 'https://www.O-X-L.com' issues: 'https://github.com/ansibleguy/collection_opnsense/issues' build_ignore: [] diff --git a/plugins/modules/_tmpl_direct.py b/plugins/modules/_tmpl_direct.py index a18a90ed..4244ed23 100644 --- a/plugins/modules/_tmpl_direct.py +++ b/plugins/modules/_tmpl_direct.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # template to be copied to implement new modules diff --git a/plugins/modules/_tmpl_obj.py b/plugins/modules/_tmpl_obj.py index 0afd7e51..942dfb95 100644 --- a/plugins/modules/_tmpl_obj.py +++ b/plugins/modules/_tmpl_obj.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # template to be copied to implement new modules diff --git a/plugins/modules/alias.py b/plugins/modules/alias.py index dc9ba7a0..8cd4a7f6 100644 --- a/plugins/modules/alias.py +++ b/plugins/modules/alias.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/firewall.html diff --git a/plugins/modules/alias_multi.py b/plugins/modules/alias_multi.py index e1a0da68..9e3cc879 100644 --- a/plugins/modules/alias_multi.py +++ b/plugins/modules/alias_multi.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/firewall.html diff --git a/plugins/modules/alias_purge.py b/plugins/modules/alias_purge.py index 9e91ba7e..28d3b8fc 100644 --- a/plugins/modules/alias_purge.py +++ b/plugins/modules/alias_purge.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/firewall.html diff --git a/plugins/modules/bind_acl.py b/plugins/modules/bind_acl.py index ecd5e4b7..376d20fa 100644 --- a/plugins/modules/bind_acl.py +++ b/plugins/modules/bind_acl.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/bind.html diff --git a/plugins/modules/bind_blocklist.py b/plugins/modules/bind_blocklist.py index 7b7b05c5..c9868479 100644 --- a/plugins/modules/bind_blocklist.py +++ b/plugins/modules/bind_blocklist.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/bind.html diff --git a/plugins/modules/bind_domain.py b/plugins/modules/bind_domain.py index 07dfbbf3..966994de 100644 --- a/plugins/modules/bind_domain.py +++ b/plugins/modules/bind_domain.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/bind.html diff --git a/plugins/modules/bind_general.py b/plugins/modules/bind_general.py index 55e3e3fa..79c12304 100644 --- a/plugins/modules/bind_general.py +++ b/plugins/modules/bind_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/bind.html diff --git a/plugins/modules/bind_record.py b/plugins/modules/bind_record.py index cef7590d..1f95a3a3 100644 --- a/plugins/modules/bind_record.py +++ b/plugins/modules/bind_record.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/bind.html diff --git a/plugins/modules/bind_record_multi.py b/plugins/modules/bind_record_multi.py index e926d26d..37086141 100644 --- a/plugins/modules/bind_record_multi.py +++ b/plugins/modules/bind_record_multi.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/bind.html diff --git a/plugins/modules/cron.py b/plugins/modules/cron.py index 1ad43231..bf858de1 100644 --- a/plugins/modules/cron.py +++ b/plugins/modules/cron.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/cron.html diff --git a/plugins/modules/dhcp_controlagent.py b/plugins/modules/dhcp_controlagent.py index 40f5812a..adab9a0c 100644 --- a/plugins/modules/dhcp_controlagent.py +++ b/plugins/modules/dhcp_controlagent.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/wireguard.html diff --git a/plugins/modules/dhcp_reservation.py b/plugins/modules/dhcp_reservation.py index 188b099b..a53bb906 100644 --- a/plugins/modules/dhcp_reservation.py +++ b/plugins/modules/dhcp_reservation.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/kea.html diff --git a/plugins/modules/dhcrelay_destination.py b/plugins/modules/dhcrelay_destination.py index e569c179..b09c32cd 100644 --- a/plugins/modules/dhcrelay_destination.py +++ b/plugins/modules/dhcrelay_destination.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/dhcrelay.html diff --git a/plugins/modules/dhcrelay_relay.py b/plugins/modules/dhcrelay_relay.py index 03b04165..de5fb759 100644 --- a/plugins/modules/dhcrelay_relay.py +++ b/plugins/modules/dhcrelay_relay.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/dhcrelay.html diff --git a/plugins/modules/frr_bfd_general.py b/plugins/modules/frr_bfd_general.py index e14332f8..7d04f427 100644 --- a/plugins/modules/frr_bfd_general.py +++ b/plugins/modules/frr_bfd_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/wireguard.html diff --git a/plugins/modules/frr_bfd_neighbor.py b/plugins/modules/frr_bfd_neighbor.py index d86a8921..afb4aa12 100644 --- a/plugins/modules/frr_bfd_neighbor.py +++ b/plugins/modules/frr_bfd_neighbor.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_bgp_as_path.py b/plugins/modules/frr_bgp_as_path.py index d6fb13c0..60a292bd 100644 --- a/plugins/modules/frr_bgp_as_path.py +++ b/plugins/modules/frr_bgp_as_path.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_bgp_community_list.py b/plugins/modules/frr_bgp_community_list.py index b679494b..6ac7fe95 100644 --- a/plugins/modules/frr_bgp_community_list.py +++ b/plugins/modules/frr_bgp_community_list.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_bgp_general.py b/plugins/modules/frr_bgp_general.py index b9f3efaa..5ecaa8dd 100644 --- a/plugins/modules/frr_bgp_general.py +++ b/plugins/modules/frr_bgp_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_bgp_neighbor.py b/plugins/modules/frr_bgp_neighbor.py index 4977b742..5a2f1982 100644 --- a/plugins/modules/frr_bgp_neighbor.py +++ b/plugins/modules/frr_bgp_neighbor.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_bgp_prefix_list.py b/plugins/modules/frr_bgp_prefix_list.py index a1f618c6..9bfbeecd 100644 --- a/plugins/modules/frr_bgp_prefix_list.py +++ b/plugins/modules/frr_bgp_prefix_list.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_diagnostic.py b/plugins/modules/frr_diagnostic.py index 5f2c42f1..7fa5a123 100644 --- a/plugins/modules/frr_diagnostic.py +++ b/plugins/modules/frr_diagnostic.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_general.py b/plugins/modules/frr_general.py index aac7c159..9c84c513 100644 --- a/plugins/modules/frr_general.py +++ b/plugins/modules/frr_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf3_general.py b/plugins/modules/frr_ospf3_general.py index 48aaa5d0..41a6036c 100644 --- a/plugins/modules/frr_ospf3_general.py +++ b/plugins/modules/frr_ospf3_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf3_interface.py b/plugins/modules/frr_ospf3_interface.py index d9041bed..e9818b1b 100644 --- a/plugins/modules/frr_ospf3_interface.py +++ b/plugins/modules/frr_ospf3_interface.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf_general.py b/plugins/modules/frr_ospf_general.py index ddcce7a1..1126d290 100644 --- a/plugins/modules/frr_ospf_general.py +++ b/plugins/modules/frr_ospf_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf_interface.py b/plugins/modules/frr_ospf_interface.py index 859dad10..52b85b58 100644 --- a/plugins/modules/frr_ospf_interface.py +++ b/plugins/modules/frr_ospf_interface.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf_network.py b/plugins/modules/frr_ospf_network.py index 84fd0441..ec51fbef 100644 --- a/plugins/modules/frr_ospf_network.py +++ b/plugins/modules/frr_ospf_network.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf_prefix_list.py b/plugins/modules/frr_ospf_prefix_list.py index 9b6616f4..4b4ebe14 100644 --- a/plugins/modules/frr_ospf_prefix_list.py +++ b/plugins/modules/frr_ospf_prefix_list.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_ospf_route_map.py b/plugins/modules/frr_ospf_route_map.py index 77b1b558..074b0a82 100644 --- a/plugins/modules/frr_ospf_route_map.py +++ b/plugins/modules/frr_ospf_route_map.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/frr_rip.py b/plugins/modules/frr_rip.py index 5c9b8a42..9e94f173 100644 --- a/plugins/modules/frr_rip.py +++ b/plugins/modules/frr_rip.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/quagga.html diff --git a/plugins/modules/gateway.py b/plugins/modules/gateway.py index a0c248cf..172951eb 100644 --- a/plugins/modules/gateway.py +++ b/plugins/modules/gateway.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/routing.html diff --git a/plugins/modules/ids_action.py b/plugins/modules/ids_action.py index a5679f9e..6dd65f5f 100644 --- a/plugins/modules/ids_action.py +++ b/plugins/modules/ids_action.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/ids_general.py b/plugins/modules/ids_general.py index 27abeac1..e99da33d 100644 --- a/plugins/modules/ids_general.py +++ b/plugins/modules/ids_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/ids_policy.py b/plugins/modules/ids_policy.py index 57ad4134..cee40e5f 100644 --- a/plugins/modules/ids_policy.py +++ b/plugins/modules/ids_policy.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/ids_policy_rule.py b/plugins/modules/ids_policy_rule.py index 5b832533..48e94572 100644 --- a/plugins/modules/ids_policy_rule.py +++ b/plugins/modules/ids_policy_rule.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/ids_rule.py b/plugins/modules/ids_rule.py index bbacd7f2..ce71f070 100644 --- a/plugins/modules/ids_rule.py +++ b/plugins/modules/ids_rule.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/ids_ruleset.py b/plugins/modules/ids_ruleset.py index 61fd819d..3d43bfa7 100644 --- a/plugins/modules/ids_ruleset.py +++ b/plugins/modules/ids_ruleset.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/ids_user_rule.py b/plugins/modules/ids_user_rule.py index def1ca19..2c8a377c 100644 --- a/plugins/modules/ids_user_rule.py +++ b/plugins/modules/ids_user_rule.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ids.html diff --git a/plugins/modules/interface_lagg.py b/plugins/modules/interface_lagg.py index 3daa99db..74998bb3 100644 --- a/plugins/modules/interface_lagg.py +++ b/plugins/modules/interface_lagg.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/interfaces.html diff --git a/plugins/modules/interface_loopback.py b/plugins/modules/interface_loopback.py index 23f4e18c..0d8f15cd 100644 --- a/plugins/modules/interface_loopback.py +++ b/plugins/modules/interface_loopback.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # template to be copied to implement new modules diff --git a/plugins/modules/interface_vip.py b/plugins/modules/interface_vip.py index 63e4d498..d7f5ba46 100644 --- a/plugins/modules/interface_vip.py +++ b/plugins/modules/interface_vip.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/interfaces.html diff --git a/plugins/modules/interface_vlan.py b/plugins/modules/interface_vlan.py index 5168e5bb..28172c12 100644 --- a/plugins/modules/interface_vlan.py +++ b/plugins/modules/interface_vlan.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/interfaces.html diff --git a/plugins/modules/interface_vxlan.py b/plugins/modules/interface_vxlan.py index cb886385..1ac4b0a4 100644 --- a/plugins/modules/interface_vxlan.py +++ b/plugins/modules/interface_vxlan.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/interfaces.html diff --git a/plugins/modules/ipsec_auth_local.py b/plugins/modules/ipsec_auth_local.py index e48e6660..93da95d9 100644 --- a/plugins/modules/ipsec_auth_local.py +++ b/plugins/modules/ipsec_auth_local.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/ipsec_auth_remote.py b/plugins/modules/ipsec_auth_remote.py index 9e494f58..958329b8 100644 --- a/plugins/modules/ipsec_auth_remote.py +++ b/plugins/modules/ipsec_auth_remote.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/ipsec_cert.py b/plugins/modules/ipsec_cert.py index ca6191ea..1b6ae964 100644 --- a/plugins/modules/ipsec_cert.py +++ b/plugins/modules/ipsec_cert.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ipsec.html diff --git a/plugins/modules/ipsec_child.py b/plugins/modules/ipsec_child.py index 7587d7e1..de16962e 100644 --- a/plugins/modules/ipsec_child.py +++ b/plugins/modules/ipsec_child.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/ipsec_connection.py b/plugins/modules/ipsec_connection.py index 8d629308..fd10d05a 100644 --- a/plugins/modules/ipsec_connection.py +++ b/plugins/modules/ipsec_connection.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/ipsec_pool.py b/plugins/modules/ipsec_pool.py index 69ef60da..3a7059d2 100644 --- a/plugins/modules/ipsec_pool.py +++ b/plugins/modules/ipsec_pool.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/ipsec_psk.py b/plugins/modules/ipsec_psk.py index bb3977e3..352ee661 100644 --- a/plugins/modules/ipsec_psk.py +++ b/plugins/modules/ipsec_psk.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/ipsec.html diff --git a/plugins/modules/ipsec_vti.py b/plugins/modules/ipsec_vti.py index 403c2d6f..fcae213c 100644 --- a/plugins/modules/ipsec_vti.py +++ b/plugins/modules/ipsec_vti.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/list.py b/plugins/modules/list.py index b9764302..153fe11d 100644 --- a/plugins/modules/list.py +++ b/plugins/modules/list.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # module to query running config diff --git a/plugins/modules/monit_alert.py b/plugins/modules/monit_alert.py index 98fc44f1..b0350dd1 100644 --- a/plugins/modules/monit_alert.py +++ b/plugins/modules/monit_alert.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/monit.html diff --git a/plugins/modules/monit_service.py b/plugins/modules/monit_service.py index 1291584e..d6028819 100644 --- a/plugins/modules/monit_service.py +++ b/plugins/modules/monit_service.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/monit.html diff --git a/plugins/modules/monit_test.py b/plugins/modules/monit_test.py index cc534c34..4503a194 100644 --- a/plugins/modules/monit_test.py +++ b/plugins/modules/monit_test.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/monit.html diff --git a/plugins/modules/nginx_general.py b/plugins/modules/nginx_general.py index cb604dff..14aaa0d3 100644 --- a/plugins/modules/nginx_general.py +++ b/plugins/modules/nginx_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/nginx.html diff --git a/plugins/modules/nginx_upstream_server.py b/plugins/modules/nginx_upstream_server.py index 2e4eee92..3d3566fe 100644 --- a/plugins/modules/nginx_upstream_server.py +++ b/plugins/modules/nginx_upstream_server.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/openvpn_client.py b/plugins/modules/openvpn_client.py index fbcf7c08..625c5da4 100644 --- a/plugins/modules/openvpn_client.py +++ b/plugins/modules/openvpn_client.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/openvpn_client_override.py b/plugins/modules/openvpn_client_override.py index 2d7115d7..1e29afb4 100644 --- a/plugins/modules/openvpn_client_override.py +++ b/plugins/modules/openvpn_client_override.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/openvpn_server.py b/plugins/modules/openvpn_server.py index add11a01..07c94a38 100644 --- a/plugins/modules/openvpn_server.py +++ b/plugins/modules/openvpn_server.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # template to be copied to implement new modules diff --git a/plugins/modules/openvpn_static_key.py b/plugins/modules/openvpn_static_key.py index 82282885..0873c1fc 100644 --- a/plugins/modules/openvpn_static_key.py +++ b/plugins/modules/openvpn_static_key.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/openvpn_status.py b/plugins/modules/openvpn_status.py index 0903b9b3..6072a9c8 100644 --- a/plugins/modules/openvpn_status.py +++ b/plugins/modules/openvpn_status.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/package.py b/plugins/modules/package.py index bad79f55..fcf293d7 100644 --- a/plugins/modules/package.py +++ b/plugins/modules/package.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/firmware.html diff --git a/plugins/modules/reload.py b/plugins/modules/reload.py index fc8a342f..46fc4752 100644 --- a/plugins/modules/reload.py +++ b/plugins/modules/reload.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # module to reload running config diff --git a/plugins/modules/rule.py b/plugins/modules/rule.py index 0b432cbc..f2bb2f51 100644 --- a/plugins/modules/rule.py +++ b/plugins/modules/rule.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/firewall.html diff --git a/plugins/modules/rule_interface_group.py b/plugins/modules/rule_interface_group.py index 81211282..9d563df6 100644 --- a/plugins/modules/rule_interface_group.py +++ b/plugins/modules/rule_interface_group.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/firewall.html diff --git a/plugins/modules/rule_multi.py b/plugins/modules/rule_multi.py index 43de5c6c..ad1e61d3 100644 --- a/plugins/modules/rule_multi.py +++ b/plugins/modules/rule_multi.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/firewall.html diff --git a/plugins/modules/rule_purge.py b/plugins/modules/rule_purge.py index ace5afa3..7f3938bd 100644 --- a/plugins/modules/rule_purge.py +++ b/plugins/modules/rule_purge.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/firewall.html diff --git a/plugins/modules/service.py b/plugins/modules/service.py index bc4f66de..fcfdd4bf 100644 --- a/plugins/modules/service.py +++ b/plugins/modules/service.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # module to interact with system services diff --git a/plugins/modules/shaper_pipe.py b/plugins/modules/shaper_pipe.py index f8b398c3..ce1ee779 100644 --- a/plugins/modules/shaper_pipe.py +++ b/plugins/modules/shaper_pipe.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/trafficshaper.html diff --git a/plugins/modules/shaper_queue.py b/plugins/modules/shaper_queue.py index e8f2b435..c8871ba8 100644 --- a/plugins/modules/shaper_queue.py +++ b/plugins/modules/shaper_queue.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/trafficshaper.html diff --git a/plugins/modules/shaper_rule.py b/plugins/modules/shaper_rule.py index 23b339f4..97b768f5 100644 --- a/plugins/modules/shaper_rule.py +++ b/plugins/modules/shaper_rule.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/trafficshaper.html diff --git a/plugins/modules/syslog.py b/plugins/modules/syslog.py index 4fd9541c..3fdaa79d 100644 --- a/plugins/modules/syslog.py +++ b/plugins/modules/syslog.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/syslog.html diff --git a/plugins/modules/system.py b/plugins/modules/system.py index b0f1a9be..256ed5d8 100644 --- a/plugins/modules/system.py +++ b/plugins/modules/system.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/firmware.html diff --git a/plugins/modules/unbound_acl.py b/plugins/modules/unbound_acl.py index a2c0b4fb..a33c66a4 100644 --- a/plugins/modules/unbound_acl.py +++ b/plugins/modules/unbound_acl.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/unbound.html diff --git a/plugins/modules/unbound_dnsbl.py b/plugins/modules/unbound_dnsbl.py index aaef3a5f..545f4a1f 100644 --- a/plugins/modules/unbound_dnsbl.py +++ b/plugins/modules/unbound_dnsbl.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/unbound.html diff --git a/plugins/modules/unbound_dot.py b/plugins/modules/unbound_dot.py index fff508b2..4f3fddcd 100644 --- a/plugins/modules/unbound_dot.py +++ b/plugins/modules/unbound_dot.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/unbound.html diff --git a/plugins/modules/unbound_forward.py b/plugins/modules/unbound_forward.py index 2dffb1ec..cd5f8f45 100644 --- a/plugins/modules/unbound_forward.py +++ b/plugins/modules/unbound_forward.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/unbound.html diff --git a/plugins/modules/unbound_general.py b/plugins/modules/unbound_general.py index c5c1dc7a..a265bd5e 100644 --- a/plugins/modules/unbound_general.py +++ b/plugins/modules/unbound_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/unbound.html diff --git a/plugins/modules/unbound_host.py b/plugins/modules/unbound_host.py index 4d7353c4..7c12018a 100644 --- a/plugins/modules/unbound_host.py +++ b/plugins/modules/unbound_host.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/unbound.html diff --git a/plugins/modules/unbound_host_alias.py b/plugins/modules/unbound_host_alias.py index 3f55acd4..f5a09116 100644 --- a/plugins/modules/unbound_host_alias.py +++ b/plugins/modules/unbound_host_alias.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/core/unbound.html diff --git a/plugins/modules/webproxy_acl.py b/plugins/modules/webproxy_acl.py index acd6d26c..01d85276 100644 --- a/plugins/modules/webproxy_acl.py +++ b/plugins/modules/webproxy_acl.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_auth.py b/plugins/modules/webproxy_auth.py index ac22bce6..2e6161ef 100644 --- a/plugins/modules/webproxy_auth.py +++ b/plugins/modules/webproxy_auth.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_cache.py b/plugins/modules/webproxy_cache.py index 2daa44eb..6a285e8d 100644 --- a/plugins/modules/webproxy_cache.py +++ b/plugins/modules/webproxy_cache.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_forward.py b/plugins/modules/webproxy_forward.py index 26813b9f..e4f2e972 100644 --- a/plugins/modules/webproxy_forward.py +++ b/plugins/modules/webproxy_forward.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_general.py b/plugins/modules/webproxy_general.py index fb82b96f..0a05b547 100644 --- a/plugins/modules/webproxy_general.py +++ b/plugins/modules/webproxy_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_icap.py b/plugins/modules/webproxy_icap.py index dc35f8c3..c667fc68 100644 --- a/plugins/modules/webproxy_icap.py +++ b/plugins/modules/webproxy_icap.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_pac_match.py b/plugins/modules/webproxy_pac_match.py index c0bdb7c9..5f4694a9 100644 --- a/plugins/modules/webproxy_pac_match.py +++ b/plugins/modules/webproxy_pac_match.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_pac_proxy.py b/plugins/modules/webproxy_pac_proxy.py index e2d5ad1d..b24bce8c 100644 --- a/plugins/modules/webproxy_pac_proxy.py +++ b/plugins/modules/webproxy_pac_proxy.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_pac_rule.py b/plugins/modules/webproxy_pac_rule.py index d179794e..306b6a12 100644 --- a/plugins/modules/webproxy_pac_rule.py +++ b/plugins/modules/webproxy_pac_rule.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_parent.py b/plugins/modules/webproxy_parent.py index fa15c202..8961cbc5 100644 --- a/plugins/modules/webproxy_parent.py +++ b/plugins/modules/webproxy_parent.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_remote_acl.py b/plugins/modules/webproxy_remote_acl.py index 83544176..9df7b0ae 100644 --- a/plugins/modules/webproxy_remote_acl.py +++ b/plugins/modules/webproxy_remote_acl.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/webproxy_traffic.py b/plugins/modules/webproxy_traffic.py index d5b33cd0..6fbab277 100644 --- a/plugins/modules/webproxy_traffic.py +++ b/plugins/modules/webproxy_traffic.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/wireguard_general.py b/plugins/modules/wireguard_general.py index 09ee319f..7472c262 100644 --- a/plugins/modules/wireguard_general.py +++ b/plugins/modules/wireguard_general.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/wireguard.html diff --git a/plugins/modules/wireguard_peer.py b/plugins/modules/wireguard_peer.py index 5fd166f2..fc1c6e0c 100644 --- a/plugins/modules/wireguard_peer.py +++ b/plugins/modules/wireguard_peer.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/wireguard.html diff --git a/plugins/modules/wireguard_server.py b/plugins/modules/wireguard_server.py index ae0e295e..7cb2b50a 100644 --- a/plugins/modules/wireguard_server.py +++ b/plugins/modules/wireguard_server.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/wireguard.html diff --git a/plugins/modules/wireguard_show.py b/plugins/modules/wireguard_show.py index 111a5961..ef7fd73b 100644 --- a/plugins/modules/wireguard_show.py +++ b/plugins/modules/wireguard_show.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright: (C) 2024, AnsibleGuy +# Copyright: (C) 2025, AnsibleGuy # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) # see: https://docs.opnsense.org/development/api/plugins/wireguard.html diff --git a/tests/rule.yml b/tests/rule.yml index 7cc754db..7ac4f2a2 100644 --- a/tests/rule.yml +++ b/tests/rule.yml @@ -134,6 +134,18 @@ protocol: 'TCP' description: 'ANSIBLE_TEST_1_12' + - name: Test self (this firewall) + ansibleguy.opnsense.rule: + destination_net: '(self)' + destination_port: 69 + protocol: 'UDP' + description: 'ANSIBLE_TEST_1_13' + register: opn21 + failed_when: > + opn21.failed or + not opn21.changed + when: not ansible_check_mode + - name: Cleanup ansibleguy.opnsense.rule: description: "{{ item }}" @@ -145,6 +157,7 @@ - 'ANSIBLE_TEST_1_10' - 'ANSIBLE_TEST_1_11' - 'ANSIBLE_TEST_1_12' + - 'ANSIBLE_TEST_1_13' - name: Testing Rules - aliases hosts: localhost