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。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在剧本中使用它，请指定： 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

字符串

网关出接口或隧道。源系统.接口.名称。

distance

整数

管理距离 (1 - 255)。

dst

字符串

此路由的目标 IP 和掩码。

dstaddr

字符串

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

dynamic_gateway

字符串

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

选项

  • "enable"

  • "disable"

gateway

字符串

此路由的网关 IP。

internet_service

整数

互联网服务数据库中的应用程序 ID。源防火墙.internet-service.id。

internet_service_custom

字符串

互联网服务自定义数据库中的应用程序名称。源防火墙.internet-service-custom.name。

字符串

启用/禁用在链路监视器或运行状况检查关闭时撤销此静态路由。

选项

  • "enable"

  • "disable"

preferred_source

字符串

此路由的首选源 IP。

priority

整数

管理优先级 (1 - 65535)。

sdwan

字符串

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

选项

  • "enable"

  • "disable"

sdwan_zone

列表 / 元素=字典

选择 SD-WAN 区域。

name

字符串 / 必需

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

seq_num

整数 / 必需

序列号。请参见 备注。

src

字符串

此路由的源前缀。

status

字符串

启用/禁用此静态路由。

选项

  • "enable"

  • "disable"

tag

整数

路由标签。

字符串

启用/禁用通过虚拟 WAN 链路出站。

选项

  • "enable"

  • "disable"

vrf

整数

虚拟路由转发 ID。

weight

整数

管理权重 (0 - 255)。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

备注

注意

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

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

  • 该模块支持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"

version

字符串

FortiGate的版本

返回值：始终返回

示例： "v5.6.3"

作者

  • 郑连 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪滨 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • 米格尔·安赫尔·穆诺兹 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)