fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy модуль — Настройка явных прокси-политик.

Примечание

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

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

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

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

Впервые в fortinet.fortimanager 2.2.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_explicitproxypolicy словарь	Установленные параметры верхнего уровня.
action строка	Действие политики. Варианты: `"deny"` `"accept"`
active_auth_method строка	Устарело, пожалуйста, переименуйте на active_auth_method. Активный метод аутентификации. Варианты: `"ntlm"` `"basic"` `"digest"` `"form"` `"none"` `"negotiate"`
application_list строка	Устарело, пожалуйста, переименуйте на application_list. Список приложений.
av_profile строка	Устарело, пожалуйста, переименуйте на av_profile. Профиль антивируса.
casi_profile строка	Устарело, пожалуйста, переименуйте на casi_profile. Профиль CASI.
comments строка	Комментарий.
disclaimer строка	Настройка отметки об отказе от ответственности веб-прокси. Варианты: `"disable"` `"domain"` `"policy"` `"user"`
dlp_sensor строка	Устарело, пожалуйста, переименуйте на dlp_sensor. DLP-сенсор.
dstaddr строка	Имя адреса назначения.
dstaddr_negate строка	Устарело, пожалуйста, переименуйте на dstaddr_negate. Включение/выключение проверки совпадения адреса назначения с отрицанием. Варианты: `"disable"` `"enable"`
dstaddr6 строка	IPv6 адрес назначения
dstintf строка	Имя интерфейса назначения.
global_label строка	Устарело, пожалуйста, переименуйте на global_label. Метка для общего представления.
icap_profile строка	Устарело, пожалуйста, переименуйте на icap_profile. Профиль ICAP.

END_OF_DOCUMENT_MARKER

identity-based string	Устарело, переименуйте в identity_based. Включить/выключить политику на основе идентификации. Choices: `"disable"` `"enable"`
identity-based-policy list / elements=dictionary	Устарело, переименуйте в identity_based_policy. Политика на основе идентификации.
application-list string	Устарело, переименуйте в application_list. Список приложений.
av-profile string	Устарело, переименуйте в av_profile. Профайл антивируса.
casi-profile string	Устарело, переименуйте в casi_profile. Профайл CASI.
disclaimer string	Настройка отказа от ответственности веб-прокси. Choices: `"disable"` `"domain"` `"policy"` `"user"`
dlp-sensor string	Устарело, переименуйте в dlp_sensor. Сенсор DLP.
groups string	Имя группы.
icap-profile string	Устарело, переименуйте в icap_profile. Профайл ICAP.
id integer	Идентификатор.
ips-sensor string	Устарело, переименуйте в ips_sensor. Сенсор IPS.
logtraffic string	Включить/выключить логирование трафика политики. Choices: `"disable"` `"all"` `"utm"`
logtraffic-start string	Устарело, переименуйте в logtraffic_start. Включить/выключить начало логирования трафика политики. Choices: `"disable"` `"enable"`
mms-profile string	Устарело, переименуйте в mms_profile. Профайл MMS.
profile-group string	Устарело, переименуйте в profile_group. Группа профилей.
profile-protocol-options string	Устарело, переименуйте в profile_protocol_options. Параметры протокола профиля.
profile-type string	Устарело, переименуйте в profile_type. Тип профиля. Choices: `"single"` `"group"`
replacemsg-override-group string	Устарело, переименуйте в replacemsg_override_group. Укажите группу, переопределяющую сообщение аутентификации.
scan-botnet-connections string	Устарело, переименуйте в scan_botnet_connections. Включить/выключить сканирование подключений к серверам Botnet. Choices: `"disable"` `"block"` `"monitor"`
schedule string	Имя расписания.

spamfilter-profile string	Устарело, переименуйте в spamfilter_profile. Профайл спам-фильтра.
ssl-ssh-profile string	Устарело, переименуйте в ssl_ssh_profile. Профайл SSL SSH.
users string	Имя пользователя.
utm-status string	Устарело, переименуйте в utm_status. Включить профиль защиты AV/web/IPS. Варианты: `"disable"` `"enable"`
waf-profile string	Устарело, переименуйте в waf_profile. Профайл брандмауэра веб-приложений.
webfilter-profile string	Устарело, переименуйте в webfilter_profile. Профайл веб-фильтра.
ip-based string	Устарело, переименуйте в ip_based. Включить/выключить аутентификацию на основе IP-адреса. Варианты: `"disable"` `"enable"`
ips-sensor string	Устарело, переименуйте в ips_sensor. Датчик IPS.
label string	Метка для отображения раздела.
logtraffic string	Включить/выключить логирование трафика политики. Варианты: `"disable"` `"all"` `"utm"`
logtraffic-start string	Устарело, переименуйте в logtraffic_start. Включить/выключить начало логирования трафика политики. Варианты: `"disable"` `"enable"`
mms-profile string	Устарело, переименуйте в mms_profile. Профайл MMS.
policyid integer / required	Идентификатор политики.
profile-group string	Устарело, переименуйте в profile_group. Группа профилей.
profile-protocol-options string	Устарело, переименуйте в profile_protocol_options. Параметры протокола профиля.
profile-type string	Устарело, переименуйте в profile_type. Тип профиля. Варианты: `"single"` `"group"`
proxy string	Тип явного прокси-сервера. Варианты: `"web"` `"ftp"` `"wanopt"`
replacemsg-override-group string	Устарело, переименуйте в replacemsg_override_group. Укажите группу для переопределения сообщения аутентификации.
require-tfa string	Устарело, переименуйте в require_tfa. Включить/выключить требование двухфакторной аутентификации. Варианты: `"disable"` `"enable"`
scan-botnet-connections string	Устарело, переименуйте в scan_botnet_connections. Включить/выключить сканирование соединений с серверами ботнетов. Варианты: `"disable"` `"block"` `"monitor"`

расписание строка	Имя расписания.
услуга строка	Имя услуги.
service-negate строка	Устарело, пожалуйста, переименуйте его на service_negate. Включить/выключить соответствие по отрицанию услуги. Варианты: `"disable"` `"enable"`
spamfilter-profile строка	Устарело, пожалуйста, переименуйте его на spamfilter_profile. Профиль фильтра спама.
srcaddr строка	Имя адреса источника.
srcaddr-negate строка	Устарело, пожалуйста, переименуйте его на srcaddr_negate. Включить/выключить соответствие по отрицанию адреса источника. Варианты: `"disable"` `"enable"`
srcaddr6 строка	IPv6 адрес источника
ssl-ssh-profile строка	Устарело, пожалуйста, переименуйте его на ssl_ssh_profile. Профиль SSL SSH.
sso-auth-method строка	Устарело, пожалуйста, переименуйте его на sso_auth_method. Метод аутентификации SSO. Варианты: `"fsso"` `"rsso"` `"none"`
статус строка	Включить/выключить статус политики. Варианты: `"disable"` `"enable"`
метки строка	Примененные метки объекта.
transaction-based строка	Устарело, пожалуйста, переименуйте его на transaction_based. Включить/выключить аутентификацию на основе транзакций. Варианты: `"disable"` `"enable"`
прозрачный строка	Использовать IP-адрес клиента для подключения к серверу. Варианты: `"disable"` `"enable"`
utm-status строка	Устарело, пожалуйста, переименуйте его на utm_status. Включить профиль защиты AV/web/IPS. Варианты: `"disable"` `"enable"`
uuid строка	Универсальный уникальный идентификатор.
waf-profile строка	Устарело, пожалуйста, переименуйте его на waf_profile. Профиль межсетевого экрана веб-приложений.
web-auth-cookie строка	Устарело, пожалуйста, переименуйте его на web_auth_cookie. Включить/выключить cookie аутентификации веб-сайта. Варианты: `"disable"` `"enable"`
webcache строка	Включить/выключить кэш веб-страниц. Варианты: `"disable"` `"enable"`
webcache-https строка	Устарело, пожалуйста, переименуйте его на webcache_https. Включить/выключить кэш веб-страниц для HTTPS. Варианты: `"disable"` `"any"` `"enable"`
webfilter-profile строка	Устарело, пожалуйста, переименуйте его на webfilter_profile. Профиль фильтра веб-страниц.

webproxy-forward-server строка	Устаревшее, пожалуйста, переименуйте на webproxy_forward_server. Сервер прокси-сервера.
webproxy-profile строка	Устаревшее, пожалуйста, переименуйте на webproxy_profile. Профиль прокси-сервера.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбор: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc кодов, с которыми условия сбоя будут переопределены.
rc_succeeded список / элементы=целое число	Список rc кодов, с которыми условия успеха будут переопределены.
state строка / обязательный	Директива для создания, обновления или удаления объекта. Выбор: `"present"` `"absent"`
workspace_locking_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 (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 Explicit proxy policies.
      fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy:
        # 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>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_explicitproxypolicy:
          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>
          policyid: <integer>
          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 словарь	Результат запроса. Возвращается: всегда
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_explicitproxypolicy_module.html