fortiswitch_router_ripng – router ripng configuratio in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch 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 v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_router_ripng yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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 - router ripng configuration type: dict
    • aggregate_address - Set aggregate RIPng route announcement. type: list member_path: aggregate_address:id
      • id - Aggregate-address entry id. type: int required: true
      • prefix6 - Aggregate-address prefix. type: str
    • bfd - Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable
    • default_information_originate - Generate a default route. type: str choices: enable, disable
    • default_metric - Default metric of redistribute routes (Except connected). type: int
    • distribute_list - Filter networks in routing updates. type: list member_path: distribute_list:id
      • 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 collection timer. type: int
    • interface - RIPng interface configuration. type: list member_path: interface:name
      • flags - Flags. type: int
      • name - Interface name. Source system.interface.name. type: str required: true
      • passive - Suppress routing updates on an interface. type: str choices: enable, disable
      • split_horizon - Split horizon type. type: str choices: poisoned, regular
      • split_horizon_status - Enable/disable split horizon. type: str choices: enable, disable
    • offset_list - Offset list to modify RIPng metric. type: list member_path: offset_list:id
      • 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 - Metric offset. type: int
      • status - Status. type: str choices: enable, disable
    • redistribute - Redistribute configuration. type: list member_path: redistribute:name
      • flags - Flags type: int
      • 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 - Routing information timeout timer. type: int
    • update_timer - Routing table update timer. type: int

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: router ripng configuration
    fortiswitch_router_ripng:
      router_ripng:
        aggregate_address:
         -
            id:  "4"
            prefix6: "<your_own_value>"
        bfd: "enable"
        default_information_originate: "enable"
        default_metric: "8"
        distribute_list:
         -
            direction: "in"
            id:  "11"
            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: "15"
        interface:
         -
            flags: "17"
            name: "default_name_18 (source system.interface.name)"
            passive: "enable"
            split_horizon: "poisoned"
            split_horizon_status: "enable"
        offset_list:
         -
            access_list6: "<your_own_value> (source router.access-list6.name)"
            direction: "in"
            id:  "25"
            interface: "<your_own_value> (source system.interface.name)"
            offset: "27"
            status: "enable"
        redistribute:
         -
            flags: "30"
            metric: "31"
            name: "default_name_32"
            routemap: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        timeout_timer: "35"
        update_timer: "36"

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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

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)

Hint

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