Spec-Zone.ru › Ansible

модуль cisco.intersight.intersight_system_qos_policy_info — Сбор сведений о политиках System QoS в Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

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

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

Чтобы использовать её в playbook, укажите: cisco.intersight.intersight_system_qos_policy_info.

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

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

  • Получение подробных сведений о политиках System QoS и настроенных в них классах из Cisco Intersight.
  • Поиск политик по организации, имени политики или фильтрация по определённым критериям.
  • Возвращает структурированные данные, объединяющие метаданные политики с подробными настройками классов QoS.
  • Каждая политика содержит все шесть классов QoS (Bronze, Silver, Gold, Platinum, Best Effort, FC) с текущими настройками.
  • Поддерживается фильтрация по организации и имени политики.
  • Если фильтры не заданы, возвращаются все политики System QoS.
  • Возвращает структурированные данные со сведениями о политике и описаниями связанных с ней классов QoS.

Параметры

Параметр

Комментарии

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.

По умолчанию: "https://intersight.com/api/v1"

name

string

Точное имя политики System QoS, сведения о которой требуется получить.

Если указано, будут возвращены только соответствующая политика и её классы.

organization

string

Имя организации для фильтрации политик System QoS.

Для организации по умолчанию используйте значение ‘default’.

Если указано, будут возвращены только политики этой организации.

use_proxy

boolean

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

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Логическое значение, определяющее, следует ли проверять сертификат TLS для api_uri

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

# Basic Usage Examples

- name: Get all System QoS Policies
  cisco.intersight.intersight_system_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: all_qos_policies

- name: Get System QoS Policies from specific organization
  cisco.intersight.intersight_system_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
  register: devnet_qos_policies

- name: Get specific System QoS Policy by name
  cisco.intersight.intersight_system_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-system-qos
  register: specific_qos_policy

- name: Display QoS classes from retrieved policy
  ansible.builtin.debug:
    msg: "Policy {{ item.Name }} has {{ item.Classes | length }} QoS classes configured"
  loop: "{{ specific_qos_policy.intersight_system_qos_policies }}"

# Advanced filtering and conditional tasks

- name: Get all System QoS policies and show enabled classes
  cisco.intersight.intersight_system_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: qos_policies

- name: Show enabled QoS classes for each policy
  ansible.builtin.debug:
    msg: |
      Policy: {{ item.Name }}
      Enabled Classes: {{ item.Classes | selectattr('AdminState', 'equalto', 'Enabled') | map(attribute='Name') | list }}
  loop: "{{ qos_policies.intersight_system_qos_policies }}"

- name: Check if specific policy exists
  cisco.intersight.intersight_system_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: production-qos
  register: policy_check

- name: Fail if production policy doesn't exist
  ansible.builtin.fail:
    msg: "Production QoS policy not found!"
  when: policy_check.intersight_system_qos_policies | length == 0

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

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

Ключ

Описание

intersight_system_qos_policies

list / elements=dictionary

Список политик System QoS с их настройками

Возвращается: всегда

Пример: [{"Classes": [{"AdminState": "Disabled", "Cos": 1, "Mtu": 1500, "Name": "Bronze", "PacketDrop": true, "Weight": 7}, {"AdminState": "Disabled", "Cos": 2, "Mtu": 1500, "Name": "Silver", "PacketDrop": true, "Weight": 8}, {"AdminState": "Enabled", "Cos": 4, "Mtu": 1500, "Name": "Gold", "PacketDrop": true, "Weight": 9}, {"AdminState": "Enabled", "Cos": 5, "Mtu": 1500, "Name": "Platinum", "PacketDrop": true, "Weight": 10}, {"AdminState": "Enabled", "Cos": 255, "Mtu": 1500, "Name": "Best Effort", "PacketDrop": true, "Weight": 5}, {"AdminState": "Enabled", "Cos": 3, "Mtu": 2240, "Name": "FC", "PacketDrop": false, "Weight": 5}], "CreateTime": "2023-05-15T10:30:45.123Z", "Description": "System QoS policy for lab use", "ModTime": "2023-05-15T10:30:45.123Z", "Moid": "64620ac769726530014a1234", "Name": "lab-system-qos", "ObjectType": "fabric.SystemQosPolicy", "Organization": {"Moid": "675450ee69726530014753e2", "ObjectType": "organization.Organization"}, "Tags": [{"Key": "Site", "Value": "RCDN"}]}]

Авторы

  • Ron Gershburg (@rgershbu)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API