fortios_webfilter_profile – Настройка профилей веб-фильтра в Fortinet’s FortiOS и FortiGate
Новая в версии 2.8.
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять категорию функций и профилей веб-фильтра. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировано с FOS v6.0.5
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||||
|---|---|---|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | |||||
| https логическое |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | ||||
| password строка | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | ||||
| ssl_verify логическое добавлено в 2.9 |
| Обеспечивает проверку сертификата FortiGate надёжным центром сертификации. | ||||
| state строка добавлено в 2.9 |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был вынесен на этот внешний уровень. | ||||
| username строка | Имя пользователя FortiOS или FortiGate. | |||||
| vdom строка | Значение по умолчанию: "root" | Виртуальная область, среди ранее определённых. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. | ||||
| webfilter_profile словарь | Значение по умолчанию: null | Настройка профилей веб-фильтра. | ||||
| comment строка | Дополнительные комментарии. | |||||
| extended_log строка |
| Включить/выключить расширенное ведение логов для веб-фильтрации. | ||||
| ftgd_wf словарь | Настройки FortiGuard Web Filter. | |||||
| exempt_quota строка | Не останавливать квоту для этих категорий. | |||||
| filters список | Фильтры FortiGuard. | |||||
| action строка |
| Действие, которое будет выполнено при совпадении. | ||||
| auth_usr_grp строка | Группы с разрешением на аутентификацию. | |||||
| name строка / обязательно | Имя группы пользователей. Источник user.group.name. | |||||
| category целое число | Категории и группы, которые проверяет фильтр. | |||||
| id целое число / обязательно | Номер идентификатора. | |||||
| log строка |
| Включить/выключить ведение логов. | ||||
| override_replacemsg строка | Заменить сообщение. | |||||
| warn_duration строка | Продолжительность предупреждений. | |||||
| warning_duration_type строка |
| Повторное отображение предупреждения после закрытия браузера или по истечении времени. | ||||
| warning_prompt строка |
| Предупреждения для каждой категории или каждой области. | ||||
| max_quota_timeout целое число | Максимальное время квоты FortiGuard, используемое одной страницей загрузки в секундах (исключая потоки). | |||||
| options строка |
| Параметры FortiGuard Web Filter. | ||||
| ovrd строка | Разрешить переопределения профиля веб-фильтра. | |||||
| quota список | Настройки квоты трафика FortiGuard. | |||||
| category строка | Категории FortiGuard, к которым применяется квота (действие категории должно быть установлено на monitor). | |||||
| duration строка | Продолжительность квоты. | |||||
| id целое число / обязательно | Номер идентификатора. | |||||
| override_replacemsg строка | Заменить сообщение. | |||||
| type строка |
| Тип квоты. | ||||
| unit строка |
| Единица измерения квоты трафика. | ||||
| value целое число | Значение квоты трафика. | |||||
| rate_crl_urls строка |
| Включить/выключить оценку CRL по URL. | ||||
| rate_css_urls строка |
| Включить/выключить оценку CSS по URL. | ||||
| rate_image_urls string |
| Включить/выключить изображения рейтинга по URL. | ||||
| rate_javascript_urls string |
| Включить/выключить JavaScript рейтинга по URL. | ||||
| https_replacemsg string |
| Включить сообщения замены для HTTPS. | ||||
| inspection_mode string |
| Режим проверки веб-фильтрации. | ||||
| log_all_url string |
| Включить/выключить протоколирование всех посещённых URL. | ||||
| name string / обязательно | Имя профиля. | |||||
| options string |
| Параметры. | ||||
| override словарь | Настройки обхода веб-фильтра. | |||||
| ovrd_cookie string |
| Разрешить/запретить обход браузера (cookie). | ||||
| ovrd_dur string | Срок действия обхода. | |||||
| ovrd_dur_mode string |
| Режим срока действия обхода. | ||||
| ovrd_scope string |
| Область действия обхода. | ||||
| ovrd_user_group string | Группы пользователей с разрешением на использование обхода. | |||||
| name string / обязательно | Имя группы пользователей. Источник user.group.name. | |||||
| profile список | Профиль веб-фильтра с разрешением на создание обходов. | |||||
| name string / обязательно | Веб-профиль. Источник webfilter.profile.name. | |||||
| profile_attribute string |
| Атрибут профиля для извлечения с сервера RADIUS. | ||||
| profile_type string |
| Тип профиля обхода. | ||||
| ovrd_perm string |
| Разрешённые типы обхода. | ||||
| post_action string |
| Действие, выполняемое для HTTP POST трафика. | ||||
| replacemsg_group string | Группа сообщений замены. Источник system.replacemsg-group.name. | |||||
| state string |
| Устарело Начиная с Ansible 2.9, мы рекомендуем использовать параметр 'state' на верхнем уровне. Указывает, нужно ли создать или удалить объект. | ||||
| web словарь | Настройки веб-фильтрации контента. | |||||
| blacklist string |
| Включить/выключить автоматическое добавление URL, обнаруженных FortiSandbox, в чёрный список. | ||||
| bword_table целое число | Идентификатор таблицы запрещённых слов. Источник webfilter.content.id. | |||||
| bword_threshold целое число | Пороговое значение очков запрещённых слов. | |||||
| content_header_list целое число | Список заголовков контента. Источник webfilter.content-header.id. | |||||
| keyword_match string | Ключевые слова для поиска и протоколирования при совпадении. | |||||
| pattern string / обязательно | Шаблон/ключевое слово для поиска. | |||||
| log_search string |
| Включить/выключить протоколирование всех поисковых фраз. | ||||
| safe_search string |
| Тип безопасного поиска. | ||||
| urlfilter_table целое число | Идентификатор таблицы URL-фильтра. Источник webfilter.urlfilter.id. | |||||
| whitelist string |
| Настройки белого списка FortiGuard. | ||||
| youtube_restrict string |
| Уровень фильтра YouTube EDU. | ||||
| web_content_log string |
| Включение/выключение ведения журнала заблокированного веб-контента. | ||||
| web_extended_all_action_log string |
| Включение/выключение ведения журнала расширенных действий фильтрации для веб-фильтрации. | ||||
| web_filter_activex_log string |
| Включение/выключение ведения журнала ActiveX. | ||||
| web_filter_applet_log string |
| Включение/выключение ведения журнала Java-апплетов. | ||||
| web_filter_command_block_log string |
| Включение/выключение ведения журнала заблокированных команд. | ||||
| web_filter_cookie_log string |
| Включение/выключение ведения журнала фильтрации cookie. | ||||
| web_filter_cookie_removal_log string |
| Включение/выключение ведения журнала заблокированных cookie. | ||||
| web_filter_js_log string |
| Включение/выключение ведения журнала Java-скриптов. | ||||
| web_filter_jscript_log string |
| Включение/выключение ведения журнала JScripts. | ||||
| web_filter_referer_log string |
| Включение/выключение ведения журнала ссылок. | ||||
| web_filter_unknown_log string |
| Включение/выключение ведения журнала неизвестных скриптов. | ||||
| web_filter_vbs_log string |
| Включение/выключение ведения журнала VBS-скриптов. | ||||
| web_ftgd_err_log string |
| Включение/выключение ведения журнала ошибок рейтинга. | ||||
| web_ftgd_quota_usage string |
| Включение/выключение ведения журнала ежедневного использования квоты. | ||||
| web_invalid_domain_log string |
| Включение/выключение ведения журнала недопустимых доменных имён. | ||||
| web_url_log string |
| Включение/выключение ведения журнала фильтрации URL. | ||||
| wisp string |
| Включение/выключение веб-прокси WISP. | ||||
| wisp_algorithm string |
| Алгоритм выбора сервера WISP. | ||||
| wisp_servers list | Сервера WISP. | |||||
| name string / обязательно | Имя сервера. Источник web-proxy.wisp.name. | |||||
| youtube_channel_filter list | Фильтр каналов YouTube. | |||||
| channel_id string | Идентификатор канала YouTube для фильтрации. | |||||
| comment string | Комментарий. | |||||
| id integer / обязательно | Идентификатор. | |||||
| youtube_channel_status string |
| Статус фильтра канала YouTube. | ||||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Запуск как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure Web filter profiles.
fortios_webfilter_profile:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
webfilter_profile:
comment: "Optional comments."
extended_log: "enable"
ftgd_wf:
exempt_quota: "<your_own_value>"
filters:
-
action: "block"
auth_usr_grp:
-
name: "default_name_10 (source user.group.name)"
category: "11"
id: "12"
log: "enable"
override_replacemsg: "<your_own_value>"
warn_duration: "<your_own_value>"
warning_duration_type: "session"
warning_prompt: "per-domain"
max_quota_timeout: "18"
options: "error-allow"
ovrd: "<your_own_value>"
quota:
-
category: "<your_own_value>"
duration: "<your_own_value>"
id: "24"
override_replacemsg: "<your_own_value>"
type: "time"
unit: "B"
value: "28"
rate_crl_urls: "disable"
rate_css_urls: "disable"
rate_image_urls: "disable"
rate_javascript_urls: "disable"
https_replacemsg: "enable"
inspection_mode: "proxy"
log_all_url: "enable"
name: "default_name_36"
options: "activexfilter"
override:
ovrd_cookie: "allow"
ovrd_dur: "<your_own_value>"
ovrd_dur_mode: "constant"
ovrd_scope: "user"
ovrd_user_group:
-
name: "default_name_44 (source user.group.name)"
profile:
-
name: "default_name_46 (source webfilter.profile.name)"
profile_attribute: "User-Name"
profile_type: "list"
ovrd_perm: "bannedword-override"
post_action: "normal"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
web:
blacklist: "enable"
bword_table: "54 (source webfilter.content.id)"
bword_threshold: "55"
content_header_list: "56 (source webfilter.content-header.id)"
keyword_match:
-
pattern: "<your_own_value>"
log_search: "enable"
safe_search: "url"
urlfilter_table: "61 (source webfilter.urlfilter.id)"
whitelist: "exempt-av"
youtube_restrict: "none"
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: "primary-secondary"
wisp_servers:
-
name: "default_name_83 (source web-proxy.wisp.name)"
youtube_channel_filter:
-
channel_id: "<your_own_value>"
comment: "Comment."
id: "87"
youtube_channel_status: "disable"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа FortiGate Пример: 1547 |
| http_method строка | всегда | Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate для последней операции Пример: 200 |
| mkey строка | успех | Главный ключ (id), используемый в последнем вызове FortiGate Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: успех |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_webfilter_profile_module.html