Модуль fortinet.fortimanager.fmgr_firewall_shapingprofile — настройка профилей формирования трафика.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_shapingprofile.

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

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

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

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation логический	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_shapingprofile словарь	Набор параметров верхнего уровня.
classes список / элементы=словарь	Классы.
class_id псевдонимы: class-id целое число	Идентификатор класса.
guaranteed_bandwidth псевдонимы: guaranteed-bandwidth целое число	Гарантированная пропускная способность в процентах.
maximum_bandwidth псевдонимы: maximum-bandwidth целое число	Максимальная пропускная способность в процентах.
name строка	Имя класса.
priority строка	Приоритет. Варианты: `"top"` `"critical"` `"high"` `"medium"` `"low"`
comment строка	Комментарий.
default_class псевдонимы: default-class целое число	Идентификатор класса по умолчанию для обработки неклассифицированных пакетов.
default_class_id псевдонимы: default-class-id любой	(целое число или строка) Идентификатор класса по умолчанию для обработки неклассифицированных пакетов
npu_offloading псевдонимы: npu-offloading строка	Включить или отключить разгрузку обработки на NPU. Варианты: `"disable"` `"enable"`
profile_name псевдонимы: profile-name строка / обязательный	Имя профиля формирования трафика.
shaping_entries псевдонимы: shaping-entries список / элементы=словарь	Записи формирования трафика.
burst_in_msec псевдонимы: burst-in-msec целое число	Количество байтов, передаваемых с максимальной пропускной способностью за время всплеска.
cburst_in_msec псевдонимы: cburst-in-msec целое число	Количество байтов, которые можно передать с максимально возможной для интерфейса скоростью.
class_id псевдонимы: class-id любой	(целое число или строка) Идентификатор класса.
guaranteed_bandwidth_percentage псевдонимы: guaranteed-bandwidth-percentage целое число	Гарантированная пропускная способность в процентах.
id целое число	Идентификатор.
limit целое число	Жёсткое ограничение фактического размера очереди в пакетах.
max целое число	Средний размер очереди в пакетах, при котором вероятность отбрасывания RED достигает максимума.
maximum_bandwidth_percentage псевдонимы: maximum-bandwidth-percentage целое число	Максимальная пропускная способность в процентах.
min целое число	Средний размер очереди в пакетах, при котором появляется вероятность отбрасывания RED.
priority строка	Приоритет. Варианты: `"low"` `"medium"` `"high"` `"critical"` `"top"`
red_probability псевдонимы: red-probability целое число	Максимальная вероятность
type строка	Выберите тип профиля формирования трафика Варианты: `"policing"` `"queuing"`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия успешного завершения.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state строка / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов используют соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Чтобы игнорировать это предупреждение, установите deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой, если возвращён ненулевой код rc. Условия завершения с ошибкой или успешного завершения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure shaping profiles.
      fortinet.fortimanager.fmgr_firewall_shapingprofile:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shapingprofile:
          comment: "ansible-comment"
          profile_name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the shaping profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shapingprofile"
          params:
            adom: "ansible"
            shaping_profile: "your_value"

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии условий

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_firewall_shapingprofile_module.html