fortinet.fortios.fortios_router_ospf6 module – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_router_ospf6
.
New in fortinet.fortios 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 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure IPv6 OSPF. |
|
Area border router type. Choices:
|
|
OSPF6 area configuration. |
|
Authentication mode. Choices:
|
|
Summary default cost of stub or NSSA area. |
|
Area entry IP address. |
|
Authentication algorithm. Choices:
|
|
Encryption algorithm. Choices:
|
|
IPsec authentication and encryption keys. |
|
Authentication key. |
|
Encryption key. |
|
Security Parameters Index. see <a href=’#notes’>Notes</a>. |
|
Key roll-over interval. |
|
Enable/disable originate type 7 default into NSSA area. Choices:
|
|
OSPFv3 default metric. |
|
OSPFv3 metric type for default routes. Choices:
|
|
Enable/disable redistribute into NSSA area. Choices:
|
|
NSSA translator role type. Choices:
|
|
OSPF6 area range configuration. |
|
Enable/disable advertise status. Choices:
|
|
Range entry ID. see <a href=’#notes’>Notes</a>. |
|
IPv6 prefix. |
|
Stub summary setting. Choices:
|
|
Area type setting. Choices:
|
|
OSPF6 virtual link configuration. |
|
Authentication mode. Choices:
|
|
Dead interval. |
|
Hello interval. |
|
Authentication algorithm. Choices:
|
|
Encryption algorithm. Choices:
|
|
IPsec authentication and encryption keys. |
|
Authentication key. |
|
Encryption key. |
|
Security Parameters Index. see <a href=’#notes’>Notes</a>. |
|
Key roll-over interval. |
|
Virtual link entry name. |
|
A.B.C.D, peer router ID. |
|
Retransmit interval. |
|
Transmit delay. |
|
Reference bandwidth in terms of megabits per second. |
|
Enable/disable Bidirectional Forwarding Detection (BFD). Choices:
|
|
Default information metric. |
|
Default information metric type. Choices:
|
|
Enable/disable generation of default route. Choices:
|
|
Default information route map. Source router.route-map.name. |
|
Default metric of redistribute routes. |
|
Log OSPFv3 neighbor changes. Choices:
|
|
OSPF6 interface configuration. |
|
A.B.C.D, in IPv4 address format. |
|
Authentication mode. Choices:
|
|
Enable/disable Bidirectional Forwarding Detection (BFD). Choices:
|
|
Cost of the interface, value range from 0 to 65535, 0 means auto-cost. |
|
Dead interval. |
|
Hello interval. |
|
Configuration interface name. Source system.interface.name. |
|
Authentication algorithm. Choices:
|
|
Encryption algorithm. Choices:
|
|
IPsec authentication and encryption keys. |
|
Authentication key. |
|
Encryption key. |
|
Security Parameters Index. see <a href=’#notes’>Notes</a>. |
|
Key roll-over interval. |
|
MTU for OSPFv3 packets. |
|
Enable/disable ignoring MTU field in DBD packets. Choices:
|
|
Interface entry name. |
|
OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media. |
|
Cost of the interface, value range from 0 to 65535, 0 means auto-cost. |
|
IPv6 link local address of the neighbor. |
|
Poll interval time in seconds. |
|
Priority. |
|
Network type. Choices:
|
|
Priority. |
|
Retransmit interval. |
|
Enable/disable OSPF6 routing on this interface. Choices:
|
|
Transmit delay. |
|
Passive interface configuration. |
|
Passive interface name. Source system.interface.name. |
|
Redistribute configuration. |
|
Redistribute metric setting. |
|
Metric type. Choices:
|
|
Redistribute name. |
|
Route map name. Source router.route-map.name. |
|
Status. Choices:
|
|
OSPFv3 restart mode (graceful or none). Choices:
|
|
Enable/disable continuing graceful restart upon topology change. Choices:
|
|
Graceful restart period in seconds. |
|
A.B.C.D, in IPv4 address format. |
|
SPF calculation frequency. |
|
IPv6 address summary configuration. |
|
Enable/disable advertise status. Choices:
|
|
Summary address entry ID. see <a href=’#notes’>Notes</a>. |
|
IPv6 prefix. |
|
Tag value. |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure IPv6 OSPF.
fortinet.fortios.fortios_router_ospf6:
vdom: "{{ vdom }}"
router_ospf6:
abr_type: "cisco"
area:
-
authentication: "none"
default_cost: "10"
id: "7"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "<you_own_value>"
key_rollover_interval: "300"
nssa_default_information_originate: "enable"
nssa_default_information_originate_metric: "10"
nssa_default_information_originate_metric_type: "1"
nssa_redistribution: "enable"
nssa_translator_role: "candidate"
range:
-
advertise: "disable"
id: "22"
prefix6: "<your_own_value>"
stub_type: "no-summary"
type: "regular"
virtual_link:
-
authentication: "none"
dead_interval: "40"
hello_interval: "10"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "<you_own_value>"
key_rollover_interval: "300"
name: "default_name_37"
peer: "<your_own_value>"
retransmit_interval: "5"
transmit_delay: "1"
auto_cost_ref_bandwidth: "1000"
bfd: "enable"
default_information_metric: "10"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: "<your_own_value> (source router.route-map.name)"
default_metric: "10"
log_neighbour_changes: "enable"
ospf6_interface:
-
area_id: "<your_own_value>"
authentication: "none"
bfd: "global"
cost: "0"
dead_interval: "0"
hello_interval: "0"
interface: "<your_own_value> (source system.interface.name)"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "<you_own_value>"
key_rollover_interval: "300"
mtu: "0"
mtu_ignore: "enable"
name: "default_name_66"
neighbor:
-
cost: "0"
ip6: "<your_own_value>"
poll_interval: "10"
priority: "1"
network_type: "broadcast"
priority: "1"
retransmit_interval: "5"
status: "disable"
transmit_delay: "1"
passive_interface:
-
name: "default_name_78 (source system.interface.name)"
redistribute:
-
metric: "0"
metric_type: "1"
name: "default_name_82"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
restart_mode: "none"
restart_on_topology_change: "enable"
restart_period: "120"
router_id: "<your_own_value>"
spf_timers: "<your_own_value>"
summary_address:
-
advertise: "disable"
id: "92"
prefix6: "<your_own_value>"
tag: "0"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |