Модуль fortinet.fortimanager.fmgr_icap_profile — Настройка профилей ICAP.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_icap_profile.

Новый в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать для данных из источников перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
icap_profile словарь	Установленные параметры верхнего уровня.
204_response строка	Устарело, пожалуйста, переименуйте на 204_response. Включение/выключение разрешения ответа 204 от сервера ICAP. Варианты: `"disable"` `"enable"`
204_size_limit целое число	Устарело, пожалуйста, переименуйте на 204_size_limit. Максимальный размер ответа 204, сохраняемый клиентом ICAP в мегабайтах
chunk_encap строка	Устарело, пожалуйста, переименуйте на chunk_encap. Включение/выключение фрагментации. Варианты: `"disable"` `"enable"`
comment строка	Комментарий.
extension_feature список / элементы=строка	Устарело, пожалуйста, переименуйте на extension_feature. Включение/выключение функций расширения ICAP. Варианты: `"scan-progress"`
file_transfer список / элементы=строка	Устарело, пожалуйста, переименуйте на file_transfer. Настройка протоколов передачи файлов для передачи переданных файлов на ICAP … Варианты: `"ssh"` `"ftp"`
file_transfer_failure строка	Устарело, пожалуйста, переименуйте на file_transfer_failure. Действие, которое необходимо выполнить, если сервер ICAP недоступен при обработке … Варианты: `"error"` `"bypass"`
file_transfer_path строка	Устарело, пожалуйста, переименуйте на file_transfer_path. Компонент пути URI ICAP, который идентифицирует процесс передачи файлов …
file_transfer_server строка	Устарело, пожалуйста, переименуйте на file_transfer_server. Сервер ICAP, который нужно использовать для передачи файлов.
icap_block_log строка	Устарело, пожалуйста, переименуйте на icap_block_log. Включение/выключение журналирования UTM при обнаружении заражения. Варианты: `"disable"` `"enable"`
icap_headers список / элементы=словарь	Устарело, пожалуйста, переименуйте на icap_headers. Заголовки ICAP.
base64_encoding строка	Устарело, пожалуйста, переименуйте на base64_encoding. Включение/выключение использования кодирования base64 содержимого HTTP. Варианты: `"disable"` `"enable"`
content строка	Содержимое HTTP-заголовка.
id целое число	Идентификатор пересылаемого HTTP-заголовка.
name строка	Имя пересылаемого HTTP-заголовка.

END_OF_DOCUMENT_MARKER

methods list / elements=string	Допустимые методы HTTP, которые будут отправлены на ICAP-сервер для дальнейшей обработки. Choices: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"other"` `"connect"`
name string / required	Имя профиля ICAP.
preview string	Включить/отключить предварительный просмотр данных на ICAP-сервере. Choices: `"disable"` `"enable"`
preview-data-length integer	Устарело, переименуйте в preview_data_length. Длина предварительного просмотра данных, которые будут отправлены на ICAP-сервер.
replacemsg-group string	Устарело, переименуйте в replacemsg_group. Группа сообщений для замены.
request string	Включить/отключить передачу HTTP-запроса на ICAP-сервер. Choices: `"disable"` `"enable"`
request-failure string	Устарело, переименуйте в request_failure. Действие, которое необходимо выполнить, если ICAP-сервер недоступен при обработке … Choices: `"error"` `"bypass"`
request-path string	Устарело, переименуйте в request_path. Компонент пути URI ICAP, который идентифицирует обработку HTTP-запроса s…
request-server string	Устарело, переименуйте в request_server. ICAP-сервер, который будет использоваться для HTTP-запроса.
respmod-default-action string	Устарело, переименуйте в respmod_default_action. Действие по умолчанию для изменения ответа ICAP Choices: `"bypass"` `"forward"`
respmod-forward-rules list / elements=dictionary	Устарело, переименуйте в respmod_forward_rules. Правила переадресации Respmod.
action string	Действие, которое необходимо выполнить для ICAP-сервера. Choices: `"bypass"` `"forward"`
header-group list / elements=dictionary	Устарело, переименуйте в header_group. Группа заголовков.
case-sensitivity string	Устарело, переименуйте в case_sensitivity. Включить/отключить регистрозависимость при сопоставлении заголовка. Choices: `"disable"` `"enable"`
header string	Регулярное выражение для HTTP-заголовка.
header-name string	Устарело, переименуйте в header_name. HTTP-заголовок.
id integer	ID.
host string	Объект адреса для хоста.
http-resp-status-code any	(list) Устарело, переименуйте в http_resp_status_code. Код состояния HTTP-ответа.
name string	Имя адреса.
response string	Включить/отключить передачу HTTP-ответа на ICAP-сервер. Choices: `"disable"` `"enable"`

response-failure string	Устаревшее, пожалуйста, переименуйте его в response_failure. Действие, которое необходимо выполнить, если к серверу ICAP невозможно подключиться при обработке… Варианты: `"error"` `"bypass"`
response-path string	Устаревшее, пожалуйста, переименуйте его в response_path. Компонент пути URI ICAP, идентифицирующий обработку HTTP-ответа…
response-req-hdr string	Устаревшее, пожалуйста, переименуйте его в response_req_hdr. Включение/отключение добавления req-hdr для изменения ответа ICAP Варианты: `"disable"` `"enable"`
response-server string	Устаревшее, пожалуйста, переименуйте его в response_server. Сервер ICAP, который нужно использовать для HTTP-ответа.
scan-progress-interval integer	Устаревшее, пожалуйста, переименуйте его в scan_progress_interval. Значение интервала сканирования прогресса.
streaming-content-bypass string	Устаревшее, пожалуйста, переименуйте его в streaming_content_bypass. Включение/выключение обхода сервера ICAP для потокового контента. Варианты: `"disable"` `"enable"`
timeout integer	Время
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, при которых будет выведено сообщение об ошибке.
rc_succeeded list / elements=integer	Список rc-кодов, при которых будет выведено сообщение об успешном выполнении.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным или другим, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Configure ICAP profiles.
      fortinet.fortimanager.fmgr_icap_profile:
        # 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>
        state: present # <value in [present, absent]>
        icap_profile:
          methods:
            - delete
            - get
            - head
            - options
            - post
            - put
            - trace
            - other
            - connect
          name: <string>
          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>
          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>

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложно

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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_module.html