Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.7.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

pblock

string / обязательный

Параметр (pblock) в запрошенном URL.

pm_config_pblock_firewall_proxypolicy

dictionary

Набор параметров верхнего уровня.

_policy_block

integer

Назначенный блок политики.

access_proxy

псевдонимы: access-proxy

list / elements=string

Прокси доступа IPv4.

access_proxy6

псевдонимы: access-proxy6

list / elements=string

Прокси доступа IPv6.

action

string

Разрешить или запретить трафик, соответствующий параметрам политики.

Варианты:

  • "accept"
  • "deny"
  • "redirect"
  • "isolate"

application_list

псевдонимы: application-list

list / elements=string

Имя существующего списка приложений.

av_profile

псевдонимы: av-profile

list / elements=string

Имя существующего антивирусного профиля.

block_notification

псевдонимы: block-notification

string

Включить или отключить уведомление о блокировке.

Варианты:

  • "disable"
  • "enable"

casb_profile

псевдонимы: casb-profile

list / elements=string

Имя существующего профиля CASB.

cifs_profile

псевдонимы: cifs-profile

list / elements=string

Имя существующего профиля CIFS.

comments

string

Необязательные комментарии.

decrypted_traffic_mirror

псевдонимы: decrypted-traffic-mirror

list / elements=string

Зеркалирование расшифрованного трафика.

detect_https_in_http_request

псевдонимы: detect-https-in-http-request

string

Включить или отключить обнаружение HTTPS в HTTP-запросе.

Варианты:

  • "disable"
  • "enable"

device_ownership

псевдонимы: device-ownership

string

Если параметр включен, контроль владения выполняется на уровне политики.

Варианты:

  • "disable"
  • "enable"

diameter_filter_profile

псевдонимы: diameter-filter-profile

list / elements=string

Имя существующего профиля фильтрации Diameter.

disclaimer

string

Настройка отказа от ответственности веб-прокси

Варианты:

  • "disable"
  • "domain"
  • "policy"
  • "user"

dlp_profile

псевдонимы: dlp-profile

list / elements=string

Имя существующего профиля DLP.

dlp_sensor

псевдонимы: dlp-sensor

list / elements=string

Имя существующего датчика DLP.

dnsfilter_profile

псевдонимы: dnsfilter-profile

list / elements=string

Имя существующего профиля фильтрации DNS.

dstaddr

list / elements=string

Объекты адресов назначения.

dstaddr6

list / elements=string

Объекты адресов назначения IPv6.

dstaddr_negate

псевдонимы: dstaddr-negate

string

Если параметр включен, адреса назначения сопоставляются с любым адресом, КРОМЕ указанных адресов назначения.

Варианты:

  • "disable"
  • "enable"

dstintf

list / elements=string

Имена интерфейсов назначения.

emailfilter_profile

псевдонимы: emailfilter-profile

list / elements=string

Имя существующего профиля фильтрации электронной почты.

file_filter_profile

псевдонимы: file-filter-profile

list / elements=string

Имя существующего профиля фильтрации файлов.

global_label

псевдонимы: global-label

string

Отображаемая метка веб-интерфейса Global.

groups

list / elements=string

Имена объектов групп.

http_tunnel_auth

псевдонимы: http-tunnel-auth

string

Включить или отключить аутентификацию HTTP-туннеля.

Варианты:

  • "disable"
  • "enable"

https_sub_category

псевдонимы: https-sub-category

string

Включить или отключить сопоставление политик с подкатегориями HTTPS.

Варианты:

  • "disable"
  • "enable"

icap_profile

псевдонимы: icap-profile

list / elements=string

Имя существующего профиля ICAP.

internet_service

псевдонимы: internet-service

string

Включить или отключить использование интернет-служб для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service6

псевдонимы: internet-service6

string

Включить или отключить использование интернет-служб IPv6 для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service6_custom

псевдонимы: internet-service6-custom

list / elements=string

Имя пользовательской интернет-службы IPv6.

internet_service6_custom_group

псевдонимы: internet-service6-custom-group

list / elements=string

Имя пользовательской группы интернет-служб IPv6.

internet_service6_fortiguard

псевдонимы: internet-service6-fortiguard

list / elements=string

Имя интернет-службы FortiGuard IPv6.

internet_service6_group

псевдонимы: internet-service6-group

list / elements=string

Имя группы интернет-служб IPv6.

internet_service6_name

псевдонимы: internet-service6-name

list / elements=string

Имя интернет-службы IPv6.

internet_service6_negate

псевдонимы: internet-service6-negate

string

Если параметр включен, интернет-службы сопоставляются с любой интернет-службой IPv6, КРОМЕ выбранной интернет-службы IPv6.

Варианты:

  • "disable"
  • "enable"

internet_service_custom

псевдонимы: internet-service-custom

list / elements=string

Имя пользовательской интернет-службы.

internet_service_custom_group

псевдонимы: internet-service-custom-group

list / elements=string

Имя пользовательской группы интернет-служб.

internet_service_fortiguard

псевдонимы: internet-service-fortiguard

list / elements=string

Имя интернет-службы FortiGuard.

internet_service_group

псевдонимы: internet-service-group

list / elements=string

Имя группы интернет-служб.

internet_service_id

aliases: internet-service-id

list / elements=string

Идентификатор интернет-службы.

internet_service_name

aliases: internet-service-name

list / elements=string

Имя интернет-службы.

internet_service_negate

aliases: internet-service-negate

string

Если параметр включен, интернет-службы сопоставляются с любой интернет-службой, КРОМЕ выбранной.

Варианты:

  • "disable"
  • "enable"

ips_sensor

aliases: ips-sensor

list / elements=string

Имя существующего датчика IPS.

ips_voip_filter

aliases: ips-voip-filter

list / elements=string

Имя существующего фильтра VoIP

isolator_server

aliases: isolator-server

list / elements=string

Имя сервера изоляции.

label

string

Метка, отображаемая в графическом интерфейсе и специфичная для VDOM.

log_http_transaction

aliases: log-http-transaction

string

Включить или отключить журналирование HTTP-транзакций.

Варианты:

  • "disable"
  • "enable"

logtraffic

string

Включить или отключить журналирование трафика, проходящего через политику.

Варианты:

  • "disable"
  • "all"
  • "utm"

logtraffic_start

aliases: logtraffic-start

string

Включить или отключить журналирование начала трафика политики.

Варианты:

  • "disable"
  • "enable"

mms_profile

aliases: mms-profile

list / elements=string

Имя существующего профиля MMS.

name

string

Имя политики.

policyid

integer / required

Идентификатор политики.

poolname

list / elements=string

Имя объекта пула IP-адресов.

poolname6

list / elements=string

Имя объекта пула IPv6-адресов.

profile_group

aliases: profile-group

list / elements=string

Имя группы профилей.

profile_protocol_options

aliases: profile-protocol-options

list / elements=string

Имя существующего профиля параметров протокола.

profile_type

aliases: profile-type

string

Определяет, разрешает ли политика брандмауэра использовать группы профилей безопасности или только отдельные профили.

Варианты:

  • "single"
  • "group"

proxy

string

Тип явного прокси-сервера.

Варианты:

  • "explicit-web"
  • "transparent-web"
  • "ftp"
  • "wanopt"
  • "ssh"
  • "ssh-tunnel"
  • "access-proxy"
  • "ztna-proxy"

redirect_url

aliases: redirect-url

string

URL перенаправления для дальнейшей обработки явным веб-прокси.

replacemsg_override_group

aliases: replacemsg-override-group

list / elements=string

Группа переопределения сообщений замены для аутентификации.

schedule

list / elements=string

Имя объекта расписания.

sctp_filter_profile

aliases: sctp-filter-profile

list / elements=string

Имя существующего профиля фильтра SCTP.

service

list / elements=string

Имена объектов служб.

service_negate

aliases: service-negate

string

Если параметр включен, службы сопоставляются с любой службой, КРОМЕ указанных служб назначения.

Варианты:

  • "disable"
  • "enable"

session_ttl

aliases: session-ttl

string

Время жизни (в секундах) сеансов, разрешенных этой политикой.

srcaddr

list / elements=string

Объекты адресов источника.

srcaddr6

list / elements=string

Объекты адресов источника IPv6.

srcaddr_negate

aliases: srcaddr-negate

string

Если параметр включен, адреса источника сопоставляются с любым адресом, КРОМЕ указанных адресов источника.

Варианты:

  • "disable"
  • "enable"

srcintf

list / elements=string

Имена интерфейсов источника.

ssh_filter_profile

aliases: ssh-filter-profile

list / elements=string

Имя существующего профиля фильтра SSH.

ssh_policy_redirect

aliases: ssh-policy-redirect

string

Перенаправлять трафик SSH в соответствующую политику прозрачного прокси.

Варианты:

  • "disable"
  • "enable"

ssl_ssh_profile

aliases: ssl-ssh-profile

list / elements=string

Имя существующего профиля SSL SSH.

status

string

Включить или отключить активный статус политики.

Варианты:

  • "disable"
  • "enable"

telemetry_profile

aliases: telemetry-profile

list / elements=string

Имя существующего профиля телеметрии.

transparent

string

Включите этот параметр, чтобы использовать IP-адрес клиента для подключения к серверу.

Варианты:

  • "disable"
  • "enable"

url_risk

aliases: url-risk

list / elements=string

Название уровня риска URL.

users

list / elements=string

Имена объектов пользователей.

utm_status

aliases: utm-status

string

Включить использование профилей, датчиков и списков UTM.

Варианты:

  • "disable"
  • "enable"

uuid

string

Универсальный уникальный идентификатор

videofilter_profile

aliases: videofilter-profile

list / elements=string

Имя существующего профиля VideoFilter.

virtual_patch_profile

aliases: virtual-patch-profile

list / elements=string

Профиль виртуальных исправлений.

voip_profile

aliases: voip-profile

list / elements=string

Имя существующего профиля VoIP.

waf_profile

aliases: waf-profile

list / elements=string

Имя существующего профиля межсетевого экрана веб-приложений.

webcache

string

Включить или отключить веб-кэширование.

Варианты:

  • "disable"
  • "enable"

webcache_https

aliases: webcache-https

string

Включить или отключить веб-кэширование для HTTPS

Варианты:

  • "disable"
  • "enable"

webfilter_profile

aliases: webfilter-profile

list / elements=string

Имя существующего профиля веб-фильтрации.

webproxy_forward_server

aliases: webproxy-forward-server

list / elements=string

Имя сервера переадресации веб-прокси.

webproxy_profile

aliases: webproxy-profile

list / elements=string

Имя профиля веб-прокси.

ztna_ems_tag

aliases: ztna-ems-tag

list / elements=string

Имена тегов ZTNA EMS.

ztna_ems_tag_negate

aliases: ztna-ems-tag-negate

string

Если параметр включён, теги ZTNA EMS будут соответствовать любому тегу, КРОМЕ указанных тегов ZTNA EMS.

Варианты:

  • "disable"
  • "enable"

ztna_proxy

aliases: ztna-proxy

list / elements=string

Прокси-сервер пересылки трафика IPv4 ZTNA.

ztna_tags_match_logic

aliases: ztna-tags-match-logic

string

Логика сопоставления тегов ZTNA.

Варианты:

  • "or"
  • "and"

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, которыми будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, которыми будут переопределены условия успешного выполнения.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "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.
  • Обычно выполнение модуля может завершиться с ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure proxy policies.
      fortinet.fortimanager.fmgr_pm_config_pblock_firewall_proxypolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pblock: <your own value>
        state: present # <value in [present, absent]>
        pm_config_pblock_firewall_proxypolicy:
          policyid: 0 # Required variable, integer
          # _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>
          # 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>
          # isolator_server: <list or string>
          # url_risk: <list or string>
          # ztna_ems_tag_negate: <value in [disable, enable]>
          # https_sub_category: <value in [disable, enable]>
          # telemetry_profile: <list or string>
          # internet_service_fortiguard: <list or string>
          # internet_service6_fortiguard: <list or string>
          # poolname6: <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

Предупреждение выводится, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_pm_config_pblock_firewall_proxypolicy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API