модуль fortinet.fortimanager.fmgr_webproxy_profile_headers — настройка заголовков пересылаемых HTTP-запросов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_webproxy_profile_headers.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
profile string / обязательный | Параметр (profile) в запрошенном URL. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, которыми будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, которыми будут переопределены условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
webproxy_profile_headers dictionary | Набор параметров верхнего уровня. |
|
action string |
Действие при пересылке заголовка HTTP. Варианты:
|
|
add_option псевдонимы: add-option string |
Настройка параметров для добавления содержимого к существующему заголовку HTTP или добавления нового заголовка HTTP. Варианты:
|
|
base64_encoding псевдонимы: base64-encoding string |
Включение или отключение кодирования содержимого HTTP в формате base64. Варианты:
|
|
content string |
Содержимое заголовков HTTP. |
|
dstaddr any |
(список или строка) Адрес назначения и имена групп адресов. |
|
dstaddr6 any |
(список или строка) Адрес назначения и имена групп адресов |
|
id integer / обязательный |
Идентификатор пересылаемого заголовка HTTP. |
|
name string |
Имя пересылаемого заголовка HTTP. |
|
protocol list / elements=string |
Настройка протокола Варианты:
|
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global и другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 HTTP forwarded requests headers.
fortinet.fortimanager.fmgr_webproxy_profile_headers:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
profile: <your own value>
state: present # <value in [present, absent]>
webproxy_profile_headers:
id: 0 # Required variable, integer
# action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
# content: <string>
# 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"]
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный запрошенный URL. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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_headers_module.html
