Модуль fortinet.fortimanager.fmgr_dvmdb_device — таблица устройств, большинство атрибутов доступны только для чтения и могут изменяться только внутри системы.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_dvmdb_device.

Добавлено в fortinet.fortimanager 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит работу без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
device string / обязательный	Параметр (device) в запрошенном URL.
dvmdb_device dictionary	Задаёт параметры верхнего уровня.
adm_pass any	(список) Пароль администратора.
adm_usr string	Имя пользователя администратора.
app_ver string	Версия приложений.
av_ver string	Версия антивируса.
beta integer	Бета-версия.
branch_pt integer	Точка ветвления.
build integer	Сборка.
checksum string	Контрольная сумма.
cluster_worker string	Рабочий узел кластера.
conf_status string	Состояние конфигурации. Варианты: `"unknown"` `"insync"` `"outofsync"`
conn_mode string	Режим подключения. Варианты: `"active"` `"passive"`
conn_status string	Состояние подключения. Варианты: `"UNKNOWN"` `"up"` `"down"`
db_status string	Состояние базы данных. Варианты: `"unknown"` `"nomod"` `"mod"`
desc string	Описание.
dev_status string	Состояние устройства. Варианты: `"none"` `"unknown"` `"checkedin"` `"inprogress"` `"installed"` `"aborted"` `"sched"` `"retry"` `"canceled"` `"pending"` `"retrieved"` `"changed_conf"` `"sync_fail"` `"timeout"` `"rev_revert"` `"auto_updated"`
eip string	Внешний IP-адрес.
fap_cnt integer	Количество FAP.
faz_full_act псевдонимы: faz.full_act integer	FAZ.
faz_perm псевдонимы: faz.perm integer	FAZ.
faz_quota псевдонимы: faz.quota integer	FAZ.
faz_used псевдонимы: faz.used integer	FAZ.
fex_cnt integer	Количество FEX.
first_tunnel_up integer	Время поднятия первого туннеля.
flags list / элементы=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 integer	Количество vCPU в VM Meter.
foslic_dr_site string	Состояние площадки аварийного восстановления VM Meter. Варианты: `"disable"` `"enable"`
foslic_inst_time integer	Время первого развертывания VM Meter
foslic_last_sync integer	Время последней синхронизации VM Meter
foslic_ram integer	Размер оперативной памяти устройства VM Meter
foslic_type string	Тип лицензии VM Meter. Варианты: `"temporary"` `"trial"` `"regular"` `"trial_expired"`
foslic_utm list / элементы=string	Службы VM Meter fw — межсетевой экран av — антивирус ips — IPS app — управление приложениями url — веб-фильтр utm — полный UTM fwb — FortiWeb Варианты: `"fw"` `"av"` `"ips"` `"app"` `"url"` `"utm"` `"fwb"`
fsw_cnt integer	Количество FSW.
ha_group_id integer	Идентификатор группы HA.
ha_group_name string	Имя группы HA.
ha_mode string	Enabled — значение зарезервировано для устройств HA, не работающих под управлением FOS. Варианты: `"standalone"` `"AP"` `"AA"` `"ELBC"` `"DUAL"` `"enabled"` `"unknown"` `"fmg-enabled"` `"autoscale"`
ha_slave list / элементы=dictionary	Подчинённый узел HA.
conf_status integer	Состояние конфигурации.
idx integer	Индекс.
name string	Имя.
prio integer	Приоритет.
role string	Роль. Варианты: `"slave"` `"master"`
sn string	Серийный номер.
status integer	Состояние.
ha_upgrade_mode integer	Режим обновления HA.
ha_vsn псевдонимы: ha.vsn string	HA.
hdisk_size integer	Размер жесткого диска.
hostname string	Имя хоста.
hw_generation integer	Поколение аппаратного обеспечения.
hw_rev_major integer	Старшая часть ревизии аппаратного обеспечения.
hw_rev_minor integer	Младшая часть ревизии аппаратного обеспечения.
hyperscale integer	Гипермасштабирование.
ip string	IP-адрес.
ips_ext integer	Расширение IPS.
ips_ver string	Версия IPS.
last_checked integer	Время последней проверки.
last_resync integer	Время последней повторной синхронизации.
latitude string	Широта.
lic_flags integer	Флаги лицензии.
lic_region string	Регион лицензии.
location_from string	Источник местоположения.
logdisk_size integer	Размер диска для журналов.
longitude string	Долгота.

maxvdom integer	Максимальное количество VDOM.
meta_fields aliases: meta fields dictionary	Метаполя по умолчанию
mgmt_id integer	Идентификатор управления.
mgmt_if string	Интерфейс управления.
mgmt_mode string	Режим управления. Варианты: `"unreg"` `"fmg"` `"faz"` `"fmgfaz"`
mgmt_uuid string	UUID управления.
mgt_vdom string	VDOM управления.
module_sn string	Серийный номер модуля.
mr integer	MR.
name string	Уникальное имя устройства.
nsxt_service_name string	Имя службы NSX-T.
os_type string	Тип ОС. Варианты: `"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"` `"fra"` `"sim"`
os_ver string	Версия ОС. Варианты: `"unknown"` `"0.0"` `"1.0"` `"2.0"` `"3.0"` `"4.0"` `"5.0"` `"6.0"` `"7.0"` `"8.0"` `"9.0"`
patch integer	Патч.
platform_str string	Строка платформы.
prefer_img_ver string	Предпочтительная версия образа.
prio integer	Приоритет.
private_key string	Закрытый ключ.
private_key_status integer	Состояние закрытого ключа.
psk string	Предварительно установленный ключ.
relver_info string	Сведения о версии выпуска.
role string	Роль. Варианты: `"master"` `"ha-slave"` `"autoscale-slave"`
sn string	Уникальное значение для каждого устройства.
sov_sase_license string	Лицензия SOV SASE.
tunnel_sn string	Серийный номер туннеля.
vdom list / elements=dictionary	VDOM.
comments string	Комментарии.
meta_fields aliases: meta fields dictionary	Метаполя.
name string	Имя.
opmode string	Режим работы. Варианты: `"nat"` `"transparent"`
rtm_prof_id integer	Идентификатор профиля RTM.
status string	Состояние.
vdom_type string	Тип VDOM. Варианты: `"traffic"` `"admin"`
vpn_id integer	Идентификатор VPN.
version integer	Версия.
vm_cpu integer	Процессор VM.
vm_cpu_limit integer	Ограничение процессора VM.
vm_lic_expire integer	Срок действия лицензии VM.
vm_lic_overdue_since integer	Дата, с которой лицензия VM просрочена.
vm_mem integer	Память VM.
vm_mem_limit integer	Ограничение памяти VM.
vm_payg_status integer	Состояние оплаты VM по мере использования (PAYG).
vm_status any	(int или str) Состояние VM.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, для которых переопределяются условия успешного выполнения.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global и другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов используют соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
Этот модуль 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 of deleting device
      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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое сообщение в ответе API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_dvmdb_device_module.html