fortinet.fortimanager.fmgr_system_fortiguard модуль — Настройка служб FortiGuard.

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
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_fortiguard словарь	Установленные параметры верхнего уровня.
antispam_cache строка	Устаревшее, пожалуйста, переименуйте в antispam_cache. Включить/выключить кэширование запросов FortiGuard антиспам. Варианты: `"disable"` `"enable"`
antispam_cache_mpercent целое число	Устаревшее, пожалуйста, переименуйте в antispam_cache_mpercent. Максимальный процент памяти FortiGate, разрешенный для кэша антиспама…
antispam_cache_mpermille целое число	Устаревшее, пожалуйста, переименуйте в antispam_cache_mpermille. Максимальное промилле памяти FortiGate, разрешенное для кэша антиспама…
antispam_cache_ttl целое число	Устаревшее, пожалуйста, переименуйте в antispam_cache_ttl. Время жизни записей кэша антиспама в секундах
antispam_expiration целое число	Устаревшее, пожалуйста, переименуйте в antispam_expiration. Срок действия антиспама.
antispam_force_off строка	Устаревшее, пожалуйста, переименуйте в antispam_force_off. Включить/выключить отключение сервиса FortiGuard антиспам. Варианты: `"disable"` `"enable"`
antispam_license целое число	Устаревшее, пожалуйста, переименуйте в antispam_license. Лицензия антиспама.
antispam_timeout целое число	Устаревшее, пожалуйста, переименуйте в antispam_timeout. Время ожидания запроса антиспама.
anycast_sdns_server_ip строка	Устаревшее, пожалуйста, переименуйте в anycast_sdns_server_ip. IP-адрес сервера рейтингов FortiGuard anycast DNS.
anycast_sdns_server_port целое число	Устаревшее, пожалуйста, переименуйте в anycast_sdns_server_port. Порт для подключения к серверу рейтингов FortiGuard anycast DNS.
auto_firmware_upgrade строка	Устаревшее, пожалуйста, переименуйте в auto_firmware_upgrade. Включить/выключить автоматическое обновление прошивки с уровнем патчей FortiGuard. Варианты: `"disable"` `"enable"`

auto-firmware-upgrade-day list / elements=string	Устарело, переименуйте в auto_firmware_upgrade_day. Допустимый день Choices: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
auto-firmware-upgrade-delay integer	Устарело, переименуйте в auto_firmware_upgrade_delay. Задержка в днях
auto-firmware-upgrade-end-hour integer	Устарело, переименуйте в auto_firmware_upgrade_end_hour. Конечное время в заданном временном интервале для автоматического…
auto-firmware-upgrade-start-hour integer	Устарело, переименуйте в auto_firmware_upgrade_start_hour. Начальное время в заданном временном интервале для автоматическ…
auto-join-forticloud string	Устарело, переименуйте в auto_join_forticloud. Автоматическое подключение и вход в FortiCloud. Choices: `"disable"` `"enable"`
avquery-cache string	Устарело, переименуйте в avquery_cache. Включить/отключить кэш антивируса FortiGuard. Choices: `"disable"` `"enable"`
avquery-cache-mpercent integer	Устарело, переименуйте в avquery_cache_mpercent. Максимальный процент памяти, который может использовать кэш антивируса
avquery-cache-ttl integer	Устарело, переименуйте в avquery_cache_ttl. Время жизни для записей кэша антивируса
avquery-force-off string	Устарело, переименуйте в avquery_force_off. Отключить службу антивируса FortiGuard. Choices: `"disable"` `"enable"`
avquery-license integer	Устарело, переименуйте в avquery_license. Интервал времени между проверками лицензии для компонента антивируса FortiGuard…
avquery-timeout integer	Устарело, переименуйте в avquery_timeout. Время ожидания запроса антивируса
ddns-server-ip string	Устарело, переименуйте в ddns_server_ip. IP-адрес сервера FortiDDNS.
ddns-server-ip6 string	Устарело, переименуйте в ddns_server_ip6. IPv6-адрес сервера FortiDDNS.
ddns-server-port integer	Устарело, переименуйте в ddns_server_port. Порт, используемый для связи с серверами FortiDDNS.
FDS-license-expiring-days integer	Устарело, переименуйте в FDS_license_expiring_days. Пороговое значение для количества дней до истечения срока действия лицензии FortiGuard…
fortiguard-anycast string	Устарело, переименуйте в fortiguard_anycast. Включить/отключить использование сети anycast FortiGuard. Choices: `"disable"` `"enable"`
fortiguard-anycast-source string	Устарело, переименуйте в fortiguard_anycast_source. Настроить, какой из серверов Fortinet будет предоставлять службы FortiGuard… Choices: `"fortinet"` `"aws"` `"debug"`
gui-prompt-auto-upgrade string	Устарело, переименуйте в gui_prompt_auto_upgrade. Включить/отключить запрос на автоматическое обновление микропрограммы патч-уровня… Choices: `"disable"` `"enable"`
interface string	Укажите исходящий интерфейс для доступа к серверу.

interface-select-method string	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите, как выбрать исходящий интерфейс для достижения сервера. Варианты: `"auto"` `"sdwan"` `"specify"`
load-balance-servers integer	Устарело, пожалуйста, переименуйте на load_balance_servers. Количество серверов для чередования в качестве первого варианта FortiGuard.
outbreak-prevention-cache string	Устарело, пожалуйста, переименуйте на outbreak_prevention_cache. Включить/выключить кэш FortiGuard Virus Outbreak Prevention. Варианты: `"disable"` `"enable"`
outbreak-prevention-cache-mpercent integer	Устарело, пожалуйста, переименуйте на outbreak_prevention_cache_mpercent. Максимальный процент памяти для FortiGuard Virus Outbreak Pr…
outbreak-prevention-cache-mpermille integer	Устарело, пожалуйста, переименуйте на outbreak_prevention_cache_mpermille. Максимальная промилле памяти для FortiGuard Virus Outbreak …
outbreak-prevention-cache-ttl integer	Устарело, пожалуйста, переименуйте на outbreak_prevention_cache_ttl. Время жизни кэша FortiGuard Virus Outbreak Prevention…
outbreak-prevention-expiration integer	Устарело, пожалуйста, переименуйте на outbreak_prevention_expiration. Срок действия предотвращения вспышек.
outbreak-prevention-force-off string	Устарело, пожалуйста, переименуйте на outbreak_prevention_force_off. Выключить службу FortiGuard Virus Outbreak Prevention. Варианты: `"disable"` `"enable"`
outbreak-prevention-license integer	Устарело, пожалуйста, переименуйте на outbreak_prevention_license. Лицензия на предотвращение вспышек.
outbreak-prevention-timeout integer	Устарело, пожалуйста, переименуйте на outbreak_prevention_timeout. Таймаут FortiGuard Virus Outbreak Prevention
persistent-connection string	Устарело, пожалуйста, переименуйте на persistent_connection. Включить/выключить использование постоянного подключения для получения уведомлений о обновлениях… Варианты: `"disable"` `"enable"`
port string	Порт, используемый для связи с серверами FortiGuard. Варианты: `"53"` `"80"` `"8888"` `"443"`
protocol string	Протокол, используемый для связи с серверами FortiGuard. Варианты: `"udp"` `"http"` `"https"`
proxy-password any	(список) Устарело, пожалуйста, переименуйте на proxy_password. Пароль пользователя прокси.
proxy-server-ip string	Устарело, пожалуйста, переименуйте на proxy_server_ip. IP-адрес сервера прокси.
proxy-server-port integer	Устарело, пожалуйста, переименуйте на proxy_server_port. Порт, используемый для связи с прокси-сервером.
proxy-username string	Устарело, пожалуйста, переименуйте на proxy_username. Имя пользователя прокси.
sandbox-inline-scan string	Устарело, пожалуйста, переименуйте на sandbox_inline_scan. Включить/выключить FortiCloud Sandbox inline-scan. Варианты: `"disable"` `"enable"`
sandbox-region string	Устарело, пожалуйста, переименуйте на sandbox_region. Область облачного песочницы.

sdns-options list / elements=string	Устарело, переименуйте в sdns_options. Параметры настройки службы FortiGuard DNS. Choices: `"include-question-section"`
sdns-server-ip any	(list) Устарело, переименуйте в sdns_server_ip. IP-адрес сервера FortiDNS.
sdns-server-port integer	Устарело, переименуйте в sdns_server_port. Порт, используемый для связи с серверами FortiDNS.
service-account-id string	Устарело, переименуйте в service_account_id. Идентификатор учетной записи службы.
source-ip string	Устарело, переименуйте в source_ip. Исходный IPv4-адрес, используемый для связи с FortiGuard.
source-ip6 string	Устарело, переименуйте в source_ip6. Исходный IPv6-адрес, используемый для связи с FortiGuard.
update-build-proxy string	Устарело, переименуйте в update_build_proxy. Включить/выключить перестроение словаря прокси. Choices: `"disable"` `"enable"`
update-dldb string	Устарело, переименуйте в update_dldb. Включить/выключить обновление сигнатур DLP. Choices: `"disable"` `"enable"`
update-extdb string	Устарело, переименуйте в update_extdb. Включить/выключить обновление внешних ресурсов. Choices: `"disable"` `"enable"`
update-ffdb string	Устарело, переименуйте в update_ffdb. Включить/выключить обновление базы данных интернет-сервисов. Choices: `"disable"` `"enable"`
update-server-location string	Устарело, переименуйте в update_server_location. Местоположение сервера обновления сигнатур. Choices: `"any"` `"usa"` `"automatic"` `"eu"`
update-uwdb string	Устарело, переименуйте в update_uwdb. Включить/выключить обновление разрешённых списков. Choices: `"disable"` `"enable"`
vdom string	Виртуальное доменное имя службы FortiGuard.
videofilter-expiration integer	Устарело, переименуйте в videofilter_expiration. Срок действия Videofilter.
videofilter-license integer	Устарело, переименуйте в videofilter_license. Лицензия Videofilter.
webfilter-cache string	Устарело, переименуйте в webfilter_cache. Включить/выключить кэширование веб-фильтра FortiGuard. Choices: `"disable"` `"enable"`
webfilter-cache-ttl integer	Устарело, переименуйте в webfilter_cache_ttl. Время жизни записей кэша веб-фильтра в секундах.
webfilter-expiration integer	Устарело, переименуйте в webfilter_expiration. Срок действия Webfilter.
webfilter-force-off string	Устарело, переименуйте в webfilter_force_off. Включить/выключить отключение службы веб-фильтрации FortiGuard. Choices: `"disable"` `"enable"`
webfilter-license integer	Устарело, переименуйте в webfilter_license. Лицензия Webfilter.

webfilter-timeout integer	Устаревшее, пожалуйста, переименуйте его в webfilter_timeout. Время ожидания запроса веб-фильтра
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: Configure FortiGuard services.
      fortinet.fortimanager.fmgr_system_fortiguard:
        # 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, ...]
        adom: <your own value>
        system_fortiguard:
          antispam_cache: <value in [disable, enable]>
          antispam_cache_mpercent: <integer>
          antispam_cache_ttl: <integer>
          antispam_expiration: <integer>
          antispam_force_off: <value in [disable, enable]>
          antispam_license: <integer>
          antispam_timeout: <integer>
          auto_join_forticloud: <value in [disable, enable]>
          ddns_server_ip: <string>
          ddns_server_port: <integer>
          load_balance_servers: <integer>
          outbreak_prevention_cache: <value in [disable, enable]>
          outbreak_prevention_cache_mpercent: <integer>
          outbreak_prevention_cache_ttl: <integer>
          outbreak_prevention_expiration: <integer>
          outbreak_prevention_force_off: <value in [disable, enable]>
          outbreak_prevention_license: <integer>
          outbreak_prevention_timeout: <integer>
          port: <value in [53, 80, 8888, ...]>
          sdns_server_ip: <list or string>
          sdns_server_port: <integer>
          service_account_id: <string>
          source_ip: <string>
          source_ip6: <string>
          update_server_location: <value in [any, usa, automatic, ...]>
          webfilter_cache: <value in [disable, enable]>
          webfilter_cache_ttl: <integer>
          webfilter_expiration: <integer>
          webfilter_force_off: <value in [disable, enable]>
          webfilter_license: <integer>
          webfilter_timeout: <integer>
          protocol: <value in [udp, http, https]>
          proxy_password: <list or string>
          proxy_server_ip: <string>
          proxy_server_port: <integer>
          proxy_username: <string>
          sandbox_region: <string>
          avquery_cache_ttl: <integer>
          avquery_timeout: <integer>
          avquery_cache: <value in [disable, enable]>
          avquery_cache_mpercent: <integer>
          avquery_license: <integer>
          avquery_force_off: <value in [disable, enable]>
          fortiguard_anycast: <value in [disable, enable]>
          fortiguard_anycast_source: <value in [fortinet, aws, debug]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          sdns_options:
            - include-question-section
          anycast_sdns_server_ip: <string>
          anycast_sdns_server_port: <integer>
          persistent_connection: <value in [disable, enable]>
          update_build_proxy: <value in [disable, enable]>
          update_extdb: <value in [disable, enable]>
          update_ffdb: <value in [disable, enable]>
          update_uwdb: <value in [disable, enable]>
          videofilter_expiration: <integer>
          videofilter_license: <integer>
          ddns_server_ip6: <string>
          vdom: <string>
          auto_firmware_upgrade: <value in [disable, enable]>
          auto_firmware_upgrade_day:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
          auto_firmware_upgrade_end_hour: <integer>
          auto_firmware_upgrade_start_hour: <integer>
          sandbox_inline_scan: <value in [disable, enable]>
          auto_firmware_upgrade_delay: <integer>
          gui_prompt_auto_upgrade: <value in [disable, enable]>
          FDS_license_expiring_days: <integer>
          antispam_cache_mpermille: <integer>
          outbreak_prevention_cache_mpermille: <integer>
          update_dldb: <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 список / элементы=строка	Предупреждение, если параметры, используемые в 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_fortiguard_module.html