Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_webproxy_profile – настройка профилей веб-прокси.

Примечание

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

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

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

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

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

proposed_method

строка

Переопределенный метод для базового запроса Json RPC.

Варианты:

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

rc_failed

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

revision_note

строка

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

state

строка / обязательный

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

Варианты:

  • "present"
  • "absent"

webproxy_profile

словарь

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

header_client_cert

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

строка

Действие с заголовками HTTP Client-Cert/Client-Cert-Chain в пересылаемых ответах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_client_ip

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

строка

Действие с заголовком HTTP client-IP в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_front_end_https

псевдонимы: header-front-end-https

строка

Действие с заголовком HTTP front-end-HTTPS в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_via_request

псевдонимы: header-via-request

строка

Действие с заголовком HTTP via в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_via_response

псевдонимы: header-via-response

строка

Действие с заголовком HTTP via в пересылаемых ответах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_x_authenticated_groups

псевдонимы: header-x-authenticated-groups

строка

Действие с заголовком HTTP x-authenticated-groups в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_x_authenticated_user

псевдонимы: header-x-authenticated-user

строка

Действие с заголовком HTTP x-authenticated-user в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_x_forwarded_client_cert

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

строка

Действие с заголовком HTTP x-forwarded-client-cert в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

header_x_forwarded_for

псевдонимы: header-x-forwarded-for

строка

Действие с заголовком HTTP x-forwarded-for в пересылаемых запросах

Варианты:

  • "pass"
  • "add"
  • "remove"

headers

список / элементы=словарь

Заголовки.

action

строка

Действие при пересылке заголовка HTTP.

Варианты:

  • "add-to-request"
  • "add-to-response"
  • "remove-from-request"
  • "remove-from-response"
  • "monitor-request"
  • "monitor-response"

add_option

псевдонимы: add-option

строка

Настройка добавления содержимого к существующему заголовку HTTP или добавления нового заголовка HTTP.

Варианты:

  • "append"
  • "new-on-not-found"
  • "new"
  • "replace"
  • "replace-when-match"

base64_encoding

псевдонимы: base64-encoding

строка

Включить или отключить кодирование содержимого HTTP в формате base64.

Варианты:

  • "disable"
  • "enable"

content

строка

Содержимое заголовков HTTP.

dstaddr

любой тип

(список или строка) Адрес назначения и имена групп адресов.

dstaddr6

любой тип

(список или строка) Адрес назначения и имена групп адресов

id

целое число

Идентификатор пересылаемого заголовка HTTP.

name

строка

Имя пересылаемого заголовка HTTP.

protocol

список / элементы=строка

Настройка протокола

Варианты:

  • "https"
  • "http"

log_header_change

псевдонимы: log-header-change

строка

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

Варианты:

  • "disable"
  • "enable"

max_cache_object_size

псевдонимы: max-cache-object-size

целое число

Максимальный размер объекта кэша.

name

строка / обязательный

Имя профиля.

strip_encoding

псевдонимы: strip-encoding

строка

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

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

строка

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.

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.
  • Обычно выполнение модуля завершается ошибкой при возврате ненулевого кода 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 web proxy profiles.
      fortinet.fortimanager.fmgr_webproxy_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_profile:
          name: "your value" # Required variable, string
          # header_client_ip: <value in [pass, add, remove]>
          # header_front_end_https: <value in [pass, add, remove]>
          # header_via_request: <value in [pass, add, remove]>
          # header_via_response: <value in [pass, add, remove]>
          # header_x_authenticated_groups: <value in [pass, add, remove]>
          # header_x_authenticated_user: <value in [pass, add, remove]>
          # header_x_forwarded_for: <value in [pass, add, remove]>
          # headers:
          #   - action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
          #     content: <string>
          #     id: <integer>
          #     name: <string>
          #     add_option: <value in [append, new-on-not-found, new, ...]>
          #     base64_encoding: <value in [disable, enable]>
          #     dstaddr: <list or string>
          #     dstaddr6: <list or string>
          #     protocol: ["https", "http"]
          # log_header_change: <value in [disable, enable]>
          # strip_encoding: <value in [disable, enable]>
          # header_x_forwarded_client_cert: <value in [pass, add, remove]>
          # max_cache_object_size: <integer>
          # header_client_cert: <value in [pass, add, remove]>

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

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

Ключ

Описание

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–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_profile_module.html

Spec-Zone.ru

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