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

Ansible 入门

  • Ansible 入门
  • Execution Environments 入门

安装、升级和配置

  • 安装指南
  • Ansible 移植指南

使用 Ansible

  • 构建 Ansible 清单
  • 使用 Ansible 命令行工具
  • 使用 Ansible 剧本
  • 使用 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 命名空间中的集合
  • 所有模块和插件的索引
  • 剧本关键字
  • 返回值
  • Ansible 配置设置
  • 控制 Ansible 的行为方式:优先级规则
  • YAML 语法
  • Python 3 支持
  • 解释器发现
  • 发布和维护
  • 测试策略
  • 健全性测试
  • 常见问题解答
  • 词汇表
  • Ansible 参考:模块实用程序
  • 特殊变量
  • 红帽 Ansible 自动化平台
  • Ansible Automation Hub
  • 记录 Ansible 输出

路线图

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




Ansible
  • 集合索引
  • Fortinet 命名空间中的集合
  • Fortinet.Fortimanager
  • fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck 模块 – SD-WAN 状态检查或健康检查。


fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck 模块 – SD-WAN 状态检查或健康检查。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它,请指定:fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck。

fortinet.fortimanager 2.0.0 中的新增功能

  • 概要

  • 参数

  • 注释

  • 示例

  • 返回值

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括在使用前需要调整到数据源的所有参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True,模块将继续执行而不验证参数。

选择

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选择

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

用于创建、更新或删除对象的指令。

选择

  • "present"

  • "absent"

wanprof

字符串 / 必需

请求的 URL 中的参数 (wanprof)。

wanprof_system_virtualwanlink_healthcheck

字典

设置的顶级参数。

_dynamic_server

别名:_dynamic-server

字符串

动态服务器。

addr_mode

别名:addr-mode

字符串

地址模式

选择

  • "ipv4"

  • "ipv6"

diffservcode

字符串

区分服务代码点

dns_request_domain

别名:dns-request-domain

字符串

用于 DNS 探测解析的完全限定域名。

failtime

整数

在服务器被认为丢失之前的失败次数

ha_priority

别名:ha-priority

整数

HA 选举优先级

http_agent

别名:http-agent

字符串

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

http_get

别名:http-get

字符串

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

http_match

别名:http-match

字符串

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

internet_service_id

别名:internet-service-id

字符串

互联网服务 ID。

interval

整数

状态检查间隔,或尝试连接到服务器之间的时间

members

任何

(列表或字符串)成员序列号列表。

name

字符串 / 必需

状态检查或健康检查名称。

packet_size

别名:packet-size

整数

twamp 测试会话的数据包大小,

password

任何

(列表)身份验证模式下的 Twamp 控制器密码

port

整数

用于通过所选协议与服务器通信的端口号。

probe_count

别名:probe-count

整数

应用于计算延迟和抖动的最新探测次数

probe_packets

别名:probe-packets

字符串

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

选择

  • "禁用"

  • "启用"

probe_timeout

别名: probe-timeout

整数

探测数据包被视为丢失前等待的时间

protocol

字符串

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

选择

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

  • "twamp"

  • "ping6"

  • "dns"

recoverytime

整数

服务器被视为恢复之前收到的成功响应次数

security_mode

别名: security-mode

字符串

Twamp 控制器安全模式。

选择

  • "none"

  • "authentication"

server

任何

(列表) 服务器的 IP 地址或 FQDN 名称。

sla

列表 / 元素=字典

SLA。

id

整数

SLA ID。

jitter_threshold

别名: jitter-threshold

整数

用于 SLA 决策的抖动值,单位为毫秒。

latency_threshold

别名: latency-threshold

整数

用于 SLA 决策的延迟值,单位为毫秒。

link_cost_factor

别名: link-cost-factor

列表 / 元素=字符串

选择链路所依据的标准。

选择

  • "latency"

  • "jitter"

  • "packet-loss"

packetloss_threshold

别名: packetloss-threshold

整数

用于 SLA 决策的丢包率,单位为百分比。

sla_fail_log_period

别名: sla-fail-log-period

整数

生成 SLA 失败日志消息的时间间隔,单位为秒

sla_pass_log_period

别名: sla-pass-log-period

整数

生成 SLA 通过日志消息的时间间隔,单位为秒

system_dns

别名: system-dns

字符串

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

选择

  • "禁用"

  • "启用"

threshold_alert_jitter

别名: threshold-alert-jitter

整数

抖动告警阈值

threshold_alert_latency

别名: threshold-alert-latency

整数

延迟告警阈值

threshold_alert_packetloss

别名: threshold-alert-packetloss

整数

丢包率告警阈值

threshold_warning_jitter

别名: threshold-warning-jitter

整数

抖动警告阈值

threshold_warning_latency

别名: threshold-warning-latency

整数

延迟警告阈值

threshold_warning_packetloss

别名: threshold-warning-packetloss

整数

丢包率警告阈值

timeout

整数

在未收到服务器回复从而认为连接尝试失败之前等待的时间

update_cascade_interface

别名: update-cascade-interface

字符串

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

选择

  • "禁用"

  • "启用"

update_static_route

别名: update-static-route

字符串

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

选择

  • "禁用"

  • "启用"

workspace_locking_adom

字符串

用于在工作区模式下运行的 FortiManager 的锁定 ADOM,该值可以是 global 以及其他(包括 root)。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间,单位为秒。

默认值: 300

备注

注意

  • 从 2.4.0 版本开始,所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用,但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成这项工作。

  • 要创建或更新对象,请使用 state present 指令。

  • 要删除对象,请使用 state absent 指令。

  • 通常,当返回非零 rc 时,运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SD-WAN status checking or health checking.
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_healthcheck:
          _dynamic_server: <string>
          addr_mode: <value in [ipv4, ipv6]>
          failtime: <integer>
          http_agent: <string>
          http_get: <string>
          http_match: <string>
          interval: <integer>
          members: <list or string>
          name: <string>
          packet_size: <integer>
          password: <list or string>
          port: <integer>
          protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          recoverytime: <integer>
          security_mode: <value in [none, authentication]>
          server: <list or string>
          sla:
            -
              id: <integer>
              jitter_threshold: <integer>
              latency_threshold: <integer>
              link_cost_factor:
                - "latency"
                - "jitter"
                - "packet-loss"
              packetloss_threshold: <integer>
          threshold_alert_jitter: <integer>
          threshold_alert_latency: <integer>
          threshold_alert_packetloss: <integer>
          threshold_warning_jitter: <integer>
          threshold_warning_latency: <integer>
          threshold_warning_packetloss: <integer>
          update_cascade_interface: <value in [disable, enable]>
          update_static_route: <value in [disable, enable]>
          internet_service_id: <string>
          probe_packets: <value in [disable, enable]>
          sla_fail_log_period: <integer>
          sla_pass_log_period: <integer>
          timeout: <integer>
          ha_priority: <integer>
          diffservcode: <string>
          probe_timeout: <integer>
          dns_request_domain: <string>
          probe_count: <integer>
          system_dns: <value in [disable, enable]>

返回值

通用返回值在此处记录 此处,以下是此模块特有的字段

Key

描述

meta

字典

请求的结果。

返回值: always

request_url

字符串

请求的完整 URL。

返回值: always

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回值: always

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回值: always

response_message

字符串

API 响应的描述性消息。

返回值: always

示例: "OK."

system_information

字典

目标系统的信息。

返回值: always

rc

整数

请求的状态。

返回值: always

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则发出警告。

返回值: complex

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)

集合链接

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

© Copyright Ansible 项目贡献者。 最后更新于 2024 年 12 月 19 日。