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 设备。 
- 示例包括所有需要在使用前根据数据源调整的参数和值。 
参数
| 参数 | 注释 | 
|---|---|
| 无需使用用户名和密码即可访问 FortiManager 的令牌。 | |
| 请求 URL 中的参数 (adom)。 | |
| 仅当模块模式与 FortiManager API 结构差异时设置为 True,模块将继续执行而无需验证参数。 选项 
 | |
| 设置的顶级参数。 | |
| 注释。 | |
| 成本。 | |
| 检测故障时间。 | |
| 检测 HTTP GET。 | |
| 检测 HTTP 匹配。 | |
| 检测 HTTP 端口。 | |
| 检测间隔。 | |
| 检测协议。 选项 
 | |
| 检测恢复时间。 | |
| 检测服务器。 | |
| 检测超时。 | |
| 动态映射。 | |
| 范围。 | |
| 名称。 | |
| vdom。 | |
| 注释。 | |
| 成本。 | |
| 检测故障时间。 | |
| 检测 HTTP GET。 | |
| 检测 HTTP 匹配。 | |
| 检测 HTTP 端口。 | |
| 检测间隔。 | |
| 检测协议。 选项 
 | |
| 检测恢复时间。 | |
| 检测服务器。 | |
| 检测超时。 | |
| 网关。 | |
| IPv6 网关。 | |
| 入站溢出阈值。 | |
| 接口。 | |
| 优先级。 | |
| 源。 | |
| IPv6 源。 | |
| 溢出阈值。 | |
| 状态。 选项 
 | |
| 流量比例。 | |
| 权重。 | |
| 网关。 | |
| IPv6 网关。 | |
| 入站溢出阈值。 | |
| 接口。 | |
| 名称。 | |
| 优先级。 | |
| 源。 | |
| IPv6 源。 | |
| 溢出阈值。 | |
| 状态。 选项 
 | |
| 流量比例。 | |
| 权重。 | |
| 启用/禁用任务日志记录。 选项 
 | |
| 使用FortiCloud API访问令牌验证Ansible客户端。 | |
| 底层Json RPC请求的覆盖方法。 选项 
 | |
| 将覆盖失败条件的RC代码列表。 | |
| 将覆盖成功条件的RC代码列表。 | |
| 创建、更新或删除对象的指令。 选项 
 | |
| 在工作区模式下运行FortiManager时要锁定的ADOM,值可以是global和其他包括root。 | |
| 等待其他用户释放工作区锁的最大时间(秒)。 默认值:  | 
注释
注意
- 从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>
返回值
常用的返回值已在此处记录,以下是此模块特有的字段
| 键 | 描述 | 
|---|---|
| 请求的结果。 返回:始终 | |
| 请求的完整URL。 返回:始终 示例:  | |
| API请求的状态。 返回:始终 示例:  | |
| API响应。 返回:始终 | |
| API响应的描述性消息。 返回:始终 示例:  | |
| 目标系统的信息。 返回:始终 | |
| 请求的状态。 返回:始终 示例:  | |
| 如果剧本中使用的参数不受当前FortiManager版本支持,则会发出警告。 返回:复杂类型 | 
