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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
device строка / обязательно	Параметр (device) в запрошенном URL.
dvmdb_device словарь	Установленные параметры верхнего уровня.
adm_pass любой	(список) Пароль администратора.
adm_usr строка	Имя пользователя администратора.
app_ver строка	Версия приложения.
av_ver строка	Версия антивируса.
beta целое число	Бета версия.
branch_pt целое число	Номер ветки.
build целое число	Номер сборки.
checksum строка	Контрольная сумма.
cluster_worker строка	Рабочий узел кластера.
conf_status строка	Статус конфигурации. Варианты: `"unknown"` `"insync"` `"outofsync"`
conn_mode строка	Режим подключения. Варианты: `"active"` `"passive"`
conn_status строка	Статус подключения. Варианты: `"UNKNOWN"` `"up"` `"down"`
db_status строка	Статус базы данных. Варианты: `"unknown"` `"nomod"` `"mod"`
desc строка	Описание.
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.
faz.full_act целое число	Устаревшее, переименуйте на faz_full_act. Faz.
faz.perm целое число	Устаревшее, переименуйте на faz_perm. Faz.

END_OF_DOCUMENT_MARKER

faz.quota integer	Устарело, переименуйте в faz_quota. Faz.
faz.used integer	Устарело, переименуйте в faz_used. Faz.
fex_cnt integer	Fex cnt.
first_tunnel_up integer	Первый поднятый туннель.
flags list / 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 integer	Количество vCPU счетчика VM.
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 / elements=string	Сервисы VM Meter fw - Брандмауэр av - Антивирус ips - IPS app - Контроль приложений url - Веб-фильтр utm - Полный UTM fwb - FortiWeb Варианты: `"fw"` `"av"` `"ips"` `"app"` `"url"` `"utm"` `"fwb"`
fsw_cnt integer	Fsw cnt.
ha.vsn string	Устарело, переименуйте в ha_vsn. Ha.
ha_group_id integer	ID группы HA.
ha_group_name string	Имя группы HA.
ha_mode string	Включено - значение зарезервировано для устройств HA без FOS. Варианты: `"standalone"` `"AP"` `"AA"` `"ELBC"` `"DUAL"` `"enabled"` `"unknown"` `"fmg-enabled"` `"autoscale"`
ha_slave list / elements=dictionary	Ведомый HA.
conf_status integer	Статус конфигурации.
idx integer	Idx.
name string	Имя.
prio integer	Приоритет.

role string	Роль. Choices: `"slave"` `"master"`
sn string	Серийный номер.
status integer	Статус.
ha_upgrade_mode integer	Режим обновления HA.
hdisk_size integer	Размер жесткого диска.
hostname string	Имя хоста.
hw_generation integer	Поколение оборудования.
hw_rev_major integer	Основная версия оборудования.
hw_rev_minor integer	Второстепенная версия оборудования.
hyperscale integer	Hyperscale.
ip string	IP-адрес.
ips_ext integer	Ips ext.
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	Maxvdom.
meta fields dictionary	Устарело, переименуйте в meta_fields. Метаданные по умолчанию
mgmt_id integer	ID управления.
mgmt_if string	Интерфейс управления.
mgmt_mode string	Режим управления. Choices: `"unreg"` `"fmg"` `"faz"` `"fmgfaz"`
mgmt_uuid string	UUID управления.
mgt_vdom string	Управляющий vdom.

module_sn string	Серийный номер модуля.
mr integer	Mr.
name string	Уникальное имя устройства.
nsxt_service_name string	Имя службы Nsxt.
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"`
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	Patch.
platform_str string	Platform str.
prefer_img_ver string	Prefer img ver.
prio integer	Prio.
private_key string	Закрытый ключ.
private_key_status integer	Статус закрытого ключа.
psk string	Psk.
relver_info string	Relver info.
role string	Роль. Варианты: `"master"` `"ha-slave"` `"autoscale-slave"`
sn string	Уникальное значение для каждого устройства.
vdom list / elements=dictionary	Vdom.
comments string	Комментарии.
meta fields dictionary	Устарело, переименуйте в meta_fields. Метаданные.
name string	Имя.
opmode string	Режим работы. Варианты: `"nat"` `"transparent"`
rtm_prof_id integer	ID профиля 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_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, значение может быть глобальным и другими, включая корневой.
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
      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 список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_dvmdb_device_module.html