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.0

Requirements

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

  • ansible>=2.9.0

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • vdom - 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. type: str default: root
  • router_ripng - Configure RIPng. type: dict
    • aggregate_address - Aggregate address. type: list
      • id - Aggregate address entry ID. type: int required: True
      • prefix6 - Aggregate address prefix. type: str
    • default_information_originate - Enable/disable generation of default route. type: str choices: enable, disable
    • default_metric - Default metric. type: int
    • distance - distance type: list
      • access_list6 - Access list for route destination. Source router.access-list6.name. type: str
      • distance - Distance (1 - 255). type: int
      • id - Distance ID. type: int required: True
      • prefix6 - Distance prefix6. type: str
    • distribute_list - Distribute list. type: list
      • direction - Distribute list direction. type: str choices: in, out
      • id - Distribute list ID. type: int required: True
      • interface - Distribute list interface name. Source system.interface.name. type: str
      • listname - Distribute access/prefix list name. Source router.access-list6.name router.prefix-list6.name. type: str
      • status - status type: str choices: enable, disable
    • garbage_timer - Garbage timer. type: int
    • interface - RIPng interface configuration. type: list
      • flags - Flags. type: int
      • name - Interface name. Source system.interface.name. type: str required: True
      • split_horizon - Enable/disable split horizon. type: str choices: poisoned, regular
      • split_horizon_status - Enable/disable split horizon. type: str choices: enable, disable
    • max_out_metric - Maximum metric allowed to output(0 means "not set"). type: int
    • neighbor - neighbor type: list
      • id - Neighbor entry ID. type: int required: True
      • interface - Interface name. Source system.interface.name. type: str
      • ip6 - IPv6 link-local address. type: str
    • network - Network. type: list
      • id - Network entry ID. type: int required: True
      • prefix - Network IPv6 link-local prefix. type: str
    • offset_list - Offset list. type: list
      • access_list6 - IPv6 access list name. Source router.access-list6.name. type: str
      • direction - Offset list direction. type: str choices: in, out
      • id - Offset-list ID. type: int required: True
      • interface - Interface name. Source system.interface.name. type: str
      • offset - offset type: int
      • status - status type: str choices: enable, disable
    • passive_interface - Passive interface configuration. type: list
      • name - Passive interface name. Source system.interface.name. type: str required: True
    • redistribute - Redistribute configuration. type: list
      • metric - Redistribute metric setting. type: int
      • name - Redistribute name. type: str required: True
      • routemap - Route map name. Source router.route-map.name. type: str
      • status - status type: str choices: enable, disable
    • timeout_timer - Timeout timer. type: int
    • update_timer - Update timer. type: int

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure RIPng.
    fortios_router_ripng:
      vdom:  "{{ vdom }}"
      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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.