Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_icap_profile – Настройка профилей ICAP в FortiOS и FortiGate от Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: fortinet.fortios.fortios_icap_profile.

Новое в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), предоставляя пользователю возможность устанавливать и изменять функции icap и категорию профиля. Примеры включают все параметры, и значения должны быть скорректированы под источники данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Указанные ниже требования необходимы на хосте, на котором выполняется этот модуль.

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создается в графическом интерфейсе Fortigate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (default)
  • true

icap_profile

dictionary

Настройка профилей ICAP.

chunk_encap

string

Включить/отключить инкапсуляцию фрагментов.

Варианты:

  • "disable"
  • "enable"

comment

string

Комментарий.

extension_feature

list / elements=string

Включить/отключить расширенные функции ICAP.

Варианты:

  • "scan-progress"

file_transfer

list / elements=string

Настройка протоколов передачи файлов для передачи переданных файлов на ICAP-сервер как REQMOD.

Варианты:

  • "ssh"
  • "ftp"

file_transfer_failure

string

Действие, которое необходимо выполнить, если ICAP-сервер недоступен при обработке передачи файла.

Варианты:

  • "error"
  • "bypass"

file_transfer_path

string

Компонент пути URI ICAP, который идентифицирует службу обработки передачи файлов.

file_transfer_server

string

ICAP-сервер, который необходимо использовать для передачи файла. Источник icap.server.name icap.server-group.name.

icap_block_log

string

Включить/отключить журнал UTM при обнаружении инфекции.

Варианты:

  • "disable"
  • "enable"

icap_headers

list / elements=dictionary

Настройка пересылаемых заголовков ICAP.

base64_encoding

string

Включить/отключить использование кодировки base64 для HTTP-контента.

Варианты:

  • "disable"
  • "enable"

content

string

Контент HTTP-заголовка.

id

integer / required

ID пересылаемого HTTP-заголовка. см. <a href=’#notes’>Примечания</a>.

name

string

Имя пересылаемого HTTP-заголовка.

methods

list / elements=string

Разрешенные методы HTTP, которые будут отправлены на ICAP-сервер для дальнейшей обработки.

Варианты:

  • "delete"
  • "get"
  • "head"
  • "options"
  • "post"
  • "put"
  • "trace"
  • "connect"
  • "other"

name

string / required

Имя профиля ICAP.

preview

string

Включить/отключить предварительный просмотр данных на ICAP-сервере.

Варианты:

  • "disable"
  • "enable"

preview_data_length

integer

Длина предварительного просмотра данных, которые будут отправлены на ICAP-сервер.

replacemsg_group

string

Группа сообщений для замены. Источник system.replacemsg-group.name.

request

string

Включить/отключить передачу HTTP-запроса на ICAP-сервер.

Варианты:

  • "disable"
  • "enable"

request_failure

string

Действие, которое необходимо выполнить, если ICAP-сервер недоступен при обработке HTTP-запроса.

Варианты:

  • "error"
  • "bypass"

request_path

string

Компонент пути URI ICAP, который идентифицирует службу обработки HTTP-запроса.

request_server

string

ICAP-сервер, который необходимо использовать для HTTP-запроса. Источник icap.server.name icap.server-group.name.

respmod_default_action

string

Действие по умолчанию для обработки модификации ответа ICAP (respmod).

Варианты:

  • "forward"
  • "bypass"

respmod_forward_rules

list / elements=dictionary

Правила переадресации режима ответа ICAP.

action

string

Действие, которое необходимо выполнить для сервера ICAP.

Choices:

  • "forward"
  • "bypass"

header_group

list / elements=dictionary

Группа HTTP-заголовков.

case_sensitivity

string

Включить/отключить чувствительность к регистру при сопоставлении заголовка.

Choices:

  • "disable"
  • "enable"

header

string

Регулярное выражение HTTP-заголовка.

header_name

string

HTTP-заголовок.

id

integer / required

Идентификатор. См. <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 / required

Код состояния ответа HTTP. См. <a href=’#notes’>Примечания</a>.

name

string / required

Имя адреса.

response

string

Включить/отключить передачу ответа HTTP на сервер ICAP.

Choices:

  • "disable"
  • "enable"

response_204

string

Разрешить/запретить ответ 204 от сервера ICAP.

Choices:

  • "disable"
  • "enable"

response_failure

string

Действие, которое необходимо выполнить, если сервер ICAP недоступен при обработке ответа HTTP.

Choices:

  • "error"
  • "bypass"

response_path

string

Компонент пути URI ICAP, который определяет службу обработки ответа HTTP.

response_req_hdr

string

Включить/отключить добавление req-hdr для обработки модификации ответа ICAP (respmod).

Choices:

  • "disable"
  • "enable"

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 для потокового контента.

Choices:

  • "disable"
  • "enable"

timeout

integer

Время (в секундах), в течение которого клиент ICAP ожидает ответа от сервера ICAP.

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Разделяется символом слеша, если атрибутов более одного.

Параметр, помеченный как member_path, является допустимым для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент под указанным путем к атрибуту.

Если указан member_state, параметр state игнорируется.

Choices:

  • "present"
  • "absent"

state

string / required

Указывает, следует ли создать или удалить объект.

Choices:

  • "present"
  • "absent"

vdom

string

Виртуальный домен, среди ранее определенных. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль.

Default: "root"

Примечания

Примечание

  • Устаревший fortiosapi был объявлен устаревшим, httpapi является предпочтительным способом запуска playbook'ов
  • Модуль поддерживает 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"
          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: "34"
                  host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
                  http_resp_status_code:
                      -
                          code: "<you_own_value>"
                  name: "default_name_38"
          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

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для размещения контента в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (id), использованный в последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Указание результата операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_icap_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API