Модуль fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting — глобальные настройки FortiAnalyzer Cloud.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.1.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит работу без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрошенном URL.
devprof_log_fortianalyzercloud_setting dictionary	Набор параметров верхнего уровня.
__change_ip integer	Скрытый атрибут.
access_config псевдонимы: access-config string	Включить или отключить доступ FortiAnalyzer к конфигурации и данным. Варианты: `"disable"` `"enable"`
certificate string	Сертификат для обмена данными с FortiAnalyzer.
certificate_verification псевдонимы: certificate-verification string	Включить или отключить проверку подлинности FortiAnalyzer с помощью сертификата. Варианты: `"disable"` `"enable"`
conn_timeout псевдонимы: conn-timeout integer	Тайм-аут подключения к FortiAnalyzer в секундах
enc_algorithm псевдонимы: enc-algorithm string	Настройка уровня защиты SSL для безопасного обмена данными с FortiAnalyzer. Варианты: `"high"` `"low"` `"high-medium"` `"low-medium"`
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	Интервал между keepalive-сообщениями OFTP в секундах
preshared_key псевдонимы: preshared-key string	Предварительно установленный ключ для автоматической авторизации в FortiAnalyzer.
priority string	Задайте приоритет передачи журналов. Варианты: `"low"` `"default"`
serial any	(список) Серийные номера FortiAnalyzer.
source_ip псевдонимы: source-ip string	Исходный адрес IPv4 или IPv6 для обмена данными с FortiAnalyzer.
ssl_min_proto_version псевдонимы: ssl-min-proto-version string	Минимальная поддерживаемая версия протокола для SSL/TLS-подключений Варианты: `"default"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"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 Cloud settings.
      fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_log_fortianalyzercloud_setting:
          # __change_ip: <integer>
          # access_config: <value in [disable, enable]>
          # certificate: <string>
          # conn_timeout: <integer>
          # enc_algorithm: <value in [high, low, high-medium, ...]>
          # hmac_algorithm: <value in [sha256, sha1]>
          # ips_archive: <value in [disable, enable]>
          # monitor_failure_retry_period: <integer>
          # monitor_keepalive_period: <integer>
          # source_ip: <string>
          # ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          # status: <value in [disable, enable]>
          # upload_day: <string>
          # upload_interval: <value in [daily, weekly, monthly]>
          # upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
          # upload_time: <string>
          # max_log_rate: <integer>
          # priority: <value in [low, default]>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # preshared_key: <string>
          # certificate_verification: <value in [disable, enable]>
          # serial: <list or 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_fortianalyzercloud_setting_module.html