Модуль fortinet.fortios.fortios_firewall_shaping_profile – Настройка профилей формирования трафика в FortiOS и FortiGate Fortinet.

Примечание

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

У вас, возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создаётся в GUI Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_shaping_profile dictionary	Настроить профили ограничения.
comment string	Комментарий.
default_class_id integer	ID класса по умолчанию для обработки неклассифицированных пакетов (включая весь локальный трафик). Источник firewall.traffic-class.class-id.
profile_name string / required	Имя профиля ограничения.
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	ID класса. Источник firewall.traffic-class.class-id.
guaranteed_bandwidth_percentage integer	Гарантированная пропускная способность в процентах.
id integer / required	Номер ID. см. <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"`
member_path string	Путь к атрибуту элемента для выполнения операции. Разделяется символом слеша, если атрибутов больше одного. Параметр, помеченный как member_path, является допустимым для выполнения операции с элементом.
member_state string	Добавить или удалить элемент под указанным путём к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`

state string / required	Указывает, следует ли создать или удалить объект. Choices: `"present"` `"absent"`
vdom string	Виртуальный домен, среди ранее определенных. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль. Default: `"root"`

Примечания

Примечание

Устаревшее fortiosapi было признано устаревшим, httpapi — предпочтительный способ запуска playbooks
Модуль поддерживает 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"
          profile_name: "<your_own_value>"
          shaping_entries:
              -
                  burst_in_msec: "0"
                  cburst_in_msec: "0"
                  class_id: "0"
                  guaranteed_bandwidth_percentage: "0"
                  id: "11"
                  limit: "1000"
                  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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_shaping_profile_module.html