модуль fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting — Глобальные настройки FortiAnalyzer.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting.

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрашиваемом URL.
devprof_log_fortianalyzer_setting dictionary	Набор параметров верхнего уровня.
__change_ip integer	Скрытый атрибут.
access_config псевдонимы: access-config string	Включить/отключить доступ FortiAnalyzer к конфигурации и данным. Варианты: `"disable"` `"enable"`
alt_server псевдонимы: alt-server string	Альтернативный сервер.
certificate string	Сертификат, используемый для связи с FortiAnalyzer.
certificate_verification псевдонимы: certificate-verification string	Включить/отключить проверку подлинности FortiAnalyzer с помощью сертификата. Варианты: `"disable"` `"enable"`
conn_timeout псевдонимы: conn-timeout integer	Тайм-аут подключения к FortiAnalyzer в секундах
enc_algorithm псевдонимы: enc-algorithm string	Включить/отключить передачу данных журнала FortiAnalyzer с шифрованием SSL. Варианты: `"default"` `"high"` `"low"` `"disable"` `"high-medium"` `"low-medium"`
fallback_to_primary псевдонимы: fallback-to-primary string	Включить/отключить переключение этого устройства FortiGate на основной FortiAnalyzer, когда он станет доступен. Варианты: `"disable"` `"enable"`
hmac_algorithm псевдонимы: hmac-algorithm string	Алгоритм HMAC туннеля IPsec FortiAnalyzer. Варианты: `"sha256"` `"sha1"`
interface string	Указать исходящий интерфейс для доступа к серверу.
interface_select_method псевдонимы: interface-select-method string	Указать способ выбора исходящего интерфейса для доступа к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ips_archive псевдонимы: ips-archive string	Включить/отключить ведение журнала архивирования пакетов IPS. Варианты: `"disable"` `"enable"`
max_log_rate псевдонимы: max-log-rate integer	Максимальная скорость передачи журналов FortiAnalyzer в МБ/с
monitor_failure_retry_period псевдонимы: monitor-failure-retry-period integer	Интервал между попытками повторного подключения к FortiAnalyzer в секундах
monitor_keepalive_period псевдонимы: monitor-keepalive-period integer	Интервал между сообщениями поддержания соединения OFTP в секундах
preshared_key псевдонимы: preshared-key string	Предварительно согласованный ключ, используемый для автоматической авторизации на FortiAnalyzer.
priority string	Задать приоритет передачи журналов. Варианты: `"low"` `"default"`
reliable string	Включить/отключить надежное ведение журналов на FortiAnalyzer. Варианты: `"disable"` `"enable"`
serial any	(список) Серийные номера FortiAnalyzer.
server string	Удалённый FortiAnalyzer.
server_cert_ca псевдонимы: server-cert-ca string	Обязательный центр сертификации на FortiGate в цепочке сертификатов сервера.
source_ip псевдонимы: source-ip string	Исходный адрес IPv4 или IPv6, используемый для связи с FortiAnalyzer.
ssl_min_proto_version псевдонимы: ssl-min-proto-version string	Минимальная поддерживаемая версия протокола для SSL/TLS-подключений Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status string	Включить/отключить ведение журналов на FortiAnalyzer. Варианты: `"disable"` `"enable"`
upload_day псевдонимы: upload-day string	День недели
upload_interval псевдонимы: upload-interval string	Периодичность загрузки файлов журналов на FortiAnalyzer. Варианты: `"daily"` `"weekly"` `"monthly"`
upload_option псевдонимы: upload-option string	Включить/отключить ведение журналов на жёстком диске с последующей загрузкой на FortiAnalyzer. Варианты: `"store-and-upload"` `"realtime"` `"1-minute"` `"5-minute"`
upload_time псевдонимы: upload-time string	Время загрузки журналов
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
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, переопределяющий условия успешного выполнения.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем в секундах. По умолчанию: `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
  gather_facts: false
  tasks:
    - name: Global FortiAnalyzer settings.
      fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_log_fortianalyzer_setting:
          # certificate: <string>
          # conn_timeout: <integer>
          # enc_algorithm: <value in [default, high, low, ...]>
          # hmac_algorithm: <value in [sha256, sha1]>
          # ips_archive: <value in [disable, enable]>
          # monitor_failure_retry_period: <integer>
          # monitor_keepalive_period: <integer>
          # reliable: <value in [disable, enable]>
          # ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          # upload_day: <string>
          # upload_interval: <value in [daily, weekly, monthly]>
          # upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
          # upload_time: <string>
          # access_config: <value in [disable, enable]>
          # certificate_verification: <value in [disable, enable]>
          # max_log_rate: <integer>
          # priority: <value in [low, default]>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # preshared_key: <string>
          # alt_server: <string>
          # fallback_to_primary: <value in [disable, enable]>
          # server_cert_ca: <string>
          # serial: <list or string>
          # source_ip: <string>
          # status: <value in [disable, enable]>
          # __change_ip: <integer>
          # server: <string>
          # vrf_select: <integer>

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
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 список / элементы типа «строка»	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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_devprof_log_fortianalyzer_setting_module.html