модуль fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_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_fortianalyzer3_setting.

Добавлено в fortinet.fortimanager 2.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
system_locallog_fortianalyzer3_setting dictionary	Набор параметров верхнего уровня.
peer_cert_cn псевдонимы: peer-cert-cn string	Общее имя сертификата удалённого FortiAnalyzer.
reliable string	Включить или отключить надёжное ведение журналов в реальном времени. disable — отключить надёжное ведение журналов в реальном времени. enable — включить надёжное ведение журналов в реальном времени. Варианты: `"disable"` `"enable"`
secure_connection псевдонимы: secure-connection string	Включить или отключить защиту соединения с помощью TLS/SSL. disable — отключить SSL-соединение. enable — включить SSL-соединение. Варианты: `"disable"` `"enable"`
server string	Полное доменное имя, имя узла или IP-адрес удалённого сервера FortiAnalyzer
server_ip псевдонимы: server-ip string	IP-адрес удалённого сервера FortiAnalyzer.
severity string	Минимальный уровень важности записей журнала. emergency — уровень «Аварийная ситуация». alert — уровень «Тревога». critical — уровень «Критический». error — уровень «Ошибка». warning — уровень «Предупреждение». notification — уровень «Уведомление». information — уровень «Информация». debug — уровень «Отладка». Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status string	Состояние ведения журнала в FortiAnalyzer. disable — ведение журнала в FortiAnalyzer отключено. realtime — передача журналов в FortiAnalyzer в реальном времени. upload — передача журналов в FortiAnalyzer по расписанию. Варианты: `"disable"` `"realtime"` `"upload"`
upload_time псевдонимы: upload-time any	(список) Время передачи файлов локального журнала
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку workspace. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Измените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, однако при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки workspace. Для этого предназначены параметры верхнего уровня 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_fortianalyzer3_setting:
        # workspace_locking_adom: <global or your adom name>
        system_locallog_fortianalyzer3_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 запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при наличии сложных данных

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_fortianalyzer3_setting_module.html