fortinet.fortios.fortios_router_static 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 IPv4 静态路由表。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_router_static。

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_static

字典

配置 IPv4 静态路由表。

bfd

字符串

启用/禁用双向转发检测 (BFD)。

选项

  • "enable"

  • "disable"

blackhole

字符串

启用/禁用黑洞。

选项

  • "enable"

  • "disable"

comment

字符串

可选注释。

device

字符串

网关输出接口或隧道。源 system.interface.name。

distance

整数

管理距离 (1 - 255)。

dst

字符串

此路由的目标 IP 和掩码。

dstaddr

字符串

防火墙地址或地址组的名称。源 firewall.address.name firewall.addrgrp.name。

dynamic_gateway

字符串

启用使用从 DHCP 或 PPP 服务器检索的动态网关。

选项

  • "enable"

  • "disable"

gateway

字符串

此路由的网关 IP。

internet_service

整数

Internet 服务数据库中的应用程序 ID。源 firewall.internet-service.id。

internet_service_custom

字符串

Internet 服务自定义数据库中的应用程序名称。源 firewall.internet-service-custom.name。

字符串

当链路监控或运行状况检查关闭时，启用/禁用此静态路由的撤回。

选项

  • "enable"

  • "disable"

preferred_source

字符串

此路由的首选源 IP。

priority

整数

管理优先级 (1 - 65535)。

sdwan

字符串

启用/禁用通过 SD-WAN 出口。

选项

  • "enable"

  • "disable"

sdwan_zone

列表 / 元素=字典

选择 SD-WAN 区域。

name

字符串 / 必填

SD-WAN 区域名称。源 system.sdwan.zone.name。

seq_num

整数 / 必填

序列号。请参阅 注释。

src

字符串

此路由的源前缀。

status

字符串

启用/禁用此静态路由。

选项

  • "enable"

  • "disable"

tag

整数

路由标记。

字符串

启用/禁用通过 virtual-wan-link 出口。

选项

  • "enable"

  • "disable"

vrf

整数

虚拟路由转发 ID。

weight

整数

管理权重 (0 - 255)。

state

字符串 / 必填

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在先前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置为不同的单元并使用。

默认值： "root"

注释

注意

  • 我们强烈建议您使用自己的值作为 seq_num 而不是 0，虽然“0”是一个特殊的占位符，允许后端为对象分配最新的可用编号，但它确实有局限性。请在问答中查找更多详细信息。

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

  • 该模块支持 check_mode。

示例

- name: Configure IPv4 static routing tables.
  fortinet.fortios.fortios_router_static:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_static:
          bfd: "enable"
          blackhole: "enable"
          comment: "Optional comments."
          device: "<your_own_value> (source system.interface.name)"
          distance: "10"
          dst: "<your_own_value>"
          dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          dynamic_gateway: "enable"
          gateway: "<your_own_value>"
          internet_service: "0"
          internet_service_custom: "<your_own_value> (source firewall.internet-service-custom.name)"
          link_monitor_exempt: "enable"
          preferred_source: "<your_own_value>"
          priority: "1"
          sdwan: "enable"
          sdwan_zone:
              -
                  name: "default_name_19 (source system.sdwan.zone.name)"
          seq_num: "<you_own_value>"
          src: "<your_own_value>"
          status: "enable"
          tag: "0"
          virtual_wan_link: "enable"
          vrf: "unspecified"
          weight: "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"

版本

字符串

FortiGate 的版本

返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)