fortinet.fortios.fortios_router_multicast 模块 – 配置 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_multicast。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改路由器功能和组播类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 FortiGate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性，则由斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项
|
|
配置路由器组播。 |
|
PIM 接口。 |
|
启用/禁用协议无关组播 (PIM) 双向转发检测 (BFD)。 选项
|
|
从 hello 数据包中排除 GenID（与旧的 Cisco IOS 兼容）。 选项
|
|
DR 选举优先级。 |
|
旧邻居信息过期之前的时间（0-65535 秒）。 |
|
发送 PIM hello 消息的间隔（0-65535 秒）。 |
|
IGMP 配置选项。 |
|
允许 IGMP 主机加入的组。源路由器.access-list.name。 |
|
在收到 IGMPv2 leave 后立即取消成员资格的组。源路由器.access-list.name。 |
|
在删除组之前进行的组特定查询次数 (2-7)。 |
|
IGMPv2 leave 和删除组之间的时间间隔 (1-65535 毫秒)。 |
|
向 IGMP 主机发送查询的间隔 (1-65535 秒)。 |
|
等待 IGMP 查询响应的最长时间 (1-25 秒)。 |
|
在成为网络查询单元之前的查询超时时间 (60-900)。 |
|
启用/禁用要求 IGMP 数据包包含路由器警报选项。 选项
|
|
要支持的 IGMP 的最大版本。 选项
|
|
加入组播组。 |
|
组播组 IP 地址。 |
|
组播组的可接受源。源路由器.multicast-flow.name。 |
|
接口名称。源系统.interface.name。 |
|
被确认的邻居路由器。源路由器.access-list.name。 |
|
启用/禁用侦听 IGMP 但不参与 PIM。 选项
|
|
PIM 操作模式。 选项
|
|
在此接口上延迟泛洪数据包 (100-5000 毫秒)。 |
|
启用/禁用竞争以在选举中成为 RP。 选项
|
|
此 RP 管理的组播组。源路由器.access-list.name。 |
|
RP 候选广告间隔 (1-16383 秒)。 |
|
路由器作为 RP 的优先级。 |
|
启用/禁用 RPF 邻居查询的回退。 选项
|
|
用于回退 RPF 邻居的过滤器。源路由器.access-list.name。 |
|
发送状态刷新数据包的间隔 (1-100 秒)。 |
|
静态设置要转发出的组播组。源路由器.multicast-flow.name。 |
|
将被转发（仅应用于新的组播路由）的多播数据包的最小 TTL (1-255)。 |
|
启用/禁用 IP 组播路由。 选项
|
|
PIM 稀疏模式全局设置。 |
|
允许向此 Rendezvous Point (RP) 注册数据包的源。源路由器.access-list.name。 |
|
允许发送组播流量的源。源路由器.access-list.name。 |
|
启用/禁用接受来自邻居的 BSR 快速刷新数据包。 选项
|
|
启用/禁用允许此路由器成为引导路由器 (BSR)。 选项
|
|
BSR 哈希长度 (0-32)。 |
|
要宣传为候选 BSR 的接口。源系统.interface.name。 |
|
BSR 优先级 (0-255)。 |
|
启用/禁用使候选 RP 与旧的 Cisco IOS 兼容。 选项
|
|
仅使用哈希进行 RP 选择（与旧的 Cisco IOS 兼容）。 选项
|
|
校验整个注册数据包（用于旧的 Cisco IOS 兼容性）。 选项
|
|
仅对这些组进行 Cisco 注册校验和。源路由器.access-list.name。 |
|
加入/剪枝保持时间 (1-65535)。 |
|
以秒为单位发送定期 PIM 加入/剪枝消息的时间间隔 (1-65535)。 |
|
空注册的最大重试次数 (1-20)。 |
|
启用/禁用在检查 RPF 邻居和发送 REG 数据包时使用 SDWAN。 选项
|
|
通过此 RP 注册的每个源的数据包/秒限制 (0-65535)。 |
|
启用/禁用在注册数据包之前检查 RP 是否可达。 选项
|
|
覆盖注册数据包中的源地址。 选项
|
|
使用主接口地址覆盖。源系统.interface.name。 |
|
使用本地 IP 地址覆盖。 |
|
遵守 register-stop 消息的时间段 (1-65535 秒)。 |
|
静态配置 RP 地址。 |
|
使用此 RP 的组。源路由器.access-list.name。 |
|
RP 路由器地址。 |
|
RP 在 (S,G) 树上接收数据的超时时间 (1 - 65535 秒)。 |
|
启用/禁用切换到源特定树。 选项
|
|
允许切换到源树的组。源路由器.访问列表.名称。 |
|
启用/禁用源特定组播。 选项
|
|
允许进行源特定组播的组。源路由器.访问列表.名称。 |
|
组播路由的最大数量。 |
|
当组播路由数量超过此数量时生成警告，不得大于 route-limit。 |
|
虚拟域，在之前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： |
注释
注意
旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。
示例
- name: Configure router multicast.
fortinet.fortios.fortios_router_multicast:
vdom: "{{ vdom }}"
router_multicast:
interface:
-
bfd: "enable"
cisco_exclude_genid: "enable"
dr_priority: "1"
hello_holdtime: "105"
hello_interval: "30"
igmp:
access_group: "<your_own_value> (source router.access-list.name)"
immediate_leave_group: "<your_own_value> (source router.access-list.name)"
last_member_query_count: "2"
last_member_query_interval: "1000"
query_interval: "125"
query_max_response_time: "10"
query_timeout: "255"
router_alert_check: "enable"
version: "3"
join_group:
-
address: "<your_own_value>"
multicast_flow: "<your_own_value> (source router.multicast-flow.name)"
name: "default_name_22 (source system.interface.name)"
neighbour_filter: "<your_own_value> (source router.access-list.name)"
passive: "enable"
pim_mode: "sparse-mode"
propagation_delay: "500"
rp_candidate: "enable"
rp_candidate_group: "<your_own_value> (source router.access-list.name)"
rp_candidate_interval: "60"
rp_candidate_priority: "192"
rpf_nbr_fail_back: "enable"
rpf_nbr_fail_back_filter: "<your_own_value> (source router.access-list.name)"
state_refresh_interval: "60"
static_group: "<your_own_value> (source router.multicast-flow.name)"
ttl_threshold: "1"
multicast_routing: "enable"
pim_sm_global:
accept_register_list: "<your_own_value> (source router.access-list.name)"
accept_source_list: "<your_own_value> (source router.access-list.name)"
bsr_allow_quick_refresh: "enable"
bsr_candidate: "enable"
bsr_hash: "10"
bsr_interface: "<your_own_value> (source system.interface.name)"
bsr_priority: "0"
cisco_crp_prefix: "enable"
cisco_ignore_rp_set_priority: "enable"
cisco_register_checksum: "enable"
cisco_register_checksum_group: "<your_own_value> (source router.access-list.name)"
join_prune_holdtime: "210"
message_interval: "60"
null_register_retries: "1"
pim_use_sdwan: "enable"
register_rate_limit: "0"
register_rp_reachability: "enable"
register_source: "disable"
register_source_interface: "<your_own_value> (source system.interface.name)"
register_source_ip: "<your_own_value>"
register_supression: "60"
rp_address:
-
group: "<your_own_value> (source router.access-list.name)"
id: "61"
ip_address: "<your_own_value>"
rp_register_keepalive: "185"
spt_threshold: "enable"
spt_threshold_group: "<your_own_value> (source router.access-list.name)"
ssm: "enable"
ssm_range: "<your_own_value> (source router.access-list.name)"
route_limit: "2147483647"
route_threshold: ""
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
FortiGate 镜像的版本号。 返回值： 始终 示例： |
|
上次用于将内容置入 FortiGate 的方法。 返回值： 始终 示例： |
|
FortiGate 在上次应用的操作中给出的最后结果。 返回值： 始终 示例： |
|
上次调用 FortiGate 时使用的主密钥 (ID)。 返回值： 成功 示例： |
|
用于完成请求的表的名称。 返回值： 始终 示例： |
|
用于完成请求的表的路径。 返回值： 始终 示例： |
|
内部版本号。 返回值： 始终 示例： |
|
设备的序列号。 返回值： 始终 示例： |
|
操作结果的指示。 返回值： 始终 示例： |
|
使用的虚拟域。 返回值： 始终 示例： |
|
FortiGate 的版本。 返回值： 始终 示例： |