Модуль fortinet.fortios.fortios_firewall_shaping_profile — настройка профилей формирования трафика в 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_shaping_profile.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции брандмауэра и категории shaping_profile. В примерах приведены все параметры и значения; перед использованием их необходимо скорректировать в соответствии с источниками данных. Проверено на FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_shaping_profile dictionary	Настройка профилей формирования трафика.
comment string	Комментарий.
default_class_id integer	Идентификатор класса по умолчанию для обработки неклассифицированных пакетов (включая весь локальный трафик). Источник: firewall.traffic-class.class-id.
npu_offloading string	Включить или отключить разгрузку на NPU. Варианты: `"disable"` `"enable"`
profile_name string / обязательный	Имя профиля формирования трафика.
shaping_entries list / elements=dictionary	Определение записей формирования трафика для этого профиля.
burst_in_msec integer	Количество байтов, которое можно передать пакетом со скоростью максимальной пропускной способности. Формула: burst = maximum-bandwidth*burst-in-msec.
cburst_in_msec integer	Количество байтов, которое можно передать пакетом с максимально возможной для интерфейса скоростью. Формула: cburst = maximum-bandwidth*cburst-in-msec.
class_id integer	Идентификатор класса. Источник: firewall.traffic-class.class-id.
guaranteed_bandwidth_percentage integer	Гарантированная пропускная способность в процентах.
id integer / обязательный	Номер идентификатора. См. <a href=’#notes’>примечания</a>.
limit integer	Жёсткое ограничение фактического размера очереди в пакетах.
max integer	Средний размер очереди в пакетах, при котором вероятность отбрасывания RED достигает максимума.
maximum_bandwidth_percentage integer	Максимальная пропускная способность в процентах.
min integer	Средний размер очереди в пакетах, при котором становится возможным отбрасывание RED.
priority string	Приоритет. Варианты: `"top"` `"critical"` `"high"` `"medium"` `"low"`
red_probability integer	Максимальная вероятность (в процентах) маркировки RED.
type string	Выберите тип профиля формирования трафика: policing / queuing. Варианты: `"policing"` `"queuing"`
member_path string	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path предназначен для выполнения операций с элементами.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из списка ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure shaping profiles.
  fortinet.fortios.fortios_firewall_shaping_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_shaping_profile:
          comment: "Comment."
          default_class_id: "0"
          npu_offloading: "disable"
          profile_name: "<your_own_value>"
          shaping_entries:
              -
                  burst_in_msec: "0"
                  cburst_in_msec: "0"
                  class_id: "0"
                  guaranteed_bandwidth_percentage: "0"
                  id: "12"
                  limit: "100"
                  max: "250"
                  maximum_bandwidth_percentage: "1"
                  min: "83"
                  priority: "top"
                  red_probability: "0"
          type: "policing"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем вызове 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–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_shaping_profile_module.html