Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_webproxy_explicitproxy module – Явный прокси веб-прокси

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: fortinet.fortimanager.fmgr_webproxy_explicitproxy.

Новое в fortinet.fortimanager 2.12.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.

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"

webproxy_explicitproxy

dictionary

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

client_cert

псевдонимы: client-cert

string

Сертификат клиента.

Варианты:

  • "disable"
  • "enable"

detect_https_in_http_request

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

string

Обнаруживать HTTPS в HTTP-запросе.

Варианты:

  • "disable"
  • "enable"

dns_mode

псевдонимы: dns-mode

string

Режим DNS.

Варианты:

  • "recursive"
  • "non-recursive"
  • "forward-only"

dstport_from_incoming

псевдонимы: dstport-from-incoming

string

Порт назначения из входящего подключения.

Варианты:

  • "disable"
  • "enable"

empty_cert_action

псевдонимы: empty-cert-action

string

Действие при отсутствии сертификата.

Варианты:

  • "block"
  • "accept"
  • "accept-unmanageable"

ftp_incoming_port

псевдонимы: ftp-incoming-port

list / elements=string

Входящий порт FTP.

ftp_over_http

псевдонимы: ftp-over-http

string

FTP через HTTP.

Варианты:

  • "disable"
  • "enable"

header_proxy_agent

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

string

Заголовок proxy agent.

Варианты:

  • "disable"
  • "enable"

http

string

HTTP.

Варианты:

  • "disable"
  • "enable"

http_connection_mode

псевдонимы: http-connection-mode

string

Режим HTTP-подключения.

Варианты:

  • "static"
  • "multiplex"
  • "serverpool"

http_incoming_port

псевдонимы: http-incoming-port

list / elements=string

Входящий порт HTTP.

https_incoming_port

псевдонимы: https-incoming-port

list / elements=string

Входящий порт HTTPS.

incoming_ip

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

string

Входящий IP-адрес.

incoming_ip6

псевдонимы: incoming-ip6

string

Входящий IPv6-адрес.

interface

list / elements=string

Интерфейс.

ipv6_status

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

string

Состояние IPv6.

Варианты:

  • "disable"
  • "enable"

learn_dst_from_sni

псевдонимы: learn-dst-from-sni

string

Получать адрес назначения из SNI.

Варианты:

  • "disable"
  • "enable"

name

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

Имя.

pac_file_data

псевдонимы: pac-file-data

string

Данные PAC-файла.

pac_file_name

псевдонимы: pac-file-name

string

Имя PAC-файла.

pac_file_server_port

псевдонимы: pac-file-server-port

string

Порт сервера PAC-файла.

pac_file_server_status

псевдонимы: pac-file-server-status

string

Состояние сервера PAC-файла.

Варианты:

  • "disable"
  • "enable"

pac_file_through_https

псевдонимы: pac-file-through-https

string

Передача PAC-файла через HTTPS.

Варианты:

  • "disable"
  • "enable"

pac_file_url

псевдонимы: pac-file-url

string

URL PAC-файла.

pref_dns_result

псевдонимы: pref-dns-result

string

Предпочтительный результат DNS.

Варианты:

  • "ipv4"
  • "ipv6"
  • "ipv4-strict"
  • "ipv6-strict"

realm

string

Область.

return_to_sender

псевдонимы: return-to-sender

string

Возврат отправителю.

Варианты:

  • "disable"
  • "enable"

sec_default_action

псевдонимы: sec-default-action

string

Действие безопасности по умолчанию.

Варианты:

  • "deny"
  • "accept"

secure_web_proxy

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

string

Защищённый веб-прокси.

Варианты:

  • "disable"
  • "enable"
  • "secure"

secure_web_proxy_cert

псевдонимы: secure-web-proxy-cert

list / elements=string

Сертификат защищённого веб-прокси.

socks

string

SOCKS.

Варианты:

  • "disable"
  • "enable"

socks_incoming_port

псевдонимы: socks-incoming-port

list / elements=string

Входящий порт SOCKS.

ssl_algorithm

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

string

Алгоритм SSL.

Варианты:

  • "high"
  • "low"
  • "medium"

ssl_dh_bits

псевдонимы: ssl-dh-bits

string

Разрядность DH для SSL.

Варианты:

  • "768"
  • "1024"
  • "1536"
  • "2048"

status

string

Состояние.

Варианты:

  • "disable"
  • "enable"

unknown_http_version

псевдонимы: unknown-http-version

string

Неизвестная версия HTTP.

Варианты:

  • "best-effort"
  • "reject"

user_agent_detect

псевдонимы: user-agent-detect

string

Обнаружение user agent.

Варианты:

  • "disable"
  • "enable"

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: Web proxy explicit proxy
      fortinet.fortimanager.fmgr_webproxy_explicitproxy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_explicitproxy:
          name: "your value" # Required variable, string
          # detect_https_in_http_request: <value in [disable, enable]>
          # dns_mode: <value in [recursive, non-recursive, forward-only]>
          # dstport_from_incoming: <value in [disable, enable]>
          # ftp_incoming_port: <list or string>
          # ftp_over_http: <value in [disable, enable]>
          # header_proxy_agent: <value in [disable, enable]>
          # http: <value in [disable, enable]>
          # http_connection_mode: <value in [static, multiplex, serverpool]>
          # http_incoming_port: <list or string>
          # https_incoming_port: <list or string>
          # incoming_ip6: <string>
          # interface: <list or string>
          # ipv6_status: <value in [disable, enable]>
          # learn_dst_from_sni: <value in [disable, enable]>
          # pac_file_data: <string>
          # pac_file_name: <string>
          # pac_file_server_port: <string>
          # pac_file_server_status: <value in [disable, enable]>
          # pac_file_through_https: <value in [disable, enable]>
          # pac_file_url: <string>
          # pref_dns_result: <value in [ipv4, ipv6, ipv4-strict, ...]>
          # realm: <string>
          # return_to_sender: <value in [disable, enable]>
          # sec_default_action: <value in [deny, accept]>
          # secure_web_proxy: <value in [disable, enable, secure]>
          # secure_web_proxy_cert: <list or string>
          # socks: <value in [disable, enable]>
          # socks_incoming_port: <list or string>
          # ssl_algorithm: <value in [high, low, medium]>
          # ssl_dh_bits: <value in [768, 1024, 1536, ...]>
          # status: <value in [disable, enable]>
          # unknown_http_version: <value in [best-effort, reject]>
          # incoming_ip: <string>
          # client_cert: <value in [disable, enable]>
          # empty_cert_action: <value in [block, accept, accept-unmanageable]>
          # user_agent_detect: <value in [disable, enable]>

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

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

Ключ

Описание

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.

Возвращается: complex

Авторы

  • 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_webproxy_explicitproxy_module.html

Spec-Zone.ru

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