fortinet.fortimanager.fmgr_system_dm – Настройка dm.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_dm.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут выполняться | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут выполняться | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| system_dm словарь | настройки верхнего уровня | ||
| concurrent-install-image-limit целое число | Значение по умолчанию: 500 | Максимальное количество одновременных установок изображений (1 - 1000). | |
| concurrent-install-limit целое число | Значение по умолчанию: 480 | Максимальное количество одновременных установок (5 - 2000). | |
| concurrent-install-script-limit целое число | Значение по умолчанию: 480 | Максимальное количество одновременных установок скриптов (5 - 2000). | |
| discover-timeout целое число | Значение по умолчанию: 6 | Таймаут проверки подключения при обнаружении устройства (3 - 15). | |
| dpm-logsize целое число | Значение по умолчанию: 10000 | Максимальный размер лога dpm на устройство (1 - 10000 Кб). | |
| fgfm-sock-timeout целое число | Значение по умолчанию: 360 | Максимальное время простоя сокета FGFM (90 - 1800 сек). | |
| fgfm_keepalive_itvl целое число | Значение по умолчанию: 120 | Интервал проверки активности протокола FGFM (30 - 600 сек). | |
| force-remote-diff строка |
| Всегда использовать удаленное сравнение при установке. отключено - Отключить. включено - Включить. | |
| fortiap-refresh-cnt целое число | Значение по умолчанию: 500 | Максимальное количество автоматических обновлений FortiAP за один раз (1 - 10000). | |
| fortiap-refresh-itvl целое число | Значение по умолчанию: 10 | Интервал автоматического обновления статуса FortiAP (0 - 1440) минут, значение 0 отключает автоматическое обновление. | |
| fortiext-refresh-cnt целое число | Значение по умолчанию: 50 | Максимальное количество устройств FortiExtender для автоматического обновления (1 - 10000). | |
| install-image-timeout целое число | Значение по умолчанию: 3600 | Максимальное время ожидания передачи изображения и обновления устройства (600 - 7200 сек). | |
| install-tunnel-retry-itvl целое число | Значение по умолчанию: 60 | Время повторной установления туннеля во время установки (10 - 60 сек). | |
| max-revs целое число | Значение по умолчанию: 100 | Максимальное количество сохранённых ревизий (1 - 250). | |
| nr-retry целое число | Значение по умолчанию: 1 | Количество попыток. | |
| retry строка |
| Включение/отключение повторной установки конфигурации. отключено - Отключить. включено - Включить. | |
| retry-intvl целое число | Значение по умолчанию: 15 | Интервал повтора. | |
| rollback-allow-reboot строка |
| Включение/отключение перезагрузки FortiGate для отката при установке скрипта/конфигурации. отключено - Отключить. включено - Включить. | |
| script-logsize целое число | Значение по умолчанию: 100 | Максимальный размер лога скрипта на устройство (1 - 10000 Кб). | |
| skip-scep-check строка |
| Включение/отключение установки объектов, связанных с scep, даже если scep url настроен. отключено - Отключить. включено - Включить. | |
| skip-tunnel-fcp-req строка |
| Включение/отключение пропуска запроса fcp, отправленного из туннеля fgfm. отключено - Отключить. включено - Включить. | |
| verify-install строка |
| Проверка установки по сравнению с удалённой конфигурацией. отключено - Отключить. оптимально - Проверка установки на наличие ошибок команд. включено - Всегда проверять установку. | |
| workspace_locking_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: Configure dm.
fmgr_system_dm:
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, ...]
system_dm:
concurrent-install-image-limit: <value of integer>
concurrent-install-limit: <value of integer>
concurrent-install-script-limit: <value of integer>
discover-timeout: <value of integer>
dpm-logsize: <value of integer>
fgfm-sock-timeout: <value of integer>
fgfm_keepalive_itvl: <value of integer>
force-remote-diff: <value in [disable, enable]>
fortiap-refresh-cnt: <value of integer>
fortiap-refresh-itvl: <value of integer>
fortiext-refresh-cnt: <value of integer>
install-image-timeout: <value of integer>
install-tunnel-retry-itvl: <value of integer>
max-revs: <value of integer>
nr-retry: <value of integer>
retry: <value in [disable, enable]>
retry-intvl: <value of integer>
rollback-allow-reboot: <value in [disable, enable]>
script-logsize: <value of integer>
skip-scep-check: <value in [disable, enable]>
skip-tunnel-fcp-req: <value in [disable, enable]>
verify-install: <value in [disable, optimal, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_system_dm_module.html
