fortios_router_ospf6 – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_router_ospf6 – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

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

## Requirements

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host - / required |  | FortiOS or FortiGate ip address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol
password - | Default: "" | FortiOS or FortiGate password.
router_ospf6 - | Default: null | Configure IPv6 OSPF.
| abr-type - | Choices: cisco ibm standard | Area border router type.
| area - |  | OSPF6 area configuration.
|  | default-cost - |  | Summary default cost of stub or NSSA area.
|  | id - / required |  | Area entry IP address.
|  | nssa-default-information-originate - | Choices: enable disable | Enable/disable originate type 7 default into NSSA area.
|  | nssa-default-information-originate-metric - |  | OSPFv3 default metric.
|  | nssa-default-information-originate-metric-type - | Choices: 1 2 | OSPFv3 metric type for default routes.
|  | nssa-redistribution - | Choices: enable disable | Enable/disable redistribute into NSSA area.
|  | nssa-translator-role - | Choices: candidate never always | NSSA translator role type.
|  | range - |  | OSPF6 area range configuration.
|  |  | advertise - | Choices: disable enable | Enable/disable advertise status.
|  |  | id - / required |  | Range entry ID.
|  |  | prefix6 - |  | IPv6 prefix.
|  | stub-type - | Choices: no-summary summary | Stub summary setting.
|  | type - | Choices: regular nssa stub | Area type setting.
|  | virtual-link - |  | OSPF6 virtual link configuration.
|  |  | dead-interval - |  | Dead interval.
|  |  | hello-interval - |  | Hello interval.
|  |  | name - / required |  | Virtual link entry name.
|  |  | peer - |  | A.B.C.D, peer router ID.
|  |  | retransmit-interval - |  | Retransmit interval.
|  |  | transmit-delay - |  | Transmit delay.
| auto-cost-ref-bandwidth - |  | Reference bandwidth in terms of megabits per second.
| bfd - | Choices: enable disable | Enable/disable Bidirectional Forwarding Detection (BFD).
| default-information-metric - |  | Default information metric.
| default-information-metric-type - | Choices: 1 2 | Default information metric type.
| default-information-originate - | Choices: enable always disable | Enable/disable generation of default route.
| default-information-route-map - |  | Default information route map. Source router.route-map.name.
| default-metric - |  | Default metric of redistribute routes.
| log-neighbour-changes - | Choices: enable disable | Enable logging of OSPFv3 neighbour's changes
| ospf6-interface - |  | OSPF6 interface configuration.
|  | area-id - |  | A.B.C.D, in IPv4 address format.
|  | bfd - | Choices: global enable disable | Enable/disable Bidirectional Forwarding Detection (BFD).
|  | cost - |  | Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
|  | dead-interval - |  | Dead interval.
|  | hello-interval - |  | Hello interval.
|  | interface - |  | Configuration interface name. Source system.interface.name.
|  | name - / required |  | Interface entry name.
|  | neighbor - |  | OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media
|  |  | cost - |  | Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
|  |  | ip6 - / required |  | IPv6 link local address of the neighbor.
|  |  | poll-interval - |  | Poll interval time in seconds.
|  |  | priority - |  | priority
|  | network-type - | Choices: broadcast point-to-point non-broadcast point-to-multipoint point-to-multipoint-non-broadcast | Network type.
|  | priority - |  | priority
|  | retransmit-interval - |  | Retransmit interval.
|  | status - | Choices: disable enable | Enable/disable OSPF6 routing on this interface.
|  | transmit-delay - |  | Transmit delay.
| passive-interface - |  | Passive interface configuration.
|  | name - / required |  | Passive interface name. Source system.interface.name.
| redistribute - |  | Redistribute configuration.
|  | metric - |  | Redistribute metric setting.
|  | metric-type - | Choices: 1 2 | Metric type.
|  | name - / required |  | Redistribute name.
|  | routemap - |  | Route map name. Source router.route-map.name.
|  | status - | Choices: enable disable | status
| router-id - |  | A.B.C.D, in IPv4 address format.
| spf-timers - |  | SPF calculation frequency.
| summary-address - |  | IPv6 address summary configuration.
|  | advertise - | Choices: disable enable | Enable/disable advertise status.
|  | id - / required |  | Summary address entry ID.
|  | prefix6 - |  | IPv6 prefix.
|  | tag - |  | Tag value.
username - / required |  | FortiOS or FortiGate username.
vdom - | 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"
      tasks:
      - name: Configure IPv6 OSPF.
        fortios_router_ospf6:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          router_ospf6:
            abr-type: "cisco"
            area:
             -
                default-cost: "5"
                id:  "6"
                nssa-default-information-originate: "enable"
                nssa-default-information-originate-metric: "8"
                nssa-default-information-originate-metric-type: "1"
                nssa-redistribution: "enable"
                nssa-translator-role: "candidate"
                range:
                 -
                    advertise: "disable"
                    id:  "14"
                    prefix6: "<your_own_value>"
                stub-type: "no-summary"
                type: "regular"
                virtual-link:
                 -
                    dead-interval: "19"
                    hello-interval: "20"
                    name: "default_name_21"
                    peer: "<your_own_value>"
                    retransmit-interval: "23"
                    transmit-delay: "24"
            auto-cost-ref-bandwidth: "25"
            bfd: "enable"
            default-information-metric: "27"
            default-information-metric-type: "1"
            default-information-originate: "enable"
            default-information-route-map: "<your_own_value> (source router.route-map.name)"
            default-metric: "31"
            log-neighbour-changes: "enable"
            ospf6-interface:
             -
                area-id: "<your_own_value>"
                bfd: "global"
                cost: "36"
                dead-interval: "37"
                hello-interval: "38"
                interface: "<your_own_value> (source system.interface.name)"
                name: "default_name_40"
                neighbor:
                 -
                    cost: "42"
                    ip6: "<your_own_value>"
                    poll-interval: "44"
                    priority: "45"
                network-type: "broadcast"
                priority: "47"
                retransmit-interval: "48"
                status: "disable"
                transmit-delay: "50"
            passive-interface:
             -
                name: "default_name_52 (source system.interface.name)"
            redistribute:
             -
                metric: "54"
                metric-type: "1"
                name: "default_name_56"
                routemap: "<your_own_value> (source router.route-map.name)"
                status: "enable"
            router-id: "<your_own_value>"
            spf-timers: "<your_own_value>"
            summary-address:
             -
                advertise: "disable"
                id:  "63"
                prefix6: "<your_own_value>"
                tag: "65"

## 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

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

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