Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/modules/2_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@

**TESTS**: Used in multiple ones

Contribution
************

Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!

----

Info
****

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

.. include:: ../_include/param_basic.rst

----

Examples
********

Expand Down
9 changes: 9 additions & 0 deletions docs/source/modules/2_reload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@

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

Contribution
************

Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!

----

Info
****

Expand All @@ -30,6 +37,8 @@ Definition

.. include:: ../_include/param_basic.rst

----

Examples
********

Expand Down
2 changes: 2 additions & 0 deletions docs/source/modules/acmeclient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Contribution

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

----

Prerequisites
*************

Expand Down
9 changes: 8 additions & 1 deletion docs/source/modules/alias.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Alias

This module allows you to manage single aliases.

Contribution
************

Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!

----

Info
****
Expand All @@ -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 <https://docs.opnsense.org/manual/how-tos/maxmind_geo_ip.html>`_


Mass-Manage
===========

Expand All @@ -47,6 +52,8 @@ Definition

.. include:: ../_include/param_basic.rst

----

Examples
********

Expand Down
9 changes: 9 additions & 0 deletions docs/source/modules/alias_multi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/superstes>`_ for developing these modules!

----

Info
****

Expand Down Expand Up @@ -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
********

Expand Down
10 changes: 10 additions & 0 deletions docs/source/modules/bind.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,18 @@ DNS - BIND

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

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
*************

Expand Down Expand Up @@ -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
****

Expand Down Expand Up @@ -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
********
Expand Down
9 changes: 9 additions & 0 deletions docs/source/modules/cron.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ Cron Jobs

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

Contribution
************

Thanks to `@Rath <https://github.com/superstes>`_ for developing this module!

----

Definition
**********
Expand All @@ -33,11 +39,14 @@ Definition

.. include:: ../_include/param_basic.rst

----

Usage
*****

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>`_

----

Examples
********
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/dhcp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ DHCP
Contribution
************

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

----

Expand Down
6 changes: 6 additions & 0 deletions docs/source/modules/dhcrelay_destination.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Contribution

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

----

Definition
**********

Expand All @@ -32,13 +34,17 @@ Definition

.. include:: ../_include/param_basic.rst

----

Info
****

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

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

----

Examples
********

Expand Down
6 changes: 6 additions & 0 deletions docs/source/modules/dhcrelay_relay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Contribution

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

----

Definition
**********

Expand All @@ -34,13 +36,17 @@ Definition

.. include:: ../_include/param_basic.rst

----

Info
****

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

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

----

Examples
********

Expand Down
6 changes: 6 additions & 0 deletions docs/source/modules/frr_bfd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 8 additions & 0 deletions docs/source/modules/frr_bgp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -28,6 +34,7 @@ os-frr

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

----

## Definition

Expand Down Expand Up @@ -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

Expand Down
12 changes: 11 additions & 1 deletion docs/source/modules/frr_diagnostic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
Expand All @@ -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
Expand Down
13 changes: 13 additions & 0 deletions docs/source/modules/frr_general.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand All @@ -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

Expand Down
10 changes: 10 additions & 0 deletions docs/source/modules/frr_ospf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -30,6 +36,7 @@ os-frr

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

----

## Definition

Expand Down Expand Up @@ -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_)
Expand Down
Loading
Loading