Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy — настройка политик явного прокси-сервера.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.2.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_explicitproxypolicy

dictionary

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

action

string

Действие политики.

Варианты:

  • "deny"
  • "accept"

active_auth_method

псевдонимы: active-auth-method

string

Метод активной аутентификации.

Варианты:

  • "ntlm"
  • "basic"
  • "digest"
  • "form"
  • "none"
  • "negotiate"

application_list

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

string

Список приложений.

av_profile

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

string

Антивирусный профиль.

casi_profile

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

string

Профиль CASI.

comments

string

Комментарий.

disclaimer

string

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

Варианты:

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

dlp_sensor

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

string

Датчик DLP.

dstaddr

string

Имя адреса назначения.

dstaddr6

string

Адрес назначения IPv6

dstaddr_negate

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

string

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

Варианты:

  • "disable"
  • "enable"

dstintf

string

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

global_label

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

string

Метка для глобального представления.

icap_profile

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

string

Профиль ICAP.

identity_based

псевдонимы: identity-based

string

Включить/отключить политику на основе идентификации.

Варианты:

  • "disable"
  • "enable"

identity_based_policy

псевдонимы: identity-based-policy

list / elements=dictionary

Политика на основе идентификации.

application_list

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

string

Список приложений.

av_profile

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

string

Антивирусный профиль.

casi_profile

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

string

Профиль CASI.

disclaimer

string

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

Варианты:

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

dlp_sensor

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

string

Датчик DLP.

groups

string

Имя группы.

icap_profile

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

string

Профиль ICAP.

id

integer

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

ips_sensor

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

string

Датчик IPS.

logtraffic

string

Включить/отключить регистрацию трафика политики.

Варианты:

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

logtraffic_start

псевдонимы: logtraffic-start

string

Включить/отключить регистрацию начала трафика политики.

Варианты:

  • "disable"
  • "enable"

mms_profile

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

string

Профиль MMS

profile_group

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

string

Группа профилей

profile_protocol_options

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

string

Параметры протокола профиля.

profile_type

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

string

Тип профиля

Варианты:

  • "single"
  • "group"

replacemsg_override_group

псевдонимы: replacemsg-override-group

string

Укажите группу переопределения сообщения-замены для аутентификации.

scan_botnet_connections

псевдонимы: scan-botnet-connections

string

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

Варианты:

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

schedule

string

Имя расписания.

spamfilter_profile

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

string

Профиль фильтрации спама.

ssl_ssh_profile

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

string

Профиль SSL SSH.

users

string

Имя пользователя.

utm_status

псевдонимы: utm-status

string

Включить профиль защиты AV/веб/IPS.

Варианты:

  • "disable"
  • "enable"

waf_profile

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

string

Профиль межсетевого экрана веб-приложений.

webfilter_profile

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

string

Профиль веб-фильтрации.

ip_based

псевдонимы: ip-based

string

Включить/отключить аутентификацию на основе IP-адреса.

Варианты:

  • "disable"
  • "enable"

ips_sensor

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

string

Датчик IPS.

label

string

Метка для представления раздела.

logtraffic

string

Включить/отключить регистрацию трафика политики.

Варианты:

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

logtraffic_start

псевдонимы: logtraffic-start

string

Включить/отключить регистрацию начала трафика политики.

Варианты:

  • "disable"
  • "enable"

mms_profile

aliases: mms-profile

string

Профиль MMS

policyid

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

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

profile_group

aliases: profile-group

string

Группа профилей

profile_protocol_options

aliases: profile-protocol-options

string

Параметры протокола профиля.

profile_type

aliases: profile-type

string

Тип профиля

Варианты:

  • "single"
  • "group"

proxy

string

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

Варианты:

  • "web"
  • "ftp"
  • "wanopt"

replacemsg_override_group

aliases: replacemsg-override-group

string

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

require_tfa

aliases: require-tfa

string

Включить или отключить обязательную двухфакторную аутентификацию.

Варианты:

  • "disable"
  • "enable"

scan_botnet_connections

aliases: scan-botnet-connections

string

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

Варианты:

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

schedule

string

Имя расписания.

service

string

Имя службы.

service_negate

aliases: service-negate

string

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

Варианты:

  • "disable"
  • "enable"

spamfilter_profile

aliases: spamfilter-profile

string

Профиль фильтрации спама.

srcaddr

string

Имя исходного адреса.

srcaddr6

string

Исходный адрес IPv6

srcaddr_negate

aliases: srcaddr-negate

string

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

Варианты:

  • "disable"
  • "enable"

ssl_ssh_profile

aliases: ssl-ssh-profile

string

Профиль SSL/SSH.

sso_auth_method

aliases: sso-auth-method

string

Метод аутентификации SSO.

Варианты:

  • "fsso"
  • "rsso"
  • "none"

status

string

Включить или отключить политику.

Варианты:

  • "disable"
  • "enable"

tags

string

Применённые теги объекта.

transaction_based

aliases: transaction-based

string

Включить или отключить аутентификацию на основе транзакций.

Варианты:

  • "disable"
  • "enable"

transparent

string

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

Варианты:

  • "disable"
  • "enable"

utm_status

aliases: utm-status

string

Включить профиль защиты от вирусов, веб-угроз и IPS.

Варианты:

  • "disable"
  • "enable"

uuid

string

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

waf_profile

aliases: waf-profile

string

Профиль межсетевого экрана веб-приложений.

web_auth_cookie

aliases: web-auth-cookie

string

Включить или отключить cookie веб-аутентификации.

Варианты:

  • "disable"
  • "enable"

webcache

string

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

Варианты:

  • "disable"
  • "enable"

webcache_https

aliases: webcache-https

string

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

Варианты:

  • "disable"
  • "any"
  • "enable"

webfilter_profile

aliases: webfilter-profile

string

Профиль веб-фильтрации.

webproxy_forward_server

aliases: webproxy-forward-server

string

Сервер пересылки веб-прокси.

webproxy_profile

aliases: webproxy-profile

string

Профиль веб-прокси.

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 / обязательный

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

Варианты:

  • "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 Explicit proxy policies.
      fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_explicitproxypolicy:
          policyid: 0 # Required variable, integer
          # action: <value in [deny, accept]>
          # active_auth_method: <value in [ntlm, basic, digest, ...]>
          # application_list: <string>
          # av_profile: <string>
          # casi_profile: <string>
          # comments: <string>
          # disclaimer: <value in [disable, domain, policy, ...]>
          # dlp_sensor: <string>
          # dstaddr: <string>
          # dstaddr_negate: <value in [disable, enable]>
          # dstaddr6: <string>
          # dstintf: <string>
          # global_label: <string>
          # icap_profile: <string>
          # identity_based: <value in [disable, enable]>
          # identity_based_policy:
          #   - application_list: <string>
          #     av_profile: <string>
          #     casi_profile: <string>
          #     disclaimer: <value in [disable, domain, policy, ...]>
          #     dlp_sensor: <string>
          #     groups: <string>
          #     icap_profile: <string>
          #     id: <integer>
          #     ips_sensor: <string>
          #     logtraffic: <value in [disable, all, utm]>
          #     logtraffic_start: <value in [disable, enable]>
          #     mms_profile: <string>
          #     profile_group: <string>
          #     profile_protocol_options: <string>
          #     profile_type: <value in [single, group]>
          #     replacemsg_override_group: <string>
          #     scan_botnet_connections: <value in [disable, block, monitor]>
          #     schedule: <string>
          #     spamfilter_profile: <string>
          #     ssl_ssh_profile: <string>
          #     users: <string>
          #     utm_status: <value in [disable, enable]>
          #     waf_profile: <string>
          #     webfilter_profile: <string>
          # ip_based: <value in [disable, enable]>
          # ips_sensor: <string>
          # label: <string>
          # logtraffic: <value in [disable, all, utm]>
          # logtraffic_start: <value in [disable, enable]>
          # mms_profile: <string>
          # profile_group: <string>
          # profile_protocol_options: <string>
          # profile_type: <value in [single, group]>
          # proxy: <value in [web, ftp, wanopt]>
          # replacemsg_override_group: <string>
          # require_tfa: <value in [disable, enable]>
          # scan_botnet_connections: <value in [disable, block, monitor]>
          # schedule: <string>
          # service: <string>
          # service_negate: <value in [disable, enable]>
          # spamfilter_profile: <string>
          # srcaddr: <string>
          # srcaddr_negate: <value in [disable, enable]>
          # srcaddr6: <string>
          # ssl_ssh_profile: <string>
          # sso_auth_method: <value in [fsso, rsso, none]>
          # status: <value in [disable, enable]>
          # tags: <string>
          # transaction_based: <value in [disable, enable]>
          # transparent: <value in [disable, enable]>
          # utm_status: <value in [disable, enable]>
          # uuid: <string>
          # waf_profile: <string>
          # web_auth_cookie: <value in [disable, enable]>
          # webcache: <value in [disable, enable]>
          # webcache_https: <value in [disable, any, enable]>
          # webfilter_profile: <string>
          # webproxy_forward_server: <string>
          # webproxy_profile: <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_pkg_firewall_explicitproxypolicy_module.html

Spec-Zone.ru

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