fortinet.fortimanager.fmgr_system_logfetch_serversettings – Настройки сервера извлечения логов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач, укажите: fortinet.fortimanager.fmgr_system_logfetch_serversettings.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут игнорироваться условия отказа | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут игнорироваться условия успешного выполнения | ||
| state строка / обязательный |
| направление создания, обновления или удаления объекта | |
| system_logfetch_serversettings словарь | параметры верхнего уровня | ||
| max-conn-per-session целое число | По умолчанию: 3 | Максимальное количество одновременных подключений к файловому скачиванию на сессию. | |
| max-sessions целое число | По умолчанию: 1 | Максимальное количество одновременных сессий извлечения. | |
| session-timeout целое число | По умолчанию: 10 | Таймаут сессии извлечения в минутах. | |
| workspace_locking_adom строка | область ADOM для блокировки при работе FortiManager в режиме рабочей области. Значение может быть глобальным или другим, включая корневой. | ||
| 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: Log-fetch server settings.
fmgr_system_logfetch_serversettings:
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_logfetch_serversettings:
max-conn-per-session: <value of integer>
max-sessions: <value of integer>
session-timeout: <value of integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| 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_logfetch_serversettings_module.html
