Skip to content

vHBA Template

A vHBA Template encapsulates a reusable set of Fibre Channel adapter, QoS, network, and pool references for vHBA creation. Templates standardize vHBA configuration across multiple SAN Connectivity Policies and enable centralized updates that automatically propagate to all derived vHBAs when override is disabled.

Location in Intersight GUI: Templates » vHBA

Diagram
NameTypeConstraintMandatoryDefault Value
intersightClassintersightNo

NameTypeConstraintMandatoryDefault Value
organizationsListorganizationsNo

NameTypeConstraintMandatoryDefault Value
templatesClasstemplatesNo

templates (compute.intersight.organizations)

Section titled “templates (compute.intersight.organizations)”
NameTypeConstraintMandatoryDefault Value
vhbaListvhbaNo

vhba (compute.intersight.organizations.templates)

Section titled “vhba (compute.intersight.organizations.templates)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
descriptionStringNo
managedBooleantrue, falseNotrue
tagsListtagsNo
fabricChoiceA, BNo
vhba_typeChoicefc-initiator, fc-nvme-initiator, fc-nvme-target, fc-targetNofc-initiator
persistent_lun_bindingsBooleantrue, falseNofalse
enable_overrideBooleantrue, falseNofalse
pin_group_nameStringNo
peer_vhba_nameStringNo
wwpn_poolStringNo
fibre_channel_adapter_policyStringNo
fibre_channel_network_policyStringNo
fibre_channel_qos_policyStringNo

tags (compute.intersight.organizations.templates.vhba)

Section titled “tags (compute.intersight.organizations.templates.vhba)”
NameTypeConstraintMandatoryDefault Value
keyStringYes
valueStringNo
typeChoiceKeyValue, PathTagNo

Example-1: FC initiator vHBA template on Fabric A with all common policy references, including tags.

compute:
intersight:
organizations:
- name: MyOrganization
templates:
vhba:
- name: vhba-a-template
description: Standard FI-A FC initiator vHBA template
fabric: A
vhba_type: fc-initiator
persistent_lun_bindings: false
enable_override: false
wwpn_pool: wwpn-pool-a
fibre_channel_adapter_policy: fc-adapter-standard
fibre_channel_qos_policy: fc-qos-standard
fibre_channel_network_policy: fc-network-vsan-a
tags:
- key: env
value: prod

Example-2: FC NVMe initiator vHBA template on Fabric B for NVMe-oF workloads.

compute:
intersight:
organizations:
- name: MyOrganization
templates:
vhba:
- name: vhba-b-nvme-template
description: FI-B NVMe initiator vHBA template
fabric: B
vhba_type: fc-nvme-initiator
wwpn_pool: wwpn-pool-b
fibre_channel_adapter_policy: fc-adapter-nvme
fibre_channel_qos_policy: fc-qos-standard
fibre_channel_network_policy: fc-network-vsan-b