fortinet.fortios.fortios_firewall_shaper_traffic_shaper модуль – Настройка общего формирователя трафика в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.

Для использования в playbook укажите: 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.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_shaper_traffic_shaper dictionary	Настроить общий шейпер трафика.
bandwidth_unit string	Единица измерения для гарантированной и максимальной пропускной способности для этого шейпера (Kbps, Mbps или Gbps). Варианты: `"kbps"` `"mbps"` `"gbps"`
cos string	Маркер VLAN CoS.
cos_marking string	Включить/выключить маркировку VLAN CoS. Варианты: `"enable"` `"disable"`
cos_marking_method string	Выберите метод маркировки VLAN CoS. Варианты: `"multi-stage"` `"static"`
diffserv string	Включить/выключить изменение параметра DiffServ, применяемого к трафику, принимаемому этим шейпером. Варианты: `"enable"` `"disable"`
diffservcode string	Параметр DiffServ, который будет применяться к трафику, принимаемому этим шейпером.
dscp_marking_method string	Выберите метод маркировки DSCP. Варианты: `"multi-stage"` `"static"`
exceed_bandwidth integer	Превышение пропускной способности, используемое для многоступенчатой маркировки DSCP/VLAN CoS. Единицы зависят от параметра bandwidth-unit.
exceed_class_id integer	Идентификатор класса для трафика в guaranteed-bandwidth и maximum-bandwidth. Источник firewall.traffic-class.class-id.
exceed_cos string	Маркер VLAN CoS для трафика в [guaranteed-bandwidth, exceed-bandwidth].
exceed_dscp string	Маркер DSCP для трафика в guaranteed-bandwidth и exceed-bandwidth.
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 для трафика в exceed-bandwidth и maximum-bandwidth.
name string / required	Имя шейпера трафика.
overhead integer	Нагрузка на пакет, используемая в вычислениях скорости.

per_policy string	Включить/отключить применение отдельного формирователя для каждой политики. Например, если включено, гарантированная пропускная способность применяется отдельно для каждой политики. Варианты: `"disable"` `"enable"`
priority string	Трафик с более высоким приоритетом с большей вероятностью будет пересылаться без задержек и без нарушения гарантированной пропускной способности. Варианты: `"low"` `"medium"` `"high"`
member_path string	Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр, помеченный member_path, допустим для выполнения операций с членами.
member_state string	Добавить или удалить члена по указанному пути к атрибуту. Когда указан member_state, опция state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из ранее определённых. VDOM — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный компонент. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi устарел; httpapi — предпочтительный способ запуска playbooks
Модуль поддерживает 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 Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для внесения контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней применённой операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name string	Название таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_shaper_traffic_shaper_module.html