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
Authors

Synopsis ¶

This module is able to configure a FortiGate or FortiOS (FOS) device 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.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_ospf6 - Configure IPv6 OSPF. type: dict

abr_type - Area border router type. type: str choices: cisco, ibm, standard
area - OSPF6 area configuration. type: list

default_cost - Summary default cost of stub or NSSA area. type: int
id - Area entry IP address. type: str required: True
nssa_default_information_originate - Enable/disable originate type 7 default into NSSA area. type: str choices: enable, disable
nssa_default_information_originate_metric - OSPFv3 default metric. type: int
nssa_default_information_originate_metric_type - OSPFv3 metric type for default routes. type: str choices: 1, 2
nssa_redistribution - Enable/disable redistribute into NSSA area. type: str choices: enable, disable
nssa_translator_role - NSSA translator role type. type: str choices: candidate, never, always
range - OSPF6 area range configuration. type: list

advertise - Enable/disable advertise status. type: str choices: disable, enable
id - Range entry ID. type: int required: True
prefix6 - IPv6 prefix. type: str

stub_type - Stub summary setting. type: str choices: no-summary, summary
type - Area type setting. type: str choices: regular, nssa, stub
virtual_link - OSPF6 virtual link configuration. type: list

dead_interval - Dead interval. type: int
hello_interval - Hello interval. type: int
name - Virtual link entry name. type: str required: True
peer - A.B.C.D, peer router ID. type: str
retransmit_interval - Retransmit interval. type: int
transmit_delay - Transmit delay. type: int

auto_cost_ref_bandwidth - Reference bandwidth in terms of megabits per second. type: int
bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable
default_information_metric - Default information metric. type: int
default_information_metric_type - Default information metric type. type: str choices: 1, 2
default_information_originate - Enable/disable generation of default route. type: str choices: enable, always, disable
default_information_route_map - Default information route map. Source router.route-map.name. type: str
default_metric - Default metric of redistribute routes. type: int
log_neighbour_changes - Enable logging of OSPFv3 neighbour"s changes type: str choices: enable, disable
ospf6_interface - OSPF6 interface configuration. type: list

area_id - A.B.C.D, in IPv4 address format. type: str
bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: global, enable, disable
cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int
dead_interval - Dead interval. type: int
hello_interval - Hello interval. type: int
interface - Configuration interface name. Source system.interface.name. type: str
name - Interface entry name. type: str required: True
neighbor - OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media type: list

cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int
ip6 - IPv6 link local address of the neighbor. type: str required: True
poll_interval - Poll interval time in seconds. type: int
priority - priority type: int

network_type - Network type. type: str choices: broadcast, point-to-point, non-broadcast, point-to-multipoint, point-to-multipoint-non-broadcast
priority - priority type: int
retransmit_interval - Retransmit interval. type: int
status - Enable/disable OSPF6 routing on this interface. type: str choices: disable, enable
transmit_delay - Transmit delay. type: int

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
metric_type - Metric type. type: str choices: 1, 2
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

router_id - A.B.C.D, in IPv4 address format. type: str
spf_timers - SPF calculation frequency. type: str
summary_address - IPv6 address summary configuration. type: list

advertise - Enable/disable advertise status. type: str choices: disable, enable
id - Summary address entry ID. type: int required: True
prefix6 - IPv6 prefix. type: str
tag - Tag value. 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 IPv6 OSPF.
    fortios_router_ospf6:
      vdom:  "{{ vdom }}"
      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: 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.