fortinet.fortios.fortios_router_route_map 模块 – 在 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_route_map。

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置路由映射。

comments

字符串

可选注释。

name

字符串 / 必需

名称。

rule

列表 / 元素=字典

规则。

action

字符串

动作。

选项

  • "permit"

  • "deny"

id

整数 / 必需

规则 ID。参见 注释。

match_as_path

字符串

匹配 BGP AS 路径列表。源 router.aspath-list.name。

match_community

字符串

匹配 BGP 社区列表。源 router.community-list.name。

match_community_exact

字符串

启用/禁用社区的精确匹配。

选项

  • "enable"

  • "disable"

match_extcommunity

字符串

匹配 BGP 扩展社区列表。源 router.extcommunity-list.name。

match_extcommunity_exact

字符串

启用/禁用扩展社区的精确匹配。

选项

  • "enable"

  • "disable"

match_flags

整数

要匹配的 BGP 标志值 (0 - 65535)

match_interface

字符串

匹配接口配置。源 system.interface.name。

match_ip6_address

字符串

匹配 access-list6 或 prefix-list6 允许的 IPv6 地址。源 router.access-list6.name router.prefix-list6.name。

match_ip6_nexthop

字符串

匹配 access-list6 或 prefix-list6 传递的下一跳 IPv6 地址。源 router.access-list6.name router.prefix-list6.name。

match_ip_address

字符串

匹配 access-list 或 prefix-list 允许的 IP 地址。源 router.access-list.name router.prefix-list.name。

match_ip_nexthop

字符串

匹配 access-list 或 prefix-list 传递的下一跳 IP 地址。源 router.access-list.name router.prefix-list.name。

match_metric

整数

匹配重新分发路由的度量。

match_origin

字符串

匹配 BGP 源代码。

选项

  • "none"

  • "egp"

  • "igp"

  • "incomplete"

match_route_type

字符串

匹配路由类型。

选项

  • "external-type1"

  • "external-type2"

  • "none"

  • "1"

  • "2"

match_tag

整数

匹配标签。

match_vrf

整数

匹配 VRF ID。

set_aggregator_as

整数

BGP 聚合器 AS。

set_aggregator_ip

字符串

BGP 聚合器 IP。

set_aspath

列表 / 元素=字典

预先添加 BGP AS 路径属性。

as

字符串 / 必需

AS 号码 (0 - 4294967295)。对于重复的数字使用引号，例如，“1 1 2”。

set_aspath_action

字符串

指定 set-aspath 的首选操作。

选项

  • "prepend"

  • "replace"

set_atomic_aggregate

字符串

启用/禁用 BGP 原子聚合属性。

选项

  • "enable"

  • "disable"

set_community

列表 / 元素=字典

BGP 社区属性。

community

字符串 / 必需

属性：AA|AA:NN|internet|local-AS|no-advertise|no-export（知名社区需要精确匹配）。

set_community_additive

字符串

启用/禁用将 set-community 添加到现有社区。

选项

  • "enable"

  • "disable"

set_community_delete

字符串

删除与社区列表匹配的社区。源 router.community-list.name。

set_dampening_max_suppress

整数

抑制路由的最大持续时间 (1 - 255 分钟，0 = 未设置)。

set_dampening_reachability_half_life

整数

惩罚的可达性半衰期 (1 - 45 分钟，0 = 未设置)。

set_dampening_reuse

整数

开始重新使用路由的值 (1 - 20000，0 = 未设置)。

set_dampening_suppress

整数

开始抑制路由的值 (1 - 20000，0 = 未设置)。

set_dampening_unreachability_half_life

整数

惩罚的不可达性半衰期 (1 - 45 分钟，0 = 未设置)。

set_extcommunity_rt

列表 / 元素=字典

路由目标扩展社区。

community

字符串 / 必需

AA:NN。

set_extcommunity_soo

列表 / 元素=字典

源站点扩展社区。

community

字符串 / 必需

社区（格式 = AA:NN）。

set_flags

整数

BGP 标志值 (0 - 65535)

set_ip6_nexthop

字符串

下一跳的 IPv6 全局地址。

set_ip6_nexthop_local

字符串

下一跳的 IPv6 本地地址。

set_ip_nexthop

字符串

下一跳的 IP 地址。

set_ip_prefsrc

字符串

首选源的 IP 地址。

set_local_preference

整数

BGP 本地首选路径属性。

set_metric

整数

度量值。

set_metric_type

字符串

度量类型。

选项

  • "external-type1"

  • "external-type2"

  • "none"

  • "1"

  • "2"

set_origin

字符串

BGP 源代码。

选项

  • "none"

  • "egp"

  • "igp"

  • "incomplete"

set_originator_id

字符串

BGP 发起者 ID 属性。

set_priority

整数

路由表的优先级。

set_route_tag

整数

路由表的路由标签。

set_tag

整数

标签值。

set_vpnv4_nexthop

字符串

VPNv4 下一跳的 IP 地址。

set_vpnv6_nexthop

字符串

VPNv6 下一跳的 IPv6 全局地址。

set_vpnv6_nexthop_local

字符串

VPNv6 下一跳的 IPv6 链路本地地址。

set_weight

整数

路由表的 BGP 权重。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

注释

注意

  • 已弃用旧版 fortiosapi，推荐使用 httpapi 运行 playbook

  • 该模块支持 check_mode。

示例

- name: Configure route maps.
  fortinet.fortios.fortios_router_route_map:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_route_map:
          comments: "<your_own_value>"
          name: "default_name_4"
          rule:
              -
                  action: "permit"
                  id: "7"
                  match_as_path: "<your_own_value> (source router.aspath-list.name)"
                  match_community: "<your_own_value> (source router.community-list.name)"
                  match_community_exact: "enable"
                  match_extcommunity: "<your_own_value> (source router.extcommunity-list.name)"
                  match_extcommunity_exact: "enable"
                  match_flags: "32767"
                  match_interface: "<your_own_value> (source system.interface.name)"
                  match_ip_address: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  match_ip_nexthop: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  match_ip6_address: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
                  match_ip6_nexthop: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
                  match_metric: ""
                  match_origin: "none"
                  match_route_type: "external-type1"
                  match_tag: ""
                  match_vrf: ""
                  set_aggregator_as: "0"
                  set_aggregator_ip: "<your_own_value>"
                  set_aspath:
                      -
                          as: "<your_own_value>"
                  set_aspath_action: "prepend"
                  set_atomic_aggregate: "enable"
                  set_community:
                      -
                          community: "<your_own_value>"
                  set_community_additive: "enable"
                  set_community_delete: "<your_own_value> (source router.community-list.name)"
                  set_dampening_max_suppress: "0"
                  set_dampening_reachability_half_life: "0"
                  set_dampening_reuse: "0"
                  set_dampening_suppress: "0"
                  set_dampening_unreachability_half_life: "0"
                  set_extcommunity_rt:
                      -
                          community: "<your_own_value>"
                  set_extcommunity_soo:
                      -
                          community: "<your_own_value>"
                  set_flags: "32767"
                  set_ip_nexthop: "<your_own_value>"
                  set_ip_prefsrc: "<your_own_value>"
                  set_ip6_nexthop: "<your_own_value>"
                  set_ip6_nexthop_local: "<your_own_value>"
                  set_local_preference: ""
                  set_metric: ""
                  set_metric_type: "external-type1"
                  set_origin: "none"
                  set_originator_id: "<your_own_value>"
                  set_priority: ""
                  set_route_tag: ""
                  set_tag: ""
                  set_vpnv4_nexthop: "<your_own_value>"
                  set_vpnv6_nexthop: "<your_own_value>"
                  set_vpnv6_nexthop_local: "<your_own_value>"
                  set_weight: ""

返回值

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

键

描述

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)