модуль cisco.intersight.intersight_vhba_template_info — сбор информации о шаблонах vHBA в Cisco Intersight

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.intersight.

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

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

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

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

Параметры

Параметр	Описание
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	Точное имя шаблона vHBA, сведения о котором необходимо получить. Если параметр задан, будет возвращен только соответствующий шаблон.
organization string	Имя организации для фильтрации шаблонов vHBA. Для организации по умолчанию используйте ‘default’. Если параметр задан, будут возвращены только шаблоны из этой организации.
use_proxy boolean	Если `no`, прокси-сервер использоваться не будет, даже если он задан в переменной среды на целевых узлах. Допустимые значения: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр управления проверкой сертификата TLS для api_uri Допустимые значения: `false` `true` ← (по умолчанию)

Примеры

# Basic Usage Examples
- name: Fetch all vHBA Templates from all organizations
  cisco.intersight.intersight_vhba_template_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: all_vhba_templates

- name: Display all template names
  debug:
    msg: "Template: {{ item.Name }}"
  loop: "{{ all_vhba_templates.api_response }}"
  when: all_vhba_templates.api_response is iterable

# Organization-specific Examples
- name: Fetch all vHBA Templates from the default organization
  cisco.intersight.intersight_vhba_template_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
  register: default_org_templates

- name: Fetch all vHBA Templates from a custom organization
  cisco.intersight.intersight_vhba_template_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Engineering"
  register: engineering_templates

# Name-specific Example
- name: Fetch a specific vHBA Template
  cisco.intersight.intersight_vhba_template_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "production-vhba-template"
  register: specific_template

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

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

Ключ	Описание
api_response dictionary	Ответ API, содержащий информацию о шаблоне vHBA. При запросе одного шаблона или если шаблоны не найдены возвращается словарь. Если найдено несколько шаблонов, возвращается список. Возвращается: всегда Пример: {"Description": "Production vHBA template for FI-attached servers", "EnableOverride": false, "FcAdapterPolicy": {"Moid": "fcadapter12345678901234567890", "Name": "fc-adapter-policy", "ObjectType": "vnic.FcAdapterPolicy"}, "FcNetworkPolicy": {"Moid": "fcnetwork12345678901234567890", "Name": "fc-network-policy", "ObjectType": "vnic.FcNetworkPolicy"}, "FcQosPolicy": {"Moid": "fcqos12345678901234567890", "Name": "fc-qos-policy", "ObjectType": "vnic.FcQosPolicy"}, "FcZonePolicies": [{"Moid": "fczone12345678901234567890", "Name": "fc-zone-policy-1", "ObjectType": "fabric.FcZonePolicy"}], "Moid": "12345678901234567890abcd", "Name": "production-vhba-template", "ObjectType": "vnic.VhbaTemplate", "Organization": {"Moid": "org12345678901234567890", "Name": "default", "ObjectType": "organization.Organization"}, "PersistentBindings": false, "SwitchId": "A", "Tags": [{"Key": "Environment", "Value": "Production"}, {"Key": "Site", "Value": "DataCenter-A"}], "Type": "fc-initiator", "WwpnAddressType": "POOL", "WwpnPool": {"Moid": "wwpnpool12345678901234567890", "Name": "default-wwpn-pool", "ObjectType": "fcpool.Pool"}}

Ключ

Описание

api_response

dictionary

Ответ API, содержащий информацию о шаблоне vHBA.

При запросе одного шаблона или если шаблоны не найдены возвращается словарь.

Если найдено несколько шаблонов, возвращается список.

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

Пример: {"Description": "Production vHBA template for FI-attached servers", "EnableOverride": false, "FcAdapterPolicy": {"Moid": "fcadapter12345678901234567890", "Name": "fc-adapter-policy", "ObjectType": "vnic.FcAdapterPolicy"}, "FcNetworkPolicy": {"Moid": "fcnetwork12345678901234567890", "Name": "fc-network-policy", "ObjectType": "vnic.FcNetworkPolicy"}, "FcQosPolicy": {"Moid": "fcqos12345678901234567890", "Name": "fc-qos-policy", "ObjectType": "vnic.FcQosPolicy"}, "FcZonePolicies": [{"Moid": "fczone12345678901234567890", "Name": "fc-zone-policy-1", "ObjectType": "fabric.FcZonePolicy"}], "Moid": "12345678901234567890abcd", "Name": "production-vhba-template", "ObjectType": "vnic.VhbaTemplate", "Organization": {"Moid": "org12345678901234567890", "Name": "default", "ObjectType": "organization.Organization"}, "PersistentBindings": false, "SwitchId": "A", "Tags": [{"Key": "Environment", "Value": "Production"}, {"Key": "Site", "Value": "DataCenter-A"}], "Type": "fc-initiator", "WwpnAddressType": "POOL", "WwpnPool": {"Moid": "wwpnpool12345678901234567890", "Name": "default-wwpn-pool", "ObjectType": "fcpool.Pool"}}

Авторы

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_vhba_template_info_module.html