fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy module – Настройка политики очередей исходящего трафика QoS FortiSwitch.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation логическое значение	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Возможные значения: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/отключить ведение журнала для задачи. Возможные значения: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method строка	Переопределяемый метод для базового запроса Json RPC. Возможные значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note строка	Примечание к изменению, которое можно указать при создании или обновлении объекта.
state строка / обязательный	Указание на создание, обновление или удаление объекта. Возможные значения: `"present"` `"absent"`
switchcontroller_qos_queuepolicy словарь	Набор параметров верхнего уровня.
cos_queue псевдонимы: cos-queue список / элементы=словарь	Очередь COS.
description строка	Описание очереди COS.
drop_policy псевдонимы: drop-policy строка	Политика отбрасывания пакетов для очереди COS. Возможные значения: `"taildrop"` `"weighted-random-early-detection"`
ecn строка	Включить/отключить маркировку пакетов ECN для отбрасывания пакетов, подлежащих отбрасыванию. Возможные значения: `"disable"` `"enable"`
max_rate псевдонимы: max-rate целое число	Максимальная скорость передачи
max_rate_percent псевдонимы: max-rate-percent целое число	Максимальная скорость передачи
min_rate псевдонимы: min-rate целое число	Минимальная скорость передачи
min_rate_percent псевдонимы: min-rate-percent целое число	Минимальная скорость передачи
name строка	Идентификатор очереди COS.
weight целое число	Вес при планировании с помощью взвешенного циклического обслуживания (WRR).
name строка / обязательный	Имя политики QoS
rate_by псевдонимы: rate-by строка	Единица измерения скорости очереди COS: кбит/с или проценты. Возможные значения: `"kbps"` `"percent"`
schedule строка	Планирование очереди COS. Возможные значения: `"strict"` `"round-robin"` `"weighted"`
workspace_locking_adom строка	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure FortiSwitch QoS egress queue policy.
      fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_qos_queuepolicy:
          name: "your value" # Required variable, string
          # cos_queue:
          #   - description: <string>
          #     drop_policy: <value in [taildrop, weighted-random-early-detection]>
          #     max_rate: <integer>
          #     min_rate: <integer>
          #     name: <string>
          #     weight: <integer>
          #     max_rate_percent: <integer>
          #     min_rate_percent: <integer>
          #     ecn: <value in [disable, enable]>
          # schedule: <value in [strict, round-robin, weighted]>
          # rate_by: <value in [kbps, percent]>

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

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

Ключ	Описание
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_switchcontroller_qos_queuepolicy_module.html