fortios_router_ripng – Configure RIPng in Fortinet’s FortiOS and FortiGate

New in version 2.9.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ripng category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Requirements

The below requirements are needed on the host that executes this module.

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments
host
string
FortiOS or FortiGate IP address.
https
boolean
    Choices:
  • no
  • yes ←
Indicates if the requests towards FortiGate must use HTTPS protocol.
password
string
Default:
""
FortiOS or FortiGate password.
router_ripng
dictionary
Configure RIPng.
aggregate_address
list
Aggregate address.
id
integer / required
Aggregate address entry ID.
prefix6
string
Aggregate address prefix.
default_information_originate
string
    Choices:
  • enable
  • disable
Enable/disable generation of default route.
default_metric
integer
Metric that the FortiGate unit advertises to adjacent routers.
distance
list
Administrative distance
access_list6
string
Access list for route destination. Source router.access-list6.name.
distance
integer
Distance (1 - 255).
id
integer / required
Distance ID.
prefix6
string
Distance prefix6.
distribute_list
list
Use this to filter incoming or outgoing updates using an access list or a prefix list.
direction
string
    Choices:
  • in
  • out
Distribute list direction.
id
integer / required
Distribute list ID.
interface
string
Distribute list interface name. Source system.interface.name.
listname
string
Distribute access/prefix list name. Source router.access-list6.name router.prefix-list6.name.
status
string
    Choices:
  • enable
  • disable
Use this to activate or deactivate
garbage_timer
integer
Time in seconds that must elapse after the timeout interval for a route expires,.
interface
list
RIPng interface configuration.
flags
integer
Configuration flags of the interface.
name
string / required
Interface name. Source system.interface.name.
split_horizon
string
    Choices:
  • poisoned
  • regular
Configure RIP to use either regular or poisoned split horizon on this interface.
split_horizon_status
string
    Choices:
  • enable
  • disable
Enable/disable split horizon.
max_out_metric
integer
Maximum metric allowed to output(0 means 'not set').
neighbor
list
List of neighbors.
id
integer / required
Neighbor entry ID.
interface
string
Interface name. Source system.interface.name.
ip6
string
IPv6 link-local address.
network
list
list of networks connected.
id
integer / required
Network entry ID.
prefix
string
Network IPv6 link-local prefix.
offset_list
list
Adds the specified offset to the metric (hop count) of a route.
access_list6
string
IPv6 access list name. Source router.access-list6.name.
direction
string
    Choices:
  • in
  • out
Offset list direction.
id
integer / required
Offset-list ID.
interface
string
Interface name. Source system.interface.name.
offset
integer
Offset range
status
string
    Choices:
  • enable
  • disable
Indicates if the offset is active or not
passive_interface
list
Passive interface configuration.
name
string / required
Passive interface name. Source system.interface.name.
redistribute
list
Redistribute configuration.
metric
integer
Redistribute metric setting.
name
string / required
Redistribute name.
routemap
string
Route map name. Source router.route-map.name.
status
string
    Choices:
  • enable
  • disable
Indicates if the redistribute is active or not
timeout_timer
integer
Time interval in seconds after which a route is declared unreachable.
update_timer
integer
The time interval in seconds between RIP updates.
ssl_verify
boolean
    Choices:
  • no
  • yes ←
Ensures FortiGate certificate must be verified by a proper CA.
username
string
FortiOS or FortiGate username.
vdom
string
Default:
"root"
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

  • Requires fortiosapi library developed by Fortinet

  • Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure RIPng.
    fortios_router_ripng:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      router_ripng:
        aggregate_address:
         -
            id:  "4"
            prefix6: "<your_own_value>"
        default_information_originate: "enable"
        default_metric: "7"
        distance:
         -
            access_list6: "<your_own_value> (source router.access-list6.name)"
            distance: "10"
            id:  "11"
            prefix6: "<your_own_value>"
        distribute_list:
         -
            direction: "in"
            id:  "15"
            interface: "<your_own_value> (source system.interface.name)"
            listname: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
            status: "enable"
        garbage_timer: "19"
        interface:
         -
            flags: "21"
            name: "default_name_22 (source system.interface.name)"
            split_horizon: "poisoned"
            split_horizon_status: "enable"
        max_out_metric: "25"
        neighbor:
         -
            id:  "27"
            interface: "<your_own_value> (source system.interface.name)"
            ip6: "<your_own_value>"
        network:
         -
            id:  "31"
            prefix: "<your_own_value>"
        offset_list:
         -
            access_list6: "<your_own_value> (source router.access-list6.name)"
            direction: "in"
            id:  "36"
            interface: "<your_own_value> (source system.interface.name)"
            offset: "38"
            status: "enable"
        passive_interface:
         -
            name: "default_name_41 (source system.interface.name)"
        redistribute:
         -
            metric: "43"
            name: "default_name_44"
            routemap: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        timeout_timer: "47"
        update_timer: "48"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.