Модуль fortinet.fortimanager.fmgr_icap_profile — настройка профилей ICAP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_icap_profile.
Добавлено в 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. |
icap_profile dictionary | Набор параметров верхнего уровня. |
|
204_response псевдонимы: 204-response string |
Включить/отключить разрешение ответа 204 от сервера ICAP. Варианты:
|
|
204_size_limit псевдонимы: 204-size-limit integer |
Ограничение размера ответа 204, сохраняемого клиентом ICAP, в мегабайтах |
|
allow_204_response псевдонимы: allow-204-response string |
Включить/отключить разрешение ответа 204 от сервера ICAP. Варианты:
|
|
chunk_encap псевдонимы: chunk-encap string |
Включить/отключить инкапсуляцию блоками Варианты:
|
|
comment string |
Комментарий. |
|
extension_feature псевдонимы: extension-feature list / элементы=string |
Включить/отключить дополнительные функции ICAP. Варианты:
|
|
file_transfer псевдонимы: file-transfer list / элементы=string |
Настроить протоколы передачи файлов для отправки передаваемых файлов на сервер ICAP в качестве REQMOD. Варианты:
|
|
file_transfer_failure псевдонимы: file-transfer-failure string |
Действие, выполняемое, если при обработке передачи файла невозможно связаться с сервером ICAP. Варианты:
|
|
file_transfer_path псевдонимы: file-transfer-path string |
Компонент пути URI ICAP, указывающий службу обработки передачи файлов. |
|
file_transfer_server псевдонимы: file-transfer-server string |
Сервер ICAP, используемый для передачи файла. |
|
icap_block_log псевдонимы: icap-block-log string |
Включить/отключить журнал UTM при обнаружении заражения Варианты:
|
|
icap_headers псевдонимы: icap-headers list / элементы=dictionary |
Заголовки ICAP. |
|
base64_encoding псевдонимы: base64-encoding string |
Включить/отключить кодирование содержимого HTTP в формате Base64. Варианты:
|
|
content string |
Содержимое заголовка HTTP. |
|
http_header псевдонимы: http-header string |
Заголовок HTTP. |
|
id integer |
Идентификатор перенаправляемого заголовка HTTP. |
|
name string |
Имя перенаправляемого заголовка HTTP. |
|
sesson_info_type псевдонимы: sesson-info-type string |
Тип сведений о сеансе. Варианты:
|
|
source string |
Источник. Варианты:
|
|
methods list / элементы=string |
Разрешённые методы HTTP, которые будут передаваться на сервер ICAP для дальнейшей обработки. Варианты:
|
|
name string / обязательный |
Имя профиля ICAP. |
|
ocr-only string |
Устарело, переименуйте параметр в ocr_only. Включить/отключить отправку этим устройством FortiGate только содержимого, предназначенного для OCR, на … Варианты:
|
|
ocr_only string |
Только OCR. Варианты:
|
|
preview string |
Включить/отключить предварительную передачу данных на сервер ICAP. Варианты:
|
|
preview_data_length псевдонимы: preview-data-length integer |
Длина предварительно передаваемых данных для отправки на сервер ICAP. |
|
replacemsg_group псевдонимы: replacemsg-group string |
Группа сообщений для замены. |
|
request string |
Включить/отключить передачу HTTP-запроса на сервер ICAP. Варианты:
|
|
request_failure псевдонимы: request-failure string |
Действие, выполняемое, если при обработке HTTP-запроса невозможно связаться с сервером ICAP. Варианты:
|
|
request_path псевдонимы: request-path string |
Компонент пути URI ICAP, указывающий службу обработки HTTP-запросов. |
|
request_server псевдонимы: request-server string |
Сервер ICAP, используемый для HTTP-запроса. |
|
respmod_default_action псевдонимы: respmod-default-action string |
Действие по умолчанию для изменения ответа ICAP Варианты:
|
|
respmod_forward_rules псевдонимы: respmod-forward-rules list / элементы=dictionary |
Правила перенаправления Respmod. |
|
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 |
Имя адреса. |
|
response string |
Включить/отключить передачу HTTP-ответа на сервер ICAP. Варианты:
|
|
response_failure псевдонимы: response-failure string |
Действие, выполняемое, если при обработке HTTP-ответа невозможно связаться с сервером ICAP. Варианты:
|
|
response_path псевдонимы: response-path string |
Компонент пути URI ICAP, указывающий службу обработки HTTP-ответов. |
|
response_req_hdr псевдонимы: response-req-hdr string |
Включить/отключить добавление req-hdr для изменения ответа ICAP Варианты:
|
|
response_server aliases: response-server string |
ICAP-сервер для HTTP-ответа. |
|
scan_oversize_log aliases: scan-oversize-log string |
Сканирование слишком большого журнала. Варианты:
|
|
scan_progress_interval aliases: scan-progress-interval integer |
Интервал обновления хода сканирования. |
|
scan_size_limit aliases: scan-size-limit integer |
Ограничение размера сканирования. |
|
streaming_content_bypass aliases: streaming-content-bypass string |
Включить или отключить обход ICAP-сервера для потокового содержимого. Варианты:
|
|
timeout integer |
Время |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых будут переопределены условия сбоя. |
rc_succeeded list / elements=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: Configure ICAP profiles.
fortinet.fortimanager.fmgr_icap_profile:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
icap_profile:
name: "your value" # Required variable, string
# methods: ["delete", "get", "head", "options", "post", "put", "trace", "other",
# "connect"]
# replacemsg_group: <string>
# request: <value in [disable, enable]>
# request_failure: <value in [error, bypass]>
# request_path: <string>
# request_server: <string>
# response: <value in [disable, enable]>
# response_failure: <value in [error, bypass]>
# response_path: <string>
# response_server: <string>
# streaming_content_bypass: <value in [disable, enable]>
# icap_headers:
# - base64_encoding: <value in [disable, enable]>
# content: <string>
# id: <integer>
# name: <string>
# http_header: <string>
# sesson_info_type: <value in [client-ip, user, upn, ...]>
# source: <value in [content, http-header, session]>
# preview: <value in [disable, enable]>
# preview_data_length: <integer>
# response_req_hdr: <value in [disable, enable]>
# respmod_default_action: <value in [bypass, forward]>
# respmod_forward_rules:
# - 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>
# 204_response: <value in [disable, enable]>
# 204_size_limit: <integer>
# chunk_encap: <value in [disable, enable]>
# extension_feature: ["scan-progress"]
# file_transfer: ["ssh", "ftp"]
# file_transfer_failure: <value in [error, bypass]>
# file_transfer_path: <string>
# file_transfer_server: <string>
# icap_block_log: <value in [disable, enable]>
# scan_progress_interval: <integer>
# timeout: <integer>
# comment: <string>
# ocr_only: <value in [disable, enable]>
# ocr_only: <value in [disable, enable]>
# scan_oversize_log: <value in [disable, enable]>
# scan_size_limit: <integer>
# allow_204_response: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
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_icap_profile_module.html