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

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_fortiview_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_fortiview_autocache dictionary	Набор параметров верхнего уровня.
aggressive_fortiview псевдонимы: aggressive-fortiview string	Включить или отключить агрессивное автоматическое кэширование FortiView. disable — отключить агрессивное автоматическое кэширование FortiView. enable — включить агрессивное автоматическое кэширование FortiView. Возможные значения: `"disable"` `"enable"`
incr_fortiview псевдонимы: incr-fortiview string	Включить или отключить инкрементальный кэш FortiView. disable — отключить автоматическое инкрементальное кэширование FortiView. enable — включить автоматическое инкрементальное кэширование FortiView. Возможные значения: `"disable"` `"enable"`
interval integer	Интервал автоматического кэширования FortiView в часах.
status string	Включить или отключить автоматическое кэширование FortiView. disable — отключить автоматическое кэширование FortiView. enable — включить автоматическое кэширование FortiView. Возможные значения: `"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: FortiView auto-cache settings.
      fortinet.fortimanager.fmgr_system_fortiview_autocache:
        # workspace_locking_adom: <global or your adom name>
        system_fortiview_autocache:
          # aggressive_fortiview: <value in [disable, enable]>
          # interval: <integer>
          # status: <value in [disable, enable]>
          # incr_fortiview: <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_fortiview_autocache_module.html