fortios_router_ospf – Configure OSPF in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.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_ospf - Configure OSPF. type: dict
- abr_type - Area border router type. type: str choices: cisco, ibm, shortcut, standard
- area - OSPF area configuration. type: list
- authentication - Authentication type. type: str choices: none, text, md5
- default_cost - Summary default cost of stub or NSSA area. type: int
- filter_list - OSPF area filter-list configuration. type: list
- direction - Direction. type: str choices: in, out
- id - Filter list entry ID. type: int required: True
- list - Access-list or prefix-list name. Source router.access-list.name router.prefix-list.name. type: str
- id - Area entry IP address. type: str required: True
- nssa_default_information_originate - Redistribute, advertise, or do not originate Type-7 default route into NSSA area. type: str choices: enable, always, disable
- nssa_default_information_originate_metric - OSPF default metric. type: int
- nssa_default_information_originate_metric_type - OSPF 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 - OSPF area range configuration. type: list
- advertise - Enable/disable advertise status. type: str choices: disable, enable
- id - Range entry ID. type: int required: True
- prefix - Prefix. type: str
- substitute - Substitute prefix. type: str
- substitute_status - Enable/disable substitute status. type: str choices: enable, disable
- shortcut - Enable/disable shortcut option. type: str choices: disable, enable, default
- stub_type - Stub summary setting. type: str choices: no-summary, summary
- type - Area type setting. type: str choices: regular, nssa, stub
- virtual_link - OSPF virtual link configuration. type: list
- authentication - Authentication type. type: str choices: none, text, md5
- authentication_key - Authentication key. type: str
- dead_interval - Dead interval. type: int
- hello_interval - Hello interval. type: int
- md5_key - MD5 key. type: str
- name - Virtual link entry name. type: str required: True
- peer - Peer IP. 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 - Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable
- database_overflow - Enable/disable database overflow. type: str choices: enable, disable
- database_overflow_max_lsas - Database overflow maximum LSAs. type: int
- database_overflow_time_to_recover - Database overflow time to recover (sec). type: int
- 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
- distance - Distance of the route. type: int
- distance_external - Administrative external distance. type: int
- distance_inter_area - Administrative inter-area distance. type: int
- distance_intra_area - Administrative intra-area distance. type: int
- distribute_list - Distribute list configuration. type: list
- access_list - Access list name. Source router.access-list.name. type: str
- id - Distribute list entry ID. type: int required: True
- protocol - Protocol type. type: str choices: connected, static, rip
- distribute_list_in - Filter incoming routes. Source router.access-list.name router.prefix-list.name. type: str
- distribute_route_map_in - Filter incoming external routes by route-map. Source router.route-map.name. type: str
- log_neighbour_changes - Enable logging of OSPF neighbour"s changes type: str choices: enable, disable
- neighbor - OSPF neighbor configuration are used when OSPF runs on non-broadcast media type: list
- cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int
- id - Neighbor entry ID. type: int required: True
- ip - Interface IP address of the neighbor. type: str
- poll_interval - Poll interval time in seconds. type: int
- priority - Priority. type: int
- network - OSPF network configuration. type: list
- area - Attach the network to area. type: str
- id - Network entry ID. type: int required: True
- prefix - Prefix. type: str
- ospf_interface - OSPF interface configuration. type: list
- authentication - Authentication type. type: str choices: none, text, md5
- authentication_key - Authentication key. type: str
- bfd - 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
- database_filter_out - Enable/disable control of flooding out LSAs. type: str choices: enable, disable
- dead_interval - Dead interval. type: int
- hello_interval - Hello interval. type: int
- hello_multiplier - Number of hello packets within dead interval. type: int
- interface - Configuration interface name. Source system.interface.name. type: str
- ip - IP address. type: str
- md5_key - MD5 key. type: str
- mtu - MTU for database description packets. type: int
- mtu_ignore - Enable/disable ignore MTU. type: str choices: enable, disable
- name - Interface entry name. type: str required: True
- network_type - Network type. type: str choices: broadcast, non-broadcast, point-to-point, point-to-multipoint, point-to-multipoint-non-broadcast
- prefix_length - Prefix length. type: int
- priority - Priority. type: int
- resync_timeout - Graceful restart neighbor resynchronization timeout. type: int
- retransmit_interval - Retransmit interval. type: int
- status - Enable/disable status. 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
- tag - Tag value. type: int
- restart_mode - OSPF restart mode (graceful or LLS). type: str choices: none, lls, graceful-restart
- restart_period - Graceful restart period. type: int
- rfc1583_compatible - Enable/disable RFC1583 compatibility. type: str choices: enable, disable
- router_id - Router ID. type: str
- spf_timers - SPF calculation frequency. type: str
- summary_address - IP address summary configuration. type: list
- advertise - Enable/disable advertise status. type: str choices: disable, enable
- id - Summary address entry ID. type: int required: True
- prefix - Prefix. type: str
- tag - Tag value. type: int
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 OSPF.
fortios_router_ospf:
vdom: "{{ vdom }}"
router_ospf:
abr_type: "cisco"
area:
-
authentication: "none"
default_cost: "6"
filter_list:
-
direction: "in"
id: "9"
list: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
id: "11"
nssa_default_information_originate: "enable"
nssa_default_information_originate_metric: "13"
nssa_default_information_originate_metric_type: "1"
nssa_redistribution: "enable"
nssa_translator_role: "candidate"
range:
-
advertise: "disable"
id: "19"
prefix: "<your_own_value>"
substitute: "<your_own_value>"
substitute_status: "enable"
shortcut: "disable"
stub_type: "no-summary"
type: "regular"
virtual_link:
-
authentication: "none"
authentication_key: "<your_own_value>"
dead_interval: "29"
hello_interval: "30"
md5_key: "<your_own_value>"
name: "default_name_32"
peer: "<your_own_value>"
retransmit_interval: "34"
transmit_delay: "35"
auto_cost_ref_bandwidth: "36"
bfd: "enable"
database_overflow: "enable"
database_overflow_max_lsas: "39"
database_overflow_time_to_recover: "40"
default_information_metric: "41"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: "<your_own_value> (source router.route-map.name)"
default_metric: "45"
distance: "46"
distance_external: "47"
distance_inter_area: "48"
distance_intra_area: "49"
distribute_list:
-
access_list: "<your_own_value> (source router.access-list.name)"
id: "52"
protocol: "connected"
distribute_list_in: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
distribute_route_map_in: "<your_own_value> (source router.route-map.name)"
log_neighbour_changes: "enable"
neighbor:
-
cost: "58"
id: "59"
ip: "<your_own_value>"
poll_interval: "61"
priority: "62"
network:
-
area: "<your_own_value>"
id: "65"
prefix: "<your_own_value>"
ospf_interface:
-
authentication: "none"
authentication_key: "<your_own_value>"
bfd: "global"
cost: "71"
database_filter_out: "enable"
dead_interval: "73"
hello_interval: "74"
hello_multiplier: "75"
interface: "<your_own_value> (source system.interface.name)"
ip: "<your_own_value>"
md5_key: "<your_own_value>"
mtu: "79"
mtu_ignore: "enable"
name: "default_name_81"
network_type: "broadcast"
prefix_length: "83"
priority: "84"
resync_timeout: "85"
retransmit_interval: "86"
status: "disable"
transmit_delay: "88"
passive_interface:
-
name: "default_name_90 (source system.interface.name)"
redistribute:
-
metric: "92"
metric_type: "1"
name: "default_name_94"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
tag: "97"
restart_mode: "none"
restart_period: "99"
rfc1583_compatible: "enable"
router_id: "<your_own_value>"
spf_timers: "<your_own_value>"
summary_address:
-
advertise: "disable"
id: "105"
prefix: "<your_own_value>"
tag: "107"
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