fortinet.fortimanager.fmgr_dvmdb_device 模块 – 设备表，大多数属性为只读，只能在内部更改。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包括所有需要在使用前调整为数据源的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选项 false ←（默认） true
device 字符串 / 必需	请求 URL 中的参数 (device)。
dvmdb_device 字典	设置的顶级参数。
adm_pass 任何	（列表）Adm pass。
adm_usr 字符串	Adm usr。
app_ver 字符串	App ver。
av_ver 字符串	Av ver。
beta 整数	Beta。
branch_pt 整数	Branch pt。
build 整数	Build。
checksum 字符串	Checksum。
cluster_worker 字符串	Cluster worker。
conf_status 字符串	Conf status。 选项 "unknown" "insync" "outofsync"
conn_mode 字符串	Conn mode。 选项 "active" "passive"
conn_status 字符串	Conn status。 选项 "UNKNOWN" "up" "down"
db_status 字符串	Db status。 选项 "unknown" "nomod" "mod"
desc 字符串	Desc。
dev_status 字符串	Dev status。 选项 "none" "unknown" "checkedin" "inprogress" "installed" "aborted" "sched" "retry" "canceled" "pending" "retrieved" "changed_conf" "sync_fail" "timeout" "rev_revert" "auto_updated"
eip 字符串	Eip。
fap_cnt 整数	Fap cnt。
faz_full_act 别名：faz.full_act 整数	Faz。
faz_perm 别名：faz.perm 整数	Faz。
faz_quota 别名：faz.quota 整数	Faz。
faz_used 别名：faz.used 整数	Faz。
fex_cnt 整数	Fex cnt。
first_tunnel_up 整数	First tunnel up。
flags 列表 / elements=string	标志。 选项 "has_hdd" "vdom_enabled" "discover" "reload" "interim_build" "offline_mode" "is_model" "fips_mode" "linked_to_model" "ip-conflict" "faz-autosync" "need_reset" "backup_mode" "azure_vwan_nva" "fgsp_configured" "cnf_mode" "sase_managed" "override_management_intf" "sdwan_management" "deny_api_access"
foslic_cpu 整数	VM Meter vCPU 计数。
foslic_dr_site 字符串	VM Meter DR 站点状态。 选项 "disable" "enable"
foslic_inst_time 整数	VM Meter 首次部署时间
foslic_last_sync 整数	VM Meter 上次同步时间
foslic_ram 整数	VM Meter 设备 RAM 大小
foslic_type 字符串	VM Meter 许可证类型。 选项 "temporary" "trial" "regular" "trial_expired"
foslic_utm 列表 / elements=string	VM Meter 服务 fw - 防火墙 av - 防病毒 ips - IPS app - 应用程序控制 url - Web 过滤器 utm - 完整 UTM fwb - FortiWeb 选项 "fw" "av" "ips" "app" "url" "utm" "fwb"
fsw_cnt 整数	Fsw cnt。
ha_group_id 整数	Ha group id。
ha_group_name 字符串	Ha group name。
ha_mode 字符串	启用 - 为非 FOS HA 设备保留的值。 选项 "standalone" "AP" "AA" "ELBC" "DUAL" "enabled" "unknown" "fmg-enabled" "autoscale"
ha_slave 列表 / 元素=字典	Ha 从设备。
conf_status 整数	Conf status。
idx 整数	索引。
name 字符串	名称。
prio 整数	优先级。
role 字符串	角色。 选项 "slave" "master"
sn 字符串	序列号。
status 整数	状态。
ha_upgrade_mode 整数	Ha 升级模式。
ha_vsn 别名: ha.vsn 字符串	Ha。
hdisk_size 整数	硬盘大小。
hostname 字符串	主机名。
hw_generation 整数	硬件代数。
hw_rev_major 整数	硬件主修订版本。
hw_rev_minor 整数	硬件次修订版本。
hyperscale 整数	超大规模。
ip 字符串	IP地址。
ips_ext 整数	IPS 扩展。
ips_ver 字符串	IPS 版本。
last_checked 整数	上次检查时间。
last_resync 整数	上次重新同步时间。
latitude 字符串	纬度。
lic_flags 整数	许可证标志。
lic_region 字符串	许可证区域。
location_from 字符串	位置来源。
logdisk_size 整数	日志磁盘大小。
longitude 字符串	经度。
maxvdom 整数	最大虚拟域。
meta_fields 别名: meta fields 字典	默认元字段
mgmt_id 整数	管理 ID。
mgmt_if 字符串	管理接口。
mgmt_mode 字符串	管理模式。 选项 "unreg" "fmg" "faz" "fmgfaz"
mgmt_uuid 字符串	管理 UUID。
mgt_vdom 字符串	管理虚拟域。
module_sn 字符串	模块序列号。
mr 整数	Mr。
name 字符串	设备的唯一名称。
nsxt_service_name 字符串	NSXT 服务名称。
os_type 字符串	操作系统类型。 选项 "unknown" "fos" "fsw" "foc" "fml" "faz" "fwb" "fch" "fct" "log" "fmg" "fsa" "fdd" "fac" "fpx" "fna" "fdc" "ffw" "fsr" "fad" "fap" "fxt" "fts" "fai" "fwc" "fis" "fed" "fpa" "fca" "ftc" "fss"
os_ver 字符串	操作系统版本。 选项 "unknown" "0.0" "1.0" "2.0" "3.0" "4.0" "5.0" "6.0" "7.0" "8.0" "9.0"
patch 整数	补丁。
platform_str 字符串	平台字符串。
prefer_img_ver 字符串	首选镜像版本。
prio 整数	优先级。
private_key 字符串	私钥。
private_key_status 整数	私钥状态。
psk 字符串	预共享密钥。
relver_info 字符串	版本信息。
role 字符串	角色。 选项 "master" "ha-slave" "autoscale-slave"
sn 字符串	每个设备的唯一值。
vdom 列表 / 元素=字典	虚拟域。
comments 字符串	注释。
meta_fields 别名: meta fields 字典	元字段。
name 字符串	名称。
opmode 字符串	操作模式。 选项 "nat" "transparent"
rtm_prof_id 整数	RTM 配置文件 ID。
status 字符串	状态。
vdom_type 字符串	虚拟域类型。 选项 "traffic" "admin"
vpn_id 整数	VPN ID。
version 整数	版本。
vm_cpu 整数	虚拟机 CPU。
vm_cpu_limit 整数	虚拟机 CPU 限制。
vm_lic_expire 整数	虚拟机许可证过期时间。
vm_lic_overdue_since 整数	虚拟机许可证逾期时间。
vm_mem 整数	虚拟机内存。
vm_mem_limit 整数	虚拟机内存限制。
vm_payg_status 整数	虚拟机按需付费状态。
vm_status 任何	（整数或字符串）虚拟机状态。
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ←（默认） true
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	用于底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的返回代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的返回代码列表。
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 有助于完成工作。

• 通常，当返回非零 rc 时，运行一个模块可能会失败。 您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件

示例

- name: Delete first FOS devices from FMG In a specific adom
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
    device_adom: "root"
  tasks:
    - name: Fetch all devices
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "dvmdb_device"
          params:
            adom: "{{ device_adom }}"
            device: "your_value"
      register: alldevices
    - name: No name
      when: alldevices.meta.response_data != []
      ansible.builtin.debug:
        msg:
          - "We are going to delete device: {{ alldevices.meta.response_data[0].name }}"
          - "IP of the device is: {{ alldevices.meta.response_data[0].ip }}"
    - name: Create The Task To Delete The Device
      when: alldevices.meta.response_data != [] and False
      fortinet.fortimanager.fmgr_dvm_cmd_del_device:
        dvm_cmd_del_device:
          device: "{{ alldevices.meta.response_data[0].name }}"
          adom: "{{ device_adom }}"
          flags:
            - "create_task"
            - "nonblocking"
      register: uninstalling_task
    - name: Poll the task
      when: alldevices.meta.response_data != [] and False
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ uninstalling_task.meta.response_data.taskid }}"
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 5
      failed_when: taskinfo.meta.response_data.state == 'error'

返回值

通用返回值已在此处记录 此处，以下是此模块独有的字段

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

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）