:source: fmgd_router_ospf.py
:orphan:
.. _fmgd_router_ospf:
fmgd_router_ospf -- Configure OSPF.
+++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
access_token -The token to access FortiManager without using username and password. type: strrequired: false
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: boolrequired: false default: False
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: strrequired: false
proposed_method - The overridden method for the underlying Json RPC request. type: strrequired: false choices: set, update, add
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: listrequired: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: listrequired: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: strrequired: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integerrequired: falsedefault: 300
device - The parameter in requested url type: strrequired: true
vdom - The parameter in requested url type: strrequired: true
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
lsa_refresh_interval(Alias name: lsa-refresh-interval) The minimal ospf lsa update time interval type: int more...
Supported Version Ranges: v7.6.0 -> latest
Notes
-----
.. note::
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure OSPF.
fortinet.fmgdevice.fmgd_router_ospf:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
router_ospf:
# abr_type:
# area:
# - authentication:
# comments:
# default_cost:
# filter_list:
# - direction:
# id:
# list:
# id:
# nssa_default_information_originate:
# nssa_default_information_originate_metric:
# nssa_default_information_originate_metric_type:
# nssa_redistribution:
# nssa_translator_role:
# range:
# - advertise:
# id:
# prefix:
# substitute:
# substitute_status:
# shortcut:
# stub_type:
# type:
# virtual_link:
# - authentication:
# authentication_key:
# dead_interval:
# hello_interval:
# keychain:
# md5_keys:
# - id:
# key_string:
# name:
# peer:
# retransmit_interval:
# transmit_delay:
# md5_keychain:
# auto_cost_ref_bandwidth:
# bfd:
# database_overflow:
# database_overflow_max_lsas:
# database_overflow_time_to_recover:
# default_information_metric:
# default_information_metric_type:
# default_information_originate:
# default_information_route_map:
# default_metric:
# distance:
# distance_external:
# distance_inter_area:
# distance_intra_area:
# distribute_list:
# - access_list:
# id:
# protocol:
# distribute_list_in:
# distribute_route_map_in:
# log_neighbour_changes:
# neighbor:
# - cost:
# id:
# ip:
# poll_interval:
# priority:
# network:
# - area:
# comments:
# id:
# prefix:
# ospf_interface:
# - authentication:
# authentication_key:
# bfd:
# comments:
# cost:
# database_filter_out:
# dead_interval:
# hello_interval:
# hello_multiplier:
# interface:
# ip:
# keychain:
# md5_keys:
# - id:
# key_string:
# mtu:
# mtu_ignore:
# name:
# network_type:
# prefix_length:
# priority:
# resync_timeout:
# retransmit_interval:
# status:
# transmit_delay:
# md5_keychain:
# linkdown_fast_failover:
# passive_interface:
# redistribute:
# metric:
# metric_type:
# name:
# routemap:
# status:
# tag:
# restart_mode:
# restart_on_topology_change:
# restart_period:
# rfc1583_compatible:
# router_id:
# spf_timers:
# summary_address:
# - advertise:
# id:
# prefix:
# tag:
# lsa_refresh_interval:
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
meta - The result of the request.returned: alwaystype: dict
request_url - The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code - The status of api request. returned: alwaystype: intsample: 0
response_data - The data body of the api response. returned: optionaltype: list or dict
response_message - The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information - The information of the target system. returned: alwaystype: dict
rc - The status the request. returned: alwaystype: intsample: 0
version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager versiontype: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)