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

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.1.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.
icap_profile_icapheaders dictionary	Набор параметров верхнего уровня.
base64_encoding псевдонимы: base64-encoding string	Включение/отключение кодирования содержимого HTTP в формате base64. Варианты: `"disable"` `"enable"`
content string	Содержимое заголовка HTTP.
http_header псевдонимы: http-header string	Заголовок HTTP.
id integer / обязательный	Идентификатор пересылаемого заголовка HTTP.
name string	Имя пересылаемого заголовка HTTP.
sesson_info_type псевдонимы: sesson-info-type string	Тип сведений о сеансе. Варианты: `"client-ip"` `"user"` `"upn"` `"domain"` `"local-grp"` `"remote-grp"` `"proxy-name"` `"auth-user-uri"` `"auth-group-uri"`
source string	Источник. Варианты: `"content"` `"http-header"` `"session"`
profile string / обязательный	Параметр (profile) в запрошенном URL.
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"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая 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: Configure ICAP forwarded request headers.
      fortinet.fortimanager.fmgr_icap_profile_icapheaders:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        state: present # <value in [present, absent]>
        icap_profile_icapheaders:
          id: 0 # Required variable, integer
          # base64_encoding: <value in [disable, enable]>
          # content: <string>
          # name: <string>
          # http_header: <string>
          # sesson_info_type: <value in [client-ip, user, upn, ...]>
          # source: <value in [content, http-header, session]>

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

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

Ключ	Описание
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. Возвращается: в сложных случаях

Авторы

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_icap_profile_icapheaders_module.html