Skip to content

Commit 4718e19

Browse files
ansibleguyansibleguy
authored
Merge pull request #153 from ansibleguy/fix-contrib-notes+alias-self
Fix contrib notes+alias self
2 parents 6556058 + d461c43 commit 4718e19

File tree

146 files changed

+462
-106
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+462
-106
lines changed

‎docs/source/modules/2_list.rst

+9
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@
1010

1111
**TESTS**: Used in multiple ones
1212

13+
Contribution
14+
************
15+
16+
Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!
17+
18+
----
19+
1320
Info
1421
****
1522

@@ -25,6 +32,8 @@ In most cases the returned type of this module ist a list of dictionaries.
2532

2633
.. include:: ../_include/param_basic.rst
2734

35+
----
36+
2837
Examples
2938
********
3039

‎docs/source/modules/2_reload.rst

+9
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@
1010

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

13+
Contribution
14+
************
15+
16+
Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!
17+
18+
----
19+
1320
Info
1421
****
1522

@@ -30,6 +37,8 @@ Definition
3037

3138
.. include:: ../_include/param_basic.rst
3239

40+
----
41+
3342
Examples
3443
********
3544

‎docs/source/modules/acmeclient.rst

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Contribution
2323

2424
Thanks to `@jiuka <https://github.com/jiuka>`_ for developing these modules!
2525

26+
----
27+
2628
Prerequisites
2729
*************
2830

‎docs/source/modules/alias.rst

+8-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Alias
1616

1717
This module allows you to manage single aliases.
1818

19+
Contribution
20+
************
21+
22+
Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!
23+
24+
----
1925

2026
Info
2127
****
@@ -24,7 +30,6 @@ For more detailed information on what alias types are supported - see `the docum
2430

2531
To use GeoIP alias types - you need to configure a source for it first. See: `documentation <https://docs.opnsense.org/manual/how-tos/maxmind_geo_ip.html>`_
2632

27-
2833
Mass-Manage
2934
===========
3035

@@ -47,6 +52,8 @@ Definition
4752

4853
.. include:: ../_include/param_basic.rst
4954

55+
----
56+
5057
Examples
5158
********
5259

‎docs/source/modules/alias_multi.rst

+9
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ This module allows you to manage multiple aliases.
1919

2020
It is faster than the 'alias' module as it reduces the needed api/http calls.
2121

22+
Contribution
23+
************
24+
25+
Thanks to `@Rath <https://github.com/superstes>`_ for developing these modules!
26+
27+
----
28+
2229
Info
2330
****
2431

@@ -68,6 +75,8 @@ ansibleguy.opnsense.alias_purge
6875
"fail_all","boolean","false","false","fail","Fail module if single alias fails to be purged"
6976
"reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst
7077

78+
----
79+
7180
Examples
7281
********
7382

‎docs/source/modules/bind.rst

+10
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,18 @@ DNS - BIND
2020

2121
**Service Docs**: `Bind <https://docs.opnsense.org/manual/how-tos/bind.html>`_
2222

23+
Contribution
24+
************
25+
26+
Thanks to `@Rath <https://github.com/superstes>`_ for developing these modules!
27+
2328
Sponsoring
2429
**********
2530

2631
Thanks to `@telmich <https://github.com/telmich>`_ for sponsoring the development of these modules!
2732

33+
----
34+
2835
Prerequisites
2936
*************
3037

@@ -169,6 +176,8 @@ ansibleguy.opnsense.bind_record_multi
169176
"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'."
170177
"reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst
171178

179+
----
180+
172181
Info
173182
****
174183

@@ -216,6 +225,7 @@ But the default behaviour is that you can only delete all of them at once.
216225

217226
If a change is needed, you will have to run the module using 'state=absent' first and then re-create all the records.
218227

228+
----
219229

220230
Examples
221231
********

‎docs/source/modules/cron.rst

+9
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Cron Jobs
1212

1313
**API Docs**: `Core - Cron <https://docs.opnsense.org/development/api/core/cron.html>`_
1414

15+
Contribution
16+
************
17+
18+
Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!
19+
20+
----
1521

1622
Definition
1723
**********
@@ -33,11 +39,14 @@ Definition
3339

3440
.. include:: ../_include/param_basic.rst
3541

42+
----
43+
3644
Usage
3745
*****
3846

3947
To add custom cron-job scripts - see: `OPNSense Documentation <https://docs.opnsense.org/development/backend/configd.html>`_ | `OPNSense Forum <https://forum.opnsense.org/index.php?topic=6177.0>`_
4048

49+
----
4150

4251
Examples
4352
********

‎docs/source/modules/dhcp.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ DHCP
2020
Contribution
2121
************
2222

23-
Thanks to `@KalleDK <https://github.com/KalleDK>`_, `@superstes <https://github.com/superstes>`_ and `@woelfle <https://github.com/woelfle>`_ for developing these modules!
23+
Thanks to `@KalleDK <https://github.com/KalleDK>`_, `@Rath <https://github.com/superstes>`_ and `@woelfle <https://github.com/woelfle>`_ for developing these modules!
2424

2525
----
2626

‎docs/source/modules/dhcrelay_destination.rst

+6
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Contribution
1919

2020
Thanks to `@jiuka <https://github.com/jiuka>`_ for developing this module!
2121

22+
----
23+
2224
Definition
2325
**********
2426

@@ -32,13 +34,17 @@ Definition
3234

3335
.. include:: ../_include/param_basic.rst
3436

37+
----
38+
3539
Info
3640
****
3741

3842
This module manages DHCRelay destinations. A destination can contain multiple IP addresses.
3943

4044
Note: You can also use the shortform module name: :code:`ansibleguy.opnsense.dhcrelay_dst`
4145

46+
----
47+
4248
Examples
4349
********
4450

‎docs/source/modules/dhcrelay_relay.rst

+6
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Contribution
1919

2020
Thanks to `@jiuka <https://github.com/jiuka>`_ for developing this module!
2121

22+
----
23+
2224
Definition
2325
**********
2426

@@ -34,13 +36,17 @@ Definition
3436

3537
.. include:: ../_include/param_basic.rst
3638

39+
----
40+
3741
Info
3842
****
3943

4044
This module manages DHCRelay relays. Each interface can be assigned a single relay.
4145

4246
Note: You can also use the shortform module name: :code:`ansibleguy.opnsense.dhcrelay`
4347

48+
----
49+
4450
Examples
4551
********
4652

‎docs/source/modules/frr_bfd.md

+6
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,16 @@
1010

1111
**FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_)
1212

13+
## Contribution
14+
15+
Thanks to [@Rath](https://github.com/superstes) for developing these modules!
16+
1317
## Sponsoring
1418

1519
Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules!
1620

21+
----
22+
1723
## Prerequisites
1824

1925
You need to install the FRR plugin:

‎docs/source/modules/frr_bgp.md

+8
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,16 @@
1515

1616
**FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_)
1717

18+
## Contribution
19+
20+
Thanks to [@Rath](https://github.com/superstes) for developing these modules!
21+
1822
## Sponsoring
1923

2024
Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules!
2125

26+
----
27+
2228
## Prerequisites
2329

2430
You need to install the FRR plugin:
@@ -28,6 +34,7 @@ os-frr
2834

2935
You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html).
3036

37+
----
3138

3239
## Definition
3340

@@ -123,6 +130,7 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic
123130
| 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! |
124131
| 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). |
125132

133+
----
126134

127135
## Examples
128136

‎docs/source/modules/frr_diagnostic.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,15 @@
1010

1111
**FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_)
1212

13+
## Contribution
14+
15+
Thanks to [@Rath](https://github.com/superstes) for developing this module!
16+
1317
## Sponsoring
1418

15-
Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules!
19+
Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of this module!
20+
21+
----
1622

1723
## Prerequisites
1824

@@ -23,6 +29,8 @@ os-frr
2329

2430
You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html).
2531

32+
----
33+
2634
## Definition
2735

2836
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
3341
|:------------|:----------------|:---------|:----------------------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3442
| 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' |
3543

44+
----
45+
3646
## Examples
3747

3848
### ansibleguy.opnsense.frr_diagnostic

‎docs/source/modules/frr_general.md

+13
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@
1010

1111
**FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_)
1212

13+
## Contribution
14+
15+
Thanks to [@Rath](https://github.com/superstes) for developing this module!
16+
17+
## Sponsoring
18+
19+
Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of this module!
20+
21+
----
22+
1323
## Prerequisites
1424

1525
You need to install the FRR plugin:
@@ -19,6 +29,8 @@ os-frr
1929

2030
You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html).
2131

32+
----
33+
2234
## Definition
2335

2436
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
3446
| carp | bool | false | false | carp_failover | Will activate the routing service only on the primary device |
3547
| snmp_agentx | bool | false | false | - | En- or disable support for Net-SNMP AgentX |
3648

49+
----
3750

3851
## Examples
3952

‎docs/source/modules/frr_ospf.md

+10
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,16 @@
1717

1818
**FRR Docs**: [FRRouting](https://docs.frrouting.org/) (_make sure you are looking at the current OPNSense package version!_)
1919

20+
## Contribution
21+
22+
Thanks to [@Rath](https://github.com/superstes) for developing these modules!
23+
2024
## Sponsoring
2125

2226
Thanks to [@telmich](https://github.com/telmich) for sponsoring the development of these modules!
2327

28+
----
29+
2430
## Prerequisites
2531

2632
You need to install the FRR plugin:
@@ -30,6 +36,7 @@ os-frr
3036

3137
You can also install it using the [package module](https://opnsense.ansibleguy.net/modules/package.html).
3238

39+
----
3340

3441
## Definition
3542

@@ -141,6 +148,9 @@ For basic parameters see: [Basics](https://opnsense.ansibleguy.net/usage/2_basic
141148
| network_type | string | false | - | nw_type | One of: 'broadcast', 'point-to-point' |
142149
| 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). |
143150

151+
152+
----
153+
144154
## Examples
145155

146156
### OSPF (_IPv4_)

0 commit comments

Comments
 (0)