fortinet.fortimanager.fmgr_dynamic_virtualwanlink_server_dynamicmapping 模块 – 动态虚拟 WAN 链路服务器动态映射

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_dynamic_virtualwanlink_server_dynamicmapping。

fortinet.fortimanager 2.0.0 中的新功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有参数和值，这些参数和值在使用前需要调整到数据源。

参数 

参数	注释
access_token 字符串	在不使用用户名和密码的情况下访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时，才设置为 True，模块继续执行而不验证参数。选择 `false` ← (默认) `true`
dynamic_virtualwanlink_server_dynamicmapping 字典	顶层参数集。
_scope 列表 / elements=dictionary	范围。
name 字符串	名称。
vdom 字符串	虚拟域。
server 任意	（列表）服务器。
enable_log 布尔值	启用/禁用任务日志记录。选择 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	用于底层 Json RPC 请求的重写方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / elements=integer	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=integer	将覆盖成功条件的 rc 代码列表。
server 字符串 / 必需	请求 URL 中的参数（服务器）。
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: Dynamic virtual wan link server dynamic mapping
      fortinet.fortimanager.fmgr_dynamic_virtualwanlink_server_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>
        server: <your own value>
        state: present # <value in [present, absent]>
        dynamic_virtualwanlink_server_dynamicmapping:
          _scope:
            -
              name: <string>
              vdom: <string>
          server: <list or string>

返回值 

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

键	描述
meta 字典	请求的结果。返回: 总是
request_url 字符串	请求的完整 URL。返回: 总是示例: `"/sys/login/user"`
response_code 整数	API 请求的状态。返回: 总是示例: `0`
response_data 列表 / elements=string	API 响应。返回: 总是
response_message 字符串	API 响应的描述性消息。返回: 总是示例: `"OK."`
system_information 字典	目标系统的信息。返回: 总是
rc 整数	请求的状态。返回: 总是示例: `0`
version_check_warning 列表 / elements=string	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。返回: 复杂

作者

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