fortinet.fortimanager.fmgr_system_report_setting – Настройки отчетов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_report_setting.
Новое в версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия успешного завершения | ||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | |
| system_report_setting словарь | параметры верхнего уровня | ||
| aggregate-report строка |
| Включить/выключить включение отчета группы вместе с отчетами по устройствам. выключить - Исключить отчет группы вместе с отчетами по устройствам. включить - Включить отчет группы вместе с отчетами по устройствам. | |
| hcache-lossless строка |
| Использование кэшей hc без потерь. выключить - Использовать кэши hc с потерями. включить - Не использовать кэши hc с потерями. | |
| ldap-cache-timeout целое число | Значение по умолчанию: 60 | Тайм-аут кэша LDAP в минутах, по умолчанию 60, 0 - кэш не используется. | |
| max-table-rows целое число | Значение по умолчанию: 10000 | Максимальное количество строк, которые могут быть сгенерированы в одной таблице. | |
| report-priority строка |
| Приоритет отчета sql. высокий - Высокий низкий - Низкий авто - Автоматический | |
| template-auto-install строка |
| Язык, используемый для новых ADOM (по умолчанию = по умолчанию). по умолчанию - По умолчанию. английский - Английский. | |
| week-start строка |
| День недели, с которого начинается неделя. воскресенье - Воскресенье. понедельник - Понедельник. | |
| 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: Report settings.
fmgr_system_report_setting:
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_report_setting:
aggregate-report: <value in [disable, enable]>
hcache-lossless: <value in [disable, enable]>
ldap-cache-timeout: <value of integer>
max-table-rows: <value of integer>
report-priority: <value in [high, low, auto]>
template-auto-install: <value in [default, english]>
week-start: <value in [sun, mon]>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_report_setting_module.html
