fortinet.fortimanager.fmgr_waf_profile_urlaccess – Список доступа к URL

Примечание

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

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

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

В версии 2.10: добавлено в fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательный				параметр (adom) в запрошенном URL
bypass_validation логический			Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
profile строка / обязательный				параметр (profile) в запрошенном URL
rc_failed список / элементы=строка				список кодов rc, при которых условия будут нарушены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут выполнены
state строка / обязательный			Варианты: present absent	направление для создания, обновления или удаления объекта
waf_profile_urlaccess словарь				настройки верхнего уровня
	access-pattern список / элементы=строка			без описания
		id целое число		ID шаблона доступа к URL.
		negate строка	Варианты: отключить включить	Включить/выключить отмену соответствия.
		pattern строка		Шаблон URL.
		regex строка	Варианты: отключить включить	Включить/выключить поиск по регулярному выражению.
		srcaddr строка		Адрес источника.
	action строка		Варианты: обойти разрешить заблокировать	Действие.
	address строка			Адрес хоста.
	id целое число			ID доступа к URL.
	log строка		Варианты: отключить включить	Включить/выключить ведение журнала.
	severity строка		Варианты: низкий средний высокий	Уровень серьезности.
workspace_locking_adom строка				ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корень
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: URL access list
     fmgr_waf_profile_urlaccess:
        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>
        profile: <your own value>
        state: <value in [present, absent]>
        waf_profile_urlaccess:
           access-pattern:
             -
                 id: <value of integer>
                 negate: <value in [disable, enable]>
                 pattern: <value of string>
                 regex: <value in [disable, enable]>
                 srcaddr: <value of string>
           action: <value in [bypass, permit, block]>
           address: <value of string>
           id: <value of integer>
           log: <value in [disable, enable]>
           severity: <value in [low, medium, high]>

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
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_waf_profile_urlaccess_module.html