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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_shapingprofile.

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

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL-адресе
bypass_validation логическое			Варианты: нет ← да	устанавливается в True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_shapingprofile словарь				параметры верхнего уровня
	comment строка			Комментарий.
	default-class-id целое число			Идентификатор класса по умолчанию для обработки неклассифицированных пакетов (включая весь локальный трафик).
	profile-name строка			Имя профиля формирования трафика.
	shaping-entries список / элементы=строка			нет описания
		class-id целое число		Идентификатор класса.
		guaranteed-bandwidth-percentage целое число		Гарантированная пропускная способность в процентах.
		id целое число		Идентификатор.
		maximum-bandwidth-percentage целое число		Максимальная пропускная способность в процентах.
		priority строка	Варианты: низкий средний высокий	Приоритет.
rc_failed список / элементы=строка				список кодов rc, при которых условия будут отклонены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут выполнены
state строка / обязательно			Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_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 profiles.
     fmgr_firewall_shapingprofile:
        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_shapingprofile:
           comment: <value of string>
           default-class-id: <value of integer>
           profile-name: <value of string>
           shaping-entries:
             -
                 class-id: <value of integer>
                 guaranteed-bandwidth-percentage: <value of integer>
                 id: <value of integer>
                 maximum-bandwidth-percentage: <value of integer>
                 priority: <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_firewall_shapingprofile_module.html