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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо скорректировать для использования в источниках данных.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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_report_setting словарь	Настройка параметров верхнего уровня.
aggregate_report строка	Устарело, пожалуйста, переименуйте на aggregate_report. Включить/выключить включение группового отчета вместе с отчетами по устройствам. disable - Исключение группового отчета вместе с отчетами по устройствам. enable - Включить групповой отчет вместе с отчетами по устройствам. Варианты: `"disable"` `"enable"`
capwap_port целое	Устарело, пожалуйста, переименуйте на capwap_port. Исключение трафика capwap по порту.
capwap_service строка	Устарело, пожалуйста, переименуйте на capwap_service. Исключение трафика capwap по службе.
exclude_capwap строка	Устарело, пожалуйста, переименуйте на exclude_capwap. Исключение трафика capwap. disable - Выключить. by-port - По порту. by-service - По службе. Варианты: `"disable"` `"by-port"` `"by-service"`
hcache_lossless строка	Устарело, пожалуйста, переименуйте на hcache_lossless. Используемость hcaches с потерями. disable - Используйте hcaches с потерями. enable - Не использовать hcaches с потерями. Варианты: `"disable"` `"enable"`
ldap_cache_timeout целое	Устарело, пожалуйста, переименуйте на ldap_cache_timeout. Таймаут кэша LDAP в минутах, по умолчанию 60, 0 означает не использовать кэш.
max_rpt_pdf_rows целое	Устарело, пожалуйста, переименуйте на max_rpt_pdf_rows. Максимальное количество строк, которые могут быть сгенерированы в одном PDF.
max_table_rows целое	Устарело, пожалуйста, переименуйте на max_table_rows. Максимальное количество строк, которые могут быть сгенерированы в одной таблице.
report_priority строка	Устарело, пожалуйста, переименуйте на report_priority. Приоритет sql отчета. high - Высокий low - Низкий auto - Авто Варианты: `"high"` `"low"` `"auto"`
template_auto_install строка	Устарело, пожалуйста, переименуйте на template_auto_install. Язык, используемый для новых ADOM. default - По умолчанию. english - Английский. Варианты: `"default"` `"english"`

week-start string	Устарело, пожалуйста, переименуйте на week_start. День недели, с которого начинается неделя. sun - Воскресенье. mon - Понедельник. Выбори: `"sun"` `"mon"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Report settings.
      fortinet.fortimanager.fmgr_system_report_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_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 словарь	Результат запроса. Возвращается: всегда
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_report_setting_module.html