fortios_router_ripng – Configure RIPng in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_router_ripng v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: 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
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • router_ripng - Configure RIPng. type: dict more...
    • aggregate_address - Aggregate address. type: list member_path: aggregate_address:id more...
      • id - Aggregate address entry ID. see Notes. type: int required: true more...
      • prefix6 - Aggregate address prefix. type: str more...
    • default_information_originate - Enable/disable generation of default route. type: str choices: enable, disable more...
    • default_metric - Default metric. type: int more...
    • distance - Distance. type: list member_path: distance:id more...
      • access_list6 - Access list for route destination. Source router.access-list6.name. type: str more...
      • distance - Distance (1 - 255). type: int more...
      • id - Distance ID. see Notes. type: int required: true more...
      • prefix6 - Distance prefix6. type: str more...
    • distribute_list - Distribute list. type: list member_path: distribute_list:id more...
      • direction - Distribute list direction. type: str choices: in, out more...
      • id - Distribute list ID. see Notes. type: int required: true more...
      • interface - Distribute list interface name. Source system.interface.name. type: str more...
      • listname - Distribute access/prefix list name. Source router.access-list6.name router.prefix-list6.name. type: str more...
      • status - Status. type: str choices: enable, disable more...
    • garbage_timer - Garbage timer. type: int more...
    • interface - RIPng interface configuration. type: list member_path: interface:name more...
      • flags - Flags. type: int more...
      • name - Interface name. Source system.interface.name. type: str required: true more...
      • split_horizon - Enable/disable split horizon. type: str choices: poisoned, regular more...
      • split_horizon_status - Enable/disable split horizon. type: str choices: enable, disable more...
    • max_out_metric - Maximum metric allowed to output(0 means "not set"). type: int more...
    • neighbor - Neighbor. type: list member_path: neighbor:id more...
      • id - Neighbor entry ID. see Notes. type: int required: true more...
      • interface - Interface name. Source system.interface.name. type: str more...
      • ip6 - IPv6 link-local address. type: str more...
    • network - Network. type: list member_path: network:id more...
      • id - Network entry ID. see Notes. type: int required: true more...
      • prefix - Network IPv6 link-local prefix. type: str more...
    • offset_list - Offset list. type: list member_path: offset_list:id more...
      • access_list6 - IPv6 access list name. Source router.access-list6.name. type: str more...
      • direction - Offset list direction. type: str choices: in, out more...
      • id - Offset-list ID. see Notes. type: int required: true more...
      • interface - Interface name. Source system.interface.name. type: str more...
      • offset - Offset. type: int more...
      • status - Status. type: str choices: enable, disable more...
    • passive_interface - Passive interface configuration. type: list member_path: passive_interface:name more...
      • name - Passive interface name. Source system.interface.name. type: str required: true more...
    • redistribute - Redistribute configuration. type: list member_path: redistribute:name more...
      • metric - Redistribute metric setting. type: int more...
      • name - Redistribute name. type: str required: true more...
      • routemap - Route map name. Source router.route-map.name. type: str more...
      • status - Status. type: str choices: enable, disable more...
    • timeout_timer - Timeout timer. type: int more...
    • update_timer - Update timer. type: int more...

Notes

Note

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

Examples

- name: Configure RIPng.
  fortinet.fortios.fortios_router_ripng:
      vdom: "{{ vdom }}"
      router_ripng:
          aggregate_address:
              -
                  id: "4"
                  prefix6: "<your_own_value>"
          default_information_originate: "enable"
          default_metric: "1"
          distance:
              -
                  access_list6: "<your_own_value> (source router.access-list6.name)"
                  distance: "0"
                  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: "120"
          interface:
              -
                  flags: "8"
                  name: "default_name_22 (source system.interface.name)"
                  split_horizon: "poisoned"
                  split_horizon_status: "enable"
          max_out_metric: "0"
          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: "0"
                  status: "enable"
          passive_interface:
              -
                  name: "default_name_41 (source system.interface.name)"
          redistribute:
              -
                  metric: "0"
                  name: "default_name_44"
                  routemap: "<your_own_value> (source router.route-map.name)"
                  status: "enable"
          timeout_timer: "180"
          update_timer: "30"

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.