Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_system_report_autocache — Настройки автоматического кэширования отчетов.

Примечание

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

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

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

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

Добавлено в 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_autocache

dictionary

Параметры верхнего уровня.

aggressive_schedule

псевдонимы: aggressive-schedule

string

Включить или отключить агрессивное автоматическое кэширование отчетов по расписанию.

disable — отключить агрессивное автоматическое кэширование по расписанию.

enable — включить агрессивное автоматическое кэширование по расписанию.

Варианты:

  • "disable"
  • "enable"

order

string

Порядок обработки таблиц журналов SQL.

oldest-first — сначала обрабатывается самая старая таблица журналов SQL.

Варианты:

  • "oldest-first"

sche_rpt_only

псевдонимы: sche-rpt-only

string

Включить или отключить автоматическое кэширование только для отчетов, сформированных по расписанию.

disable — отключить автоматическое кэширование только для отчетов, сформированных по расписанию.

enable — включить автоматическое кэширование только для отчетов, сформированных по расписанию.

Варианты:

  • "disable"
  • "enable"

status

string

Включить или отключить автоматическое кэширование отчетов SQL.

disable — отключить автоматическое кэширование отчетов SQL.

enable — включить автоматическое кэширование отчетов SQL.

Варианты:

  • "disable"
  • "enable"

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 auto-cache settings.
      fortinet.fortimanager.fmgr_system_report_autocache:
        # workspace_locking_adom: <global or your adom name>
        system_report_autocache:
          # aggressive_schedule: <value in [disable, enable]>
          # order: <value in [oldest-first]>
          # status: <value in [disable, enable]>
          # sche_rpt_only: <value in [disable, enable]>

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

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

Ключ

Описание

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_autocache_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API