ansible.builtin.fortios_router_ripng (v2.9.27) — module

Configure RIPng in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

router_ripng:
    default: null
    description:
    - Configure RIPng.
    suboptions:
      aggregate_address:
        description:
        - Aggregate address.
        suboptions:
          id:
            description:
            - Aggregate address entry ID.
            required: true
            type: int
          prefix6:
            description:
            - Aggregate address prefix.
            type: str
        type: list
      default_information_originate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable generation of default route.
        type: str
      default_metric:
        description:
        - Metric that the FortiGate unit advertises to adjacent routers.
        type: int
      distance:
        description:
        - Administrative distance
        suboptions:
          access_list6:
            description:
            - Access list for route destination. Source router.access-list6.name.
            type: str
          distance:
            description:
            - Distance (1 - 255).
            type: int
          id:
            description:
            - Distance ID.
            required: true
            type: int
          prefix6:
            description:
            - Distance prefix6.
            type: str
        type: list
      distribute_list:
        description:
        - Use this to filter incoming or outgoing updates using an access list or a prefix
          list.
        suboptions:
          direction:
            choices:
            - in
            - out
            description:
            - Distribute list direction.
            type: str
          id:
            description:
            - Distribute list ID.
            required: true
            type: int
          interface:
            description:
            - Distribute list interface name. Source system.interface.name.
            type: str
          listname:
            description:
            - Distribute access/prefix list name. Source router.access-list6.name router.prefix-list6.name.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Use this to activate or deactivate
            type: str
        type: list
      garbage_timer:
        description:
        - Time in seconds that must elapse after the timeout interval for a route expires,.
        type: int
      interface:
        description:
        - RIPng interface configuration.
        suboptions:
          flags:
            description:
            - Configuration flags of the interface.
            type: int
          name:
            description:
            - Interface name. Source system.interface.name.
            required: true
            type: str
          split_horizon:
            choices:
            - poisoned
            - regular
            description:
            - Configure RIP to use either regular or poisoned split horizon on this interface.
            type: str
          split_horizon_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable split horizon.
            type: str
        type: list
      max_out_metric:
        description:
        - Maximum metric allowed to output(0 means 'not set').
        type: int
      neighbor:
        description:
        - List of neighbors.
        suboptions:
          id:
            description:
            - Neighbor entry ID.
            required: true
            type: int
          interface:
            description:
            - Interface name. Source system.interface.name.
            type: str
          ip6:
            description:
            - IPv6 link-local address.
            type: str
        type: list
      network:
        description:
        - list of networks connected.
        suboptions:
          id:
            description:
            - Network entry ID.
            required: true
            type: int
          prefix:
            description:
            - Network IPv6 link-local prefix.
            type: str
        type: list
      offset_list:
        description:
        - Adds the specified offset to the metric (hop count) of a route.
        suboptions:
          access_list6:
            description:
            - IPv6 access list name. Source router.access-list6.name.
            type: str
          direction:
            choices:
            - in
            - out
            description:
            - Offset list direction.
            type: str
          id:
            description:
            - Offset-list ID.
            required: true
            type: int
          interface:
            description:
            - Interface name. Source system.interface.name.
            type: str
          offset:
            description:
            - Offset range
            type: int
          status:
            choices:
            - enable
            - disable
            description:
            - Indicates if the offset is active or not
            type: str
        type: list
      passive_interface:
        description:
        - Passive interface configuration.
        suboptions:
          name:
            description:
            - Passive interface name. Source system.interface.name.
            required: true
            type: str
        type: list
      redistribute:
        description:
        - Redistribute configuration.
        suboptions:
          metric:
            description:
            - Redistribute metric setting.
            type: int
          name:
            description:
            - Redistribute name.
            required: true
            type: str
          routemap:
            description:
            - Route map name. Source router.route-map.name.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Indicates if the redistribute is active or not
            type: str
        type: list
      timeout_timer:
        description:
        - Time interval in seconds after which a route is declared unreachable.
        type: int
      update_timer:
        description:
        - The time interval in seconds between RIP updates.
        type: int
    type: dict

Outputs

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