модуль fortinet.fortimanager.fmgr_system_locallog_fortianalyzer_setting – Настройки отправки локальных журналов в FortiAnalyzer.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_system_locallog_fortianalyzer_setting.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, которыми будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, которыми будут переопределены условия успешного выполнения. |
system_locallog_fortianalyzer_setting dictionary | Набор параметров верхнего уровня. |
|
peer_cert_cn псевдонимы: peer-cert-cn string |
Общее имя сертификата удаленного FortiAnalyzer. |
|
reliable string |
Включить/отключить надежное ведение журналов в реальном времени. disable — отключить надежное ведение журналов в реальном времени. enable — включить надежное ведение журналов в реальном времени. Варианты:
|
|
secure_connection псевдонимы: secure-connection string |
Включить/отключить защищенное TLS/SSL-соединение. disable — отключить SSL-соединение. enable — включить SSL-соединение. Варианты:
|
|
server string |
FQDN, имя хоста или IP-адрес удаленного сервера FortiAnalyzer |
|
server_ip псевдонимы: server-ip string |
IP-адрес удаленного сервера FortiAnalyzer. |
|
severity string |
Минимальный уровень серьезности событий для записи в журнал. emergency — критический уровень. alert — уровень предупреждения. critical — высокий уровень. error — уровень ошибки. warning — уровень предупреждения. notification — уровень уведомления. information — информационный уровень. debug — уровень отладки. Варианты:
|
|
status string |
Состояние отправки журналов в FortiAnalyzer. disable — отправка журналов в FortiAnalyzer отключена. realtime — отправка журналов в FortiAnalyzer в режиме реального времени. upload — отправка журналов в FortiAnalyzer по расписанию. Варианты:
|
|
upload_time псевдонимы: upload-time any |
(список) Время отправки файлов локальных журналов |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, для именования всех входных аргументов используется соглашение с подчеркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании выводятся предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться с ошибкой при возврате ненулевого кода rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Settings for locallog to fortianalyzer.
fortinet.fortimanager.fmgr_system_locallog_fortianalyzer_setting:
# workspace_locking_adom: <global or your adom name>
system_locallog_fortianalyzer_setting:
# reliable: <value in [disable, enable]>
# secure_connection: <value in [disable, enable]>
# server_ip: <string>
# severity: <value in [emergency, alert, critical, ...]>
# status: <value in [disable, realtime, upload]>
# upload_time: <list or string>
# server: <string>
# peer_cert_cn: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный запрошенный URL. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_locallog_fortianalyzer_setting_module.html
