fortinet.fortimanager.fmgr_firewall_proxyaddress – Настройка веб-прокси-адреса.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation булево			Варианты: нет ← да	устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_proxyaddress словарь				настройка параметров верхнего уровня
	case-sensitivity строка		Варианты: выключено включено	Включить для повышения чувствительности к регистру в шаблоне.
	category строка			Идентификатор категории FortiGuard.
	color целое число			Целое число для определения цвета значка в графическом интерфейсе (1 - 32, по умолчанию 0, что устанавливает значение в 1).
	comment строка			Дополнительные комментарии.
	header строка			Имя HTTP-заголовка как регулярное выражение.
	header-group список / элементы=строка			без описания
		case-sensitivity строка	Варианты: выключено включено	Чувствительность к регистру в шаблоне.
		header строка		Регулярное выражение HTTP-заголовка.
		header-name строка		HTTP-заголовок.
		id целое число		Идентификатор.
	header-name строка			Имя HTTP-заголовка.
	host строка			Объект адреса для хоста.
	host-regex строка			Имя хоста как регулярное выражение.
	method список / элементы=строка		Варианты: удаление получение получение_головка опции отправка обновление отслеживание подключение	без описания
	name строка			Имя адреса.
	path строка			Путь URL как регулярное выражение.
	query строка			Сопоставление части запроса URL как регулярного выражения.
	referrer строка		Варианты: выключено включено	Включение/выключение использования поля referrer в HTTP-заголовке для сопоставления адреса.
	tagging список / элементы=строка			без описания
		category строка		Категория тегов.
		name строка		Имя записи тегирования.
		tags строка		без описания
	type строка		Варианты: host-regex url category method ua header src-advanced dst-advanced	Тип адреса прокси.
	ua список / элементы=строка		Варианты: chrome ms firefox safari other	без описания
	uuid строка			Универсальный уникальный идентификатор (UUID; автоматически назначается, но может быть переустановлен вручную).
	visibility строка		Варианты: выключено включено	Включение/выключение видимости объекта в графическом интерфейсе.
rc_failed список / элементы=строка				список rc-кодов, с которыми будут переопределены условия для сбоя
rc_succeeded список / элементы=строка				список rc-кодов, с которыми будут переопределены условия для успеха
state строка / обязательно			Варианты: present absent	направление создания, обновления или удаления объекта
workspace_locking_adom строка				adom для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая 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: Web proxy address configuration.
     fmgr_firewall_proxyaddress:
        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]>
        firewall_proxyaddress:
           case-sensitivity: <value in [disable, enable]>
           category: <value of string>
           color: <value of integer>
           comment: <value of string>
           header: <value of string>
           header-group:
             -
                 case-sensitivity: <value in [disable, enable]>
                 header: <value of string>
                 header-name: <value of string>
                 id: <value of integer>
           header-name: <value of string>
           host: <value of string>
           host-regex: <value of string>
           method:
             - delete
             - get
             - head
             - options
             - post
             - put
             - trace
             - connect
           name: <value of string>
           path: <value of string>
           query: <value of string>
           referrer: <value in [disable, enable]>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           type: <value in [host-regex, url, category, ...]>
           ua:
             - chrome
             - ms
             - firefox
             - safari
             - other
           uuid: <value of string>
           visibility: <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_firewall_proxyaddress_module.html