FRR Diagnostic

STATE: stable

TESTS: frr_diagnostic

API Docs: Plugins - Quagga

Service Docs: Dynamic Routing

FRR Docs: FRRouting (make sure you are looking at the current OPNSense package version!)

Sponsoring

Thanks to @telmich for sponsoring the development of these modules!

Prerequisites

You need to install the FRR plugin:

os-frr

You can also install it using the package module.

Definition

For basic parameters see: Basics

ansibleguy.opnsense.frr_diagnostic

Parameter

Type

Required

Default value

Aliases

Comment

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

- hosts: localhost
  gather_facts: no
  module_defaults:
    group/ansibleguy.opnsense.all:
      firewall: 'opnsense.template.ansibleguy.net'
      api_credential_file: '/home/guy/.secret/opn.key'

  tasks:
    - name: Example
      ansibleguy.opnsense.frr_diagnostic:
        target: 'generalroute'
      register: frr_info

    - name: Printing
      ansible.builtin.debug:
        var: frr_info.data