Spec-Zone.ru › Ansible

Модуль cisco.intersight.intersight_vhba_template — управление шаблонами 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.

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

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

  • Создание, обновление и удаление шаблонов vHBA в Cisco Intersight.
  • Шаблоны vHBA определяют конфигурации интерфейсов Fibre Channel, которые могут использоваться политиками подключения SAN.
  • Шаблоны обеспечивают стандартизированный способ настройки vHBA с согласованными политиками Fibre Channel.
  • Шаблоны vHBA применимы только для развертываний с подключением к FI (Fabric Interconnect).
  • Дополнительные сведения см. в документации 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.

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

description

псевдонимы: descr

string

Описание шаблона vHBA, заданное пользователем.

Описание может содержать буквы (a–z, A–Z), цифры (0–9), дефис (-), точку (.), двоеточие (:) или символ подчёркивания (_).

enable_override

boolean

Если параметр включён, конфигурация производных экземпляров может переопределять конфигурацию шаблона.

Варианты:

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

fibre_channel_adapter_policy_name

string

Имя политики адаптера Fibre Channel.

Обязательно, если state имеет значение present.

fibre_channel_network_policy_name

string

Имя сетевой политики Fibre Channel.

Обязательно, если state имеет значение present.

fibre_channel_qos_policy_name

string

Имя политики QoS Fibre Channel.

Обязательно, если state имеет значение present.

fibre_channel_zone_policy_names

list / элементы=string

Список имён политик зон Fibre Channel.

Связь с политиками зон FC для настройки зон на коммутаторе.

name

string / обязательный

Имя, присвоенное шаблону vHBA.

Имя должно быть уникальным в пределах организации.

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

organization

string

Имя организации, которой назначен этот ресурс.

Политики, созданные в пользовательской организации, применимы только к устройствам той же организации.

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

По умолчанию: "default"

persistent_bindings

boolean

Включает сохранение связей с идентификаторами LUN в памяти до их ручной очистки.

Варианты:

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

pin_group_name

string

Имя группы Pingroup, связанной с vHBA для статической привязки.

При развертывании SCP будет найдено имя pingroup и получен соответствующий порт восходящего канала или агрегированный канал для привязки трафика vHBA.

state

string

Если задано значение present, будет проверено наличие ресурса и при необходимости он будет создан.

Если задано значение absent, будет проверено отсутствие ресурса и при необходимости он будет удалён.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

switch_id

string

Порт фабрики, с которым будет связан vHBA.

Варианты:

  • "A" ← (по умолчанию)
  • "B"

tags

list / элементы=dictionary

Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».

use_proxy

boolean

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

Варианты:

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

validate_certs

boolean

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

Варианты:

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

vhba_type

string

Настройка типа vHBA для шаблона.

Эта конфигурация поддерживается только адаптерами Cisco VIC серии 14XX и более поздних серий.

Обязательно, если state имеет значение present.

Варианты:

  • "fc-initiator"
  • "fc-nvme-initiator"
  • "fc-nvme-target"
  • "fc-target"

wwpn_pool_name

string

Пул WWPN, назначенный шаблону vHBA.

Обязательно, если state имеет значение present.

Примеры

- name: Create a basic vHBA Template with WWPN pool
  cisco.intersight.intersight_vhba_template:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "basic-vhba-template"
    description: "Basic vHBA template for production servers"
    enable_override: false
    vhba_type: "fc-initiator"
    switch_id: "A"
    persistent_bindings: false
    wwpn_pool_name: "default-wwpn-pool"
    fibre_channel_network_policy_name: "fc-network-policy"
    fibre_channel_qos_policy_name: "fc-qos-policy"
    fibre_channel_adapter_policy_name: "fc-adapter-policy"
    tags:
      - Key: "Environment"
        Value: "Production"
      - Key: "Site"
        Value: "DataCenter-A"
    state: present

- name: Create a vHBA Template with override enabled
  cisco.intersight.intersight_vhba_template:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "override-vhba-template"
    description: "vHBA template with override enabled"
    enable_override: true
    vhba_type: "fc-target"
    switch_id: "B"
    persistent_bindings: true
    wwpn_pool_name: "default-wwpn-pool"
    fibre_channel_network_policy_name: "fc-network-policy"
    fibre_channel_qos_policy_name: "fc-qos-policy"
    fibre_channel_adapter_policy_name: "fc-adapter-policy"
    state: present

- name: Create a vHBA Template with FC Zone policies
  cisco.intersight.intersight_vhba_template:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "vhba-with-zones"
    description: "vHBA template with FC zone policies"
    enable_override: false
    vhba_type: "fc-initiator"
    switch_id: "A"
    persistent_bindings: false
    wwpn_pool_name: "default-wwpn-pool"
    fibre_channel_network_policy_name: "fc-network-policy"
    fibre_channel_qos_policy_name: "fc-qos-policy"
    fibre_channel_adapter_policy_name: "fc-adapter-policy"
    fibre_channel_zone_policy_names:
      - "fc-zone-policy-1"
      - "fc-zone-policy-2"
    state: present

- name: Create a vHBA Template with pin group
  cisco.intersight.intersight_vhba_template:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "vhba-pinned-template"
    description: "vHBA template with static pinning"
    enable_override: false
    vhba_type: "fc-nvme-initiator"
    switch_id: "A"
    persistent_bindings: true
    wwpn_address_type: "pool"
    wwpn_pool_name: "nvme-wwpn-pool"
    fibre_channel_network_policy_name: "fc-network-policy"
    fibre_channel_qos_policy_name: "fc-qos-policy"
    fibre_channel_adapter_policy_name: "fc-adapter-policy"
    pin_group_name: "pingroup-a"
    state: present

- name: Delete a vHBA Template
  cisco.intersight.intersight_vhba_template:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "old-vhba-template"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Результат ответа API, возвращённый для указанного ресурса.

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

Пример: {"api_response": {"EnableOverride": false, "FcNetworkPolicy": {"Name": "fc-network-policy", "ObjectType": "vnic.FcNetworkPolicy"}, "Name": "test-vhba-template", "ObjectType": "vnic.VhbaTemplate", "PersistentBindings": false, "SwitchId": "A", "Tags": [{"Key": "Environment", "Value": "Production"}], "Type": "fc-initiator", "WwpnAddressType": "POOL", "WwpnPool": {"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_module.html

Spec-Zone.ru

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