Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_webproxy_profile модуль — Настройка профилей веб-прокси.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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, с которыми будут переопределены условия успешного завершения.

state

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

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

Варианты:

  • "present"
  • "absent"

webproxy_profile

словарь

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

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"
END_OF_DOCUMENT_MARKER

headers

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

Заголовки.

action

строка

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

Варианты:

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

add-option

строка

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

Варианты:

  • "append"
  • "new-on-not-found"
  • "new"

base64-encoding

строка

Устарело, пожалуйста, переименуйте на base64_encoding. Включение/выключение использования кодирования base64 содержимого HTTP.

Варианты:

  • "disable"
  • "enable"

content

строка

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

dstaddr

любой

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

dstaddr6

любой

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

id

целое число

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

name

строка

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

protocol

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

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

Варианты:

  • "https"
  • "http"

log-header-change

строка

Устарело, пожалуйста, переименуйте на log_header_change. Включение/выключение регистрации изменений HTTP-заголовка.

Варианты:

  • "disable"
  • "enable"

name

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

Имя профиля.

strip-encoding

строка

Устарело, пожалуйста, переименуйте на strip_encoding. Включение/выключение удаления неподдерживаемого кодирования из заголовка запроса.

Варианты:

  • "disable"
  • "enable"

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_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 web proxy profiles.
      fortinet.fortimanager.fmgr_webproxy_profile:
        # 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>
        state: present # <value in [present, absent]>
        webproxy_profile:
          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]>
          name: <string>
          strip_encoding: <value in [disable, enable]>
          header_x_forwarded_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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_webproxy_profile_module.html

Spec-Zone.ru

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