fortinet.fortimanager.fmgr_dvm_cmd_update_device 模块 – 刷新设备的 FGFM 连接和系统信息。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新功能

概要 

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

参数 

参数	注释
access_token 字符串	在不使用用户名和密码的情况下访问 FortiManager 的令牌。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。选项 `false` ←（默认） `true`
dvm_cmd_update_device 字典	设置的顶层参数。
adom 字符串	要在其上执行命令的 ADOM 的名称或 ID。
device 字符串	目标设备的名称或 ID。
flags 列表 / 元素=字符串	create_task - 在任务管理器数据库中创建一个新任务。 nonblocking - API 将立即返回以进行非阻塞调用。选项 `“none”` `“create_task”` `“nonblocking”` `“log_dev”`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ←（默认） `true`
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌验证 Ansible 客户端。
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
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: Refresh the FGFM connection and system information of a device.
      fortinet.fortimanager.fmgr_dvm_cmd_update_device:
        # 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, ...]
        dvm_cmd_update_device:
          adom: <string>
          device: <string>
          flags:
            - "none"
            - "create_task"
            - "nonblocking"
            - "log_dev"

返回值 

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

键	描述
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 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。已返回：复杂

作者

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