Модуль fortinet.fortimanager.fmgr_fmupdate_service — включение/отключение служб, предоставляемых встроенным FortiGuard.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Описание
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включение/отключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
fmupdate_service dictionary	Набор параметров верхнего уровня.
avips string	Включение/отключение встроенного FortiGuard для предоставления обновлений антивируса FortiGuard и IPS disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_antispam псевдонимы: query-antispam string	Включение/отключение службы защиты от спама disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_antivirus псевдонимы: query-antivirus string	Включение/отключение службы запросов антивируса disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_filequery псевдонимы: query-filequery string	Включение/отключение службы запросов файлов disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_geoip псевдонимы: query-geoip string	Включение/отключение службы GeoIP disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_ioc псевдонимы: query-ioc string	Включение/отключение встроенного FortiGuard для предоставления запросов IoC disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_iot псевдонимы: query-iot string	Включение/отключение службы запросов файлов disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_iot_collection псевдонимы: query-iot-collection string	Включение/отключение службы запросов IoT Collection disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_iot_vulnerability псевдонимы: query-iot-vulnerability string	Включение/отключение службы запросов об уязвимостях IoT disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_outbreak_prevention псевдонимы: query-outbreak-prevention string	Включение/отключение службы запросов для предотвращения вспышек угроз disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
query_webfilter псевдонимы: query-webfilter string	Включение/отключение службы Web Filter disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
webfilter_https_traversal псевдонимы: webfilter-https-traversal string	Включение/отключение обработки HTTPS-трафика службой Web Filter disable — отключить параметр. enable — включить параметр. Варианты: `"disable"` `"enable"`
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 или другое значение, включая 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: Enable/disable services provided by the built-in FortiGuard.
      fortinet.fortimanager.fmgr_fmupdate_service:
        # workspace_locking_adom: <global or your adom name>
        fmupdate_service:
          # avips: <value in [disable, enable]>
          # query_antispam: <value in [disable, enable]>
          # query_antivirus: <value in [disable, enable]>
          # query_filequery: <value in [disable, enable]>
          # query_geoip: <value in [disable, enable]>
          # query_outbreak_prevention: <value in [disable, enable]>
          # query_webfilter: <value in [disable, enable]>
          # webfilter_https_traversal: <value in [disable, enable]>
          # query_iot: <value in [disable, enable]>
          # query_iot_collection: <value in [disable, enable]>
          # query_iot_vulnerability: <value in [disable, enable]>
          # query_ioc: <value in [disable, enable]>

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

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

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