модуль fortinet.fortios.fortios_firewall_shaper_traffic_shaper — Настройка общего формирователя трафика в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_firewall_shaper_traffic_shaper.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию firewall_shaper и категорию traffic_shaper. Перед использованием необходимо скорректировать все параметры и значения в примерах в соответствии с источниками данных. Проверено на FOS v6.0.0
Требования
На узле, где выполняется этот модуль, должны быть соблюдены следующие требования.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_shaper_traffic_shaper dictionary | Настройка общего формирователя трафика. |
|
bandwidth_unit string |
Единица измерения гарантированной и максимальной пропускной способности этого формирователя (Kbps, Mbps или Gbps). Варианты:
|
|
cos string |
Метка VLAN CoS. |
|
cos_marking string |
Включить или отключить маркировку VLAN CoS. Варианты:
|
|
cos_marking_method string |
Выбор метода маркировки VLAN CoS. Варианты:
|
|
diffserv string |
Включить или отключить изменение настройки DiffServ, применяемой к трафику, обрабатываемому этим формирователем. Варианты:
|
|
diffservcode string |
Настройка DiffServ, применяемая к трафику, обрабатываемому этим формирователем. |
|
dscp_marking_method string |
Выбор метода маркировки DSCP. Варианты:
|
|
exceed_bandwidth integer |
Превышенная пропускная способность, используемая для многоэтапной маркировки DSCP/VLAN CoS. Единицы измерения зависят от настройки bandwidth-unit. |
|
exceed_class_id integer |
Идентификатор класса для трафика в пределах гарантированной и максимальной пропускной способности. Источник: firewall.traffic-class.class-id. |
|
exceed_cos string |
Метка VLAN CoS для трафика в диапазоне [guaranteed-bandwidth, exceed-bandwidth]. |
|
exceed_dscp string |
Метка DSCP для трафика в диапазоне гарантированной и превышенной пропускной способности. |
|
guaranteed_bandwidth integer |
Объём пропускной способности, гарантированный для этого формирователя (0–80000000). Единицы измерения зависят от настройки bandwidth-unit. |
|
maximum_bandwidth integer |
Верхний предел пропускной способности, установленный этим формирователем (0–80000000). Значение 0 означает отсутствие ограничения. Единицы измерения зависят от настройки bandwidth-unit. |
|
maximum_cos string |
Метка VLAN CoS для трафика в диапазоне [exceed-bandwidth, maximum-bandwidth]. |
|
maximum_dscp string |
Метка DSCP для трафика в диапазоне превышенной и максимальной пропускной способности. |
|
name string / обязательный |
Имя формирователя трафика. |
|
overhead integer |
Накладные расходы на размер каждого пакета, учитываемые при расчёте скорости. |
|
per_policy string |
Включить или отключить применение отдельного формирователя для каждой политики. Например, если параметр включён, гарантированная пропускная способность применяется отдельно для каждой политики. Варианты:
|
|
priority string |
Трафик с более высоким приоритетом с большей вероятностью будет передан без задержек и без ущерба для гарантированной пропускной способности. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанием member_path можно использовать для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure shared traffic shaper.
fortinet.fortios.fortios_firewall_shaper_traffic_shaper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaper_traffic_shaper:
bandwidth_unit: "kbps"
cos: "<your_own_value>"
cos_marking: "enable"
cos_marking_method: "multi-stage"
diffserv: "enable"
diffservcode: "<your_own_value>"
dscp_marking_method: "multi-stage"
exceed_bandwidth: "0"
exceed_class_id: "0"
exceed_cos: "<your_own_value>"
exceed_dscp: "<your_own_value>"
guaranteed_bandwidth: "0"
maximum_bandwidth: "0"
maximum_cos: "<your_own_value>"
maximum_dscp: "<your_own_value>"
name: "default_name_18"
overhead: "0"
per_policy: "disable"
priority: "low"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный в последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_firewall_shaper_traffic_shaper_module.html