Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

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.

pkg

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

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

pkg_firewall_proxypolicy

dictionary

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

_policy_block

integer

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

access_proxy

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

any

(список или строка) Прокси доступа.

access_proxy6

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

any

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

action

string

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

Варианты:

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

application_list

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

string

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

av_profile

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

string

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

block_notification

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

string

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

Варианты:

  • "disable"
  • "enable"

casb_profile

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

string

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

cifs_profile

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

string

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

comments

string

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

decrypted_traffic_mirror

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

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

string

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

disclaimer

string

Настройка уведомления веб-прокси

Варианты:

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

dlp_profile

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

string

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

dlp_sensor

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

string

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

dnsfilter_profile

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

any

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

dstaddr

any

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

dstaddr6

any

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

dstaddr_negate

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

string

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

Варианты:

  • "disable"
  • "enable"

dstintf

any

(список или строка) Имена интерфейсов назначения.

emailfilter_profile

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

string

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

file_filter_profile

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

string

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

global_label

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

string

Метка, видимая в глобальном веб-интерфейсе управления.

groups

any

(список или строка) Имена объектов групп.

http_tunnel_auth

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

string

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

Варианты:

  • "disable"
  • "enable"

https_sub_category

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

string

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

Варианты:

  • "disable"
  • "enable"

icap_profile

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

string

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

internet_service

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

string

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

Варианты:

  • "disable"
  • "enable"

internet_service6

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

string

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

Варианты:

  • "disable"
  • "enable"

internet_service6_custom

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

any

(список) Имя пользовательского интернет-сервиса IPv6.

internet_service6_custom_group

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

any

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

internet_service6_fortiguard

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

any

(список) Имя интернет-сервиса FortiGuard IPv6.

internet_service6_group

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

any

(список) Имя группы интернет-сервисов IPv6.

internet_service6_name

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

any

(список) Имя интернет-сервиса IPv6.

internet_service6_negate

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

string

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

Варианты:

  • "disable"
  • "enable"

internet_service_custom

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

any

(список или строка) Имя пользовательского интернет-сервиса.

internet_service_custom_group

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

any

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

internet_service_fortiguard

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

any

(список) Имя интернет-сервиса FortiGuard.

internet_service_group

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

any

(список или строка) Имя группы интернет-сервисов.

internet_service_id

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

any

(список или строка) Идентификатор интернет-сервиса.

internet_service_name

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

any

(список или строка) Имя интернет-сервиса.

internet_service_negate

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

string

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

Варианты:

  • "disable"
  • "enable"

ips_sensor

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

string

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

ips_voip_filter

aliases: ips-voip-filter

string

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

isolator_server

aliases: isolator-server

any

(список) Имя сервера-изолятора.

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

string

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

name

string

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

policyid

integer / required

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

poolname

any

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

poolname6

any

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

profile_group

aliases: profile-group

string

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

profile_protocol_options

aliases: profile-protocol-options

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

string

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

scan_botnet_connections

aliases: scan-botnet-connections

string

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

Варианты:

  • "disable"
  • "block"
  • "monitor"

schedule

string

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

sctp_filter_profile

aliases: sctp-filter-profile

string

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

service

any

(список или строка) Имена объектов служб.

service_negate

aliases: service-negate

string

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

Варианты:

  • "disable"
  • "enable"

session_ttl

aliases: session-ttl

any

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

spamfilter_profile

aliases: spamfilter-profile

string

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

srcaddr

any

(список или строка) Объекты исходных адресов

srcaddr6

any

(список или строка) Объекты исходных адресов IPv6.

srcaddr_negate

aliases: srcaddr-negate

string

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

Варианты:

  • "disable"
  • "enable"

srcintf

any

(список или строка) Имена исходных интерфейсов.

ssh_filter_profile

aliases: ssh-filter-profile

string

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

ssh_policy_redirect

aliases: ssh-policy-redirect

string

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

Варианты:

  • "disable"
  • "enable"

ssl_ssh_profile

aliases: ssl-ssh-profile

string

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

status

string

Включить или отключить действие политики.

Варианты:

  • "disable"
  • "enable"

tags

string

Имена тегов объектов, примененных к адресу.

telemetry_profile

aliases: telemetry-profile

any

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

transparent

string

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

Варианты:

  • "disable"
  • "enable"

url_risk

aliases: url-risk

any

(список) Имя уровня риска URL-адреса.

users

any

(список или строка) Имена объектов пользователей.

utm_status

aliases: utm-status

string

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

Варианты:

  • "disable"
  • "enable"

uuid

string

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

videofilter_profile

aliases: videofilter-profile

string

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

virtual_patch_profile

aliases: virtual-patch-profile

string

Профиль виртуального исправления.

voip_profile

aliases: voip-profile

string

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

waf_profile

aliases: waf-profile

string

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

webcache

string

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

Варианты:

  • "disable"
  • "enable"

webcache_https

aliases: webcache-https

string

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

Варианты:

  • "disable"
  • "enable"

webfilter_profile

aliases: webfilter-profile

string

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

webproxy_forward_server

aliases: webproxy-forward-server

string

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

webproxy_profile

aliases: webproxy-profile

string

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

ztna_ems_tag

aliases: ztna-ems-tag

any

(список или строка) Имена тегов ZTNA EMS.

ztna_ems_tag_negate

aliases: ztna-ems-tag-negate

string

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

Варианты:

  • "disable"
  • "enable"

ztna_proxy

aliases: ztna-proxy

any

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

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, для которых условия успешного выполнения будут переопределены.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

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

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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

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_pkg_firewall_proxypolicy_module.html

Spec-Zone.ru

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