fortinet.fortimanager.fmgr_icap_profile – Настройка профилей ICAP.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач, укажите: fortinet.fortimanager.fmgr_icap_profile.

Новое в версии 2.10: от fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
icap_profile словарь			параметры верхнего уровня
	methods список / элементы=строка	Варианты: delete get head options post put trace other	нет описания
	name строка		Имя профиля ICAP.
	replacemsg-group строка		Группа сообщений замены.
	request строка	Варианты: выкл вкл	Включить/выключить передачу HTTP-запроса на сервер ICAP.
	request-failure строка	Варианты: ошибка пропустить	Действие, которое следует предпринять, если сервер ICAP недоступен при обработке HTTP-запроса.
	request-path строка		Компонент пути ICAP-URI, идентифицирующий службу обработки HTTP-запросов.
	request-server строка		Сервер ICAP, который необходимо использовать для HTTP-запроса.
	response строка	Варианты: выкл вкл	Включить/выключить передачу HTTP-ответа на сервер ICAP.
	response-failure строка	Варианты: ошибка пропустить	Действие, которое следует предпринять, если сервер ICAP недоступен при обработке HTTP-ответа.
	response-path строка		Компонент пути ICAP-URI, идентифицирующий службу обработки HTTP-ответа.
	response-server строка		Сервер ICAP, который необходимо использовать для HTTP-ответа.
	streaming-content-bypass строка	Варианты: выкл вкл	Включить/выключить обход сервера ICAP для потокового контента.
rc_failed список / элементы=строка			список кодов rc, при которых условия завершения работы будут переопределены
rc_succeeded список / элементы=строка			список кодов rc, при которых условия успеха будут переопределены
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка			adom для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть global и другими, включая root
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия завершения работы или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure ICAP profiles.
     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: <value in [present, absent]>
        icap_profile:
           methods:
             - delete
             - get
             - head
             - options
             - post
             - put
             - trace
             - other
           name: <value of string>
           replacemsg-group: <value of string>
           request: <value in [disable, enable]>
           request-failure: <value in [error, bypass]>
           request-path: <value of string>
           request-server: <value of string>
           response: <value in [disable, enable]>
           response-failure: <value in [error, bypass]>
           response-path: <value of string>
           response-server: <value of string>
           streaming-content-bypass: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_icap_profile_module.html