Модуль fortinet.fortimanager.fmgr_webproxy_profile_headers — Настройка заголовков HTTP перенаправляемых запросов.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиент Ansible с помощью токена доступа к API forticloud.
profile строка / обязательно	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
webproxy_profile_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"`
base64_encoding строка	Устарело, пожалуйста, переименуйте на base64_encoding. Включить/выключить использование кодирования base64 содержимого HTTP. Варианты: `"disable"` `"enable"`
content строка	Содержимое HTTP-заголовков.
dstaddr любой	(список или строка) Названия конечного адреса и группы адресов.
dstaddr6 любой	(список или строка) Названия конечного адреса и группы адресов
id целое число / обязательно	Идентификатор пересылаемого HTTP-заголовка.
name строка	Имя пересылаемого HTTP-заголовка.
protocol список / элементы=строка	Настройка протокола Варианты: `"https"` `"http"`

END_OF_DOCUMENT_MARKER

workspace_locking_adom строка	Домен 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 HTTP forwarded requests headers.
      fortinet.fortimanager.fmgr_webproxy_profile_headers:
        # 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>
        profile: <your own value>
        state: present # <value in [present, absent]>
        webproxy_profile_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

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

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

Ключ	Описание
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_headers_module.html