fortinet.fortimanager.fmgr_dvmdb_adom – Таблица ADOM, большинство атрибутов — только для чтения и могут быть изменены только внутренне.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_adom.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров | |
| dvmdb_adom словарь | устанавливаемые параметры верхнего уровня | ||
| desc строка | нет описания | ||
| flags список / элементы=строка |
| нет описания | |
| log_db_retention_hours целое число | По умолчанию: 1440 | нет описания | |
| log_disk_quota целое число | нет описания | ||
| log_disk_quota_alert_thres целое число | По умолчанию: 90 | нет описания | |
| log_disk_quota_split_ratio целое число | По умолчанию: 70 | нет описания | |
| log_file_retention_hours целое число | По умолчанию: 8760 | нет описания | |
| meta fields словарь | нет описания | ||
| mig_mr целое число | По умолчанию: 2 | нет описания | |
| mig_os_ver строка |
| нет описания | |
| mode строка |
| ems - (Значение больше не используется с версии 4.3) provider - Глобальная база данных. | |
| mr целое число | По умолчанию: 2 | нет описания | |
| name строка | нет описания | ||
| os_ver строка |
| нет описания | |
| restricted_prds список / элементы=строка |
| нет описания | |
| state целое число | По умолчанию: 1 | нет описания | |
| uuid строка | нет описания | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут нарушены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут выполнены | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | ADOM для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным или другим, включая root | ||
| workspace_locking_timeout целое число | По умолчанию: 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: ADOM table, most attributes are read-only and can only be changed internally.
fmgr_dvmdb_adom:
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, ...]
state: <value in [present, absent]>
dvmdb_adom:
desc: <value of string>
flags:
- migration
- db_export
- no_vpn_console
- backup
- other_devices
- central_sdwan
- is_autosync
- per_device_wtp
- policy_check_on_install
- install_on_policy_check_fail
- auto_push_cfg
log_db_retention_hours: <value of integer>
log_disk_quota: <value of integer>
log_disk_quota_alert_thres: <value of integer>
log_disk_quota_split_ratio: <value of integer>
log_file_retention_hours: <value of integer>
meta fields: <value of dict>
mig_mr: <value of integer>
mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
mode: <value in [ems, gms, provider]>
mr: <value of integer>
name: <value of string>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
restricted_prds:
- fos
- foc
- fml
- fch
- fwb
- log
- fct
- faz
- fsa
- fsw
- fmg
- fdd
- fac
- fpx
state: <value of integer>
uuid: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрошенный URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа 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_adom_module.html