• 博客
  • 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 命名空间中的集合
    • F5 Networks 命名空间中的集合
    • Fortinet 命名空间中的集合
      • Fortinet.Fortimanager
        • 描述
        • 插件索引
      • Fortinet.Fortios
    • FRR 命名空间中的集合
    • Gluster 命名空间中的集合
    • Google 命名空间中的集合
    • Grafana 命名空间中的集合
    • Hetzner 命名空间中的集合
    • HPE 命名空间中的集合
    • IBM 命名空间中的集合
    • Ieisystem 命名空间中的集合
    • Infinidat 命名空间中的集合
    • Infoblox 命名空间中的集合
    • Inspur 命名空间中的集合
    • Juniper Networks 命名空间中的集合
    • 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 Automation Platform
  • Ansible Automation Hub
  • 记录 Ansible 输出

路线图

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




Ansible
  • 集合索引
  • Fortinet 命名空间中的集合
  • Fortinet.Fortimanager
  • fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members 模块 – 添加到虚拟广域网链路的 FortiGate 接口。


fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members 模块 – 添加到虚拟广域网链路的 FortiGate 接口。

注意

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

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

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

要在 playbook 中使用它,请指定: fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members。

fortinet.fortimanager 2.0.0 中的新增功能

  • 概要

  • 参数

  • 备注

  • 示例

  • 返回值

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构差异时设置为 True,模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

dynamic_virtualwanlink_members

字典

设置的顶级参数。

comment

字符串

注释。

cost

整数

成本。

detect_failtime

别名:detect-failtime

整数

检测故障时间。

detect_http_get

别名:detect-http-get

字符串

检测 HTTP GET。

detect_http_match

别名:detect-http-match

字符串

检测 HTTP 匹配。

detect_http_port

别名:detect-http-port

整数

检测 HTTP 端口。

detect_interval

别名:detect-interval

整数

检测间隔。

detect_protocol

别名:detect-protocol

字符串

检测协议。

选项

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

detect_recoverytime

别名:detect-recoverytime

整数

检测恢复时间。

detect_server

别名:detect-server

字符串

检测服务器。

detect_timeout

别名:detect-timeout

整数

检测超时。

dynamic_mapping

列表 / 元素=字典

动态映射。

_scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

vdom。

comment

字符串

注释。

cost

整数

成本。

detect_failtime

别名:detect-failtime

整数

检测故障时间。

detect_http_get

别名:detect-http-get

字符串

检测 HTTP GET。

detect_http_match

别名:detect-http-match

字符串

检测 HTTP 匹配。

detect_http_port

别名:detect-http-port

整数

检测 HTTP 端口。

detect_interval

别名:detect-interval

整数

检测间隔。

detect_protocol

别名:detect-protocol

字符串

检测协议。

选项

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

detect_recoverytime

别名:detect-recoverytime

整数

检测恢复时间。

detect_server

别名:detect-server

字符串

检测服务器。

detect_timeout

别名:detect-timeout

整数

检测超时。

gateway

字符串

网关。

gateway6

字符串

IPv6 网关。

ingress_spillover_threshold

别名:ingress-spillover-threshold

整数

入站溢出阈值。

interface

字符串

接口。

priority

整数

优先级。

source

字符串

源。

source6

字符串

IPv6 源。

spillover_threshold

别名:spillover-threshold

整数

溢出阈值。

status

字符串

状态。

选项

  • "disable"

  • "enable"

volume_ratio

别名:volume-ratio

整数

流量比例。

weight

整数

权重。

gateway

字符串

网关。

gateway6

字符串

IPv6 网关。

ingress_spillover_threshold

别名:ingress-spillover-threshold

整数

入站溢出阈值。

interface

字符串

接口。

name

字符串 / 必需

名称。

priority

整数

优先级。

source

字符串

源。

source6

字符串

IPv6 源。

spillover_threshold

别名:spillover-threshold

整数

溢出阈值。

status

字符串

状态。

选项

  • "disable"

  • "enable"

volume_ratio

别名:volume-ratio

整数

流量比例。

weight

整数

权重。

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"

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: FortiGate interfaces added to the virtual-wan-link.
      fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members:
        # 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>
        state: present # <value in [present, absent]>
        dynamic_virtualwanlink_members:
          comment: <string>
          cost: <integer>
          detect_failtime: <integer>
          detect_http_get: <string>
          detect_http_match: <string>
          detect_http_port: <integer>
          detect_interval: <integer>
          detect_protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          detect_recoverytime: <integer>
          detect_server: <string>
          detect_timeout: <integer>
          dynamic_mapping:
            -
              _scope:
                -
                  name: <string>
                  vdom: <string>
              comment: <string>
              cost: <integer>
              detect_failtime: <integer>
              detect_http_get: <string>
              detect_http_match: <string>
              detect_http_port: <integer>
              detect_interval: <integer>
              detect_protocol: <value in [ping, tcp-echo, udp-echo, ...]>
              detect_recoverytime: <integer>
              detect_server: <string>
              detect_timeout: <integer>
              gateway: <string>
              gateway6: <string>
              ingress_spillover_threshold: <integer>
              interface: <string>
              priority: <integer>
              source: <string>
              source6: <string>
              spillover_threshold: <integer>
              status: <value in [disable, enable]>
              volume_ratio: <integer>
              weight: <integer>
          gateway: <string>
          gateway6: <string>
          ingress_spillover_threshold: <integer>
          interface: <string>
          name: <string>
          priority: <integer>
          source: <string>
          source6: <string>
          spillover_threshold: <integer>
          status: <value in [disable, enable]>
          volume_ratio: <integer>
          weight: <integer>

返回值

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

键

描述

meta

字典

请求的结果。

返回:始终

request_url

字符串

请求的完整URL。

返回:始终

示例: "/sys/login/user"

response_code

整数

API请求的状态。

返回:始终

示例: 0

response_data

列表 / 元素=字符串

API响应。

返回:始终

response_message

字符串

API响应的描述性消息。

返回:始终

示例: "OK."

system_information

字典

目标系统的信息。

返回:始终

rc

整数

请求的状态。

返回:始终

示例: 0

version_check_warning

列表 / 元素=字符串

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

返回:复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李兴 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢宏斌 (@fgtdev-hblu)

收藏链接

  • 问题追踪器
  • 主页
  • 代码库 (源码)
上一页 下一页

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