community.network.fmgr_secprof_web – Управление профилями безопасности веб-фильтра в FortiManager

Примечание

Этот плагин входит в коллекцию community.network (версия 1.3.0).

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

Для использования в книге задач укажите: community.network.fmgr_secprof_web.

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

Обзор

Управление профилями безопасности веб-фильтра в FortiManager через книги задач с использованием API FMG

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
adom строка	Значение по умолчанию: "root"	ADOM, к которому должна относиться конфигурация.
comment строка		Дополнительные комментарии.
extended_log строка	Варианты: disable enable	Включить/выключить расширенное ведение журнала для веб-фильтрации. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
ftgd_wf строка		ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API FMGR JSON! Список нескольких дочерних объектов для добавления. Ожидается список словарей. Словари должны использовать параметры API FortiManager, а не ansible, перечисленные ниже. Если передано, все другие префиксные подпараметры ИГНОРИРУЮТСЯ. Этот объект взаимоисключающий со своими параметрами. Мы предполагаем, что вы знаете, что делаете с этими параметрами списка и используете руководство по API JSON. В СЛУЧАЕ СОМНЕНИЙ, ВМЕСТО ЭТОГО ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ ДЛЯ СОЗДАНИЯ ОБЪЕКТОВ С МНОЖЕСТВОМ ЗАДАЧ
ftgd_wf_exempt_quota строка		Не останавливать квоту для этих категорий.
ftgd_wf_filters_action строка	Варианты: block monitor warning authenticate	Действие, которое необходимо выполнить для совпадений. choice \| block \| Блокировать доступ. choice \| monitor \| Разрешить доступ, одновременно регистрируя действие. choice \| warning \| Разрешить доступ после предупреждения пользователя. choice \| authenticate \| Проверить пользователя перед разрешением доступа.
ftgd_wf_filters_auth_usr_grp строка		Группы с правом на проверку подлинности.
ftgd_wf_filters_category строка		Категории и группы, которые проверяет фильтр.
ftgd_wf_filters_log строка	Варианты: disable enable	Включить/выключить ведение журнала. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
ftgd_wf_filters_override_replacemsg строка		Заменить сообщение о переопределении.
ftgd_wf_filters_warn_duration строка		Продолжительность предупреждений.
ftgd_wf_filters_warning_duration_type строка	Варианты: session timeout	Повторное отображение предупреждения после закрытия браузера или по истечении срока ожидания. choice \| session \| После завершения сеанса. choice \| timeout \| После истечения срока ожидания.
ftgd_wf_filters_warning_prompt строка	Варианты: per-domain per-category	Предупреждения в каждой категории или каждом домене. choice \| per-domain \| Предупреждения по каждому домену. choice \| per-category \| Предупреждения по каждой категории.
ftgd_wf_max_quota_timeout строка		Максимальное время ожидания квоты FortiGuard, используемой одним просмотром страницы в секундах (исключая потоки).
ftgd_wf_options строка	Варианты: error-allow rate-server-ip connect-request-bypass ftgd-disable	Параметры для FortiGuard Web Filter. Параметры на основе флагов. Укажите несколько в виде списка. flag \| error-allow \| Разрешить проход веб-страниц с ошибкой рейтинга. flag \| rate-server-ip \| Оценить IP-адрес сервера дополнительно к имени домена. flag \| connect-request-bypass \| Пропустить соединение, имеющее запрос CONNECT. flag \| ftgd-disable \| Отключить сканирование FortiGuard.
ftgd_wf_ovrd строка		Разрешить переопределения профилей веб-фильтра.
ftgd_wf_quota_category строка		Категории FortiGuard, к которым применяется квота (действие категории должно быть установлено на monitor).
ftgd_wf_quota_duration строка		Продолжительность квоты.
ftgd_wf_quota_override_replacemsg строка		Заменить сообщение о переопределении.
ftgd_wf_quota_type строка	Варианты: time traffic	Тип квоты. choice \| time \| Использовать квоту на основе времени. choice \| traffic \| Использовать квоту на основе трафика.
ftgd_wf_quota_unit строка	Варианты: B KB MB GB	Единица измерения квоты на трафик. choice \| B \| Квота в байтах. choice \| KB \| Квота в килобайтах. choice \| MB \| Квота в мегабайтах. choice \| GB \| Квота в гигабайтах.
ftgd_wf_quota_value строка		Значение квоты на трафик.
ftgd_wf_rate_crl_urls строка	Варианты: disable enable	Включить/выключить оценку CRL по URL. choice \| disable \| Отключить оценку CRL по URL. choice \| enable \| Включить оценку CRL по URL.
ftgd_wf_rate_css_urls строка	Варианты: disable enable	Включить/выключить оценку CSS по URL. choice \| disable \| Отключить оценку CSS по URL. choice \| enable \| Включить оценку CSS по URL.
ftgd_wf_rate_image_urls строка	Варианты: disable enable	Включить/выключить оценку изображений по URL. choice \| disable \| Отключить оценку изображений по URL (заблокированные изображения заменяются пустыми). choice \| enable \| Включить оценку изображений по URL (заблокированные изображения заменяются пустыми).
ftgd_wf_rate_javascript_urls строка	Варианты: disable enable	Включить/выключить оценку JavaScript по URL. choice \| disable \| Отключить оценку JavaScript по URL. choice \| enable \| Включить оценку JavaScript по URL.
https_replacemsg строка	Варианты: disable enable	Включить сообщения замены для HTTPS. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
inspection_mode строка	Варианты: proxy flow-based	Режим проверки веб-фильтра. choice \| proxy \| Прокси. choice \| flow-based \| Основанный на потоках.
log_all_url строка	Варианты: disable enable	Включить/выключить ведение журнала всех посещенных URL-адресов. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
mode строка	Варианты: add ← set delete update	Устанавливает один из трех режимов для управления объектом. Разрешает использование мягких добавлений вместо перезаписи существующих значений
name строка		Имя профиля.
options строка	Варианты: block-invalid-url jscript js vbs unknown wf-referer intrinsic wf-cookie per-user-bwl activexfilter cookiefilter javafilter	Параметры на основе флагов. Укажите несколько в виде списка. flag \| block-invalid-url \| Блокировать сеансы, содержащие недопустимое имя домена. flag \| jscript \| Блокировка Javascript. flag \| js \| Блокировка JS. flag \| vbs \| Блокировка VB-скриптов. flag \| unknown \| Блокировка неизвестных скриптов. flag \| wf-referer \| Блокировка по ссылке. flag \| intrinsic \| Блокировка встроенных скриптов. flag \| wf-cookie \| Блокировка cookie. flag \| per-user-bwl \| Фильтр черного/белого списка для каждого пользователя flag \| activexfilter \| Фильтр ActiveX. flag \| cookiefilter \| Фильтр cookie. flag \| javafilter \| Фильтр Java-апплетов.
override строка		ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API FMGR JSON! Список нескольких дочерних объектов для добавления. Ожидается список словарей. Словари должны использовать параметры API FortiManager, а не ansible, перечисленные ниже. Если передано, все другие префиксные подпараметры ИГНОРИРУЮТСЯ. Этот объект взаимоисключающий со своими параметрами. Мы предполагаем, что вы знаете, что делаете с этими параметрами списка и используете руководство по API JSON. В СЛУЧАЕ СОМНЕНИЙ, ВМЕСТО ЭТОГО ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ ДЛЯ СОЗДАНИЯ ОБЪЕКТОВ С МНОЖЕСТВОМ ЗАДАЧ
override_ovrd_cookie строка	Варианты: deny allow	Разрешить/запретить переопределения на основе браузера (cookie). choice \| deny \| Запретить переопределение на основе браузера (cookie). choice \| allow \| Разрешить переопределение на основе браузера (cookie).
override_ovrd_dur строка		Продолжительность переопределения.
override_ovrd_dur_mode строка	Варианты: constant ask	Режим продолжительности переопределения. choice \| constant \| Постоянный режим. choice \| ask \| Запросить продолжительность при инициировании переопределения.

override_ovrd_scope string	Варианты: user user-group ip ask browser	Область переопределения. choice \| user \| Переопределение для пользователя. choice \| user-group \| Переопределение для группы пользователей. choice \| ip \| Переопределение для IP-адреса инициатора. choice \| ask \| Запрос области при инициировании переопределения. choice \| browser \| Создание переопределения на основе браузера (cookie).
override_ovrd_user_group string		Группы пользователей с правом использования переопределения.
override_profile string		Профиль веб-фильтра с правом создания переопределений.
override_profile_attribute string	Варианты: User-Name NAS-IP-Address Framed-IP-Address Framed-IP-Netmask Filter-Id Login-IP-Host Reply-Message Callback-Number Callback-Id Framed-Route Framed-IPX-Network Class Called-Station-Id Calling-Station-Id NAS-Identifier Proxy-State Login-LAT-Service Login-LAT-Node Login-LAT-Group Framed-AppleTalk-Zone Acct-Session-Id Acct-Multi-Session-Id	Атрибут профиля для извлечения с сервера RADIUS. choice \| User-Name \| Использовать этот атрибут. choice \| NAS-IP-Address \| Использовать этот атрибут. choice \| Framed-IP-Address \| Использовать этот атрибут. choice \| Framed-IP-Netmask \| Использовать этот атрибут. choice \| Filter-Id \| Использовать этот атрибут. choice \| Login-IP-Host \| Использовать этот атрибут. choice \| Reply-Message \| Использовать этот атрибут. choice \| Callback-Number \| Использовать этот атрибут. choice \| Callback-Id \| Использовать этот атрибут. choice \| Framed-Route \| Использовать этот атрибут. choice \| Framed-IPX-Network \| Использовать этот атрибут. choice \| Class \| Использовать этот атрибут. choice \| Called-Station-Id \| Использовать этот атрибут. choice \| Calling-Station-Id \| Использовать этот атрибут. choice \| NAS-Identifier \| Использовать этот атрибут. choice \| Proxy-State \| Использовать этот атрибут. choice \| Login-LAT-Service \| Использовать этот атрибут. choice \| Login-LAT-Node \| Использовать этот атрибут. choice \| Login-LAT-Group \| Использовать этот атрибут. choice \| Framed-AppleTalk-Zone \| Использовать этот атрибут. choice \| Acct-Session-Id \| Использовать этот атрибут. choice \| Acct-Multi-Session-Id \| Использовать этот атрибут.
override_profile_type string	Варианты: list radius	Тип профиля переопределения. choice \| list \| Профиль выбран из списка. choice \| radius \| Профиль определён сервером RADIUS.
ovrd_perm string	Варианты: bannedword-override urlfilter-override fortiguard-wf-override contenttype-check-override	Флаги. Укажите несколько в виде списка. flag \| bannedword-override \| Переопределение запрещённых слов. flag \| urlfilter-override \| Переопределение фильтра URL. flag \| fortiguard-wf-override \| Переопределение FortiGuard Web Filter. flag \| contenttype-check-override \| Переопределение заголовка Content-type.
post_action string	Варианты: normal block	Действие для HTTP POST-трафика. choice \| normal \| Нормальный, POST-запросы разрешены. choice \| block \| POST-запросы заблокированы.
replacemsg_group string		Группа заменяющих сообщений.
url_extraction string		ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЕТСЯ ЗНАНИЕ API FMGR JSON! Список дочерних объектов. Ожидается список словарей. Словари должны использовать параметры API FortiManager, а не Ansible. Если предоставлено, все другие префиксные подпараметры ИГНОРИРУЮТСЯ. Этот объект ВЗАИМНО ИСКЛЮЧАЕТ свои варианты. Мы ожидаем, что вы знаете, что делаете с этими параметрами списка и используете руководство по API JSON. В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ ПОДВАРИАНТЫ НИЖЕ ДЛЯ СОЗДАНИЯ ОБЪЕКТОВ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
url_extraction_redirect_header string		Имя HTTP-заголовка для перенаправления клиента при заблокированных запросах
url_extraction_redirect_no_content string	Варианты: disable enable	Включить/выключить пустое тело сообщения в HTTP-ответе choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
url_extraction_redirect_url string		Значение HTTP-заголовка для перенаправления клиента при заблокированных запросах
url_extraction_server_fqdn string		FQDN (полное доменное имя) сервера URL-извлечения
url_extraction_status string	Варианты: disable enable	Включить URL-извлечение choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web string		ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЕТСЯ ЗНАНИЕ API FMGR JSON! Список дочерних объектов. Ожидается список словарей. Словари должны использовать параметры API FortiManager, а не Ansible. Если предоставлено, все другие префиксные подпараметры ИГНОРИРУЮТСЯ. Этот объект ВЗАИМНО ИСКЛЮЧАЕТ свои варианты. Мы ожидаем, что вы знаете, что делаете с этими параметрами списка и используете руководство по API JSON. В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ ПОДВАРИАНТЫ НИЖЕ ДЛЯ СОЗДАНИЯ ОБЪЕКТОВ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
web_blacklist string	Варианты: disable enable	Включить/выключить автоматическое добавление URL, обнаруженных FortiSandbox, в чёрный список. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_bword_table string		Идентификатор таблицы запрещённых слов.
web_bword_threshold string		Пороговое значение оценки запрещённых слов.
web_content_header_list string		Список заголовков содержимого.
web_content_log string	Варианты: disable enable	Включить/выключить протоколирование заблокированного веб-содержимого. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_extended_all_action_log string	Варианты: disable enable	Включить/выключить расширенное протоколирование действий любого фильтра для веб-фильтрации. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_activex_log string	Варианты: disable enable	Включить/выключить протоколирование ActiveX. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_applet_log string	Варианты: disable enable	Включить/выключить протоколирование Java-апплетов. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_command_block_log string	Варианты: disable enable	Включить/выключить протоколирование заблокированных команд. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_cookie_log string	Варианты: disable enable	Включить/выключить протоколирование фильтрации cookie. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_cookie_removal_log string	Варианты: disable enable	Включить/выключить протоколирование заблокированных cookie. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_js_log string	Варианты: disable enable	Включить/выключить протоколирование Java-скриптов. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_jscript_log string	Варианты: disable enable	Включить/выключить протоколирование JScripts. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_referer_log string	Варианты: disable enable	Включить/выключить протоколирование referrers. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_unknown_log string	Варианты: disable enable	Включить/выключить протоколирование неизвестных скриптов. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.
web_filter_vbs_log string	Варианты: disable enable	Включить/выключить протоколирование VBS-скриптов. choice \| disable \| Выключить настройку. choice \| enable \| Включить настройку.

web_ftgd_err_log string	Варианты: disable enable	Включить/выключить протоколирование ошибок рейтингов. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
web_ftgd_quota_usage string	Варианты: disable enable	Включить/выключить протоколирование ежедневного использования квоты. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
web_invalid_domain_log string	Варианты: disable enable	Включить/выключить протоколирование недопустимых доменных имён. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
web_keyword_match string		Ключевые слова для поиска при совпадении.
web_log_search string	Варианты: disable enable	Включить/выключить протоколирование всех поисковых фраз. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
web_safe_search string	Варианты: url header	Тип безопасного поиска. Варианты, основанные на флагах. Укажите несколько в виде списка. flag \| url \| Вставить строку безопасного поиска в URL. flag \| header \| Вставить заголовок безопасного поиска.
web_url_log string	Варианты: disable enable	Включить/выключить протоколирование фильтрации URL. choice \| disable \| Отключить настройку. choice \| enable \| Включить настройку.
web_urlfilter_table string		Идентификатор таблицы фильтров URL.
web_whitelist string	Варианты: exempt-av exempt-webcontent exempt-activex-java-cookie exempt-dlp exempt-rangeblock extended-log-others	Настройки белого списка FortiGuard. Варианты, основанные на флагах. Укажите несколько в виде списка. flag \| exempt-av \| Исключение антивируса. flag \| exempt-webcontent \| Исключение веб-контента. flag \| exempt-activex-java-cookie \| Исключение ActiveX-JAVA-Cookie. flag \| exempt-dlp \| Исключение DLP. flag \| exempt-rangeblock \| Исключение RangeBlock. flag \| extended-log-others \| Поддержка расширенного протоколирования.
web_youtube_restrict string	Варианты: strict none moderate	Уровень фильтрации YouTube EDU. choice \| strict \| Строгий доступ к YouTube. choice \| none \| Полный доступ к YouTube. choice \| moderate \| Умеренный доступ к YouTube.
wisp string	Варианты: disable enable	Включить/выключить веб-прокси WISP. choice \| disable \| Отключить веб-прокси WISP. choice \| enable \| Включить веб-прокси WISP.
wisp_algorithm string	Варианты: auto-learning primary-secondary round-robin	Алгоритм выбора серверов WISP. choice \| auto-learning \| Выбрать сервер с наименьшей нагрузкой и работоспособный. choice \| primary-secondary \| Выбрать первый работоспособный сервер в порядке. choice \| round-robin \| Выбрать следующий работоспособный сервер.
wisp_servers string		Серверы WISP.
youtube_channel_filter string		ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! НЕОБХОДИМЫ ЗНАНИЯ API FMGR JSON! Список нескольких дочерних объектов для добавления. Ожидается список словарей. Словари должны использовать параметры API FortiManager, а не перечисленные ниже параметры ansible. Если отправлено, все другие префиксные подпараметры ИГНОРИРУЮТСЯ. Этот объект ВЗАИМНО ИСКЛЮЧАЕТ свои параметры. Ожидается, что вы знаете, что делаете с этими параметрами списка и используете руководство по JSON API. В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
youtube_channel_filter_channel_id string		Идентификатор канала YouTube, подлежащий фильтрации.
youtube_channel_filter_comment string		Комментарий.
youtube_channel_status string	Варианты: disable blacklist whitelist	Статус фильтрации канала YouTube. choice \| disable \| Отключить фильтр канала YouTube. choice \| blacklist \| Заблокировать совпадения. choice \| whitelist \| Разрешить совпадения.

Примечания

Примечание

Полная документация по адресу https://ftnt-ansible-docs.readthedocs.io/en/latest/.

Примеры

- name: DELETE Profile
  community.network.fmgr_secprof_web:
    name: "Ansible_Web_Filter_Profile"
    mode: "delete"

- name: CREATE Profile
  community.network.fmgr_secprof_web:
    name: "Ansible_Web_Filter_Profile"
    comment: "Created by Ansible Module TEST"
    mode: "set"
    extended_log: "enable"
    inspection_mode: "proxy"
    log_all_url: "enable"
    options: "js"
    ovrd_perm: "bannedword-override"
    post_action: "block"
    web_content_log: "enable"
    web_extended_all_action_log: "enable"
    web_filter_activex_log: "enable"
    web_filter_applet_log: "enable"
    web_filter_command_block_log: "enable"
    web_filter_cookie_log: "enable"
    web_filter_cookie_removal_log: "enable"
    web_filter_js_log: "enable"
    web_filter_jscript_log: "enable"
    web_filter_referer_log: "enable"
    web_filter_unknown_log: "enable"
    web_filter_vbs_log: "enable"
    web_ftgd_err_log: "enable"
    web_ftgd_quota_usage: "enable"
    web_invalid_domain_log: "enable"
    web_url_log: "enable"
    wisp: "enable"
    wisp_algorithm: "auto-learning"
    youtube_channel_status: "blacklist"

Значения возврата

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

Ключ	Возвращаемое значение	Описание
api_result string	всегда	полный ответ API, включает код состояния и сообщение

Авторы

Luke Weighall (@lweighall)
Andrew Welsh (@Ghilli3)
Jim Huber (@p4r4n0y1ng)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/fmgr_secprof_web_module.html