Модуль fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy – Настройка политики очереди выхода QoS FortiSwitch.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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, с которыми будут переопределены условия для успешного завершения.
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 строка	ID очереди COS.
weight целое число	Вес в схеме расписания «взвешенный круговой порядок».
name строка / обязательно	Имя политики QoS

END_OF_DOCUMENT_MARKER

rate-by строка	Устарело, пожалуйста, переименуйте на rate_by. Скорость очереди COS в кбит/с или процентах. Варианты: `"kbps"` `"percent"`
schedule строка	Планирование очереди COS. Варианты: `"strict"` `"round-robin"` `"weighted"`
workspace_locking_adom строка	Область управления (ADOM), которая должна быть заблокирована для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно запуск одного модуля может завершиться неудачей, если возвращён ненулевой rc. Вы также можете переопределить условия завершения успехом или неудачей с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch QoS egress queue policy.
      fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_qos_queuepolicy:
          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]>
          name: <string>
          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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_qos_queuepolicy_module.html