fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy модуль — Настройка политик прокси.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлена в 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.
pkg строка / обязательно	Параметр (pkg) в запрошенном URL.
pkg_firewall_proxypolicy словарь	Настройка параметров верхнего уровня.
_policy_block целое число	Назначенный блок политики.
access-proxy любой тип	(список или строка) Устаревшее, пожалуйста, переименуйте его на access_proxy. Доступный прокси.
access-proxy6 любой тип	(список или строка) Устаревшее, пожалуйста, переименуйте его на access_proxy6. IPv6 прокси доступа.
action строка	Принять или отклонить трафик, соответствующий параметрам политики. Варианты: `"accept"` `"deny"` `"redirect"`
application-list строка	Устаревшее, пожалуйста, переименуйте его на application_list. Имя существующего списка приложений.
av-profile строка	Устаревшее, пожалуйста, переименуйте его на av_profile. Имя существующего профиля антивируса.
block-notification строка	Устаревшее, пожалуйста, переименуйте его на block_notification. Включить/выключить уведомление о блокировке. Варианты: `"disable"` `"enable"`
casb-profile строка	Устаревшее, пожалуйста, переименуйте его на casb_profile. Имя существующего профиля CASB.
cifs-profile строка	Устаревшее, пожалуйста, переименуйте его на cifs_profile. Имя существующего профиля CIFS.
comments строка	Дополнительные комментарии.
decrypted-traffic-mirror строка	Устаревшее, пожалуйста, переименуйте его на decrypted_traffic_mirror. Зеркалирование расшифрованного трафика.
detect-https-in-http-request строка	Устаревшее, пожалуйста, переименуйте его на detect_https_in_http_request. Включить/выключить обнаружение HTTPS в HTTP-запросе. Варианты: `"disable"` `"enable"`
device-ownership строка	Устаревшее, пожалуйста, переименуйте его на device_ownership. При включении принудительная проверка владения устройством выполняется на уровне политики. Варианты: `"disable"` `"enable"`
diameter-filter-profile строка	Устаревшее, пожалуйста, переименуйте его на diameter_filter_profile. Имя существующего профиля фильтра Диаметра.

disclaimer string	Настройка отказа от ответственности веб-прокси Choices: `"disable"` `"domain"` `"policy"` `"user"`
dlp-profile string	Устарело, переименуйте в dlp_profile. Имя существующего профиля DLP.
dlp-sensor string	Устарело, переименуйте в dlp_sensor. Имя существующего датчика DLP.
dnsfilter-profile any	(list) Устарело, переименуйте в dnsfilter_profile. Имя существующего профиля фильтра DNS.
dstaddr any	(list or str) Объекты адресов назначения.
dstaddr-negate string	Устарело, переименуйте в dstaddr_negate. При включении адреса назначения соответствуют любому адресу, КРОМЕ s… Choices: `"disable"` `"enable"`
dstaddr6 any	(list or str) Объекты адресов назначения IPv6.
dstintf any	(list or str) Имена интерфейсов назначения.
emailfilter-profile string	Устарело, переименуйте в emailfilter_profile. Имя существующего профиля фильтра электронной почты.
file-filter-profile string	Устарело, переименуйте в file_filter_profile. Имя существующего профиля фильтра файлов.
global-label string	Устарело, переименуйте в global_label. Глобальная метка, видимая в веб-менеджере.
groups any	(list or str) Имена групповых объектов.
http-tunnel-auth string	Устарело, переименуйте в http_tunnel_auth. Включить/выключить аутентификацию HTTP-туннеля. Choices: `"disable"` `"enable"`
icap-profile string	Устарело, переименуйте в icap_profile. Имя существующего профиля ICAP.
internet-service string	Устарело, переименуйте в internet_service. Включить/выключить использование интернет-сервисов для этой политики. Choices: `"disable"` `"enable"`
internet-service-custom any	(list or str) Устарело, переименуйте в internet_service_custom. Имя пользовательского интернет-сервиса.
internet-service-custom-group any	(list or str) Устарело, переименуйте в internet_service_custom_group. Имя группы пользовательских интернет-сервисов.
internet-service-group any	(list or str) Устарело, переименуйте в internet_service_group. Имя группы интернет-сервисов.
internet-service-id any	(list or str) Устарело, переименуйте в internet_service_id. ID интернет-сервиса.
internet-service-name any	(list or str) Устарело, переименуйте в internet_service_name. Имя интернет-сервиса.
internet-service-negate string	Устарело, переименуйте в internet_service_negate. При включении интернет-сервисы соответствуют любому интернет-сервису… Choices: `"disable"` `"enable"`

internet-service6 string	Устарело, переименуйте в internet_service6. Включить/выключить использование интернет-сервисов IPv6 для этой политики. Варианты: `"disable"` `"enable"`
internet-service6-custom any	(список) Устарело, переименуйте в internet_service6_custom. Название пользовательского интернет-сервиса IPv6.
internet-service6-custom-group any	(список) Устарело, переименуйте в internet_service6_custom_group. Название группы пользовательских интернет-сервисов IPv6.
internet-service6-group any	(список) Устарело, переименуйте в internet_service6_group. Название группы интернет-сервисов IPv6.
internet-service6-name any	(список) Устарело, переименуйте в internet_service6_name. Название интернет-сервиса IPv6.
internet-service6-negate string	Устарело, переименуйте в internet_service6_negate. При включении, интернет-сервисы сопоставляются с любым интернет-сервисом… Варианты: `"disable"` `"enable"`
ips-sensor string	Устарело, переименуйте в ips_sensor. Имя существующего IPS-сенсора.
ips-voip-filter string	Устарело, переименуйте в ips_voip_filter. Имя существующего VoIP фильтра.
label string	Видимая метка графического интерфейса, специфичная для VDOM.
log-http-transaction string	Устарело, переименуйте в log_http_transaction. Включить/выключить логирование HTTP-транзакций. Варианты: `"disable"` `"enable"`
logtraffic string	Включить/выключить логирование трафика через политику. Варианты: `"disable"` `"all"` `"utm"`
logtraffic-start string	Устарело, переименуйте в logtraffic_start. Включить/выключить начало логирования трафика политики. Варианты: `"disable"` `"enable"`
mms-profile string	Устарело, переименуйте в mms_profile. Имя существующего профиля MMS.
name string	Имя политики.
policyid integer / required	Идентификатор политики.
poolname any	(список или строка) Имя объекта пула IP-адресов.
profile-group string	Устарело, переименуйте в profile_group. Имя группы профилей.
profile-protocol-options string	Устарело, переименуйте в profile_protocol_options. Имя существующего профиля параметров протокола.
profile-type string	Устарело, переименуйте в profile_type. Определяет, разрешает ли политика брандмауэра группы профилей безопасности или отдельные… Варианты: `"single"` `"group"`
proxy string	Тип явного прокси-сервера. Варианты: `"explicit-web"` `"transparent-web"` `"ftp"` `"wanopt"` `"ssh"` `"ssh-tunnel"` `"access-proxy"` `"ztna-proxy"`

redirect-url string	Устарело, переименуйте в redirect_url. URL-адрес перенаправления для дальнейшей явной обработки веб-прокси.
replacemsg-override-group string	Устарело, переименуйте в replacemsg_override_group. Группа перезаписи сообщения аутентификации.
scan-botnet-connections string	Устарело, переименуйте в scan_botnet_connections. Включить/выключить сканирование соединений с серверами Botnet. Варианты: `"disable"` `"block"` `"monitor"`
schedule string	Имя объекта расписания.
sctp-filter-profile string	Устарело, переименуйте в sctp_filter_profile. Имя существующего профиля фильтра SCTP.
service any	(список или str) Имена объектов сервиса.
service-negate string	Устарело, переименуйте в service_negate. При включении сервисы сопоставляются с любым сервисом, КРОМЕ указанного dest… Варианты: `"disable"` `"enable"`
session-ttl any	(int или str) Устарело, переименуйте в session_ttl. TTL в секундах для сеансов, принятых этой политикой
spamfilter-profile string	Устарело, переименуйте в spamfilter_profile. Имя существующего профиля фильтра спама.
srcaddr any	(список или str) Объекты исходных адресов
srcaddr-negate string	Устарело, переименуйте в srcaddr_negate. При включении исходные адреса сопоставляются с любым адресом, КРОМЕ указанного… Варианты: `"disable"` `"enable"`
srcaddr6 any	(список или str) Объекты исходных IPv6-адресов.
srcintf any	(список или str) Имена исходных интерфейсов.
ssh-filter-profile string	Устарело, переименуйте в ssh_filter_profile. Имя существующего профиля фильтра SSH.
ssh-policy-redirect string	Устарело, переименуйте в ssh_policy_redirect. Перенаправить трафик SSH на соответствующую политику прозрачного прокси. Варианты: `"disable"` `"enable"`
ssl-ssh-profile string	Устарело, переименуйте в ssl_ssh_profile. Имя существующего профиля SSL SSH.
status string	Включить/выключить активный статус политики. Варианты: `"disable"` `"enable"`
tags string	Имена меток объектов, применяемых к адресу.
transparent string	Включите, чтобы использовать IP-адрес клиента для подключения к серверу. Варианты: `"disable"` `"enable"`
users any	(список или str) Имена объектов пользователей.
utm-status string	Устарело, переименуйте в utm_status. Включить использование профилей/датчиков/списков UTM. Варианты: `"disable"` `"enable"`

uuid строка	Универсальный уникальный идентификатор
videofilter-profile строка	Устарело, пожалуйста, переименуйте на videofilter_profile. Имя существующего профиля видеофильтра.
virtual-patch-profile строка	Устарело, пожалуйста, переименуйте на virtual_patch_profile. Профиль виртуальной заплаты.
voip-profile строка	Устарело, пожалуйста, переименуйте на voip_profile. Имя существующего профиля VoIP.
waf-profile строка	Устарело, пожалуйста, переименуйте на waf_profile. Имя существующего профиля межсетевого экрана веб-приложений.
webcache строка	Включить/отключить кэширование веб-страниц. Варианты: `"disable"` `"enable"`
webcache-https строка	Устарело, пожалуйста, переименуйте на webcache_https. Включить/отключить кэширование веб-страниц для HTTPS Варианты: `"disable"` `"enable"`
webfilter-profile строка	Устарело, пожалуйста, переименуйте на webfilter_profile. Имя существующего профиля веб-фильтра.
webproxy-forward-server строка	Устарело, пожалуйста, переименуйте на webproxy_forward_server. Имя сервера обратного прокси-сервера веб-прокси.
webproxy-profile строка	Устарело, пожалуйста, переименуйте на webproxy_profile. Имя профиля веб-прокси.
ztna-ems-tag любой	(список или строка) Устарело, пожалуйста, переименуйте на ztna_ems_tag. Имена тегов ZTNA EMS.
ztna-proxy любой	(список) Устарело, пожалуйста, переименуйте на ztna_proxy. IPv4 прокси-сервер для переадресации трафика ZTNA.
ztna-tags-match-logic строка	Устарело, пожалуйста, переименуйте на ztna_tags_match_logic. Логика сопоставления тегов ZTNA. Варианты: `"or"` `"and"`
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми условия будут игнорироваться при возникновении ошибки.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми условия будут игнорироваться при успешном выполнении.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое	Максимальное время ожидания в секундах, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют соглашение об именовании с нижним подчеркиванием (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается код rc отличный от нуля. Вы также можете переопределить условия ошибки или успеха параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure proxy policies.
      fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_proxypolicy:
          action: accept # <value in [accept, deny, redirect]>
          comments: ansible-comment
          dstaddr: all
          dstintf: any
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          srcintf: any
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the proxy policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_proxypolicy"
          params:
            adom: "ansible"
            proxy-policy: "your_value"
            pkg: "ansible" # package name

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_pkg_firewall_proxypolicy_module.html