fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper – Настройка общего формирователя трафика.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить для использования из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логический тип |
| устанавливать только в True, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | |
| firewall_shaper_trafficshaper словарь | настройка верхнего уровня | ||
| bandwidth-unit строка |
| Единица измерения гарантированной и максимальной пропускной способности для этого формирователя (Kbps, Mbps или Gbps). | |
| diffserv строка |
| Включить/выключить изменение настройки DiffServ, применяемой к трафику, принятому этим формирователем. | |
| diffservcode строка | Настройка DiffServ, применяемая к трафику, принятому этим формирователем. | ||
| guaranteed-bandwidth целое число | Объем гарантированной пропускной способности для этого формирователя (0 - 16776000). Единицы зависят от настройки bandwidth-unit. | ||
| maximum-bandwidth целое число | Верхний предел пропускной способности, навязанный этим формирователем (0 - 16776000). 0 означает отсутствие ограничения. Единицы зависят от настройки bandwidth-unit. | ||
| name строка | Имя формирователя трафика. | ||
| per-policy строка |
| Включить/выключить применение отдельного формирователя для каждой политики. Например, если включено, гарантированная пропускная способность применяется отдельно... | |
| priority строка |
| Трафик с более высоким приоритетом с большей вероятностью будет пересылаться без задержек и без нарушения гарантированной пропускной способности. | |
| rc_failed список / элементы=строка | список rc-кодов, при которых будут игнорироваться условия для завершения неудачей | ||
| rc_succeeded список / элементы=строка | список rc-кодов, при которых будут игнорироваться условия для завершения успехом | ||
| state строка / обязательный |
| направление для создания, обновления или удаления объекта | |
| 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 shared traffic shaper.
fmgr_firewall_shaper_trafficshaper:
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_trafficshaper:
bandwidth-unit: <value in [kbps, mbps, gbps]>
diffserv: <value in [disable, enable]>
diffservcode: <value of string>
guaranteed-bandwidth: <value of integer>
maximum-bandwidth: <value of integer>
name: <value of string>
per-policy: <value in [disable, enable]>
priority: <value in [high, medium, low]>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_trafficshaper_module.html
