Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Описание

  • Получение сведений о политиках QoS Fibre Channel из Cisco Intersight.
  • Запрос политик по организации или имени политики.
  • Возвращает структурированные данные с метаданными политики и сведениями о конфигурации QoS Fibre Channel.
  • Если фильтры не заданы, возвращаются все политики QoS Fibre Channel.

Параметры

Параметр

Комментарии

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

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

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

organization

string

Имя организации, по которой нужно отфильтровать политики QoS Fibre Channel.

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

Если параметр указан, возвращаются только политики этой организации.

use_proxy

boolean

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

Варианты:

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

validate_certs

boolean

Логический параметр для проверки TLS-сертификата api_uri

Варианты:

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

Примеры

# Basic Usage Examples
- name: Fetch all Fibre Channel QoS Policies from all organizations
  cisco.intersight.intersight_fibre_channel_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: all_fc_qos_policies

# Organization-specific Examples
- name: Fetch all Fibre Channel QoS Policies from the default organization
  cisco.intersight.intersight_fibre_channel_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
  register: default_org_policies

- name: Fetch all Fibre Channel QoS Policies from a custom organization
  cisco.intersight.intersight_fibre_channel_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Engineering"
  register: engineering_policies

# Specific Policy Examples
- name: Fetch a specific Fibre Channel QoS Policy by name
  cisco.intersight.intersight_fibre_channel_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "fc-qos-policy-01"
  register: specific_policy

- name: Fetch a specific policy from a specific organization
  cisco.intersight.intersight_fibre_channel_qos_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Production"
    name: "fc-qos-policy-prod"
  register: specific_org_policy

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

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

Ключ

Описание

api_response

list / elements=string

Ответ API, содержащий сведения о политике QoS Fibre Channel.

Возвращает список.

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

Пример: [{"Burst": 20480, "Cos": 5, "Description": "Fibre Channel QoS policy for production servers", "MaxDataFieldSize": 2048, "Moid": "1234567890abcdef12345678", "Name": "fc-qos-policy-01", "ObjectType": "vnic.FcQosPolicy", "Organization": {"Moid": "abcdef1234567890abcdef12", "Name": "default", "ObjectType": "organization.Organization"}, "RateLimit": 10000, "Tags": [{"Key": "Environment", "Value": "Production"}, {"Key": "Owner", "Value": "Storage-Team"}]}]

Авторы

  • 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_fibre_channel_qos_policy_info_module.html

Spec-Zone.ru

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