fortinet.fortios.fortios_router_setting 模块 – 配置 Fortinet 的 FortiOS 和 FortiGate 中的路由器设置。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_router_setting

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改路由器功能和设置类别来配置 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_setting

字典

配置路由器设置。

bgp_debug_flags

字符串

bgp_debug_flags

hostname

字符串

此虚拟域路由器的主机名。

igmp_debug_flags

字符串

igmp_debug_flags

imi_debug_flags

字符串

imi_debug_flags

isis_debug_flags

字符串

isis_debug_flags

kernel_route_distance

整数

从内核学习的路由的管理距离 (0 - 255)。

ospf6_debug_events_flags

字符串

ospf6_debug_events_flags

ospf6_debug_ifsm_flags

字符串

ospf6_debug_ifsm_flags

ospf6_debug_lsa_flags

字符串

ospf6_debug_lsa_flags

ospf6_debug_nfsm_flags

字符串

ospf6_debug_nfsm_flags

ospf6_debug_nsm_flags

字符串

ospf6_debug_nsm_flags

ospf6_debug_packet_flags

字符串

ospf6_debug_packet_flags

ospf6_debug_route_flags

字符串

ospf6_debug_route_flags

ospf_debug_events_flags

字符串

ospf_debug_events_flags

ospf_debug_ifsm_flags

字符串

ospf_debug_ifsm_flags

ospf_debug_lsa_flags

字符串

ospf_debug_lsa_flags

ospf_debug_nfsm_flags

字符串

ospf_debug_nfsm_flags

ospf_debug_nsm_flags

字符串

ospf_debug_nsm_flags

ospf_debug_packet_flags

字符串

ospf_debug_packet_flags

ospf_debug_route_flags

字符串

ospf_debug_route_flags

pimdm_debug_flags

字符串

pimdm_debug_flags

pimsm_debug_joinprune_flags

字符串

pimsm_debug_joinprune_flags

pimsm_debug_simple_flags

字符串

pimsm_debug_simple_flags

pimsm_debug_timer_flags

字符串

pimsm_debug_timer_flags

rip_debug_flags

字符串

rip_debug_flags

ripng_debug_flags

字符串

ripng_debug_flags

show_filter

字符串

作为显示路由的过滤器的前缀列表。源路由器.prefix-list.name。

vdom

字符串

虚拟域,在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。

默认值: "root"

注释

注意

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

示例

- name: Configure router settings.
  fortinet.fortios.fortios_router_setting:
      vdom: "{{ vdom }}"
      router_setting:
          bgp_debug_flags: "<your_own_value>"
          hostname: "myhostname"
          igmp_debug_flags: "<your_own_value>"
          imi_debug_flags: "<your_own_value>"
          isis_debug_flags: "<your_own_value>"
          kernel_route_distance: "255"
          ospf_debug_events_flags: "<your_own_value>"
          ospf_debug_ifsm_flags: "<your_own_value>"
          ospf_debug_lsa_flags: "<your_own_value>"
          ospf_debug_nfsm_flags: "<your_own_value>"
          ospf_debug_nsm_flags: "<your_own_value>"
          ospf_debug_packet_flags: "<your_own_value>"
          ospf_debug_route_flags: "<your_own_value>"
          ospf6_debug_events_flags: "<your_own_value>"
          ospf6_debug_ifsm_flags: "<your_own_value>"
          ospf6_debug_lsa_flags: "<your_own_value>"
          ospf6_debug_nfsm_flags: "<your_own_value>"
          ospf6_debug_nsm_flags: "<your_own_value>"
          ospf6_debug_packet_flags: "<your_own_value>"
          ospf6_debug_route_flags: "<your_own_value>"
          pimdm_debug_flags: "<your_own_value>"
          pimsm_debug_joinprune_flags: "<your_own_value>"
          pimsm_debug_simple_flags: "<your_own_value>"
          pimsm_debug_timer_flags: "<your_own_value>"
          rip_debug_flags: "<your_own_value>"
          ripng_debug_flags: "<your_own_value>"
          show_filter: "<your_own_value> (source router.prefix-list.name)"

返回值

常用返回值已在此处记录 此处,以下是此模块独有的字段。

描述

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"

状态

字符串

操作结果指示

返回:始终

示例: "success"

vdom

字符串

使用的虚拟域

返回:始终

示例: "root"

版本

字符串

FortiGate 版本

返回:始终

示例: "v5.6.3"

作者

  • 郑 linkage (@chillancezen)

  • 薛洁 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)