fortinet.fortimanager.fmgr_firewall_shaper_peripshaper – Настройка формирования трафика по IP-адресам.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_shaper_peripshaper.
Добавлено в версии 2.10: для fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логический тип |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| firewall_shaper_peripshaper словарь | устанавливаются параметры верхнего уровня | ||
| bandwidth-unit строка |
| Единица измерения максимальной пропускной способности для этого формирования (Кбит/с, Мбит/с или Гбит/с). | |
| diffserv-forward строка |
| Включить/выключить изменение настройки DiffServ Forward (исходной), применяемой к трафику, принятому этим формирователем. | |
| diffserv-reverse строка |
| Включить/выключить изменение настройки DiffServ Reverse (ответной), применяемой к трафику, принятому этим формирователем. | |
| diffservcode-forward строка | Настройка DiffServ Forward (исходной), которая будет применена к трафику, принятому этим формирователем. | ||
| diffservcode-rev строка | Настройка DiffServ Reverse (ответной), которая будет применена к трафику, принятому этим формирователем. | ||
| max-bandwidth целое число | Максимальный предел пропускной способности, накладываемый этим формирователем (0-16776000). 0 означает отсутствие ограничения. Единицы зависят от настройки bandwidth-unit. | ||
| max-concurrent-session целое число | Максимальное количество одновременных сессий, разрешенных этим формирователем (0-2097000). 0 означает отсутствие ограничения. | ||
| name строка | Имя формирования трафика. | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия отказа будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успеха будут переопределены | ||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | |
| workspace_locking_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: Configure per-IP traffic shaper.
fmgr_firewall_shaper_peripshaper:
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_shaper_peripshaper:
bandwidth-unit: <value in [kbps, mbps, gbps]>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
max-bandwidth: <value of integer>
max-concurrent-session: <value of integer>
name: <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_firewall_shaper_peripshaper_module.html
