fortios_router_ospf6 – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
| fortios_router_ospf6 | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- enable_log - Enable/Disable logging for task. type: bool required: False default: 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 more...
- abr_type - Area border router type. type: str choices: cisco, ibm, standard more...
- area - OSPF6 area configuration. type: list more...
- authentication - Authentication mode. type: str choices: none, ah, esp more...
- default_cost - Summary default cost of stub or NSSA area. type: int more...
- id - Area entry IP address. type: str required: True more...
- ipsec_auth_alg - Authentication algorithm. type: str choices: md5, sha1, sha256, sha384, sha512 more...
- ipsec_enc_alg - Encryption algorithm. type: str choices: None, des, 3des, aes128, aes192, aes256 more...
- ipsec_keys - IPsec authentication and encryption keys. type: list more...
- auth_key - Authentication key. type: str more...
- enc_key - Encryption key. type: str more...
- spi - Security Parameters Index. type: int required: True more...
- key_rollover_interval - Key roll-over interval. type: int more...
- nssa_default_information_originate - Enable/disable originate type 7 default into NSSA area. type: str choices: enable, disable more...
- nssa_default_information_originate_metric - OSPFv3 default metric. type: int more...
- nssa_default_information_originate_metric_type - OSPFv3 metric type for default routes. type: str choices: 1, 2 more...
- nssa_redistribution - Enable/disable redistribute into NSSA area. type: str choices: enable, disable more...
- nssa_translator_role - NSSA translator role type. type: str choices: candidate, never, always more...
- range - OSPF6 area range configuration. type: list more...
- advertise - Enable/disable advertise status. type: str choices: disable, enable more...
- id - Range entry ID. type: int required: True more...
- prefix6 - IPv6 prefix. type: str more...
- stub_type - Stub summary setting. type: str choices: no-summary, summary more...
- type - Area type setting. type: str choices: regular, nssa, stub more...
- virtual_link - OSPF6 virtual link configuration. type: list more...
- authentication - Authentication mode. type: str choices: none, ah, esp, area more...
- dead_interval - Dead interval. type: int more...
- hello_interval - Hello interval. type: int more...
- ipsec_auth_alg - Authentication algorithm. type: str choices: md5, sha1, sha256, sha384, sha512 more...
- ipsec_enc_alg - Encryption algorithm. type: str choices: None, des, 3des, aes128, aes192, aes256 more...
- ipsec_keys - IPsec authentication and encryption keys. type: list more...
- auth_key - Authentication key. type: str more...
- enc_key - Encryption key. type: str more...
- spi - Security Parameters Index. type: int required: True more...
- key_rollover_interval - Key roll-over interval. type: int more...
- name - Virtual link entry name. type: str required: True more...
- peer - A.B.C.D, peer router ID. type: str more...
- retransmit_interval - Retransmit interval. type: int more...
- transmit_delay - Transmit delay. type: int more...
- auto_cost_ref_bandwidth - Reference bandwidth in terms of megabits per second. type: int more...
- bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable more...
- default_information_metric - Default information metric. type: int more...
- default_information_metric_type - Default information metric type. type: str choices: 1, 2 more...
- default_information_originate - Enable/disable generation of default route. type: str choices: enable, always, disable more...
- default_information_route_map - Default information route map. Source router.route-map.name. type: str more...
- default_metric - Default metric of redistribute routes. type: int more...
- log_neighbour_changes - Enable logging of OSPFv3 neighbour"s changes type: str choices: enable, disable more...
- ospf6_interface - OSPF6 interface configuration. type: list more...
- area_id - A.B.C.D, in IPv4 address format. type: str more...
- authentication - Authentication mode. type: str choices: none, ah, esp, area more...
- bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: global, enable, disable more...
- cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int more...
- dead_interval - Dead interval. type: int more...
- hello_interval - Hello interval. type: int more...
- interface - Configuration interface name. Source system.interface.name. type: str more...
- ipsec_auth_alg - Authentication algorithm. type: str choices: md5, sha1, sha256, sha384, sha512 more...
- ipsec_enc_alg - Encryption algorithm. type: str choices: None, des, 3des, aes128, aes192, aes256 more...
- ipsec_keys - IPsec authentication and encryption keys. type: list more...
- auth_key - Authentication key. type: str more...
- enc_key - Encryption key. type: str more...
- spi - Security Parameters Index. type: int required: True more...
- key_rollover_interval - Key roll-over interval. type: int more...
- mtu - MTU for OSPFv3 packets. type: int more...
- mtu_ignore - Enable/disable ignoring MTU field in DBD packets. type: str choices: enable, disable more...
- name - Interface entry name. type: str required: True more...
- neighbor - OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media type: list more...
- cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int more...
- ip6 - IPv6 link local address of the neighbor. type: str required: True more...
- poll_interval - Poll interval time in seconds. type: int more...
- priority - priority type: int more...
- network_type - Network type. type: str choices: broadcast, point-to-point, non-broadcast, point-to-multipoint, point-to-multipoint-non-broadcast more...
- priority - priority type: int more...
- retransmit_interval - Retransmit interval. type: int more...
- status - Enable/disable OSPF6 routing on this interface. type: str choices: disable, enable more...
- transmit_delay - Transmit delay. type: int more...
- passive_interface - Passive interface configuration. type: list more...
- name - Passive interface name. Source system.interface.name. type: str required: True more...
- redistribute - Redistribute configuration. type: list more...
- metric - Redistribute metric setting. type: int more...
- metric_type - Metric type. type: str choices: 1, 2 more...
- name - Redistribute name. type: str required: True more...
- routemap - Route map name. Source router.route-map.name. type: str more...
- status - status type: str choices: enable, disable more...
- router_id - A.B.C.D, in IPv4 address format. type: str more...
- spf_timers - SPF calculation frequency. type: str more...
- summary_address - IPv6 address summary configuration. type: list more...
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:
-
authentication: "none"
default_cost: "6"
id: "7"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "13"
key_rollover_interval: "14"
nssa_default_information_originate: "enable"
nssa_default_information_originate_metric: "16"
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: "28"
hello_interval: "29"
ipsec_auth_alg: "md5"
ipsec_enc_alg: "null"
ipsec_keys:
-
auth_key: "<your_own_value>"
enc_key: "<your_own_value>"
spi: "35"
key_rollover_interval: "36"
name: "default_name_37"
peer: "<your_own_value>"
retransmit_interval: "39"
transmit_delay: "40"
auto_cost_ref_bandwidth: "41"
bfd: "enable"
default_information_metric: "43"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: "<your_own_value> (source router.route-map.name)"
default_metric: "47"
log_neighbour_changes: "enable"
ospf6_interface:
-
area_id: "<your_own_value>"
authentication: "none"
bfd: "global"
cost: "53"
dead_interval: "54"
hello_interval: "55"
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: "62"
key_rollover_interval: "63"
mtu: "64"
mtu_ignore: "enable"
name: "default_name_66"
neighbor:
-
cost: "68"
ip6: "<your_own_value>"
poll_interval: "70"
priority: "71"
network_type: "broadcast"
priority: "73"
retransmit_interval: "74"
status: "disable"
transmit_delay: "76"
passive_interface:
-
name: "default_name_78 (source system.interface.name)"
redistribute:
-
metric: "80"
metric_type: "1"
name: "default_name_82"
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: "89"
prefix6: "<your_own_value>"
tag: "91"
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