Модуль fortinet.fortimanager.fmgr_system_report_setting — настройки отчетов.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_system_report_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 / elements=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
system_report_setting dictionary	Набор параметров верхнего уровня.
aggregate_report aliases: aggregate-report string	Включить или отключить групповой отчет вместе с отчетами по отдельным устройствам. disable — не включать групповой отчет вместе с отчетами по отдельным устройствам. enable — включать групповой отчет вместе с отчетами по отдельным устройствам. Варианты: `"disable"` `"enable"`
capwap_port aliases: capwap-port integer	Исключить трафик CAPWAP по порту.
capwap_service aliases: capwap-service string	Исключить трафик CAPWAP по службе.
exclude_capwap aliases: exclude-capwap string	Исключить трафик CAPWAP. disable — отключить. by-port — по порту. by-service — по службе. Варианты: `"disable"` `"by-port"` `"by-service"`
hcache_lossless aliases: hcache-lossless string	Возможность использования готовых кэшированных данных с потерями. disable — использовать готовые кэшированные данные с потерями. enable — не использовать готовые кэшированные данные с потерями. Варианты: `"disable"` `"enable"`
ldap_cache_timeout aliases: ldap-cache-timeout integer	Тайм-аут кэша LDAP в минутах. Значение по умолчанию — 60; 0 означает, что кэш не используется.
max_rpt_pdf_rows aliases: max-rpt-pdf-rows integer	Максимальное количество строк, которое можно сформировать в одном PDF-файле.
max_table_rows aliases: max-table-rows integer	Максимальное количество строк, которое можно сформировать в одной таблице.
report_priority aliases: report-priority string	Приоритет отчета SQL. high — высокий low — низкий auto — автоматически Варианты: `"high"` `"low"` `"auto"`
template_auto_install aliases: template-auto-install string	Язык, используемый для новых ADOM. default — по умолчанию. english — английский. Варианты: `"default"` `"english"`
week_start aliases: week-start string	День недели, с которого начинается неделя. sun — воскресенье. mon — понедельник. Варианты: `"sun"` `"mon"`
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: Report settings.
      fortinet.fortimanager.fmgr_system_report_setting:
        # workspace_locking_adom: <global or your adom name>
        system_report_setting:
          # aggregate_report: <value in [disable, enable]>
          # hcache_lossless: <value in [disable, enable]>
          # ldap_cache_timeout: <integer>
          # max_table_rows: <integer>
          # report_priority: <value in [high, low, auto]>
          # template_auto_install: <value in [default, english]>
          # week_start: <value in [sun, mon]>
          # capwap_port: <integer>
          # capwap_service: <string>
          # exclude_capwap: <value in [disable, by-port, by-service]>
          # max_rpt_pdf_rows: <integer>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=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_report_setting_module.html