fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members_dynamicmapping 模块 – 添加到虚拟广域网链路的 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_dynamicmapping。

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前根据数据源调整的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
dynamic_virtualwanlink_members_dynamicmapping 字典	设置的顶级参数。
_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 整数	权重。
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌验证 Ansible 客户端。
members 字符串 / 必需	请求 URL 中的参数 (members)。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将被覆盖的导致失败的返回码列表。
rc_succeeded 列表 / 元素=整数	将被覆盖的导致成功的返回码列表。
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_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_dynamicmapping:
        # 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>
        members: <your own value>
        state: present # <value in [present, absent]>
        dynamic_virtualwanlink_members_dynamicmapping:
          _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>

返回值 

常见返回值在此处有记录此处，以下是此模块独有的字段

键	描述
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)