Модуль fortinet.fortimanager.fmgr_icap_profile_respmodforwardrules – Правила перенаправления режима ответа ICAP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
icap_profile_respmodforwardrules словарь | Настройка параметров верхнего уровня. |
|
action строка |
Действие, которое необходимо выполнить для сервера ICAP. Варианты:
|
|
header_group список / элементы=словарь |
Устаревшее, пожалуйста, переименуйте на header_group. Группа заголовков. |
|
case_sensitivity строка |
Устаревшее, пожалуйста, переименуйте на case_sensitivity. Включение/выключение чувствительности к регистру при сопоставлении заголовков. Варианты:
|
|
header строка |
Регулярное выражение HTTP-заголовка. |
|
header_name строка |
Устаревшее, пожалуйста, переименуйте на header_name. HTTP-заголовок. |
|
id целое число |
Идентификатор. |
|
host строка |
Объект адреса хоста. |
|
http_resp_status_code любой |
(список) Устаревшее, пожалуйста, переименуйте на http_resp_status_code. Код состояния HTTP-ответа. |
|
name строка / обязательно |
Имя адреса. |
profile строка / обязательно | Параметр (profile) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, при которых будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список rc-кодов, при которых будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Область (adom), которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая 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 помогают в этой работе.
- Для создания или обновления объекта используйте директиву 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: ICAP response mode forward rules.
fortinet.fortimanager.fmgr_icap_profile_respmodforwardrules:
# 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]>
icap_profile_respmodforwardrules:
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>
name: <string>
Возвращаемые значения
Общие значения, возвращаемые модулями, описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на сборку
© 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_icap_profile_respmodforwardrules_module.html
