Модуль fortinet.fortios.fortios_icap_profile – настройка профилей ICAP в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля потребуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_icap_profile.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функции и категории профилей ICAP. В примерах приведены все параметры и значения, которые перед использованием необходимо скорректировать с учетом источников данных. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
icap_profile dictionary | Настройка профилей ICAP. |
|
chunk_encap string |
Включить/отключить инкапсуляцию с передачей блоками. Варианты:
|
|
comment string |
Комментарий. |
|
extension_feature list / elements=string |
Включить/отключить дополнительные функции ICAP. Варианты:
|
|
file_transfer list / elements=string |
Настройка протоколов передачи файлов для отправки передаваемых файлов на сервер ICAP в режиме REQMOD. Варианты:
|
|
file_transfer_failure string |
Действие, выполняемое, если при обработке передачи файла невозможно связаться с сервером ICAP. Варианты:
|
|
file_transfer_path string |
Компонент пути URI ICAP, указывающий службу обработки передачи файлов. |
|
file_transfer_server string |
Сервер ICAP для передачи файлов. Источник: icap.server.name, icap.server-group.name. |
|
icap_block_log string |
Включить/отключить ведение журнала UTM при обнаружении заражения. Варианты:
|
|
icap_headers list / elements=dictionary |
Настройка заголовков запросов, пересылаемых через ICAP. |
|
base64_encoding string |
Включить/отключить кодирование содержимого HTTP в формате Base64. Варианты:
|
|
content string |
Содержимое заголовка HTTP. |
|
id integer / обязательный |
Идентификатор пересылаемого заголовка HTTP. см. <a href=’#notes’>Примечания</a>. |
|
name string |
Имя пересылаемого заголовка HTTP. |
|
methods list / elements=string |
Разрешенные методы HTTP, которые будут отправляться на сервер ICAP для дальнейшей обработки. Варианты:
|
|
name string / обязательный |
Имя профиля ICAP. |
|
ocr_only string |
Включить/отключить отправку этим устройством FortiGate на сервер ICAP только содержимого, представляющего интерес для OCR. Варианты:
|
|
preview string |
Включить/отключить предварительную отправку данных на сервер ICAP. Варианты:
|
|
preview_data_length integer |
Длина данных предварительного просмотра, отправляемых на сервер ICAP. |
|
replacemsg_group string |
Группа сообщений для замены. Источник: system.replacemsg-group.name. |
|
request string |
Включить/отключить передачу HTTP-запроса на сервер ICAP. Варианты:
|
|
request_failure string |
Действие, выполняемое, если при обработке HTTP-запроса невозможно связаться с сервером ICAP. Варианты:
|
|
request_path string |
Компонент пути URI ICAP, указывающий службу обработки HTTP-запросов. |
|
request_server string |
Сервер ICAP для обработки HTTP-запроса. Источник: icap.server.name, icap.server-group.name. |
|
respmod_default_action string |
Действие по умолчанию при обработке модификации ответа ICAP (respmod). Варианты:
|
|
respmod_forward_rules list / elements=dictionary |
Правила пересылки для режима ответа ICAP. |
|
action string |
Действие, выполняемое для сервера ICAP. Варианты:
|
|
header_group list / elements=dictionary |
Группа заголовков HTTP. |
|
case_sensitivity string |
Включить/отключить учет регистра при сопоставлении заголовка. Варианты:
|
|
header string |
Регулярное выражение для заголовка HTTP. |
|
header_name string |
Заголовок HTTP. |
|
id integer / обязательный |
Идентификатор. см. <a href=’#notes’>Примечания</a>. |
|
host string |
Объект адреса узла. Источник: firewall.address.name, firewall.addrgrp.name, firewall.proxy-address.name. |
|
http_resp_status_code list / elements=dictionary |
Код состояния ответа HTTP. |
|
code integer / обязательный |
Код состояния ответа HTTP. см. <a href=’#notes’>Примечания</a>. |
|
name string / обязательный |
Имя адреса. |
|
response string |
Включить/отключить передачу HTTP-ответа на сервер ICAP. Варианты:
|
|
response_204 string |
Включить/отключить прием ответа 204 от сервера ICAP. Варианты:
|
|
response_failure string |
Действие, выполняемое, если при обработке HTTP-ответа невозможно связаться с сервером ICAP. Варианты:
|
|
response_path string |
Компонент пути URI ICAP, указывающий службу обработки HTTP-ответов. |
|
response_req_hdr string |
Включить/отключить добавление req-hdr при обработке модификации ответа ICAP (respmod). Варианты:
|
|
response_server string |
Сервер ICAP для обработки HTTP-ответа. Источник: icap.server.name, icap.server-group.name. |
|
scan_progress_interval integer |
Значение интервала отображения хода сканирования. |
|
size_limit_204 integer |
Ограничение размера ответа 204, сохраняемого клиентом ICAP, в мегабайтах (1–10). |
|
streaming_content_bypass string |
Включить/отключить обход сервера ICAP для потокового содержимого. Варианты:
|
|
timeout integer |
Время (в секундах), в течение которого клиент ICAP ожидает ответ от сервера ICAP. |
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанием member_path предназначен для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительным способом запуска плейбуков является httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Configure ICAP profiles.
fortinet.fortios.fortios_icap_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_profile:
response_204: "disable"
size_limit_204: "1"
chunk_encap: "disable"
comment: "Comment."
extension_feature: "scan-progress"
file_transfer: "ssh"
file_transfer_failure: "error"
file_transfer_path: "<your_own_value>"
file_transfer_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
icap_block_log: "disable"
icap_headers:
-
base64_encoding: "disable"
content: "<your_own_value>"
id: "16"
name: "default_name_17"
methods: "delete"
name: "default_name_19"
ocr_only: "disable"
preview: "disable"
preview_data_length: "0"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
request: "disable"
request_failure: "error"
request_path: "<your_own_value>"
request_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
respmod_default_action: "forward"
respmod_forward_rules:
-
action: "forward"
header_group:
-
case_sensitivity: "disable"
header: "<your_own_value>"
header_name: "<your_own_value>"
id: "35"
host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
http_resp_status_code:
-
code: "<you_own_value>"
name: "default_name_39"
response: "disable"
response_failure: "error"
response_path: "<your_own_value>"
response_req_hdr: "disable"
response_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
scan_progress_interval: "10"
streaming_content_bypass: "disable"
timeout: "30"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для обработки запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для обработки запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_icap_profile_module.html