Модуль fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy_cosqueue — настройка очереди COS.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy_cosqueue.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
queue-policy string | Устарел, используйте «queue_policy» |
queue_policy string | Параметр (queue-policy) в запрошенном URL. |
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
switchcontroller_qos_queuepolicy_cosqueue dictionary | Набор параметров верхнего уровня. |
|
description string |
Описание очереди COS. |
|
drop_policy псевдонимы: drop-policy string |
Политика отбрасывания очереди COS. Варианты:
|
|
ecn string |
Включить/отключить маркировку пакетов ECN для отбрасывания пакетов, соответствующих условиям. Варианты:
|
|
max_rate псевдонимы: max-rate integer |
Максимальная скорость |
|
max_rate_percent псевдонимы: max-rate-percent integer |
Максимальная скорость |
|
min_rate псевдонимы: min-rate integer |
Минимальная скорость |
|
min_rate_percent псевдонимы: min-rate-percent integer |
Минимальная скорость |
|
name string / обязательный |
Идентификатор очереди COS. |
|
weight integer |
Вес при планировании с циклическим обслуживанием с учётом весов. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: COS queue configuration.
fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy_cosqueue:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
queue_policy: <your own value>
state: present # <value in [present, absent]>
switchcontroller_qos_queuepolicy_cosqueue:
name: "your value" # Required variable, string
# description: <string>
# drop_policy: <value in [taildrop, weighted-random-early-detection]>
# max_rate: <integer>
# min_rate: <integer>
# weight: <integer>
# max_rate_percent: <integer>
# min_rate_percent: <integer>
# ecn: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный запрошенный URL. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: сложный тип |
Ссылки на коллекцию
© 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_cosqueue_module.html
