модуль cisco.intersight.intersight_system_qos_policy — настройка политики QoS системы для Cisco Intersight
Примечание
Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.intersight.
Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_system_qos_policy.
Краткое описание
- Настройка политики QoS системы для Cisco Intersight.
- Дополнительные сведения см. в документации Cisco Intersight.
Параметры
Параметр | Комментарии |
|---|---|
api_key_id string / обязательный | Открытый идентификатор API-ключа, связанный с закрытым ключом. Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID. |
api_private_key path / обязательный | Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в API Intersight. Если используется строка, для шифрования строковых данных следует использовать Ansible Vault. Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY----- <your private key data> -----END EC PRIVATE KEY-----’ Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY. |
api_uri string | URI для доступа к API Intersight. Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI. По умолчанию: |
classes list / элементы=dictionary | Список классов QoS, настроенных в политике. Система включает предопределённые классы (Bronze, Silver, Gold, Platinum, Best Effort, FC). Классы Best Effort и FC всегда включены; на изменение их параметров распространяются ограничения. |
|
admin_state string |
Административное состояние класса QoS. Классы Best Effort и FC всегда включены. Классы Bronze, Silver, Gold и Platinum по умолчанию отключены, если не указано иное. Если значение не задано, автоматически применяются соответствующие значения по умолчанию для класса. Допустимые значения:
|
|
cos integer |
Класс обслуживания, назначаемый трафику с этой меткой QoS. Допустимый диапазон: 0–6. Значение по умолчанию для класса FC — 3. Значения по умолчанию: для Bronze — 1, Silver — 2, Gold — 4, Platinum — 5. Если значение не задано, автоматически применяются соответствующие значения по умолчанию для класса. |
|
mtu integer |
Максимальный размер блока передачи (MTU) — это наибольший размер пакета или кадра, который можно передать в сети с передачей пакетов или кадров, например в Интернете. Допустимый диапазон: 1500–9216. Значение Normal (по умолчанию) соответствует 1500, FC — 2240. Значение по умолчанию для класса FC — 2240, для остальных классов — 1500. Если значение не задано, автоматически применяются соответствующие значения по умолчанию для класса. |
|
name string / обязательный |
Имя класса QoS. Допустимые имена классов: Bronze, Silver, Gold, Platinum, Best Effort, FC. Допустимые значения:
|
|
packet_drop boolean |
Если параметр включён, этот класс QoS допускает потерю пакетов в пределах допустимого уровня. Для класса FC по умолчанию задано значение false (потеря пакетов отключена). Для всех остальных классов по умолчанию задано значение true (потеря пакетов включена). Если значение не задано, автоматически применяются соответствующие значения по умолчанию для класса. Допустимые значения:
|
|
weight integer |
Вес класса QoS определяет распределение пропускной способности между классами QoS. Допустимый диапазон: 0–10. Значения по умолчанию: для Bronze — 7, Silver — 8, Gold — 9, Platinum — 10, Best Effort и FC — 5. Если значение не задано, автоматически применяются соответствующие значения по умолчанию для класса. |
description псевдонимы: descr string | Описание политики QoS системы, заданное пользователем. Описание может содержать буквы (a–z, A–Z), цифры (0–9), дефис (-), точку (.), двоеточие (:) или подчёркивание (_). |
name string / обязательный | Имя, присвоенное политике QoS системы. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_. |
organization string | Имя организации, которой назначен этот ресурс. Профили и политики, созданные в пользовательской организации, применяются только к устройствам в той же организации. По умолчанию: |
state string | Если задано Если задано Допустимые значения:
|
tags list / элементы=dictionary | Список тегов в формате «Ключ: <ключ, заданный пользователем> Значение: <значение, заданное пользователем>». |
use_proxy boolean | Если задано Допустимые значения:
|
validate_certs boolean | Логический параметр, управляющий проверкой TLS-сертификата api_uri. Допустимые значения:
|
Примеры
- name: Configure System QoS Policy with default classes
cisco.intersight.intersight_system_qos_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: DevNet
name: lab-system-qos
description: System QoS policy for lab use
tags:
- Key: Site
Value: RCDN
classes:
- name: Bronze
admin_state: Enabled
weight: 7
- name: Silver
admin_state: Enabled
weight: 8
- name: Gold
admin_state: Enabled
weight: 9
- name: Platinum
admin_state: Enabled
weight: 10
- name: 'Best Effort'
weight: 5
- name: FC
weight: 5
- name: Configure System QoS Policy with custom settings
cisco.intersight.intersight_system_qos_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: DevNet
name: custom-system-qos
description: Custom System QoS policy
classes:
- name: Bronze
admin_state: Enabled
cos: 1
mtu: 1500
packet_drop: true
weight: 7
- name: Gold
admin_state: Enabled
cos: 4
mtu: 1500
packet_drop: true
weight: 9
- name: 'Best Effort'
mtu: 1500
weight: 6
- name: FC
weight: 8
- name: Delete System QoS Policy
cisco.intersight.intersight_system_qos_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: DevNet
name: lab-system-qos
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
api_response dictionary | Ответ API, возвращённый указанным ресурсом. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/cisco/intersight/intersight_system_qos_policy_module.html