• 博客
  • Ansible 社区论坛
  • 文档
Ansible Logo
Ansible 社区文档
Ansible

Ansible 入门

  • Ansible 入门
  • 执行环境入门

安装、升级和配置

  • 安装指南
  • Ansible 移植指南

使用 Ansible

  • 构建 Ansible 清单
  • 使用 Ansible 命令行工具
  • 使用 Ansible Playbook
  • 使用 Ansible Vault 保护敏感数据
  • 使用 Ansible 模块和插件
  • 使用 Ansible 集合
  • 在 Windows 和 BSD 上使用 Ansible
  • Ansible 使用技巧

为 Ansible 做贡献

  • Ansible 社区指南
  • Ansible 集合贡献者指南
  • ansible-core 贡献者指南
  • 高级贡献者指南
  • Ansible 文档风格指南

扩展 Ansible

  • 开发人员指南

常见 Ansible 场景

  • 旧版公有云指南

网络自动化

  • 网络入门
  • 网络高级主题
  • 网络开发人员指南

Ansible Galaxy

  • Galaxy 用户指南
  • Galaxy 开发人员指南

参考 & 附录

  • 集合索引
    • Amazon 命名空间中的集合
    • Ansible 命名空间中的集合
    • Arista 命名空间中的集合
    • Awx 命名空间中的集合
    • Azure 命名空间中的集合
    • Check_point 命名空间中的集合
    • Chocolatey 命名空间中的集合
    • Cisco 命名空间中的集合
    • Cloud 命名空间中的集合
    • Cloudscale_ch 命名空间中的集合
    • Community 命名空间中的集合
    • Containers 命名空间中的集合
    • Cyberark 命名空间中的集合
    • Dellemc 命名空间中的集合
    • F5networks 命名空间中的集合
    • Fortinet 命名空间中的集合
      • Fortinet.Fortimanager
      • Fortinet.Fortios
        • 描述
        • 插件索引
    • Frr 命名空间中的集合
    • Gluster 命名空间中的集合
    • Google 命名空间中的集合
    • Grafana 命名空间中的集合
    • Hetzner 命名空间中的集合
    • Hpe 命名空间中的集合
    • Ibm 命名空间中的集合
    • Ieisystem 命名空间中的集合
    • Infinidat 命名空间中的集合
    • Infoblox 命名空间中的集合
    • Inspur 命名空间中的集合
    • Junipernetworks 命名空间中的集合
    • Kaytus 命名空间中的集合
    • Kubernetes 命名空间中的集合
    • Kubevirt 命名空间中的集合
    • Lowlydba 命名空间中的集合
    • Mellanox 命名空间中的集合
    • Microsoft 命名空间中的集合
    • Netapp 命名空间中的集合
    • Netapp_eseries 命名空间中的集合
    • Netbox 命名空间中的集合
    • Ngine_io 命名空间中的集合
    • Openstack 命名空间中的集合
    • Openvswitch 命名空间中的集合
    • Ovirt 命名空间中的集合
    • Purestorage 命名空间中的集合
    • Sensu 命名空间中的集合
    • Servicenow 命名空间中的集合
    • Splunk 命名空间中的集合
    • T_systems_mms 命名空间中的集合
    • Telekom_mms 命名空间中的集合
    • Theforeman 命名空间中的集合
    • Vmware 命名空间中的集合
    • Vultr 命名空间中的集合
    • Vyos 命名空间中的集合
    • Wti 命名空间中的集合
  • 所有模块和插件的索引
  • Playbook 关键字
  • 返回值
  • Ansible 配置设置
  • 控制 Ansible 行为的方式:优先级规则
  • YAML 语法
  • Python 3 支持
  • 解释器发现
  • 发布和维护
  • 测试策略
  • 健全性测试
  • 常见问题解答
  • 词汇表
  • Ansible 参考:模块实用程序
  • 特殊变量
  • Red Hat Ansible 自动化平台
  • Ansible 自动化中心
  • 记录 Ansible 输出

路线图

  • Ansible 路线图
  • ansible-core 路线图




Ansible
  • 集合索引
  • Fortinet 命名空间中的集合
  • Fortinet.Fortios
  • fortinet.fortios.fortios_system_sdwan 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置具有多个出站链路和运行状况检查配置文件的冗余 Internet 连接。


fortinet.fortios.fortios_system_sdwan 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置具有多个出站链路和运行状况检查配置文件的冗余 Internet 连接。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求了解详细信息。

要在 Playbook 中使用它,请指定:fortinet.fortios.fortios_system_sdwan。

在 fortinet.fortios 2.0.0 中新增

  • 概要

  • 要求

  • 参数

  • 注释

  • 示例

  • 返回值

概要

  • 此模块能够通过允许用户设置和修改系统特性和 sdwan 类别来配置 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"

system_sdwan

字典

配置具有多个出站链路和运行状况检查配置文件的冗余 Internet 连接。

app_perf_log_period

整数

生成应用程序性能日志的时间间隔(秒)(0 - 3600)。

duplication

列表 / 元素=字典

创建 SD-WAN 重复规则。

dstaddr

列表 / 元素=字典

目标地址或地址组名称。

name

字符串 / 必需

地址或地址组名称。源 firewall.address.name firewall.addrgrp.name。

dstaddr6

列表 / 元素=字典

目标地址 6 或地址 6 组名称。

name

字符串 / 必需

地址 6 或地址 6 组名称。源 firewall.address6.name firewall.addrgrp6.name。

dstintf

列表 / 元素=字典

传出(出口)接口或区域。

name

字符串 / 必需

接口、区域或 SDWAN 区域名称。源 system.interface.name system.zone.name system.sdwan.zone.name。

id

整数 / 必需

重复规则 ID (1 - 255)。请参阅 <a href=’#notes’>注释</a>。

packet_de_duplication

字符串

启用/禁用丢弃已重复的数据包。

选择

  • "enable"

  • "disable"

packet_duplication

字符串

配置数据包重复方法。

选择

  • "disable"

  • "force"

  • "on-demand"

service

列表 / 元素=字典

服务和服务组名称。

name

字符串 / 必需

服务和服务组名称。源 firewall.service.custom.name firewall.service.group.name。

service_id

列表 / 元素=字典

SD-WAN 服务规则 ID 列表。

id

整数 / 必需

SD-WAN 服务规则 ID。请参阅 <a href=’#notes’>注释</a>。源 system.sdwan.service.id。

sla_match_service

字符串

启用/禁用数据包重复匹配服务规则中的运行状况检查 SLA。

选择

  • "enable"

  • "disable"

srcaddr

列表 / 元素=字典

源地址或地址组名称。

name

字符串 / 必需

地址或地址组名称。源 firewall.address.name firewall.addrgrp.name。

srcaddr6

列表 / 元素=字典

源地址 6 或地址 6 组名称。

name

字符串 / 必需

地址 6 或地址 6 组名称。源 firewall.address6.name firewall.addrgrp6.name。

srcintf

列表 / 元素=字典

传入(入口)接口或区域。

name

字符串 / 必需

接口、区域或 SDWAN 区域名称。源 system.interface.name system.zone.name system.sdwan.zone.name。

duplication_max_num

整数

在 SD-WAN 区域中复制数据包的最大接口成员数(2 - 4)。

fail_alert_interfaces

列表 / 元素=字典

将发出警报的物理接口。

name

字符串 / 必需

物理接口名称。源 system.interface.name。

fail_detect

字符串

启用/禁用 SD-WAN Internet 连接状态检查(故障检测)。

选择

  • "enable"

  • "disable"

health_check

列表 / 元素=字典

SD-WAN 状态检查或运行状况检查。识别 Internet 上的服务器并确定 SD-WAN 如何验证 FortiGate 是否可以与其通信。

addr_mode

字符串

地址模式(IPv4 或 IPv6)。

选择

  • "ipv4"

  • "ipv6"

class_id

整数

流量类别 ID。源 firewall.traffic-class.class-id。

detect_mode

字符串

确定如何检测服务器的模式。

选择

  • "active"

  • "passive"

  • "prefer-passive"

  • "remote"

  • "agent-based"

diffservcode

字符串

探测数据包 IP 标头中的差分服务代码点 (DSCP)。

dns_match_ip

字符串

如果协议是 DNS,则预期从 DNS 服务器返回的响应 IP。

dns_request_domain

字符串

要为 DNS 探测解析的完全限定域名。

embed_measured_health

字符串

启用/禁用嵌入测量的运行状况信息。

选择

  • "enable"

  • "disable"

failtime

整数

服务器被认为丢失之前的失败次数 (1 - 3600)。

ftp_file

字符串

在 FTP 服务器上下载的完整路径和文件名,用于 FTP 运行状况检查以进行探测。

ftp_mode

字符串

FTP 模式。

选择

  • "passive"

  • "port"

ha_priority

整数

HA 选举优先级 (1 - 50)。

http_agent

字符串

HTTP 标头中 http-agent 字段中的字符串。

http_get

字符串

如果协议是 HTTP,则用于与服务器通信的 URL。

http_match

字符串

如果协议是 HTTP,则预期从服务器返回的响应字符串。

interval

整数

状态检查间隔(毫秒),或尝试连接到服务器的时间间隔(20 - 3600*1000 毫秒)。

members

列表 / 元素=字典

成员序号列表。

seq_num

整数 / 必需

成员序号。请参阅 <a href=’#notes’>注释</a>。源 system.sdwan.members.seq-num。

mos_codec

字符串

用于 MOS 计算的编解码器。

选择

  • "g711"

  • "g722"

  • "g729"

name

字符串 / 必需

状态检查或运行状况检查名称。

packet_size

整数

TWAMP 测试会话的数据包大小。(124/158 - 1024)

password

字符串

身份验证模式下的 TWAMP 控制器密码。

port

整数

用于通过选定协议与服务器通信的端口号 (0 - 65535)。

probe_count

整数

用于计算延迟和抖动的最近探测次数 (5 - 30)。

probe_packets

字符串

启用/禁用探测数据包的传输。

选择

  • "disable"

  • "enable"

probe_timeout

整数

在探测数据包被认为丢失之前等待的时间(20 - 3600*1000 毫秒)。

protocol

字符串

用于确定 FortiGate 是否可以与服务器通信的协议。

选择

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

  • "https"

  • "twamp"

  • "dns"

  • "tcp-connect"

  • "ftp"

  • "ping6"

quality_measured_method

字符串

测量 tcp-connect 质量的方法。

选择

  • "half-open"

  • "half-close"

recoverytime

整数

服务器被视为恢复正常之前收到的成功响应次数 (1 - 3600)。

security_mode

字符串

Twamp 控制器的安全模式。

选择

  • "none"

  • "authentication"

server

list / elements=string

服务器的 IP 地址或 FQDN 名称。

sla

列表 / 元素=字典

服务级别协议 (SLA)。

id

整数 / 必需

SLA ID。请参阅 <a href=’#notes’>注释</a>。

jitter_threshold

整数

用于 SLA 决策的抖动值,以毫秒为单位。(0 - 10000000)。

latency_threshold

整数

用于 SLA 决策的延迟值,以毫秒为单位。(0 - 10000000)。

link_cost_factor

list / elements=string

选择链路所依据的标准。

选择

  • "latency"

  • "jitter"

  • "packet-loss"

  • "mos"

  • "remote"

mos_threshold

字符串

SLA 标记为通过的最低平均意见得分。(1.0 - 5.0)。

packetloss_threshold

整数

用于 SLA 决策的丢包率,以百分比为单位。(0 - 100)。

priority_in_sla

整数

在 SLA 内时,要分配到路由表中的值 (0 - 65535)。

priority_out_sla

整数

在 SLA 外时,要分配到路由表中的值 (0 - 65535)。

sla_fail_log_period

整数

生成 SLA 失败日志消息的时间间隔,以秒为单位 (0 - 3600)。

sla_id_redistribute

整数

从 SLA 子表中选择 ID。所选 SLA 的优先级值将分配到路由表中 (0 - 32)。

sla_pass_log_period

整数

生成 SLA 通过日志消息的时间间隔,以秒为单位 (0 - 3600)。

source

字符串

在发送到服务器的健康检查数据包中使用的源 IP 地址。

source6

字符串

在发送到服务器的健康检查数据包中使用的源 IPv6 地址。

system_dns

字符串

启用/禁用系统 DNS 作为探测服务器。

选择

  • "disable"

  • "enable"

threshold_alert_jitter

整数

抖动告警阈值 (ms)。

threshold_alert_latency

整数

延迟告警阈值 (ms)。

threshold_alert_packetloss

整数

丢包率告警阈值(百分比)。

threshold_warning_jitter

整数

抖动警告阈值 (ms)。

threshold_warning_latency

整数

延迟警告阈值 (ms)。

threshold_warning_packetloss

整数

丢包率警告阈值(百分比)。

update_cascade_interface

字符串

启用/禁用更新级联接口。

选择

  • "enable"

  • "disable"

update_static_route

字符串

启用/禁用更新静态路由。

选择

  • "enable"

  • "disable"

user

字符串

用于访问探测服务器的用户名。

vrf

整数

虚拟路由转发 ID。

health_check_fortiguard

列表 / 元素=字典

SD-WAN 状态检查或运行状况检查。识别 FortiGuard 预定义的服务器,并确定 SD-WAN 如何验证 FGT 是否可以与其通信。

addr_mode

字符串

地址模式(IPv4 或 IPv6)。

选择

  • "ipv4"

  • "ipv6"

class_id

整数

流量类别 ID。源 firewall.traffic-class.class-id。

detect_mode

字符串

确定如何检测服务器的模式。

选择

  • "active"

  • "passive"

  • "prefer-passive"

  • "remote"

  • "agent-based"

diffservcode

字符串

探测数据包 IP 标头中的差分服务代码点 (DSCP)。

dns_match_ip

字符串

如果协议是 DNS,则预期从 DNS 服务器返回的响应 IP。

dns_request_domain

字符串

要为 DNS 探测解析的完全限定域名。

embed_measured_health

字符串

启用/禁用嵌入测量的运行状况信息。

选择

  • "enable"

  • "disable"

failtime

整数

服务器被认为丢失之前的失败次数 (1 - 3600)。

ftp_file

字符串

在 FTP 服务器上下载的完整路径和文件名,用于 FTP 运行状况检查以进行探测。

ftp_mode

字符串

FTP 模式。

选择

  • "passive"

  • "port"

ha_priority

整数

HA 选举优先级 (1 - 50)。

http_agent

字符串

HTTP 标头中 http-agent 字段中的字符串。

http_get

字符串

如果协议是 HTTP,则用于与服务器通信的 URL。

http_match

字符串

如果协议是 HTTP,则预期从服务器返回的响应字符串。

interval

整数

状态检查间隔(毫秒),或尝试连接到服务器的时间间隔(20 - 3600*1000 毫秒)。

members

列表 / 元素=字典

成员序号列表。

seq_num

整数 / 必需

成员序号。请参阅 <a href=’#notes’>注释</a>。源 system.sdwan.members.seq-num。

mos_codec

字符串

用于 MOS 计算的编解码器。

选择

  • "g711"

  • "g722"

  • "g729"

packet_size

整数

TWAMP 测试会话的数据包大小。(124/158 - 1024)

password

字符串

身份验证模式下的 TWAMP 控制器密码。

port

整数

用于通过选定协议与服务器通信的端口号 (0 - 65535)。

probe_count

整数

用于计算延迟和抖动的最近探测次数 (5 - 30)。

probe_packets

字符串

启用/禁用探测数据包的传输。

选择

  • "disable"

  • "enable"

probe_timeout

整数

在探测数据包被认为丢失之前等待的时间(20 - 3600*1000 毫秒)。

protocol

字符串

用于确定 FortiGate 是否可以与服务器通信的协议。

选择

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

  • "https"

  • "twamp"

  • "dns"

  • "tcp-connect"

  • "ftp"

quality_measured_method

字符串

测量 tcp-connect 质量的方法。

选择

  • "half-open"

  • "half-close"

recoverytime

整数

服务器被视为恢复正常之前收到的成功响应次数 (1 - 3600)。

security_mode

字符串

Twamp 控制器的安全模式。

选择

  • "none"

  • "authentication"

server

list / elements=string

来自 FortiGuard 的预定义 IP 地址或 FQDN 名称。

sla

列表 / 元素=字典

服务级别协议 (SLA)。

id

整数 / 必需

SLA ID。请参阅 <a href=’#notes’>注释</a>。

jitter_threshold

整数

用于 SLA 决策的抖动值,以毫秒为单位。(0 - 10000000)。

latency_threshold

整数

用于 SLA 决策的延迟值,以毫秒为单位。(0 - 10000000)。

link_cost_factor

list / elements=string

选择链路所依据的标准。

选择

  • "latency"

  • "jitter"

  • "packet-loss"

  • "mos"

  • "remote"

mos_threshold

字符串

SLA 标记为通过的最低平均意见得分。(1.0 - 5.0)。

packetloss_threshold

整数

用于 SLA 决策的丢包率,以百分比为单位。(0 - 100)。

priority_in_sla

整数

在 SLA 内时,要分配到路由表中的值 (0 - 65535)。

priority_out_sla

整数

在 SLA 外时,要分配到路由表中的值 (0 - 65535)。

sla_fail_log_period

整数

生成 SLA 失败日志消息的时间间隔,以秒为单位 (0 - 3600)。

sla_id_redistribute

整数

从 SLA 子表中选择 ID。所选 SLA 的优先级值将分配到路由表中 (0 - 32)。

sla_pass_log_period

整数

生成 SLA 通过日志消息的时间间隔,以秒为单位 (0 - 3600)。

source

字符串

在发送到服务器的健康检查数据包中使用的源 IP 地址。

source6

字符串

在发送到服务器的健康检查数据包中使用的源 IPv6 地址。

system_dns

字符串

启用/禁用系统 DNS 作为探测服务器。

选择

  • "disable"

  • "enable"

target_name

字符串 / 必需

状态检查或预定义的运行状况检查目标名称。

threshold_alert_jitter

整数

抖动告警阈值 (ms)。

threshold_alert_latency

整数

延迟告警阈值 (ms)。

threshold_alert_packetloss

整数

丢包率告警阈值(百分比)。

threshold_warning_jitter

整数

抖动警告阈值 (ms)。

threshold_warning_latency

整数

延迟警告阈值 (ms)。

threshold_warning_packetloss

整数

丢包率警告阈值(百分比)。

update_cascade_interface

字符串

启用/禁用更新级联接口。

选择

  • "enable"

  • "disable"

update_static_route

字符串

启用/禁用更新静态路由。

选择

  • "enable"

  • "disable"

user

字符串

用于访问探测服务器的用户名。

vrf

整数

虚拟路由转发 ID。

load_balance_mode

字符串

用于将 Internet 流量负载均衡到 SD-WAN 成员的算法或模式。

选择

  • "source-ip-based"

  • "weight-based"

  • "usage-based"

  • "source-dest-ip-based"

  • "measured-volume-based"

members

列表 / 元素=字典

添加到 SD-WAN 的 FortiGate 接口。

comment

字符串

注释。

cost

整数

此接口在 SLA 模式下用于服务的成本 (0 - 4294967295)。

gateway

字符串

此接口的默认网关。通常是此接口连接的 Internet 服务提供商的默认网关。

gateway6

字符串

IPv6 网关。

ingress_spillover_threshold

整数

此接口的入口溢出阈值(0 - 16776000 kbit/s)。当达到此流量阈值时,新会话将溢出到 SD-WAN 中的其他接口。

interface

字符串

接口名称。源 system.interface.name。

preferred_source

字符串

此成员的首选路由来源。

priority

整数

接口的 IPv4 优先级 (1 - 65535)。用于 SD-WAN 规则或优先级规则。

priority6

整数

接口的 IPv6 优先级 (1 - 65535)。用于 SD-WAN 规则或优先级规则。

priority_in_sla

整数

当此成员在 SLA 内时,此成员路由的首选优先级 (0 - 65535)。

priority_out_sla

整数

当此成员在 SLA 外时,此成员路由的首选优先级 (0 - 65535)。

seq_num

整数 / 必需

序列号(1-512)。请参阅 <a href=’#notes’>注释</a>。

source

字符串

在发送到服务器的健康检查数据包中使用的源 IP 地址。

source6

字符串

在发送到服务器的健康检查数据包中使用的源 IPv6 地址。

spillover_threshold

整数

此接口的出口溢出阈值(0 - 16776000 kbit/s)。当达到此流量阈值时,新会话将溢出到 SD-WAN 中的其他接口。

status

字符串

在 SD-WAN 中启用/禁用此接口。

选择

  • "disable"

  • "enable"

transport_group

整数

测量的传输组 (0 - 255)。

volume_ratio

整数

测量的卷比率(此值 / 所有值的总和 = 链路卷的百分比,1 - 255)。

weight

整数

此接口用于加权负载均衡的权重。(1 - 255) 更多流量将被定向到权重较高的接口。

zone

字符串

区域名称。源 system.sdwan.zone.name。

neighbor

列表 / 元素=字典

从 BGP 邻居表创建 SD-WAN 邻居,以根据 SLA 状态控制路由通告。

health_check

字符串

SD-WAN 运行状况检查名称。源 system.sdwan.health-check.name system.sdwan.health-check-fortiguard.target-name。

ip

字符串 / 必需

邻居或邻居组名称的 IP/IPv6 地址。源 router.bgp.neighbor-group.name router.bgp.neighbor.ip。

member

列表 / 元素=字典

成员序列号列表。源 system.sdwan.members.seq-num。

seq_num

整数 / 必需

成员序号。请参阅 <a href=’#notes’>注释</a>。源 system.sdwan.members.seq-num。

minimum_sla_meet_members

整数

当首选邻居时,满足 SLA 的最少成员数。

mode

字符串

选择邻居所依据的指标。

选择

  • "sla"

  • "speedtest"

role

字符串

邻居的角色。

选择

  • "standalone"

  • "primary"

  • "secondary"

service_id

整数

要与邻居一起使用的 SD-WAN 服务 ID。源 system.sdwan.service.id。

sla_id

整数

SLA ID。

neighbor_hold_boot_time

整数

从邻居启动开始,从主邻居切换到辅助邻居的等待时间,以秒为单位。(0 - 10000000)。

neighbor_hold_down

字符串

启用/禁用从辅助邻居切换到主邻居的保持切换。

选择

  • "enable"

  • "disable"

neighbor_hold_down_time

整数

当禁用保持切换时,从辅助邻居切换到主邻居的等待时间,以秒为单位。(0 - 10000000)。

service

列表 / 元素=字典

创建 SD-WAN 规则(也称为服务)以控制会话如何分配到 SD-WAN 中的接口。

addr_mode

字符串

地址模式(IPv4 或 IPv6)。

选择

  • "ipv4"

  • "ipv6"

agent_exclusive

字符串

设置/取消设置服务为独占使用代理。

选择

  • "enable"

  • "disable"

bandwidth_weight

整数

在自定义配置文件 1 公式中,可用双向带宽倒数的系数。

comment

字符串

注释。

default

字符串

启用/禁用将 SD-WAN 用作默认服务。

选择

  • "enable"

  • "disable"

dscp_forward

字符串

启用/禁用转发流量 DSCP 标记。

选择

  • "enable"

  • "disable"

dscp_forward_tag

字符串

转发流量 DSCP 标记。

dscp_reverse

字符串

启用/禁用反向流量 DSCP 标记。

选择

  • "enable"

  • "disable"

dscp_reverse_tag

字符串

反向流量 DSCP 标记。

dst

列表 / 元素=字典

目标地址名称。

name

字符串 / 必需

地址或地址组名称。源 firewall.address.name firewall.addrgrp.name。

dst6

列表 / 元素=字典

目标地址 6 名称。

name

字符串 / 必需

地址 6 或地址 6 组名称。源 firewall.address6.name firewall.addrgrp6.name。

dst_negate

字符串

启用/禁用目标地址匹配的否定。

选择

  • "enable"

  • "disable"

end_port

整数

结束目标端口号。

end_src_port

整数

结束源端口号。

gateway

字符串

启用/禁用 SD-WAN 服务网关。

选择

  • "enable"

  • "disable"

groups

列表 / 元素=字典

用户组。

name

字符串 / 必需

组名称。源 user.group.name。

hash_mode

字符串

用于选择的优先级成员的负载均衡模式的哈希算法。

选择

  • "round-robin"

  • "source-ip-based"

  • "source-dest-ip-based"

  • "inbandwidth"

  • "outbandwidth"

  • "bibandwidth"

health_check

列表 / 元素=字典

运行状况检查列表。

name

字符串 / 必需

运行状况检查名称。源 system.sdwan.health-check.name system.sdwan.health-check-fortiguard.target-name。

hold_down_time

整数

从备份成员切换到主成员的等待时间,以秒为单位 (0 - 10000000)。

id

整数 / 必需

SD-WAN 规则 ID (1 - 4000)。请参阅 <a href=’#notes’>注释</a>。

input_device

列表 / 元素=字典

源接口名称。

name

字符串 / 必需

接口名称。源 system.interface.name。

input_device_negate

字符串

启用/禁用输入设备匹配的否定。

选择

  • "enable"

  • "disable"

input_zone

列表 / 元素=字典

源输入区域名称。

name

字符串 / 必需

区域。源 system.sdwan.zone.name。

internet_service

字符串

启用/禁用将 Internet 服务用于基于应用程序的负载均衡。

选择

  • "enable"

  • "disable"

internet_service_app_ctrl

列表 / 元素=字典

基于应用程序控制的 Internet 服务 ID 列表。

id

整数 / 必需

基于应用程序控制的 Internet 服务 ID。请参阅 <a href=’#notes’>注释</a>。

internet_service_app_ctrl_category

列表 / 元素=字典

一个或多个应用程序控制类别的 ID。

id

整数 / 必需

应用程序控制类别 ID。请参阅 <a href=’#notes’>注释</a>。

internet_service_app_ctrl_group

列表 / 元素=字典

基于应用程序控制的 Internet 服务组列表。

name

字符串 / 必需

基于应用程序控制的 Internet 服务组名称。源 application.group.name。

internet_service_custom

列表 / 元素=字典

自定义 Internet 服务名称列表。

name

字符串 / 必需

自定义 Internet 服务名称。源 firewall.internet-service-custom.name。

internet_service_custom_group

列表 / 元素=字典

自定义 Internet 服务组列表。

name

字符串 / 必需

自定义 Internet 服务组名称。源 firewall.internet-service-custom-group.name。

internet_service_group

列表 / 元素=字典

Internet 服务组列表。

name

字符串 / 必需

Internet 服务组名称。源 firewall.internet-service-group.name。

internet_service_name

列表 / 元素=字典

Internet 服务名称列表。

name

字符串 / 必需

Internet 服务名称。源 firewall.internet-service-name.name。

jitter_weight

整数

在自定义配置文件 1 公式中,抖动的系数。

latency_weight

整数

在自定义配置文件 1 公式中,延迟的系数。

link_cost_factor

字符串

链路成本因子。

选择

  • "latency"

  • "jitter"

  • "packet-loss"

  • "inbandwidth"

  • "outbandwidth"

  • "bibandwidth"

  • "custom-profile-1"

link_cost_threshold

整数

链路成本值的百分比阈值变化,这将导致策略路由重新生成 (0 - 10000000)。

load_balance

字符串

启用/禁用负载均衡。

选择

  • "enable"

  • "disable"

minimum_sla_meet_members

整数

满足 SLA 的最少成员数。

mode

字符串

控制 SD-WAN 规则如何设置 SD-WAN 中接口的优先级。

选择

  • "auto"

  • "manual"

  • "priority"

  • "sla"

  • "load-balance"

name

字符串

SD-WAN 规则名称。

packet_loss_weight

整数

在自定义配置文件 1 公式中,丢包率的系数。

passive_measurement

字符串

启用/禁用基于服务标准的被动测量。

选择

  • "enable"

  • "disable"

priority_members

列表 / 元素=字典

成员序号列表。

seq_num

整数 / 必需

成员序号。请参阅 <a href=’#notes’>注释</a>。源 system.sdwan.members.seq-num。

priority_zone

列表 / 元素=字典

优先级区域名称列表。

name

字符串 / 必需

优先级区域名称。源 system.sdwan.zone.name。

protocol

整数

协议号。

quality_link

整数

质量等级。

role

字符串

要与邻居一起使用的服务角色。

选择

  • "standalone"

  • "primary"

  • "secondary"

route_tag

整数

IPv4 路由映射路由标记。

shortcut

字符串

启用/禁用此服务的快捷方式。

选择

  • "enable"

  • "disable"

shortcut_priority

字符串

此服务的 ADVPN 快捷方式的高优先级。

选择

  • "enable"

  • "disable"

  • "auto"

shortcut_stickiness

字符串

启用/禁用 ADVPN 的快捷方式粘性。

选择

  • "enable"

  • "disable"

sla

列表 / 元素=字典

服务级别协议 (SLA)。

health_check

字符串 / 必需

SD-WAN 运行状况检查。源 system.sdwan.health-check.name system.sdwan.health-check-fortiguard.target-name。

id

整数

SLA ID。

sla_compare_method

字符串

比较 SLA 模式下 SLA 值的方法。

选择

  • "order"

  • "number"

sla_stickiness

字符串

启用/禁用 SLA 粘性。

选择

  • "enable"

  • "disable"

src

列表 / 元素=字典

源地址名称。

name

字符串 / 必需

地址或地址组名称。源 firewall.address.name firewall.addrgrp.name。

src6

列表 / 元素=字典

源地址 IPv6 名称。

name

字符串 / 必需

地址 6 或地址 6 组名称。源 firewall.address6.name firewall.addrgrp6.name。

src_negate

字符串

启用/禁用源地址匹配取反。

选择

  • "enable"

  • "disable"

standalone_action

字符串

当选定的邻居角色为独立模式而服务角色不是独立模式时,启用/禁用服务。

选择

  • "enable"

  • "disable"

start_port

整数

起始目标端口号。

start_src_port

整数

起始源端口号。

status

字符串

启用/禁用 SD-WAN 服务。

选择

  • "enable"

  • "disable"

tie_break

字符串

如果多个成员满足 SLA,则选择成员的方法。

选择

  • "zone"

  • "cfg-order"

  • "fib-best-match"

  • "input-device"

tos

字符串

服务类型位模式。

tos_mask

字符串

评估的服务类型位。

use_shortcut_sla

字符串

启用/禁用使用 ADVPN 快捷方式进行质量比较。

选择

  • "enable"

  • "disable"

users

列表 / 元素=字典

用户名。

name

字符串 / 必需

用户名。源 user.local.name。

zone_mode

字符串

启用/禁用区域模式。

选择

  • "enable"

  • "disable"

speedtest_bypass_routing

字符串

在 SD-WAN 成员上进行速度测试时,启用/禁用旁路路由。

选择

  • "disable"

  • "enable"

status

字符串

启用/禁用 SD-WAN。

选择

  • "disable"

  • "enable"

zone

列表 / 元素=字典

配置 SD-WAN 区域。

advpn_health_check

字符串

ADVPN 本地覆盖链路质量的健康检查。源 system.sdwan.health-check.name。

advpn_select

字符串

启用/禁用基于 SDWAN 信息选择 ADVPN。

选择

  • "enable"

  • "disable"

minimum_sla_meet_members

整数

当首选邻居时,满足 SLA 的最少成员数。

name

字符串 / 必需

区域名称。

service_sla_tie_break

字符串

如果多个成员满足 SLA,则选择成员的方法。

选择

  • "cfg-order"

  • "fib-best-match"

  • "input-device"

vdom

字符串

虚拟域,在之前定义的那些之中。vdom 是 FortiGate 的虚拟实例,可以配置并用作不同的单元。

默认值: "root"

注释

注意

  • 遗留 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式

示例

- name: Configure redundant Internet connections with multiple outbound links and health-check profiles.
  fortinet.fortios.fortios_system_sdwan:
      vdom: "{{ vdom }}"
      system_sdwan:
          app_perf_log_period: "0"
          duplication:
              -
                  dstaddr:
                      -
                          name: "default_name_6 (source firewall.address.name firewall.addrgrp.name)"
                  dstaddr6:
                      -
                          name: "default_name_8 (source firewall.address6.name firewall.addrgrp6.name)"
                  dstintf:
                      -
                          name: "default_name_10 (source system.interface.name system.zone.name system.sdwan.zone.name)"
                  id: "11"
                  packet_de_duplication: "enable"
                  packet_duplication: "disable"
                  service:
                      -
                          name: "default_name_15 (source firewall.service.custom.name firewall.service.group.name)"
                  service_id:
                      -
                          id: "17 (source system.sdwan.service.id)"
                  sla_match_service: "enable"
                  srcaddr:
                      -
                          name: "default_name_20 (source firewall.address.name firewall.addrgrp.name)"
                  srcaddr6:
                      -
                          name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
                  srcintf:
                      -
                          name: "default_name_24 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          duplication_max_num: "2"
          fail_alert_interfaces:
              -
                  name: "default_name_27 (source system.interface.name)"
          fail_detect: "enable"
          health_check:
              -
                  addr_mode: "ipv4"
                  class_id: "0"
                  detect_mode: "active"
                  diffservcode: "<your_own_value>"
                  dns_match_ip: "<your_own_value>"
                  dns_request_domain: "<your_own_value>"
                  embed_measured_health: "enable"
                  failtime: "5"
                  ftp_file: "<your_own_value>"
                  ftp_mode: "passive"
                  ha_priority: "1"
                  http_agent: "<your_own_value>"
                  http_get: "<your_own_value>"
                  http_match: "<your_own_value>"
                  interval: "500"
                  members:
                      -
                          seq_num: "<you_own_value>"
                  mos_codec: "g711"
                  name: "default_name_48"
                  packet_size: "124"
                  password: "<your_own_value>"
                  port: "0"
                  probe_count: "30"
                  probe_packets: "disable"
                  probe_timeout: "500"
                  protocol: "ping"
                  quality_measured_method: "half-open"
                  recoverytime: "5"
                  security_mode: "none"
                  server: "192.168.100.40"
                  sla:
                      -
                          id: "61"
                          jitter_threshold: "5"
                          latency_threshold: "5"
                          link_cost_factor: "latency"
                          mos_threshold: "<your_own_value>"
                          packetloss_threshold: "0"
                          priority_in_sla: "0"
                          priority_out_sla: "0"
                  sla_fail_log_period: "0"
                  sla_id_redistribute: "0"
                  sla_pass_log_period: "0"
                  source: "<your_own_value>"
                  source6: "<your_own_value>"
                  system_dns: "disable"
                  threshold_alert_jitter: "0"
                  threshold_alert_latency: "0"
                  threshold_alert_packetloss: "0"
                  threshold_warning_jitter: "0"
                  threshold_warning_latency: "0"
                  threshold_warning_packetloss: "0"
                  update_cascade_interface: "enable"
                  update_static_route: "enable"
                  user: "<your_own_value>"
                  vrf: "0"
          health_check_fortiguard:
              -
                  addr_mode: "ipv4"
                  class_id: "0"
                  detect_mode: "active"
                  diffservcode: "<your_own_value>"
                  dns_match_ip: "<your_own_value>"
                  dns_request_domain: "<your_own_value>"
                  embed_measured_health: "enable"
                  failtime: "5"
                  ftp_file: "<your_own_value>"
                  ftp_mode: "passive"
                  ha_priority: "1"
                  http_agent: "<your_own_value>"
                  http_get: "<your_own_value>"
                  http_match: "<your_own_value>"
                  interval: "500"
                  members:
                      -
                          seq_num: "<you_own_value>"
                  mos_codec: "g711"
                  packet_size: "124"
                  password: "<your_own_value>"
                  port: "0"
                  probe_count: "30"
                  probe_packets: "disable"
                  probe_timeout: "500"
                  protocol: "ping"
                  quality_measured_method: "half-open"
                  recoverytime: "5"
                  security_mode: "none"
                  server: "192.168.100.40"
                  sla:
                      -
                          id: "116"
                          jitter_threshold: "5"
                          latency_threshold: "5"
                          link_cost_factor: "latency"
                          mos_threshold: "<your_own_value>"
                          packetloss_threshold: "0"
                          priority_in_sla: "0"
                          priority_out_sla: "0"
                  sla_fail_log_period: "0"
                  sla_id_redistribute: "0"
                  sla_pass_log_period: "0"
                  source: "<your_own_value>"
                  source6: "<your_own_value>"
                  system_dns: "disable"
                  target_name: "<your_own_value>"
                  threshold_alert_jitter: "0"
                  threshold_alert_latency: "0"
                  threshold_alert_packetloss: "0"
                  threshold_warning_jitter: "0"
                  threshold_warning_latency: "0"
                  threshold_warning_packetloss: "0"
                  update_cascade_interface: "enable"
                  update_static_route: "enable"
                  user: "<your_own_value>"
                  vrf: "0"
          load_balance_mode: "source-ip-based"
          members:
              -
                  comment: "Comments."
                  cost: "0"
                  gateway: "<your_own_value>"
                  gateway6: "<your_own_value>"
                  ingress_spillover_threshold: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  preferred_source: "<your_own_value>"
                  priority: "1"
                  priority_in_sla: "0"
                  priority_out_sla: "0"
                  priority6: "1024"
                  seq_num: "<you_own_value>"
                  source: "<your_own_value>"
                  source6: "<your_own_value>"
                  spillover_threshold: "0"
                  status: "disable"
                  transport_group: "0"
                  volume_ratio: "1"
                  weight: "1"
                  zone: "<your_own_value> (source system.sdwan.zone.name)"
          neighbor:
              -
                  health_check: "<your_own_value> (source system.sdwan.health-check.name system.sdwan.health-check-fortiguard.target-name)"
                  ip: "<your_own_value> (source router.bgp.neighbor-group.name router.bgp.neighbor.ip)"
                  member:
                      -
                          seq_num: "<you_own_value>"
                  minimum_sla_meet_members: "1"
                  mode: "sla"
                  role: "standalone"
                  service_id: "0"
                  sla_id: "0"
          neighbor_hold_boot_time: "0"
          neighbor_hold_down: "enable"
          neighbor_hold_down_time: "0"
          service:
              -
                  addr_mode: "ipv4"
                  agent_exclusive: "enable"
                  bandwidth_weight: "0"
                  comment: "Comments."
                  default: "enable"
                  dscp_forward: "enable"
                  dscp_forward_tag: "<your_own_value>"
                  dscp_reverse: "enable"
                  dscp_reverse_tag: "<your_own_value>"
                  dst:
                      -
                          name: "default_name_187 (source firewall.address.name firewall.addrgrp.name)"
                  dst_negate: "enable"
                  dst6:
                      -
                          name: "default_name_190 (source firewall.address6.name firewall.addrgrp6.name)"
                  end_port: "65535"
                  end_src_port: "65535"
                  gateway: "enable"
                  groups:
                      -
                          name: "default_name_195 (source user.group.name)"
                  hash_mode: "round-robin"
                  health_check:
                      -
                          name: "default_name_198 (source system.sdwan.health-check.name system.sdwan.health-check-fortiguard.target-name)"
                  hold_down_time: "0"
                  id: "200"
                  input_device:
                      -
                          name: "default_name_202 (source system.interface.name)"
                  input_device_negate: "enable"
                  input_zone:
                      -
                          name: "default_name_205 (source system.sdwan.zone.name)"
                  internet_service: "enable"
                  internet_service_app_ctrl:
                      -
                          id: "208"
                  internet_service_app_ctrl_category:
                      -
                          id: "210"
                  internet_service_app_ctrl_group:
                      -
                          name: "default_name_212 (source application.group.name)"
                  internet_service_custom:
                      -
                          name: "default_name_214 (source firewall.internet-service-custom.name)"
                  internet_service_custom_group:
                      -
                          name: "default_name_216 (source firewall.internet-service-custom-group.name)"
                  internet_service_group:
                      -
                          name: "default_name_218 (source firewall.internet-service-group.name)"
                  internet_service_name:
                      -
                          name: "default_name_220 (source firewall.internet-service-name.name)"
                  jitter_weight: "0"
                  latency_weight: "0"
                  link_cost_factor: "latency"
                  link_cost_threshold: "10"
                  load_balance: "enable"
                  minimum_sla_meet_members: "0"
                  mode: "auto"
                  name: "default_name_228"
                  packet_loss_weight: "0"
                  passive_measurement: "enable"
                  priority_members:
                      -
                          seq_num: "<you_own_value>"
                  priority_zone:
                      -
                          name: "default_name_234 (source system.sdwan.zone.name)"
                  protocol: "0"
                  quality_link: "0"
                  role: "standalone"
                  route_tag: "0"
                  shortcut: "enable"
                  shortcut_priority: "enable"
                  shortcut_stickiness: "enable"
                  sla:
                      -
                          health_check: "<your_own_value> (source system.sdwan.health-check.name system.sdwan.health-check-fortiguard.target-name)"
                          id: "244"
                  sla_compare_method: "order"
                  sla_stickiness: "enable"
                  src:
                      -
                          name: "default_name_248 (source firewall.address.name firewall.addrgrp.name)"
                  src_negate: "enable"
                  src6:
                      -
                          name: "default_name_251 (source firewall.address6.name firewall.addrgrp6.name)"
                  standalone_action: "enable"
                  start_port: "1"
                  start_src_port: "1"
                  status: "enable"
                  tie_break: "zone"
                  tos: "<your_own_value>"
                  tos_mask: "<your_own_value>"
                  use_shortcut_sla: "enable"
                  users:
                      -
                          name: "default_name_261 (source user.local.name)"
                  zone_mode: "enable"
          speedtest_bypass_routing: "disable"
          status: "disable"
          zone:
              -
                  advpn_health_check: "<your_own_value> (source system.sdwan.health-check.name)"
                  advpn_select: "enable"
                  minimum_sla_meet_members: "1"
                  name: "default_name_269"
                  service_sla_tie_break: "cfg-order"

返回值

通用返回值在此处有文档说明,以下是此模块独有的字段

键

描述

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"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

集合链接

  • 问题跟踪器
  • 主页
  • 存储库(源代码)
上一个 下一个

© 版权所有 Ansible 项目贡献者。 最后更新于 2024 年 12 月 19 日。