fortinet.fortios.fortios_router_ospf 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 OSPF。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

要在剧本中使用它，请指定：fortinet.fortios.fortios_router_ospf。

fortinet.fortios 2.0.0 中的新增功能

概要

• 此模块能够通过允许用户设置和修改路由器功能和 ospf 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
member_path 字符串	要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
router_ospf 字典	配置 OSPF。
abr_type 字符串	区域边界路由器类型。 选项 "cisco" "ibm" "shortcut" "standard"
area 列表 / 元素=字典	OSPF 区域配置。
authentication 字符串	身份验证类型。 选项 "none" "text" "message-digest" "md5"
comments 字符串	注释。
default_cost 整数	存根或 NSSA 区域的摘要默认成本。
filter_list 列表 / 元素=字典	OSPF 区域过滤器列表配置。
direction 字符串	方向。 选项 "in" "out"
id 整数 / 必需	过滤器列表条目 ID。请参见 注释。
list 字符串	访问列表或前缀列表名称。来源 router.access-list.name router.prefix-list.name。
id 字符串 / 必需	区域条目 IP 地址。
nssa_default_information_originate 字符串	重新分发、通告或不将类型 7 默认路由引入 NSSA 区域。 选项 "enable" "always" "disable"
nssa_default_information_originate_metric 整数	OSPF 默认度量。
nssa_default_information_originate_metric_type 字符串	默认路由的 OSPF 度量类型。 选项 "1" "2"
nssa_redistribution 字符串	启用/禁用重新分发到 NSSA 区域。 选项 "enable" "disable"
nssa_translator_role 字符串	NSSA 转换器角色类型。 选项 "candidate" "never" "always"
range 列表 / 元素=字典	OSPF 区域范围配置。
advertise 字符串	启用/禁用通告状态。 选项 "disable" "enable"
id 整数 / 必需	范围条目 ID。请参见 注释。
prefix 字符串	前缀。
substitute 字符串	替换前缀。
substitute_status 字符串	启用/禁用替换状态。 选项 "enable" "disable"
shortcut 字符串	启用/禁用快捷方式选项。 选项 "disable" "enable" "default"
stub_type 字符串	存根摘要设置。 选项 "no-summary" "summary"
type 字符串	区域类型设置。 选项 "regular" "nssa" "stub"
virtual_link 列表 / 元素=字典	OSPF 虚拟链路配置。
authentication 字符串	身份验证类型。 选项 "none" "text" "message-digest" "md5"
authentication_key 字符串	身份验证密钥。
dead_interval 整数	失效间隔。
hello_interval 整数	Hello 间隔。
keychain 字符串	消息摘要密钥链名称。来源 router.key-chain.name。
md5_key 字符串	MD5 密钥。
md5_keychain 字符串	身份验证 MD5 密钥链名称。来源 router.key-chain.name。
md5_keys 列表 / 元素=字典	MD5 密钥。
id 整数 / 必需	密钥 ID (1 - 255)。请参见 注释。
key_string 字符串	密钥密码。
name 字符串 / 必需	虚拟链路条目名称。
peer 字符串	对等 IP。
retransmit_interval 整数	重传间隔。
transmit_delay 整数	传输延迟。
auto_cost_ref_bandwidth 整数	以兆比特每秒为单位的参考带宽。
bfd 字符串	双向转发检测 (BFD)。 选项 "enable" "disable"
database_overflow 字符串	启用/禁用数据库溢出。 选项 "enable" "disable"
database_overflow_max_lsas 整数	数据库溢出最大 LSA。
database_overflow_time_to_recover 整数	数据库溢出恢复时间 (秒)。
default_information_metric 整数	默认信息度量。
default_information_metric_type 字符串	默认信息度量类型。 选项 "1" "2"
default_information_originate 字符串	启用/禁用默认路由的生成。 选项 "enable" "always" "disable"
default_information_route_map 字符串	默认信息路由映射。来源 router.route-map.name。
default_metric 整数	重新分发路由的默认度量。
distance 整数	路由的距离。
distance_external 整数	管理外部距离。
distance_inter_area 整数	管理区域间距离。
distance_intra_area 整数	管理区域内距离。
distribute_list 列表 / 元素=字典	分发列表配置。
access_list 字符串	访问列表名称。来源 router.access-list.name。
id 整数 / 必需	分发列表条目 ID。请参见 注释。
protocol 字符串	协议类型。 选项 "connected" "static" "rip"
distribute_list_in 字符串	过滤传入路由。来源 router.access-list.name router.prefix-list.name。
distribute_route_map_in 字符串	通过路由映射过滤传入的外部路由。来源 router.route-map.name。
log_neighbour_changes 字符串	OSPF 邻居更改日志。 选项 "enable" "disable"
lsa_refresh_interval 整数	最小的 OSPF LSA 更新时间间隔
neighbor 列表 / 元素=字典	当 OSPF 在非广播媒体上运行时使用 OSPF 邻居配置。
cost 整数	接口的成本，值范围为 0 到 65535，0 表示自动成本。
id 整数 / 必需	邻居条目 ID。请参见 注释。
ip 字符串	邻居接口的IP地址。
poll_interval 整数	轮询间隔时间（秒）。
priority 整数	优先级。
network 列表 / 元素=字典	OSPF网络配置。
area 字符串	将网络连接到区域。
comments 字符串	注释。
id 整数 / 必需	网络入口ID。参见注释。
prefix 字符串	前缀。
ospf_interface 列表 / 元素=字典	OSPF接口配置。
authentication 字符串	身份验证类型。 选项 "none" "text" "message-digest" "md5"
authentication_key 字符串	身份验证密钥。
bfd 字符串	双向转发检测 (BFD)。 选项 "global" "enable" "disable"
comments 字符串	注释。
cost 整数	接口的成本，值范围为 0 到 65535，0 表示自动成本。
database_filter_out 字符串	启用/禁用对泛洪输出LSA的控制。 选项 "enable" "disable"
dead_interval 整数	失效间隔。
hello_interval 整数	Hello 间隔。
hello_multiplier 整数	死时间间隔内的hello数据包数量。
interface 字符串	配置接口名称。来源：system.interface.name。
ip 字符串	IP地址。
keychain 字符串	消息摘要密钥链名称。来源 router.key-chain.name。
linkdown_fast_failover 字符串	启用/禁用快速链路故障转移。 选项 "enable" "disable"
md5_key 字符串	MD5 密钥。
md5_keychain 字符串	身份验证 MD5 密钥链名称。来源 router.key-chain.name。
md5_keys 列表 / 元素=字典	MD5 密钥。
id 整数 / 必需	密钥 ID (1 - 255)。请参见 注释。
key_string 字符串	密钥密码。
mtu 整数	数据库描述数据包的MTU。
mtu_ignore 字符串	启用/禁用忽略MTU。 选项 "enable" "disable"
name 字符串 / 必需	接口条目名称。
network_type 字符串	网络类型。 选项 "broadcast" "非广播" "点到点" "点到多点" "点到多点非广播"
prefix_length 整数	前缀长度。
priority 整数	优先级。
resync_timeout 整数	优雅重启邻居重新同步超时。
retransmit_interval 整数	重传间隔。
status 字符串	启用/禁用状态。 选项 "disable" "enable"
transmit_delay 整数	传输延迟。
passive_interface 列表 / 元素=字典	被动接口配置。
name 字符串 / 必需	被动接口名称。来源：system.interface.name。
redistribute 列表 / 元素=字典	重新分发配置。
metric 整数	重新分发度量设置。
metric_type 字符串	度量类型。 选项 "1" "2"
name 字符串 / 必需	重新分发名称。
routemap 字符串	路由映射名称。来源：router.route-map.name。
status 字符串	状态。 选项 "enable" "disable"
tag 整数	标签值。
restart_mode 字符串	OSPF重启模式（优雅重启或LLS）。 选项 "none" "lls" "graceful-restart"
restart_on_topology_change 字符串	启用/禁用在拓扑更改时继续优雅重启。 选项 "enable" "disable"
restart_period 整数	优雅重启周期。
rfc1583_compatible 字符串	启用/禁用RFC1583兼容性。 选项 "enable" "disable"
router_id 字符串	路由器ID。
spf_timers 字符串	SPF计算频率。
summary_address 列表 / 元素=字典	IP地址汇总配置。
advertise 字符串	启用/禁用通告状态。 选项 "disable" "enable"
id 整数 / 必需	汇总地址入口ID。参见注释。
prefix 字符串	前缀。
tag 整数	标签值。
vdom 字符串	虚拟域，在之前定义的虚拟域中。vdom是FortiGate的虚拟实例，可以配置并用作不同的单元。 默认值： "root"

注释

注意

• 已弃用旧版fortiosapi，httpapi是运行playbook的首选方法。

示例

- name: Configure OSPF.
  fortinet.fortios.fortios_router_ospf:
      vdom: "{{ vdom }}"
      router_ospf:
          abr_type: "cisco"
          area:
              -
                  authentication: "none"
                  comments: "<your_own_value>"
                  default_cost: "10"
                  filter_list:
                      -
                          direction: "in"
                          id: "10"
                          list: "<your_own_value> (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: "<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: "40"
                          hello_interval: "10"
                          keychain: "<your_own_value> (source router.key-chain.name)"
                          md5_key: "<your_own_value>"
                          md5_keychain: "<your_own_value> (source router.key-chain.name)"
                          md5_keys:
                              -
                                  id: "36"
                                  key_string: "<your_own_value>"
                          name: "default_name_38"
                          peer: "<your_own_value>"
                          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: "<your_own_value> (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: "<your_own_value> (source router.access-list.name)"
                  id: "58"
                  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"
          lsa_refresh_interval: "5"
          neighbor:
              -
                  cost: "0"
                  id: "66"
                  ip: "<your_own_value>"
                  poll_interval: "10"
                  priority: "1"
          network:
              -
                  area: "<your_own_value>"
                  comments: "<your_own_value>"
                  id: "73"
                  prefix: "<your_own_value>"
          ospf_interface:
              -
                  authentication: "none"
                  authentication_key: "<your_own_value>"
                  bfd: "global"
                  comments: "<your_own_value>"
                  cost: "0"
                  database_filter_out: "enable"
                  dead_interval: "0"
                  hello_interval: "0"
                  hello_multiplier: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  ip: "<your_own_value>"
                  keychain: "<your_own_value> (source router.key-chain.name)"
                  linkdown_fast_failover: "enable"
                  md5_key: "<your_own_value>"
                  md5_keychain: "<your_own_value> (source router.key-chain.name)"
                  md5_keys:
                      -
                          id: "92"
                          key_string: "<your_own_value>"
                  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: "<your_own_value> (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: "<your_own_value>"
          spf_timers: "<your_own_value>"
          summary_address:
              -
                  advertise: "disable"
                  id: "121"
                  prefix: "<your_own_value>"
                  tag: "0"

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
build 字符串	FortiGate镜像的版本号 返回： 始终 示例： "1547"
http_method 字符串	上次用于将内容置备到FortiGate的方法 返回： 始终 示例： "PUT"
http_status 字符串	FortiGate在上次应用的操作中给出的最后结果 返回： 始终 示例： "200"
mkey 字符串	上次调用FortiGate时使用的主密钥（ID） 返回： 成功 示例： "id"
name 字符串	用于完成请求的表的名称 返回： 始终 示例： "urlfilter"
path 字符串	用于完成请求的表的路径 返回： 始终 示例： "webfilter"
revision 字符串	内部修订号 返回： 始终 示例： "17.0.2.10658"
serial 字符串	设备的序列号 返回： 始终 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 返回： 始终 示例： "success"
vdom 字符串	使用的虚拟域 返回： 始终 示例： "root"
version 字符串	FortiGate的版本 返回： 始终 示例： "v5.6.3"

作者

• 郑凌 (@chillancezen)

• 薛杰 (@JieX19)

• 卢洪滨 (@fgtdev-hblu)

• 沈方 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

收藏链接

• 问题追踪器
• 主页
• 代码库（源代码）