fortinet.fortimanager.fmgr_dvmdb_device – Таблица устройств, большинство атрибутов являются только для чтения и могут быть изменены только внутренне. Обратитесь к модулю команд Device Manager для API добавления, d…
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_device
Новое в версии 2.10: of fortinet.fortimanager
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать согласно источникам данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation логическое значение |
| устанавливается в True только в случае расхождений схемы модуля со структурой API FortiManager, модуль продолжает выполнение без валидации параметров | ||
| device строка / обязательно | параметр (device) в запрошенном URL | |||
| dvmdb_device словарь | установленные параметры верхнего уровня | |||
| adm_pass строка | нет описания | |||
| adm_usr строка | нет описания | |||
| app_ver строка | нет описания | |||
| av_ver строка | нет описания | |||
| beta целое число | нет описания | |||
| branch_pt целое число | нет описания | |||
| build целое число | нет описания | |||
| checksum строка | нет описания | |||
| conf_status строка |
| нет описания | ||
| conn_mode строка |
| нет описания | ||
| conn_status строка |
| нет описания | ||
| db_status строка |
| нет описания | ||
| desc строка | нет описания | |||
| dev_status строка |
| нет описания | ||
| fap_cnt целое число | нет описания | |||
| faz.full_act целое число | нет описания | |||
| faz.perm целое число | нет описания | |||
| faz.quota целое число | нет описания | |||
| faz.used целое число | нет описания | |||
| fex_cnt целое число | нет описания | |||
| flags список / элементы=строка |
| нет описания | ||
| foslic_cpu целое число | Количество vCPU виртуальной машины. | |||
| foslic_dr_site строка |
| Статус сайта аварийного восстановления виртуальной машины. | ||
| foslic_inst_time целое число | Время первой развертывания виртуальной машины (в формате UNIX timestamp). | |||
| foslic_last_sync целое число | Время последней синхронизации виртуальной машины (в формате UNIX timestamp). | |||
| foslic_ram целое число | Размер ОЗУ виртуальной машины (в МБ). | |||
| foslic_type строка |
| Тип лицензии виртуальной машины. | ||
| foslic_utm список / элементы=строка |
| нет описания | ||
| fsw_cnt целое число | нет описания | |||
| ha_group_id целое число | нет описания | |||
| ha_group_name строка | нет описания | |||
| ha_mode строка |
| включено - Значение, зарезервированное для устройств HA, не являющихся FOS. | ||
| hdisk_size целое число | нет описания | |||
| hostname строка | нет описания | |||
| hw_rev_major целое число | нет описания | |||
| hw_rev_minor целое число | нет описания | |||
| ip строка | нет описания | |||
| ips_ext целое число | нет описания | |||
| ips_ver строка | нет описания | |||
| last_checked целое число | нет описания | |||
| last_resync целое число | нет описания | |||
| latitude строка | нет описания | |||
| lic_flags целое число | нет описания | |||
| lic_region строка | нет описания | |||
| location_from строка | нет описания | |||
| logdisk_size целое число | нет описания | |||
| longitude строка | нет описания | |||
| maxvdom целое число | Значение по умолчанию: 10 | нет описания | ||
| meta fields словарь | нет описания | |||
| mgmt_id целое число | нет описания | |||
| mgmt_if строка | нет описания | |||
| mgmt_mode строка |
| нет описания | ||
| mgt_vdom строка | нет описания | |||
| mr целое число | Значение по умолчанию: -1 | нет описания | ||
| name string | Уникальное имя устройства. | |||
| os_type string |
| нет описания | ||
| os_ver string |
| нет описания | ||
| patch integer | нет описания | |||
| platform_str string | нет описания | |||
| psk string | нет описания | |||
| sn string | Уникальное значение для каждого устройства. | |||
| vdom list / elements=string | нет описания | |||
| comments string | нет описания | |||
| name string | нет описания | |||
| opmode string |
| нет описания | ||
| rtm_prof_id integer | нет описания | |||
| status string | нет описания | |||
| version integer | нет описания | |||
| vm_cpu integer | нет описания | |||
| vm_cpu_limit integer | нет описания | |||
| vm_lic_expire integer | нет описания | |||
| vm_mem integer | нет описания | |||
| vm_mem_limit integer | нет описания | |||
| vm_status integer | нет описания | |||
| rc_failed list / elements=string | список rc-кодов, при которых условия выполнения будут игнорированы | |||
| rc_succeeded list / elements=string | список rc-кодов, при которых условия выполнения будут игнорированы | |||
| state string / required |
| директива создания, обновления или удаления объекта | ||
| workspace_locking_adom string | аддомен для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой | |||
| workspace_locking_timeout integer | По умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем | ||
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно модуль может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия для завершения ошибкой или успешного выполнения с помощью параметров rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Device table, most attributes are read-only and can only be changed internally. Refer to Device Manager Command module for API to add, d...
fmgr_dvmdb_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, ...]
adom: <your own value>
device: <your own value>
dvmdb_device:
adm_pass: <value of string>
adm_usr: <value of string>
app_ver: <value of string>
av_ver: <value of string>
beta: <value of integer>
branch_pt: <value of integer>
build: <value of integer>
checksum: <value of string>
conf_status: <value in [unknown, insync, outofsync]>
conn_mode: <value in [active, passive]>
conn_status: <value in [UNKNOWN, up, down]>
db_status: <value in [unknown, nomod, mod]>
desc: <value of string>
dev_status: <value in [none, unknown, checkedin, ...]>
fap_cnt: <value of integer>
faz.full_act: <value of integer>
faz.perm: <value of integer>
faz.quota: <value of integer>
faz.used: <value of integer>
fex_cnt: <value of integer>
flags:
- has_hdd
- vdom_enabled
- discover
- reload
- interim_build
- offline_mode
- is_model
- fips_mode
- linked_to_model
- ip-conflict
- faz-autosync
foslic_cpu: <value of integer>
foslic_dr_site: <value in [disable, enable]>
foslic_inst_time: <value of integer>
foslic_last_sync: <value of integer>
foslic_ram: <value of integer>
foslic_type: <value in [temporary, trial, regular, ...]>
foslic_utm:
- fw
- av
- ips
- app
- url
- utm
- fwb
fsw_cnt: <value of integer>
ha_group_id: <value of integer>
ha_group_name: <value of string>
ha_mode: <value in [standalone, AP, AA, ...]>
hdisk_size: <value of integer>
hostname: <value of string>
hw_rev_major: <value of integer>
hw_rev_minor: <value of integer>
ip: <value of string>
ips_ext: <value of integer>
ips_ver: <value of string>
last_checked: <value of integer>
last_resync: <value of integer>
latitude: <value of string>
lic_flags: <value of integer>
lic_region: <value of string>
location_from: <value of string>
logdisk_size: <value of integer>
longitude: <value of string>
maxvdom: <value of integer>
meta fields: <value of dict>
mgmt_id: <value of integer>
mgmt_if: <value of string>
mgmt_mode: <value in [unreg, fmg, faz, ...]>
mgt_vdom: <value of string>
mr: <value of integer>
name: <value of string>
os_type: <value in [unknown, fos, fsw, ...]>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
patch: <value of integer>
platform_str: <value of string>
psk: <value of string>
sn: <value of string>
vdom:
-
comments: <value of string>
name: <value of string>
opmode: <value in [nat, transparent]>
rtm_prof_id: <value of integer>
status: <value of string>
version: <value of integer>
vm_cpu: <value of integer>
vm_cpu_limit: <value of integer>
vm_lic_expire: <value of integer>
vm_mem: <value of integer>
vm_mem_limit: <value of integer>
vm_status: <value of integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| request_url string | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_dvmdb_device_module.html