Модуль fortinet.fortimanager.fmgr_icap_profile_respmodforwardrules – правила пересылки в режиме ответа ICAP.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_icap_profile_respmodforwardrules.
Добавлено в fortinet.fortimanager 2.1.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. |
icap_profile_respmodforwardrules dictionary | Набор параметров верхнего уровня. |
|
action string |
Действие, выполняемое для сервера ICAP. Варианты:
|
|
header_group псевдонимы: header-group list / элементы=dictionary |
Группа заголовков. |
|
case_sensitivity псевдонимы: case-sensitivity string |
Включить или отключить учёт регистра при сопоставлении заголовков. Варианты:
|
|
header string |
Регулярное выражение для заголовка HTTP. |
|
header_name псевдонимы: header-name string |
Заголовок HTTP. |
|
id integer |
Идентификатор. |
|
host string |
Объект адреса для узла. |
|
http_resp_status_code псевдонимы: http-resp-status-code any |
(список) Код состояния ответа HTTP. |
|
name string / обязательный |
Имя адреса. |
profile string / обязательный | Параметр (profile) в запрошенном URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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: ICAP response mode forward rules.
fortinet.fortimanager.fmgr_icap_profile_respmodforwardrules:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
profile: <your own value>
state: present # <value in [present, absent]>
icap_profile_respmodforwardrules:
name: "your value" # Required variable, string
# action: <value in [bypass, forward]>
# header_group:
# - case_sensitivity: <value in [disable, enable]>
# header: <string>
# header_name: <string>
# id: <integer>
# host: <string>
# http_resp_status_code: <list or integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=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_icap_profile_respmodforwardrules_module.html
