:source: fortios_router_ospf.py
:orphan:
.. fortios_router_ospf:
fortios_router_ospf -- Configure OSPF in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ospf 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
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- router_ospf - Configure OSPF. type: dict
more...
| Supported Version Ranges |
| router_ospf |
v6.0.0 -> 7.6.6 |
- abr_type - Area border router type. type: str choices: cisco, ibm, shortcut, standard
more...
|
Supported Version Ranges |
| abr_type |
v6.0.0 -> 7.6.6 |
| [cisco] |
v6.0.0 -> 7.6.6 |
| [ibm] |
v6.0.0 -> 7.6.6 |
| [shortcut] |
v6.0.0 -> 7.6.6 |
| [standard] |
v6.0.0 -> 7.6.6 |
- area - OSPF area configuration. type: list member_path: area:id
more...
| Supported Version Ranges |
| area |
v6.0.0 -> 7.6.6 |
- authentication - Authentication type. type: str choices: none, text, message-digest, md5
more...
|
Supported Version Ranges |
| authentication |
v6.0.0 -> 7.6.6 |
| [none] |
v6.0.0 -> 7.6.6 |
| [text] |
v6.0.0 -> 7.6.6 |
| [message-digest] |
v7.0.1 -> 7.6.6 |
| [md5] |
v6.0.0 -> v7.0.0 |
- comments - Comment. type: str
more...
|
Supported Version Ranges |
| comments |
v7.0.0 -> 7.6.6 |
- default_cost - Summary default cost of stub or NSSA area. type: int
more...
|
Supported Version Ranges |
| default_cost |
v6.0.0 -> 7.6.6 |
- filter_list - OSPF area filter-list configuration. type: list member_path: area:id/filter_list:id
more...
| Supported Version Ranges |
| filter_list |
v6.0.0 -> 7.6.6 |
- direction - Direction. type: str choices: in, out
more...
|
Supported Version Ranges |
| direction |
v6.0.0 -> 7.6.6 |
| [in] |
v6.0.0 -> 7.6.6 |
| [out] |
v6.0.0 -> 7.6.6 |
- id - Filter list entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- list - Access-list or prefix-list name. Source router.access-list.name router.prefix-list.name. type: str
more...
|
Supported Version Ranges |
| list |
v6.0.0 -> 7.6.6 |
- id - Area entry IP address. type: str required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- nssa_default_information_originate - Redistribute, advertise, or do not originate Type-7 default route into NSSA area. type: str choices: enable, always, disable
more...
|
Supported Version Ranges |
| nssa_default_information_originate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [always] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- nssa_default_information_originate_metric - OSPF default metric. type: int
more...
|
Supported Version Ranges |
| nssa_default_information_originate_metric |
v6.0.0 -> 7.6.6 |
- nssa_default_information_originate_metric_type - OSPF metric type for default routes. type: str choices: 1, 2
more...
|
Supported Version Ranges |
| nssa_default_information_originate_metric_type |
v6.0.0 -> 7.6.6 |
| [1] |
v6.0.0 -> 7.6.6 |
| [2] |
v6.0.0 -> 7.6.6 |
- nssa_redistribution - Enable/disable redistribute into NSSA area. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nssa_redistribution |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- nssa_translator_role - NSSA translator role type. type: str choices: candidate, never, always
more...
|
Supported Version Ranges |
| nssa_translator_role |
v6.0.0 -> 7.6.6 |
| [candidate] |
v6.0.0 -> 7.6.6 |
| [never] |
v6.0.0 -> 7.6.6 |
| [always] |
v6.0.0 -> 7.6.6 |
- range - OSPF area range configuration. type: list member_path: area:id/range:id
more...
| Supported Version Ranges |
| range |
v6.0.0 -> 7.6.6 |
- advertise - Enable/disable advertise status. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| advertise |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- id - Range entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- prefix - Prefix. type: str
more...
|
Supported Version Ranges |
| prefix |
v6.0.0 -> 7.6.6 |
- substitute - Substitute prefix. type: str
more...
|
Supported Version Ranges |
| substitute |
v6.0.0 -> 7.6.6 |
- substitute_status - Enable/disable substitute status. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| substitute_status |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- shortcut - Enable/disable shortcut option. type: str choices: disable, enable, default
more...
|
Supported Version Ranges |
| shortcut |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
- stub_type - Stub summary setting. type: str choices: no-summary, summary
more...
|
Supported Version Ranges |
| stub_type |
v6.0.0 -> 7.6.6 |
| [no-summary] |
v6.0.0 -> 7.6.6 |
| [summary] |
v6.0.0 -> 7.6.6 |
- type - Area type setting. type: str choices: regular, nssa, stub
more...
|
Supported Version Ranges |
| type |
v6.0.0 -> 7.6.6 |
| [regular] |
v6.0.0 -> 7.6.6 |
| [nssa] |
v6.0.0 -> 7.6.6 |
| [stub] |
v6.0.0 -> 7.6.6 |
- virtual_link - OSPF virtual link configuration. type: list member_path: area:id/virtual_link:name
more...
| Supported Version Ranges |
| virtual_link |
v6.0.0 -> 7.6.6 |
- authentication - Authentication type. type: str choices: none, text, message-digest, md5
more...
|
Supported Version Ranges |
| authentication |
v6.0.0 -> 7.6.6 |
| [none] |
v6.0.0 -> 7.6.6 |
| [text] |
v6.0.0 -> 7.6.6 |
| [message-digest] |
v7.0.1 -> 7.6.6 |
| [md5] |
v6.0.0 -> v7.0.0 |
- authentication_key - Authentication key. type: str
more...
|
Supported Version Ranges |
| authentication_key |
v6.0.0 -> 7.6.6 |
- dead_interval - Dead interval. type: int
more...
|
Supported Version Ranges |
| dead_interval |
v6.0.0 -> 7.6.6 |
- hello_interval - Hello interval. type: int
more...
|
Supported Version Ranges |
| hello_interval |
v6.0.0 -> 7.6.6 |
- keychain - Message-digest key-chain name. Source router.key-chain.name. type: str
more...
|
Supported Version Ranges |
| keychain |
v7.0.1 -> 7.6.6 |
- md5_key - MD5 key. type: str
more...
|
Supported Version Ranges |
| md5_key |
v6.0.0 -> v6.0.11 |
- md5_keychain - Authentication MD5 key-chain name. Source router.key-chain.name. type: str
more...
|
Supported Version Ranges |
| md5_keychain |
v6.2.0 -> v7.0.0 |
- md5_keys - MD5 key. type: list member_path: area:id/virtual_link:name/md5_keys:id
more...
| Supported Version Ranges |
| md5_keys |
v6.2.0 -> 7.6.6 |
- id - Key ID (1 - 255). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- key_string - Password for the key. type: str
more...
|
Supported Version Ranges |
| key_string |
v6.2.0 -> 7.6.6 |
- name - Virtual link entry name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- peer - Peer IP. type: str
more...
|
Supported Version Ranges |
| peer |
v6.0.0 -> 7.6.6 |
- retransmit_interval - Retransmit interval. type: int
more...
|
Supported Version Ranges |
| retransmit_interval |
v6.0.0 -> 7.6.6 |
- transmit_delay - Transmit delay. type: int
more...
|
Supported Version Ranges |
| transmit_delay |
v6.0.0 -> 7.6.6 |
- auto_cost_ref_bandwidth - Reference bandwidth in terms of megabits per second. type: int
more...
|
Supported Version Ranges |
| auto_cost_ref_bandwidth |
v6.0.0 -> 7.6.6 |
- bfd - Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable
more...
|
Supported Version Ranges |
| bfd |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- database_overflow - Enable/disable database overflow. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| database_overflow |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- database_overflow_max_lsas - Database overflow maximum LSAs. type: int
more...
|
Supported Version Ranges |
| database_overflow_max_lsas |
v6.0.0 -> 7.6.6 |
- database_overflow_time_to_recover - Database overflow time to recover (sec). type: int
more...
|
Supported Version Ranges |
| database_overflow_time_to_recover |
v6.0.0 -> 7.6.6 |
- default_information_metric - Default information metric. type: int
more...
|
Supported Version Ranges |
| default_information_metric |
v6.0.0 -> 7.6.6 |
- default_information_metric_type - Default information metric type. type: str choices: 1, 2
more...
|
Supported Version Ranges |
| default_information_metric_type |
v6.0.0 -> 7.6.6 |
| [1] |
v6.0.0 -> 7.6.6 |
| [2] |
v6.0.0 -> 7.6.6 |
- default_information_originate - Enable/disable generation of default route. type: str choices: enable, always, disable
more...
|
Supported Version Ranges |
| default_information_originate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [always] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- default_information_route_map - Default information route map. Source router.route-map.name. type: str
more...
|
Supported Version Ranges |
| default_information_route_map |
v6.0.0 -> 7.6.6 |
- default_metric - Default metric of redistribute routes. type: int
more...
|
Supported Version Ranges |
| default_metric |
v6.0.0 -> 7.6.6 |
- distance - Distance of the route. type: int
more...
|
Supported Version Ranges |
| distance |
v6.0.0 -> 7.6.6 |
- distance_external - Administrative external distance. type: int
more...
|
Supported Version Ranges |
| distance_external |
v6.0.0 -> 7.6.6 |
- distance_inter_area - Administrative inter-area distance. type: int
more...
|
Supported Version Ranges |
| distance_inter_area |
v6.0.0 -> 7.6.6 |
- distance_intra_area - Administrative intra-area distance. type: int
more...
|
Supported Version Ranges |
| distance_intra_area |
v6.0.0 -> 7.6.6 |
- distribute_list - Distribute list configuration. type: list member_path: distribute_list:id
more...
| Supported Version Ranges |
| distribute_list |
v6.0.0 -> 7.6.6 |
- access_list - Access list name. Source router.access-list.name. type: str
more...
|
Supported Version Ranges |
| access_list |
v6.0.0 -> 7.6.6 |
- id - Distribute list entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- protocol - Protocol type. type: str choices: connected, static, rip
more...
|
Supported Version Ranges |
| protocol |
v6.0.0 -> 7.6.6 |
| [connected] |
v6.0.0 -> 7.6.6 |
| [static] |
v6.0.0 -> 7.6.6 |
| [rip] |
v6.0.0 -> 7.6.6 |
- distribute_list_in - Filter incoming routes. Source router.access-list.name router.prefix-list.name. type: str
more...
|
Supported Version Ranges |
| distribute_list_in |
v6.0.0 -> 7.6.6 |
- distribute_route_map_in - Filter incoming external routes by route-map. Source router.route-map.name. type: str
more...
|
Supported Version Ranges |
| distribute_route_map_in |
v6.0.0 -> 7.6.6 |
- log_neighbour_changes - Log of OSPF neighbor changes. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| log_neighbour_changes |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- lsa_refresh_interval - The minimal OSPF LSA update time interval type: int
more...
|
Supported Version Ranges |
| lsa_refresh_interval |
v7.6.0 -> 7.6.6 |
- neighbor - OSPF neighbor configuration are used when OSPF runs on non-broadcast media. type: list member_path: neighbor:id
more...
| Supported Version Ranges |
| neighbor |
v6.0.0 -> 7.6.6 |
- cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int
more...
|
Supported Version Ranges |
| cost |
v6.0.0 -> 7.6.6 |
- id - Neighbor entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- ip - Interface IP address of the neighbor. type: str
more...
|
Supported Version Ranges |
| ip |
v6.0.0 -> 7.6.6 |
- poll_interval - Poll interval time in seconds. type: int
more...
|
Supported Version Ranges |
| poll_interval |
v6.0.0 -> 7.6.6 |
- priority - Priority. type: int
more...
|
Supported Version Ranges |
| priority |
v6.0.0 -> 7.6.6 |
- network - OSPF network configuration. type: list member_path: network:id
more...
| Supported Version Ranges |
| network |
v6.0.0 -> 7.6.6 |
- area - Attach the network to area. type: str
more...
|
Supported Version Ranges |
| area |
v6.0.0 -> 7.6.6 |
- comments - Comment. type: str
more...
|
Supported Version Ranges |
| comments |
v7.0.0 -> 7.6.6 |
- id - Network entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- prefix - Prefix. type: str
more...
|
Supported Version Ranges |
| prefix |
v6.0.0 -> 7.6.6 |
- ospf_interface - OSPF interface configuration. type: list member_path: ospf_interface:name
more...
| Supported Version Ranges |
| ospf_interface |
v6.0.0 -> 7.6.6 |
- authentication - Authentication type. type: str choices: none, text, message-digest, md5
more...
|
Supported Version Ranges |
| authentication |
v6.0.0 -> 7.6.6 |
| [none] |
v6.0.0 -> 7.6.6 |
| [text] |
v6.0.0 -> 7.6.6 |
| [message-digest] |
v7.0.1 -> 7.6.6 |
| [md5] |
v6.0.0 -> v7.0.0 |
- authentication_key - Authentication key. type: str
more...
|
Supported Version Ranges |
| authentication_key |
v6.0.0 -> 7.6.6 |
- bfd - Bidirectional Forwarding Detection (BFD). type: str choices: global, enable, disable
more...
|
Supported Version Ranges |
| bfd |
v6.0.0 -> 7.6.6 |
| [global] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- comments - Comment. type: str
more...
|
Supported Version Ranges |
| comments |
v7.0.0 -> 7.6.6 |
- cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int
more...
|
Supported Version Ranges |
| cost |
v6.0.0 -> 7.6.6 |
- database_filter_out - Enable/disable control of flooding out LSAs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| database_filter_out |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dead_interval - Dead interval. type: int
more...
|
Supported Version Ranges |
| dead_interval |
v6.0.0 -> 7.6.6 |
- hello_interval - Hello interval. type: int
more...
|
Supported Version Ranges |
| hello_interval |
v6.0.0 -> 7.6.6 |
- hello_multiplier - Number of hello packets within dead interval. type: int
more...
|
Supported Version Ranges |
| hello_multiplier |
v6.0.0 -> 7.6.6 |
- interface - Configuration interface name. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| interface |
v6.0.0 -> 7.6.6 |
- ip - IP address. type: str
more...
|
Supported Version Ranges |
| ip |
v6.0.0 -> 7.6.6 |
- keychain - Message-digest key-chain name. Source router.key-chain.name. type: str
more...
|
Supported Version Ranges |
| keychain |
v7.0.1 -> 7.6.6 |
- linkdown_fast_failover - Enable/disable fast link failover. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| linkdown_fast_failover |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- md5_key - MD5 key. type: str
more...
|
Supported Version Ranges |
| md5_key |
v6.0.0 -> v6.0.11 |
- md5_keychain - Authentication MD5 key-chain name. Source router.key-chain.name. type: str
more...
|
Supported Version Ranges |
| md5_keychain |
v6.2.0 -> v7.0.0 |
- md5_keys - MD5 key. type: list member_path: ospf_interface:name/md5_keys:id
more...
| Supported Version Ranges |
| md5_keys |
v6.2.0 -> 7.6.6 |
- id - Key ID (1 - 255). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- key_string - Password for the key. type: str
more...
|
Supported Version Ranges |
| key_string |
v6.2.0 -> 7.6.6 |
- mtu - MTU for database description packets. type: int
more...
|
Supported Version Ranges |
| mtu |
v6.0.0 -> 7.6.6 |
- mtu_ignore - Enable/disable ignore MTU. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| mtu_ignore |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- name - Interface entry name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- network_type - Network type. type: str choices: broadcast, non-broadcast, point-to-point, point-to-multipoint, point-to-multipoint-non-broadcast
more...
|
Supported Version Ranges |
| network_type |
v6.0.0 -> 7.6.6 |
| [broadcast] |
v6.0.0 -> 7.6.6 |
| [non-broadcast] |
v6.0.0 -> 7.6.6 |
| [point-to-point] |
v6.0.0 -> 7.6.6 |
| [point-to-multipoint] |
v6.0.0 -> 7.6.6 |
| [point-to-multipoint-non-broadcast] |
v6.0.0 -> 7.6.6 |
- prefix_length - Prefix length. type: int
more...
|
Supported Version Ranges |
| prefix_length |
v6.0.0 -> 7.6.6 |
- priority - Priority. type: int
more...
|
Supported Version Ranges |
| priority |
v6.0.0 -> 7.6.6 |
- resync_timeout - Graceful restart neighbor resynchronization timeout. type: int
more...
|
Supported Version Ranges |
| resync_timeout |
v6.0.0 -> 7.6.6 |
- retransmit_interval - Retransmit interval. type: int
more...
|
Supported Version Ranges |
| retransmit_interval |
v6.0.0 -> 7.6.6 |
- status - Enable/disable status. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- transmit_delay - Transmit delay. type: int
more...
|
Supported Version Ranges |
| transmit_delay |
v6.0.0 -> 7.6.6 |
- passive_interface - Passive interface configuration. type: list member_path: passive_interface:name
more...
| Supported Version Ranges |
| passive_interface |
v6.0.0 -> 7.6.6 |
- name - Passive interface name. Source system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- redistribute - Redistribute configuration. type: list member_path: redistribute:name
more...
| Supported Version Ranges |
| redistribute |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- metric - Redistribute metric setting. type: int
more...
|
Supported Version Ranges |
| metric |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- metric_type - Metric type. type: str choices: 1, 2
more...
|
Supported Version Ranges |
| metric_type |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
| [1] |
v6.0.0 -> v7.0.5 |
| [2] |
v6.0.0 -> v7.0.5 |
- name - Redistribute name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- routemap - Route map name. Source router.route-map.name. type: str
more...
|
Supported Version Ranges |
| routemap |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- status - Status. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
| [enable] |
v6.0.0 -> v7.0.5 |
| [disable] |
v6.0.0 -> v7.0.5 |
- tag - Tag value. type: int
more...
|
Supported Version Ranges |
| tag |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- restart_mode - OSPF restart mode (graceful or LLS). type: str choices: none, lls, graceful-restart
more...
|
Supported Version Ranges |
| restart_mode |
v6.0.0 -> 7.6.6 |
| [none] |
v6.0.0 -> 7.6.6 |
| [lls] |
v6.0.0 -> 7.6.6 |
| [graceful-restart] |
v6.0.0 -> 7.6.6 |
- restart_on_topology_change - Enable/disable continuing graceful restart upon topology change. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| restart_on_topology_change |
v7.2.0 -> 7.6.6 |
| [enable] |
v7.2.0 -> 7.6.6 |
| [disable] |
v7.2.0 -> 7.6.6 |
- restart_period - Graceful restart period. type: int
more...
|
Supported Version Ranges |
| restart_period |
v6.0.0 -> 7.6.6 |
- rfc1583_compatible - Enable/disable RFC1583 compatibility. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rfc1583_compatible |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- router_id - Router ID. type: str
more...
|
Supported Version Ranges |
| router_id |
v6.0.0 -> 7.6.6 |
- spf_timers - SPF calculation frequency. type: str
more...
|
Supported Version Ranges |
| spf_timers |
v6.0.0 -> 7.6.6 |
- summary_address - IP address summary configuration. type: list member_path: summary_address:id
more...
| Supported Version Ranges |
| summary_address |
v6.0.0 -> 7.6.6 |
- advertise - Enable/disable advertise status. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| advertise |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- id - Summary address entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- prefix - Prefix. type: str
more...
|
Supported Version Ranges |
| prefix |
v6.0.0 -> 7.6.6 |
- tag - Tag value. type: int
more...
|
Supported Version Ranges |
| tag |
v6.0.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure OSPF.
fortinet.fortios.fortios_router_ospf:
vdom: "{{ vdom }}"
router_ospf:
abr_type: "cisco"
area:
-
authentication: "none"
comments: ""
default_cost: "10"
filter_list:
-
direction: "in"
id: "10"
list: " (source router.access-list.name router.prefix-list.name)"
id: "12"
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: "20"
prefix: ""
substitute: ""
substitute_status: "enable"
shortcut: "disable"
stub_type: "no-summary"
type: "regular"
virtual_link:
-
authentication: "none"
authentication_key: ""
dead_interval: "40"
hello_interval: "10"
keychain: " (source router.key-chain.name)"
md5_key: ""
md5_keychain: " (source router.key-chain.name)"
md5_keys:
-
id: "36"
key_string: ""
name: "default_name_38"
peer: ""
retransmit_interval: "5"
transmit_delay: "1"
auto_cost_ref_bandwidth: "1000"
bfd: "enable"
database_overflow: "enable"
database_overflow_max_lsas: "10000"
database_overflow_time_to_recover: "300"
default_information_metric: "10"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: " (source router.route-map.name)"
default_metric: "10"
distance: "110"
distance_external: "110"
distance_inter_area: "110"
distance_intra_area: "110"
distribute_list:
-
access_list: " (source router.access-list.name)"
id: "58"
protocol: "connected"
distribute_list_in: " (source router.access-list.name router.prefix-list.name)"
distribute_route_map_in: " (source router.route-map.name)"
log_neighbour_changes: "enable"
lsa_refresh_interval: "5"
neighbor:
-
cost: "0"
id: "66"
ip: ""
poll_interval: "10"
priority: "1"
network:
-
area: ""
comments: ""
id: "73"
prefix: ""
ospf_interface:
-
authentication: "none"
authentication_key: ""
bfd: "global"
comments: ""
cost: "0"
database_filter_out: "enable"
dead_interval: "0"
hello_interval: "0"
hello_multiplier: "0"
interface: " (source system.interface.name)"
ip: ""
keychain: " (source router.key-chain.name)"
linkdown_fast_failover: "enable"
md5_key: ""
md5_keychain: " (source router.key-chain.name)"
md5_keys:
-
id: "92"
key_string: ""
mtu: "0"
mtu_ignore: "enable"
name: "default_name_96"
network_type: "broadcast"
prefix_length: "0"
priority: "1"
resync_timeout: "40"
retransmit_interval: "5"
status: "disable"
transmit_delay: "1"
passive_interface:
-
name: "default_name_105 (source system.interface.name)"
redistribute:
-
metric: "0"
metric_type: "1"
name: "default_name_109"
routemap: " (source router.route-map.name)"
status: "enable"
tag: "0"
restart_mode: "none"
restart_on_topology_change: "enable"
restart_period: "120"
rfc1583_compatible: "enable"
router_id: ""
spf_timers: ""
summary_address:
-
advertise: "disable"
id: "121"
prefix: ""
tag: "0"
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:
.. raw:: html
- 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.