Модуль fortinet.fortios.fortios_firewall_proxy_policy — настройка прокси-политик в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_firewall_proxy_policy.
Новое в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры межсетевого экрана в категории proxy_policy. Перед использованием необходимо настроить все параметры и значения примеров в соответствии с источниками данных. Проверено на FOS v6.0.0
Требования
На хосте, выполняющем этот модуль, должны быть соблюдены следующие требования.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
firewall_proxy_policy dictionary | Настройка политик прокси. |
|
access_proxy list / elements=dictionary |
Прокси доступа IPv4. |
|
name string / обязательный |
Имя прокси доступа. Источник: firewall.access-proxy.name. |
|
access_proxy6 list / elements=dictionary |
Прокси доступа IPv6. |
|
name string / обязательный |
Имя прокси доступа. Источник: firewall.access-proxy6.name. |
|
action string |
Разрешить или запретить трафик, соответствующий параметрам политики. Варианты:
|
|
application_list string |
Имя существующего списка приложений. Источник: application.list.name. |
|
av_profile string |
Имя существующего антивирусного профиля. Источник: antivirus.profile.name. |
|
block_notification string |
Включить/отключить уведомление о блокировке. Варианты:
|
|
casb_profile string |
Имя существующего профиля CASB. Источник: casb.profile.name. |
|
cifs_profile string |
Имя существующего профиля CIFS. Источник: cifs.profile.name. |
|
comments string |
Необязательные комментарии. |
|
decrypted_traffic_mirror string |
Зеркалирование расшифрованного трафика. Источник: firewall.decrypted-traffic-mirror.name. |
|
detect_https_in_http_request string |
Включить/отключить обнаружение HTTPS в HTTP-запросе. Варианты:
|
|
device_ownership string |
Если параметр включён, контроль владения будет выполняться на уровне политики. Варианты:
|
|
diameter_filter_profile string |
Имя существующего профиля фильтра Diameter. Источник: diameter-filter.profile.name. |
|
disclaimer string |
Настройка уведомления веб-прокси: по домену, политике или пользователю. Варианты:
|
|
dlp_profile string |
Имя существующего профиля DLP. Источник: dlp.profile.name. |
|
dlp_sensor string |
Имя существующего датчика DLP. Источник: dlp.sensor.name. |
|
dnsfilter_profile string |
Имя существующего профиля DNS-фильтра. Источник: dnsfilter.profile.name. |
|
dstaddr list / elements=dictionary |
Объекты адресов назначения. |
|
name string / обязательный |
Имя адреса. Источник: firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name. |
|
dstaddr6 list / elements=dictionary |
Объекты адресов назначения IPv6. |
|
name string / обязательный |
Имя адреса. Источник: firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name. |
|
dstaddr_negate string |
Если параметр включён, адреса назначения сопоставляются с любым адресом, КРОМЕ указанных адресов назначения. Варианты:
|
|
dstintf list / elements=dictionary |
Имена интерфейсов назначения. |
|
name string / обязательный |
Имя интерфейса. Источник: system.interface.name system.zone.name system.sdwan.zone.name. |
|
emailfilter_profile string |
Имя существующего профиля фильтрации электронной почты. Источник: emailfilter.profile.name. |
|
file_filter_profile string |
Имя существующего профиля фильтрации файлов. Источник: file-filter.profile.name. |
|
global_label string |
Метка, отображаемая в глобальном веб-интерфейсе управления. |
|
groups list / elements=dictionary |
Имена объектов групп. |
|
name string / обязательный |
Имя группы. Источник: user.group.name. |
|
http_tunnel_auth string |
Включить/отключить аутентификацию туннеля HTTP. Варианты:
|
|
https_sub_category string |
Включить/отключить сопоставление политик по подкатегориям HTTPS. Варианты:
|
|
icap_profile string |
Имя существующего профиля ICAP. Источник: icap.profile.name. |
|
internet_service string |
Включить/отключить использование интернет-сервисов для этой политики. Если параметр включён, адрес назначения и сервис не используются. Варианты:
|
|
internet_service6 string |
Включить/отключить использование интернет-сервисов IPv6 для этой политики. Если параметр включён, адрес назначения IPv6 и сервис не используются. Варианты:
|
|
internet_service6_custom list / elements=dictionary |
Имя пользовательского интернет-сервиса IPv6. |
|
name string / обязательный |
Имя пользовательского интернет-сервиса IPv6. Источник: firewall.internet-service-custom.name. |
|
internet_service6_custom_group list / elements=dictionary |
Имя группы пользовательских интернет-сервисов IPv6. |
|
name string / обязательный |
Имя группы пользовательских интернет-сервисов IPv6. Источник: firewall.internet-service-custom-group.name. |
|
internet_service6_fortiguard list / elements=dictionary |
Имя интернет-сервиса IPv6 FortiGuard. |
|
name string / обязательный |
Имя интернет-сервиса IPv6 FortiGuard. Источник: firewall.internet-service-fortiguard.name. |
|
internet_service6_group list / elements=dictionary |
Имя группы интернет-сервисов IPv6. |
|
name string / обязательный |
Имя группы интернет-сервисов IPv6. Источник: firewall.internet-service-group.name. |
|
internet_service6_name list / elements=dictionary |
Имя интернет-сервиса IPv6. |
|
name string / обязательный |
Имя интернет-сервиса IPv6. Источник: firewall.internet-service-name.name. |
|
internet_service6_negate string |
Если параметр включён, интернет-сервисы сопоставляются с любым интернет-сервисом IPv6, КРОМЕ выбранного интернет-сервиса IPv6. Варианты:
|
|
internet_service_custom list / elements=dictionary |
Имя пользовательского интернет-сервиса. |
|
name string / обязательный |
Имя пользовательского интернет-сервиса. Источник: firewall.internet-service-custom.name. |
|
internet_service_custom_group list / elements=dictionary |
Имя группы пользовательских интернет-сервисов. |
|
name string / обязательный |
Имя группы пользовательских интернет-сервисов. Источник: firewall.internet-service-custom-group.name. |
|
internet_service_fortiguard list / elements=dictionary |
Имя интернет-сервиса FortiGuard. |
|
name string / обязательный |
Имя интернет-сервиса FortiGuard. Источник: firewall.internet-service-fortiguard.name. |
|
internet_service_group list / elements=dictionary |
Имя группы интернет-сервисов. |
|
name string / обязательный |
Имя группы интернет-сервисов. Источник: firewall.internet-service-group.name. |
|
internet_service_id list / elements=dictionary |
Идентификатор интернет-службы. |
|
id integer / required |
Идентификатор интернет-службы. См. <a href=’#notes’>Примечания</a>. Источник firewall.internet-service.id. |
|
internet_service_name list / elements=dictionary |
Имя интернет-службы. |
|
name string / required |
Имя интернет-службы. Источник firewall.internet-service-name.name. |
|
internet_service_negate string |
Если параметр включен, интернет-службы сопоставляются с любой интернет-службой, КРОМЕ выбранной. Варианты:
|
|
ips_sensor string |
Имя существующего датчика IPS. Источник ips.sensor.name. |
|
ips_voip_filter string |
Имя существующего профиля VoIP (ips). Источник voip.profile.name. |
|
isolator_server string |
Имя сервера-изолятара. Источник web-proxy.isolator-server.name. |
|
label string |
Отображаемая в графическом интерфейсе метка, специфичная для VDOM. |
|
log_http_transaction string |
Включить/отключить журнал транзакций HTTP. Варианты:
|
|
logtraffic string |
Включить/отключить ведение журнала трафика, проходящего через политику. Варианты:
|
|
logtraffic_start string |
Включить/отключить регистрацию начала трафика политики в журнале. Варианты:
|
|
mms_profile string |
Имя существующего профиля MMS. Источник firewall.mms-profile.name. |
|
name string |
Имя политики. |
|
policyid integer / required |
Идентификатор политики. См. <a href=’#notes’>Примечания</a>. |
|
poolname list / elements=dictionary |
Имя объекта пула IP-адресов. |
|
name string / required |
Имя пула IP-адресов. Источник firewall.ippool.name. |
|
poolname6 list / elements=dictionary |
Имя объекта пула IPv6-адресов. |
|
name string / required |
Имя пула IPv6-адресов. Источник firewall.ippool6.name. |
|
profile_group string |
Имя группы профилей. Источник firewall.profile-group.name. |
|
profile_protocol_options string |
Имя существующего профиля параметров протокола. Источник firewall.profile-protocol-options.name. |
|
profile_type string |
Определяет, разрешает ли политика брандмауэра использовать группы профилей безопасности или только отдельные профили. Варианты:
|
|
proxy string |
Тип явного прокси-сервера. Варианты:
|
|
redirect_url string |
URL перенаправления для дальнейшей обработки явным веб-прокси. |
|
replacemsg_override_group string |
Группа переопределения сообщения замены для аутентификации. Источник system.replacemsg-group.name. |
|
scan_botnet_connections string |
Включить/отключить проверку подключений к серверам ботнетов. Варианты:
|
|
schedule string |
Имя объекта расписания. Источник firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
|
sctp_filter_profile string |
Имя существующего профиля фильтрации SCTP. Источник sctp-filter.profile.name. |
|
service list / elements=dictionary |
Имена объектов служб. |
|
name string / required |
Имя службы. Источник firewall.service.custom.name firewall.service.group.name. |
|
service_negate string |
Если параметр включен, службы сопоставляются с любой службой, КРОМЕ указанных служб назначения. Варианты:
|
|
session_ttl integer |
Время жизни (TTL) в секундах для сеансов, разрешенных этой политикой (0 означает использование системного значения). |
|
spamfilter_profile string |
Имя существующего профиля фильтрации спама. Источник spamfilter.profile.name. |
|
srcaddr list / elements=dictionary |
Объекты адресов источника. |
|
name string / required |
Имя адреса. Источник firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. |
|
srcaddr6 list / elements=dictionary |
Объекты адресов источника IPv6. |
|
name string / required |
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name system.external-resource.name. |
|
srcaddr_negate string |
Если параметр включен, адреса источника сопоставляются с любым адресом, КРОМЕ указанных адресов источника. Варианты:
|
|
srcintf list / elements=dictionary |
Имена интерфейсов источника. |
|
name string / required |
Имя интерфейса. Источник system.interface.name system.zone.name system.sdwan.zone.name. |
|
ssh_filter_profile string |
Имя существующего профиля фильтрации SSH. Источник ssh-filter.profile.name. |
|
ssh_policy_redirect string |
Перенаправлять трафик SSH в соответствующую политику прозрачного прокси. Варианты:
|
|
ssl_ssh_profile string |
Имя существующего профиля SSL SSH. Источник firewall.ssl-ssh-profile.name. |
|
status string |
Включить/отключить действие политики. Варианты:
|
|
telemetry_profile string |
Имя существующего профиля телеметрии. Источник telemetry-controller.profile.name. |
|
transparent string |
Включите параметр, чтобы использовать IP-адрес клиента для подключения к серверу. Варианты:
|
|
url_risk list / elements=dictionary |
Имя уровня риска URL-адреса. |
|
name string / required |
Имя уровня риска. Источник webfilter.ftgd-risk-level.name. |
|
users list / elements=dictionary |
Имена объектов пользователей. |
|
name string / required |
Имя группы. Источник user.local.name user.certificate.name. |
|
utm_status string |
Включить использование профилей/датчиков/списков UTM. Варианты:
|
|
uuid string |
Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную). |
|
videofilter_profile string |
Имя существующего профиля VideoFilter. Источник videofilter.profile.name. |
|
virtual_patch_profile string |
Имя существующего профиля виртуального исправления. Источник virtual-patch.profile.name. |
|
voip_profile string |
Имя существующего профиля VoIP. Источник voip.profile.name. |
|
waf_profile string |
Имя существующего профиля межсетевого экрана веб-приложений. Источник waf.profile.name. |
|
webcache string |
Включить/отключить кэширование веб-данных. Варианты:
|
|
webcache_https string |
Включить/отключить кэширование веб-данных для HTTPS (требуется включить глубокую проверку в ssl-ssh-profile). Варианты:
|
|
webfilter_profile string |
Имя существующего профиля веб-фильтрации. Источник webfilter.profile.name. |
|
webproxy_forward_server string |
Имя сервера пересылки веб-прокси. Источник: web-proxy.forward-server.name web-proxy.forward-server-group.name. |
|
webproxy_profile string |
Имя профиля веб-прокси. Источник: web-proxy.profile.name. |
|
ztna_ems_tag list / elements=dictionary |
Имена тегов ZTNA EMS. |
|
name string / обязательный |
Имя тега EMS. Источник: firewall.address.name firewall.addrgrp.name. |
|
ztna_ems_tag_negate string |
Если параметр включен, теги ZTNA EMS сопоставляются с любым тегом, КРОМЕ указанных тегов ZTNA EMS. Варианты:
|
|
ztna_proxy list / elements=dictionary |
Прокси-серверы ZTNA. |
|
name string / обязательный |
Имя прокси-сервера ZTNA. Источник: ztna.traffic-forward-proxy.name ztna.web-proxy.name ztna.web-portal.name. |
|
ztna_tags_match_logic string |
Логика сопоставления тегов ZTNA. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Настоятельно рекомендуем указывать собственное значение policyid вместо 0. Хотя «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, у такого подхода есть ограничения. Подробнее см. в разделе «Вопросы и ответы».
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Configure proxy policies.
fortinet.fortios.fortios_firewall_proxy_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_policy:
access_proxy:
-
name: "default_name_4 (source firewall.access-proxy.name)"
access_proxy6:
-
name: "default_name_6 (source firewall.access-proxy6.name)"
action: "accept"
application_list: "<your_own_value> (source application.list.name)"
av_profile: "<your_own_value> (source antivirus.profile.name)"
block_notification: "enable"
casb_profile: "<your_own_value> (source casb.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
detect_https_in_http_request: "enable"
device_ownership: "enable"
diameter_filter_profile: "<your_own_value> (source diameter-filter.profile.name)"
disclaimer: "disable"
dlp_profile: "<your_own_value> (source dlp.profile.name)"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
dstaddr:
-
name: "default_name_23 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall
.vip.name firewall.vipgrp.name system.external-resource.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_26 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
.external-resource.name)"
dstintf:
-
name: "default_name_28 (source system.interface.name system.zone.name system.sdwan.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_33 (source user.group.name)"
http_tunnel_auth: "enable"
https_sub_category: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_39 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_41 (source firewall.internet-service-custom-group.name)"
internet_service_fortiguard:
-
name: "default_name_43 (source firewall.internet-service-fortiguard.name)"
internet_service_group:
-
name: "default_name_45 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "47 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_49 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service6: "enable"
internet_service6_custom:
-
name: "default_name_53 (source firewall.internet-service-custom.name)"
internet_service6_custom_group:
-
name: "default_name_55 (source firewall.internet-service-custom-group.name)"
internet_service6_fortiguard:
-
name: "default_name_57 (source firewall.internet-service-fortiguard.name)"
internet_service6_group:
-
name: "default_name_59 (source firewall.internet-service-group.name)"
internet_service6_name:
-
name: "default_name_61 (source firewall.internet-service-name.name)"
internet_service6_negate: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
ips_voip_filter: "<your_own_value> (source voip.profile.name)"
isolator_server: "<your_own_value> (source web-proxy.isolator-server.name)"
label: "<your_own_value>"
log_http_transaction: "enable"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_71"
policyid: "<you_own_value>"
poolname:
-
name: "default_name_74 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_76 (source firewall.ippool6.name)"
profile_group: "<your_own_value> (source firewall.profile-group.name)"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
profile_type: "single"
proxy: "explicit-web"
redirect_url: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
scan_botnet_connections: "disable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.name)"
service:
-
name: "default_name_87 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "0"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
srcaddr:
-
name: "default_name_92 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
.external-resource.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_95 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_97 (source system.interface.name system.zone.name system.sdwan.zone.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
telemetry_profile: "<your_own_value> (source telemetry-controller.profile.name)"
transparent: "enable"
url_risk:
-
name: "default_name_105 (source webfilter.ftgd-risk-level.name)"
users:
-
name: "default_name_107 (source user.local.name user.certificate.name)"
utm_status: "enable"
uuid: "<your_own_value>"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
virtual_patch_profile: "<your_own_value> (source virtual-patch.profile.name)"
voip_profile: "<your_own_value> (source voip.profile.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
ztna_ems_tag:
-
name: "default_name_120 (source firewall.address.name firewall.addrgrp.name)"
ztna_ems_tag_negate: "enable"
ztna_proxy:
-
name: "default_name_123 (source ztna.traffic-forward-proxy.name ztna.web-proxy.name ztna.web-portal.name)"
ztna_tags_match_logic: "or"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_firewall_proxy_policy_module.html