fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy – Настройка политик формирования трафика.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливать в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
pkg строка / обязательно			параметр (pkg) в запрошенном URL
pkg_firewall_shapingpolicy словарь			установленные параметры верхнего уровня
	app-category строка		Идентификаторы одной или нескольких категорий приложений, к которым этот формирователь применяет формирование трафика для управления приложениями.
	application целое число		нет описания
	dstaddr строка		IPv4 адрес назначения и имена групп адресов.
	dstaddr6 строка		IPv6 адрес назначения и имена групп адресов.
	dstintf строка		Один или несколько исходящих (egress) интерфейсов.
	groups строка		Применить эту политику формирования трафика к группам пользователей, которые авторизовались на FortiGate.
	id целое число		Идентификатор политики формирования трафика.
	ip-version строка	Варианты: 4 6	Применить эту политику формирования трафика к трафику IPv4 или IPv6.
	per-ip-shaper строка		Формирователь трафика на основе каждого IP, который необходимо применить с этой политикой.
	schedule строка		Имя расписания.
	service строка		Имена служб и групп служб.
	srcaddr строка		IPv4 адрес источника и имена групп адресов.
	srcaddr6 строка		IPv6 адрес источника и имена групп адресов.
	status строка	Варианты: отключить включить	Включить/отключить эту политику формирования трафика.
	traffic-shaper строка		Формирователь трафика для применения к трафику, пересылаемому политикой файрвола.
	traffic-shaper-reverse строка		Формирователь трафика для применения к трафику ответа, полученному политикой файрвола.
	url-category строка		Идентификаторы одной или нескольких категорий FortiGuard Web Filtering, к которым этот формирователь применяет формирование трафика.
	users строка		Применить эту политику формирования трафика к отдельным пользователям, которые авторизовались на FortiGate.
rc_failed список / элементы=строка			список rc-кодов, при которых условия будут игнорироваться
rc_succeeded список / элементы=строка			список rc-кодов, при которых условия будут игнорироваться
state строка / обязательно		Варианты: present absent	указание на создание, обновление или удаление объекта
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: Configure shaping policies.
     fmgr_pkg_firewall_shapingpolicy:
        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>
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_firewall_shapingpolicy:
           app-category: <value of string>
           application: <value of integer>
           dstaddr: <value of string>
           dstaddr6: <value of string>
           dstintf: <value of string>
           groups: <value of string>
           id: <value of integer>
           ip-version: <value in [4, 6]>
           per-ip-shaper: <value of string>
           schedule: <value of string>
           service: <value of string>
           srcaddr: <value of string>
           srcaddr6: <value of string>
           status: <value in [disable, enable]>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           url-category: <value of string>
           users: <value of string>

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

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

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