Модуль fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_setting – Настройка локального логирования в FortiAnalyzer.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager. В этом случае модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить протоколирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, при которых условия будут считаться проваленными.
rc_succeeded список / элементы=целое	Список кодов rc, при которых условия будут считаться выполненными.
system_locallog_fortianalyzer3_setting словарь	Параметры верхнего уровня.
peer_cert_cn строка	Устарело, пожалуйста, переименуйте на peer_cert_cn. Имя общего сертификата удаленного fortianalyzer.
reliable строка	Включить/выключить надежное протоколирование в реальном времени. disable - Выключить надежное протоколирование в реальном времени. enable - Включить надежное протоколирование в реальном времени. Варианты: `"disable"` `"enable"`
secure_connection строка	Устарело, пожалуйста, переименуйте на secure_connection. Включить/выключить защищённое TLS/SSL соединение. disable - Выключить SSL соединение. enable - Включить SSL соединение. Варианты: `"disable"` `"enable"`
server строка	FQDN, имя хоста или IP-адрес удалённого сервера FortiAnalyzer.
server_ip строка	Устарело, пожалуйста, переименуйте на server_ip. IP-адрес удалённого сервера FortiAnalyzer.
severity строка	Наименьший уровень серьёзности для протоколирования. emergency - Уровень чрезвычайной ситуации. alert - Уровень тревоги. critical - Критический уровень. error - Уровень ошибки. warning - Уровень предупреждения. notification - Уровень уведомления. information - Уровень информации. debug - Уровень отладки. Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status строка	Статус протоколирования в FortiAnalyzer. disable - Протоколирование в FortiAnalyzer отключено. realtime - Протоколирование в FortiAnalyzer в реальном времени. upload - Протоколирование в FortiAnalyzer в запланированное время. Варианты: `"disable"` `"realtime"` `"upload"`
upload_time любой	(список) Устарело, пожалуйста, переименуйте на upload_time. Время загрузки файлов локального журнала.
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства. Может принимать значения global и другие, включая root.
workspace_locking_timeout целое	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Settings for locallog to fortianalyzer.
      fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_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_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 словарь	Результат запроса. Возвращаемое значение: всегда
request_url строка	Полный URL запроса. Возвращаемое значение: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращаемое значение: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращаемое значение: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращаемое значение: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращаемое значение: всегда
rc целое число	Статус запроса. Возвращаемое значение: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_locallog_fortianalyzer3_setting_module.html