fortinet.fortimanager.fmgr_wanprof_system_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_wanprof_system_virtualwanlink_members。

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_members 字典	顶级参数集。
_dynamic_member 别名: _dynamic-member 字符串	动态成员。
comment 字符串	注释。
cost 整数	此接口在 SLA 模式下服务的成本
gateway 字符串	此接口的默认网关。
gateway6 字符串	IPv6 网关。
ingress_spillover_threshold 别名: ingress-spillover-threshold 整数	此接口的入口溢出阈值
interface 字符串	接口名称。
priority 整数	接口的优先级
seq_num 别名: seq-num 整数 / 必需	序列号
source 字符串	在运行状况检查数据包中用于服务器的源 IP 地址。
source6 字符串	在运行状况检查数据包中用于服务器的源 IPv6 地址。
spillover_threshold 别名: spillover-threshold 整数	此接口的出口溢出阈值
status 字符串	启用/禁用 SD-WAN 中的此接口。选项 `"disable"` `"enable"`
volume_ratio 别名: volume-ratio 整数	测量的容量比率
weight 整数	此接口用于加权负载平衡的权重。
workspace_locking_adom 字符串	要在工作区模式下运行的 FortiManager 的锁定的 adom，该值可以是全局的和其他值，包括 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 可帮助完成工作。
要创建或更新对象，请使用状态存在指令。
要删除对象，请使用状态不存在指令。
通常，当返回非零 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: Physical FortiGate interfaces added to the virtual-wan-link.
      fortinet.fortimanager.fmgr_wanprof_system_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>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_members:
          _dynamic_member: <string>
          comment: <string>
          gateway: <string>
          gateway6: <string>
          ingress_spillover_threshold: <integer>
          interface: <string>
          priority: <integer>
          seq_num: <integer>
          source: <string>
          source6: <string>
          spillover_threshold: <integer>
          status: <value in [disable, enable]>
          volume_ratio: <integer>
          weight: <integer>
          cost: <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 版本支持，则会发出警告。返回：复杂类型

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)