Модуль fortinet.fortimanager.fmgr_pm_config_pblock_firewall_proxypolicy – Настройка прокси-политик.

Примечание

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

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

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

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_pm_config_pblock_firewall_proxypolicy.

Новое в fortinet.fortimanager 2.7.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль способен настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
forticloud_access_token string	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
pblock string / required	Параметр (pblock) в запрошенном URL.
pm_config_pblock_firewall_proxypolicy dictionary	Набор параметров верхнего уровня.
_policy_block integer	Назначенный блок политик.
access-proxy list / elements=string	Устарело, переименуйте в access_proxy. IPv4 прокси доступа.
access-proxy6 list / elements=string	Устарело, переименуйте в access_proxy6. IPv6 прокси доступа.
action string	Разрешить или запретить трафик, соответствующий параметрам политики. Варианты: `"accept"` `"deny"` `"redirect"`
application-list list / elements=string	Устарело, переименуйте в application_list. Имя существующего списка приложений.
av-profile list / elements=string	Устарело, переименуйте в av_profile. Имя существующего профиля антивируса.
block-notification string	Устарело, переименуйте в block_notification. Включить/отключить уведомление о блокировке. Варианты: `"disable"` `"enable"`
casb-profile list / elements=string	Устарело, переименуйте в casb_profile. Имя существующего профиля CASB.
cifs-profile list / elements=string	Устарело, переименуйте в cifs_profile. Имя существующего профиля CIFS.
comments string	Дополнительные комментарии.
decrypted-traffic-mirror list / elements=string	Устарело, переименуйте в decrypted_traffic_mirror. Зеркалирование расшифрованного трафика.
detect-https-in-http-request string	Устарело, переименуйте в detect_https_in_http_request. Включить/отключить обнаружение HTTPS в HTTP-запросе. Варианты: `"disable"` `"enable"`
device-ownership string	Устарело, переименуйте в device_ownership. При включении принудительное указание владельца будет выполняться на уровне политики. Варианты: `"disable"` `"enable"`
diameter-filter-profile list / elements=string	Устарело, переименуйте в diameter_filter_profile. Имя существующего профиля фильтра Diameter.
disclaimer string	Настройка отказа от ответственности веб-прокси Варианты: `"disable"` `"domain"` `"policy"` `"user"`
dlp-profile list / elements=string	Устарело, переименуйте в dlp_profile. Имя существующего профиля DLP.
dlp-sensor list / elements=string	Устарело, переименуйте в dlp_sensor. Имя существующего датчика DLP.

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

internet-service6-negate string	Устарело, переименуйте в internet_service6_negate. При включении, Интернет-сервисы соответствуют любому интернет-сервису… Choices: `"disable"` `"enable"`
ips-sensor list / elements=string	Устарело, переименуйте в ips_sensor. Имя существующего IPS-сенсора.
ips-voip-filter list / elements=string	Устарело, переименуйте в ips_voip_filter. Имя существующего VoIP
label string	Видимая метка графического интерфейса, специфичная для VDOM.
log-http-transaction string	Устарело, переименуйте в log_http_transaction. Включить/выключить логирование транзакций HTTP. Choices: `"disable"` `"enable"`
logtraffic string	Включить/выключить логирование трафика через политику. Choices: `"disable"` `"all"` `"utm"`
logtraffic-start string	Устарело, переименуйте в logtraffic_start. Включить/выключить начало логирования трафика политики. Choices: `"disable"` `"enable"`
mms-profile list / elements=string	Устарело, переименуйте в mms_profile. Имя существующего профиля MMS.
name string	Имя политики.
policyid integer / required	Идентификатор политики.
poolname list / elements=string	Имя объекта пула IP-адресов.
profile-group list / elements=string	Устарело, переименуйте в profile_group. Имя группы профилей.
profile-protocol-options list / elements=string	Устарело, переименуйте в profile_protocol_options. Имя существующего профиля параметров протокола.
profile-type string	Устарело, переименуйте в profile_type. Определяет, разрешает ли политика брандмауэра группы профилей безопасности или отдельные… Choices: `"single"` `"group"`
proxy string	Тип явного прокси-сервера. Choices: `"explicit-web"` `"transparent-web"` `"ftp"` `"wanopt"` `"ssh"` `"ssh-tunnel"` `"access-proxy"` `"ztna-proxy"`
redirect-url string	Устарело, переименуйте в redirect_url. URL перенаправления для дальнейшей обработки явного веб-прокси.
replacemsg-override-group list / elements=string	Устарело, переименуйте в replacemsg_override_group. Группа переопределения сообщения замены аутентификации.
schedule list / elements=string	Имя объекта расписания.
sctp-filter-profile list / elements=string	Устарело, переименуйте в sctp_filter_profile. Имя существующего профиля фильтра SCTP.
service list / elements=string	Имена объектов сервисов.
service-negate string	Устарело, переименуйте в service_negate. При включении, сервисы соответствуют любому сервису, КРОМЕ указанного назначения… Choices: `"disable"` `"enable"`
session-ttl string	Устарело, переименуйте в session_ttl. TTL в секундах для сессий, принятых этой политикой.
srcaddr list / elements=string	Объекты исходных адресов.
srcaddr-negate string	Устарело, переименуйте в srcaddr_negate. При включении, исходные адреса соответствуют любому адресу, КРОМЕ указанного… Choices: `"disable"` `"enable"`

srcaddr6 list / elements=string	Объекты исходных IPv6-адресов.
srcintf list / elements=string	Имена исходных интерфейсов.
ssh-filter-profile list / elements=string	Устарело, переименуйте в ssh_filter_profile. Имя существующего профиля фильтра SSH.
ssh-policy-redirect string	Устарело, переименуйте в ssh_policy_redirect. Перенаправление трафика SSH на соответствующую политику прозрачного прокси. Choices: `"disable"` `"enable"`
ssl-ssh-profile list / elements=string	Устарело, переименуйте в ssl_ssh_profile. Имя существующего профиля SSL SSH.
status string	Включить/отключить активный статус политики. Choices: `"disable"` `"enable"`
transparent string	Включите, чтобы использовать IP-адрес клиента для подключения к серверу. Choices: `"disable"` `"enable"`
users list / elements=string	Имена объектов пользователей.
utm-status string	Устарело, переименуйте в utm_status. Включить использование профилей/датчиков/списков UTM. Choices: `"disable"` `"enable"`
uuid string	Универсальный уникальный идентификатор
videofilter-profile list / elements=string	Устарело, переименуйте в videofilter_profile. Имя существующего профиля VideoFilter.
virtual-patch-profile list / elements=string	Устарело, переименуйте в virtual_patch_profile. Профайл виртуального патча.
voip-profile list / elements=string	Устарело, переименуйте в voip_profile. Имя существующего профиля VoIP.
waf-profile list / elements=string	Устарело, переименуйте в waf_profile. Имя существующего профиля межсетевого экрана веб-приложений.
webcache string	Включить/отключить веб-кэширование. Choices: `"disable"` `"enable"`
webcache-https string	Устарело, переименуйте в webcache_https. Включить/отключить веб-кэширование для HTTPS Choices: `"disable"` `"enable"`
webfilter-profile list / elements=string	Устарело, переименуйте в webfilter_profile. Имя существующего профиля веб-фильтра.
webproxy-forward-server list / elements=string	Устарело, переименуйте в webproxy_forward_server. Имя сервера переадресации веб-прокси.
webproxy-profile list / elements=string	Устарело, переименуйте в webproxy_profile. Имя профиля веб-прокси.
ztna-ems-tag list / elements=string	Устарело, переименуйте в ztna_ems_tag. Имена тегов ZTNA EMS.
ztna-proxy list / elements=string	Устарело, переименуйте в ztna_proxy. Прокси переадресации трафика ZTNA IPv4.
ztna-tags-match-logic string	Устарело, переименуйте в ztna_tags_match_logic. Логика сопоставления тегов ZTNA. Choices: `"or"` `"and"`
proposed_method string	Переопределенный метод для базового запроса Json RPC. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия сбоя.

rc_succeeded list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия успешного выполнения.
state string / required	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая root.
workspace_locking_timeout integer	Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. По умолчанию: `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 (generated based on argument schema)
  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_pm_config_pblock_firewall_proxypolicy:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pblock: <your own value>
        state: present # <value in [present, absent]>
        pm_config_pblock_firewall_proxypolicy:
          _policy_block: <integer>
          access_proxy: <list or string>
          access_proxy6: <list or string>
          action: <value in [accept, deny, redirect]>
          application_list: <list or string>
          av_profile: <list or string>
          block_notification: <value in [disable, enable]>
          casb_profile: <list or string>
          comments: <string>
          decrypted_traffic_mirror: <list or string>
          detect_https_in_http_request: <value in [disable, enable]>
          device_ownership: <value in [disable, enable]>
          disclaimer: <value in [disable, domain, policy, ...]>
          dlp_profile: <list or string>
          dnsfilter_profile: <list or string>
          dstaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          dstaddr6: <list or string>
          dstintf: <list or string>
          emailfilter_profile: <list or string>
          file_filter_profile: <list or string>
          global_label: <string>
          groups: <list or string>
          http_tunnel_auth: <value in [disable, enable]>
          icap_profile: <list or string>
          internet_service: <value in [disable, enable]>
          internet_service_custom: <list or string>
          internet_service_custom_group: <list or string>
          internet_service_group: <list or string>
          internet_service_name: <list or string>
          internet_service_negate: <value in [disable, enable]>
          internet_service6: <value in [disable, enable]>
          internet_service6_custom: <list or string>
          internet_service6_custom_group: <list or string>
          internet_service6_group: <list or string>
          internet_service6_name: <list or string>
          internet_service6_negate: <value in [disable, enable]>
          ips_sensor: <list or string>
          ips_voip_filter: <list or string>
          label: <string>
          log_http_transaction: <value in [disable, enable]>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          name: <string>
          policyid: <integer>
          poolname: <list or string>
          profile_group: <list or string>
          profile_protocol_options: <list or string>
          profile_type: <value in [single, group]>
          proxy: <value in [explicit-web, transparent-web, ftp, ...]>
          redirect_url: <string>
          replacemsg_override_group: <list or string>
          schedule: <list or string>
          sctp_filter_profile: <list or string>
          service: <list or string>
          service_negate: <value in [disable, enable]>
          session_ttl: <string>
          srcaddr: <list or string>
          srcaddr_negate: <value in [disable, enable]>
          srcaddr6: <list or string>
          srcintf: <list or string>
          ssh_filter_profile: <list or string>
          ssh_policy_redirect: <value in [disable, enable]>
          ssl_ssh_profile: <list or string>
          status: <value in [disable, enable]>
          transparent: <value in [disable, enable]>
          users: <list or string>
          utm_status: <value in [disable, enable]>
          uuid: <string>
          videofilter_profile: <list or string>
          waf_profile: <list or string>
          webcache: <value in [disable, enable]>
          webcache_https: <value in [disable, enable]>
          webfilter_profile: <list or string>
          webproxy_forward_server: <list or string>
          webproxy_profile: <list or string>
          ztna_ems_tag: <list or string>
          ztna_proxy: <list or string>
          ztna_tags_match_logic: <value in [or, and]>
          diameter_filter_profile: <list or string>
          virtual_patch_profile: <list or string>
          voip_profile: <list or string>
          dlp_sensor: <list or string>
          cifs_profile: <list or string>
          internet_service_id: <list or string>
          mms_profile: <list or string>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описательное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_pm_config_pblock_firewall_proxypolicy_module.html