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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
fmupdate_service dictionary	Набор параметров верхнего уровня.
avips string	Включить/отключить встроенный FortiGuard для предоставления обновлений антивируса и IPS FortiGuard disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-antispam string	Устарело, переименуйте в query_antispam. Включить/отключить службу защиты от спама disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-antivirus string	Устарело, переименуйте в query_antivirus. Включить/отключить службу запроса антивируса disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-filequery string	Устарело, переименуйте в query_filequery. Включить/отключить службу запроса файлов disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-geoip string	Устарело, переименуйте в query_geoip. Включить/отключить службу GeoIP disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-ioc string	Устарело, переименуйте в query_ioc. Включить/отключить встроенный FortiGuard для предоставления запроса IoC disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-iot string	Устарело, переименуйте в query_iot. Включить/отключить службу запроса файлов disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-iot-collection string	Устарело, переименуйте в query_iot_collection. Включить/отключить службу запроса коллекции IoT disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-iot-vulnerability string	Устарело, переименуйте в query_iot_vulnerability. Включить/отключить службу запроса уязвимостей IoT disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-outbreak-prevention string	Устарело, переименуйте в query_outbreak_prevention. Включить/отключить службу запроса предотвращения вспышек disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
query-webfilter string	Устарело, переименуйте в query_webfilter. Включить/отключить службу веб-фильтрации disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
webfilter-https-traversal string	Устарело, переименуйте в webfilter_https_traversal. Включить/отключить прохождение HTTPS для веб-фильтрации disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`

forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для сбоя.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для успеха.
workspace_locking_adom строка	Область (ADOM), которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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: Enable/disable services provided by the built-in FortiGuard.
      fortinet.fortimanager.fmgr_fmupdate_service:
        # 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, ...]
        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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_fmupdate_service_module.html