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。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。
要在剧本中使用它，请指定：fortinet.fortios.fortios_router_route_map。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改路由器功能和 route_map 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，需要在使用前调整到数据源。已使用 FOS v6.0.0 测试。
要求
执行此模块的主机需要满足以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选择
|
|
要操作的成员属性路径。 如果存在多个属性，则使用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选择
|
|
配置路由映射。 |
|
可选注释。 |
|
名称。 |
|
规则。 |
|
操作。 选择
|
|
规则 ID。请参阅 <a href=’#notes’>注释</a>。 |
|
匹配 BGP AS 路径列表。源路由器.aspath-list.name。 |
|
匹配 BGP 社区列表。源路由器.community-list.name。 |
|
启用/禁用社区的精确匹配。 选择
|
|
匹配 BGP 扩展社区列表。源路由器.extcommunity-list.name。 |
|
启用/禁用扩展社区的精确匹配。 选择
|
|
要匹配的 BGP 标志值 (0 - 65535) |
|
匹配接口配置。源系统.interface.name。 |
|
匹配访问列表 6 或前缀列表 6 允许的 IPv6 地址。源路由器.access-list6.name 路由器.prefix-list6.name。 |
|
匹配访问列表 6 或前缀列表 6 传递的下一跳 IPv6 地址。源路由器.access-list6.name 路由器.prefix-list6.name。 |
|
匹配访问列表或前缀列表允许的 IP 地址。源路由器.access-list.name 路由器.prefix-list.name。 |
|
匹配访问列表或前缀列表传递的下一跳 IP 地址。源路由器.access-list.name 路由器.prefix-list.name。 |
|
匹配重新分配路由的指标。 |
|
匹配 BGP 起源代码。 选择
|
|
匹配路由类型。 选择
|
|
匹配标签。 |
|
匹配 VRF ID。 |
|
BGP 聚合器 AS。 |
|
BGP 聚合器 IP。 |
|
前置 BGP AS 路径属性。 |
|
AS 号 (0 - 4294967295)。使用引号表示重复数字，例如，“1 1 2”。 |
|
指定 set-aspath 的首选操作。 选择
|
|
启用/禁用 BGP 原子聚合属性。 选择
|
|
BGP 社区属性。 |
|
属性：AA|AA:NN|internet|local-AS|no-advertise|no-export（知名社区需要完全匹配）。 |
|
启用/禁用将 set-community 添加到现有社区。 选择
|
|
删除匹配社区列表的社区。源路由器.community-list.name。 |
|
抑制路由的最大持续时间（1 - 255 分钟，0 = 未设置）。 |
|
惩罚的可达性半衰期（1 - 45 分钟，0 = 未设置）。 |
|
开始重用路由的值（1 - 20000，0 = 未设置）。 |
|
开始抑制路由的值（1 - 20000，0 = 未设置）。 |
|
惩罚的不可达性半衰期（1 - 45 分钟，0 = 未设置）。 |
|
路由目标扩展社区。 |
|
AA:NN。 |
|
源站扩展社区。 |
|
社区（格式 = AA:NN）。 |
|
BGP 标志值（0 - 65535）。 |
|
下一跳的 IPv6 全局地址。 |
|
下一跳的 IPv6 本地地址。 |
|
下一跳的 IP 地址。 |
|
首选源的 IP 地址。 |
|
BGP 本地首选路径属性。 |
|
度量值。 |
|
度量类型。 选择
|
|
BGP 源代码。 选择
|
|
BGP 发起者 ID 属性。 |
|
路由表的优先级。 |
|
路由表的路由标签。 |
|
标签值。 |
|
VPNv4 下一跳的 IP 地址。 |
|
VPNv6 下一跳的 IPv6 全局地址。 |
|
VPNv6 下一跳的 IPv6 链路本地地址。 |
|
路由表的 BGP 权重。 |
|
指示是创建还是删除对象。 选择
|
|
虚拟域，在之前定义的那些之中。vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。 默认值： |
注释
注意
遗留的 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: ""
返回值
通用返回值记录在 这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
Fortigate 镜像的构建版本号 返回： 始终 示例： |
|
上次用于将内容配置到 FortiGate 中的方法 返回： 始终 示例： |
|
FortiGate 在上次应用的操作中给出的最后结果 返回： 始终 示例： |
|
上次调用 FortiGate 时使用的主键 (id) 返回： 成功 示例： |
|
用于满足请求的表名 返回： 始终 示例： |
|
用于满足请求的表的路径 返回： 始终 示例： |
|
内部修订号 返回： 始终 示例： |
|
设备的序列号 返回： 始终 示例： |
|
操作结果的指示 返回： 始终 示例： |
|
使用的虚拟域 返回： 始终 示例： |
|
FortiGate 的版本 返回： 始终 示例： |