модуль fortinet.fortimanager.fmgr_system_fortiguard — настройка служб FortiGuard.
Примечание
Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.14.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 string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых будут переопределены условия неудачного выполнения. |
rc_succeeded list / elements=integer | Список кодов rc, для которых будут переопределены условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
system_fortiguard dictionary | Набор параметров верхнего уровня. |
|
antispam_cache aliases: antispam-cache string |
Включить/отключить кэширование запросов FortiGuard Antispam. Варианты:
|
|
antispam_cache_mpercent aliases: antispam-cache-mpercent integer |
Максимальная доля памяти FortiGate, которую разрешено использовать кэшу Antispam |
|
antispam_cache_mpermille aliases: antispam-cache-mpermille integer |
Максимальная доля памяти FortiGate в промилле, которую разрешено использовать кэшу Antispam |
|
antispam_cache_ttl aliases: antispam-cache-ttl integer |
Время жизни записей кэша Antispam в секундах |
|
antispam_expiration aliases: antispam-expiration integer |
Срок действия лицензии Antispam. |
|
antispam_force_off aliases: antispam-force-off string |
Включить/отключить возможность выключения службы FortiGuard Antispam. Варианты:
|
|
antispam_license aliases: antispam-license integer |
Лицензия Antispam. |
|
antispam_timeout aliases: antispam-timeout integer |
Время ожидания ответа на запрос Antispam |
|
anycast_sdns_server_ip aliases: anycast-sdns-server-ip string |
IP-адрес сервера рейтинговой оценки DNS FortiGuard Anycast. |
|
anycast_sdns_server_port aliases: anycast-sdns-server-port integer |
Порт для подключения к серверу рейтинговой оценки DNS FortiGuard Anycast. |
|
auto_firmware_upgrade aliases: auto-firmware-upgrade string |
Включить/отключить автоматическое обновление прошивки до версии с исправлениями, загружаемой из FortiGuard. Варианты:
|
|
auto_firmware_upgrade_day aliases: auto-firmware-upgrade-day list / elements=string |
Разрешённый день Варианты:
|
|
auto_firmware_upgrade_delay aliases: auto-firmware-upgrade-delay integer |
Задержка в днях |
|
auto_firmware_upgrade_end_hour aliases: auto-firmware-upgrade-end-hour integer |
Время окончания заданного временного интервала для автоматического обновления прошивки до версии с исправлениями из FortiGuard в 24-часовом формате |
|
auto_firmware_upgrade_start_hour aliases: auto-firmware-upgrade-start-hour integer |
Время начала заданного временного интервала для автоматического обновления прошивки до версии с исправлениями из FortiGuard в 24-часовом формате |
|
auto_join_forticloud aliases: auto-join-forticloud string |
Автоматически подключаться к FortiCloud и выполнять вход. Варианты:
|
|
avquery_cache aliases: avquery-cache string |
Включить/отключить кэш антивирусной службы FortiGuard. Варианты:
|
|
avquery_cache_mpercent aliases: avquery-cache-mpercent integer |
Максимальная доля памяти, которую может использовать антивирусный кэш |
|
avquery_cache_ttl aliases: avquery-cache-ttl integer |
Время жизни записей антивирусного кэша |
|
avquery_force_off aliases: avquery-force-off string |
Отключить антивирусную службу FortiGuard. Варианты:
|
|
avquery_license aliases: avquery-license integer |
Интервал между проверками лицензии на антивирусный контракт FortiGuard. |
|
avquery_timeout aliases: avquery-timeout integer |
Время ожидания ответа на антивирусный запрос |
|
ddns_server_ip aliases: ddns-server-ip string |
IP-адрес сервера FortiDDNS. |
|
ddns_server_ip6 aliases: ddns-server-ip6 string |
IPv6-адрес сервера FortiDDNS. |
|
ddns_server_port aliases: ddns-server-port integer |
Порт для связи с серверами FortiDDNS. |
|
dlp_expiration aliases: dlp-expiration integer |
Срок действия DLP. |
|
dlp_license aliases: dlp-license integer |
Лицензия DLP. |
|
FDS_license_expiring_days aliases: FDS-license-expiring-days integer |
Порог количества дней до истечения срока действия лицензии FortiGuard, при достижении которого создаётся запись события об истечении срока действия лицензии |
|
fnbi_expiration aliases: fnbi-expiration integer |
Срок действия Fnbi. |
|
fnbi_license aliases: fnbi-license integer |
Лицензия Fnbi. |
|
fortiguard_anycast aliases: fortiguard-anycast string |
Включить/отключить использование сети Anycast FortiGuard. Варианты:
|
|
fortiguard_anycast_source aliases: fortiguard-anycast-source string |
Настройка серверов Fortinet, предоставляющих службы FortiGuard в сети Anycast FortiGuard. Варианты:
|
|
gui_prompt_auto_upgrade aliases: gui-prompt-auto-upgrade string |
Включить/отключить отображение рекомендаций по автоматическому обновлению прошивки до версии с исправлениями. Варианты:
|
|
ia_expiration aliases: ia-expiration integer |
Срок действия Ia. |
|
ia_license aliases: ia-license integer |
Лицензия Ia. |
|
interface string |
Укажите исходящий интерфейс для связи с сервером. |
|
interface_select_method aliases: interface-select-method string |
Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты:
|
|
load_balance_servers aliases: load-balance-servers integer |
Количество серверов, между которыми выполняется чередование при выборе первого варианта FortiGuard. |
|
outbreak_prevention_cache aliases: outbreak-prevention-cache string |
Включить/отключить кэш службы предотвращения вирусных вспышек FortiGuard. Варианты:
|
|
outbreak_prevention_cache_mpercent aliases: outbreak-prevention-cache-mpercent integer |
Максимальная доля памяти, которую может использовать кэш службы предотвращения вирусных вспышек FortiGuard |
|
outbreak_prevention_cache_mpermille aliases: outbreak-prevention-cache-mpermille integer |
Максимальная доля памяти в промилле, которую может использовать кэш FortiGuard Virus Outbreak Prevention |
|
outbreak_prevention_cache_ttl aliases: outbreak-prevention-cache-ttl integer |
Время жизни записей кэша FortiGuard Virus Outbreak Prevention |
|
outbreak_prevention_expiration aliases: outbreak-prevention-expiration integer |
Срок действия предотвращения вспышек. |
|
outbreak_prevention_force_off aliases: outbreak-prevention-force-off string |
Отключить службу FortiGuard Virus Outbreak Prevention. Варианты:
|
|
outbreak_prevention_license aliases: outbreak-prevention-license integer |
Лицензия на предотвращение вспышек. |
|
outbreak_prevention_timeout aliases: outbreak-prevention-timeout integer |
Время ожидания ответа FortiGuard Virus Outbreak Prevention |
|
persistent_connection aliases: persistent-connection string |
Включить/отключить использование постоянного соединения для получения уведомлений об обновлениях от FortiGuard. Варианты:
|
|
port string |
Порт для связи с серверами FortiGuard. Варианты:
|
|
protocol string |
Протокол для связи с серверами FortiGuard. Варианты:
|
|
proxy_password aliases: proxy-password any |
(список) Пароль пользователя прокси-сервера. |
|
proxy_server_ip aliases: proxy-server-ip string |
IP-адрес прокси-сервера. |
|
proxy_server_port aliases: proxy-server-port integer |
Порт для связи с прокси-сервером. |
|
proxy_username aliases: proxy-username string |
Имя пользователя прокси-сервера. |
|
sandbox_inline_scan aliases: sandbox-inline-scan string |
Включить/отключить встроенное сканирование FortiCloud Sandbox. Варианты:
|
|
sandbox_region aliases: sandbox-region string |
Регион облачной песочницы. |
|
sdns_options aliases: sdns-options list / elements=string |
Параметры настройки службы FortiGuard DNS. Варианты:
|
|
sdns_server_ip aliases: sdns-server-ip any |
(список) IP-адрес сервера FortiDNS. |
|
sdns_server_port aliases: sdns-server-port integer |
Порт для связи с серверами FortiDNS. |
|
service_account_id aliases: service-account-id string |
Идентификатор сервисной учетной записи. |
|
source_ip aliases: source-ip string |
Исходный IPv4-адрес для связи с FortiGuard. |
|
source_ip6 aliases: source-ip6 string |
Исходный IPv6-адрес для связи с FortiGuard. |
|
subscribe_update_notification aliases: subscribe-update-notification string |
Включить/отключить подписку на получение уведомлений об обновлениях от FortiGuard. Варианты:
|
|
update_build_proxy aliases: update-build-proxy string |
Включить/отключить перестроение словаря прокси-сервера. Варианты:
|
|
update_dldb aliases: update-dldb string |
Включить/отключить обновление сигнатур DLP. Варианты:
|
|
update_extdb aliases: update-extdb string |
Включить/отключить обновление внешних ресурсов. Варианты:
|
|
update_ffdb aliases: update-ffdb string |
Включить/отключить обновление базы данных интернет-служб. Варианты:
|
|
update_server_location aliases: update-server-location string |
Расположение сервера обновления сигнатур. Варианты:
|
|
update_uwdb aliases: update-uwdb string |
Включить/отключить обновление списка разрешенных элементов. Варианты:
|
|
vdom string |
Имя виртуального домена службы FortiGuard. |
|
videofilter_expiration aliases: videofilter-expiration integer |
Срок действия фильтрации видео. |
|
videofilter_license aliases: videofilter-license integer |
Лицензия на фильтрацию видео. |
|
vrf_select aliases: vrf-select integer |
Идентификатор VRF, используемый для подключения к серверу. |
|
webfilter_cache aliases: webfilter-cache string |
Включить/отключить кэширование веб-фильтра FortiGuard. Варианты:
|
|
webfilter_cache_ttl aliases: webfilter-cache-ttl integer |
Время жизни записей кэша веб-фильтра в секундах |
|
webfilter_expiration aliases: webfilter-expiration integer |
Срок действия веб-фильтра. |
|
webfilter_force_off aliases: webfilter-force-off string |
Включить/отключить принудительное отключение службы веб-фильтрации FortiGuard. Варианты:
|
|
webfilter_license aliases: webfilter-license integer |
Лицензия на веб-фильтр. |
|
webfilter_timeout aliases: webfilter-timeout integer |
Время ожидания ответа на запрос веб-фильтра |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другой ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Configure FortiGuard services.
fortinet.fortimanager.fmgr_system_fortiguard:
# workspace_locking_adom: <global or your adom name>
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]>
# vrf_select: <integer>
# subscribe_update_notification: <value in [disable, enable]>
# dlp_expiration: <integer>
# dlp_license: <integer>
# fnbi_expiration: <integer>
# fnbi_license: <integer>
# ia_expiration: <integer>
# ia_license: <integer>
Возвращаемые значения
Общие возвращаемые значения задокументированы здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_fortiguard_module.html