Skip to content

iSCSI Boot Policy

An iSCSI Boot Policy configures how a UCS server discovers and connects to iSCSI storage targets for software iSCSI boot. It controls the target discovery method, the initiator IP source, optional CHAP authentication, and references to the iSCSI Adapter Policy and static target policies.

Location in Intersight GUI: Policies » iSCSI Boot

Diagram
NameTypeConstraintMandatoryDefault Value
intersightClassintersightNo

NameTypeConstraintMandatoryDefault Value
organizationsListorganizationsNo

NameTypeConstraintMandatoryDefault Value
policiesClasspoliciesNo

policies (compute.intersight.organizations)

Section titled “policies (compute.intersight.organizations)”
NameTypeConstraintMandatoryDefault Value
iscsi_bootListiscsi_bootNo

iscsi_boot (compute.intersight.organizations.policies)

Section titled “iscsi_boot (compute.intersight.organizations.policies)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
descriptionStringNo
managedBooleantrue, falseNotrue
tagsListtagsNo
target_source_typeChoiceStatic, AutoNoAuto
initiator_ip_sourceChoicePool, Static, DHCPNoDHCP
initiator_static_ip_v4_addressIPNo
auto_targetvendor_nameBooleantrue, falseNo
ip_poolStringNo
iscsi_adapter_policyStringNo
primary_target_policyStringNo
secondary_target_policyStringNo
chapClasschapNo
mutual_chapClassmutual_chapNo
initiator_static_ip_v4_configClassinitiator_static_ip_v4_configNo

tags (compute.intersight.organizations.policies.iscsi_boot)

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

chap (compute.intersight.organizations.policies.iscsi_boot)

Section titled “chap (compute.intersight.organizations.policies.iscsi_boot)”
NameTypeConstraintMandatoryDefault Value
user_idStringNo
passwordStringNo

mutual_chap (compute.intersight.organizations.policies.iscsi_boot)

Section titled “mutual_chap (compute.intersight.organizations.policies.iscsi_boot)”
NameTypeConstraintMandatoryDefault Value
user_idStringNo
passwordStringNo

initiator_static_ip_v4_config (compute.intersight.organizations.policies.iscsi_boot)

Section titled “initiator_static_ip_v4_config (compute.intersight.organizations.policies.iscsi_boot)”
NameTypeConstraintMandatoryDefault Value
subnet_maskIPNo
default_gatewayIPNo
primary_dnsIPNo
secondary_dnsIPNo

The target_source_type field controls how iSCSI targets are discovered and has two valid values with distinct requirements:

ValueBehaviourRequired fields
StaticTargets are defined explicitly via iSCSI Static Target Policiesprimary_target_policy (mandatory), secondary_target_policy (optional)
AutoTargets are discovered automatically via DHCP vendor optionauto_targetvendor_name: true (mandatory)

Note: Static target source requires an iSCSI Static Target Policy referenced via primary_target_policy. auto_targetvendor_name must not be set when using Static — Intersight rejects it.

ValueBehaviour
PoolInitiator IP assigned from the referenced IP pool (ip_pool field required)
StaticInitiator IP set via initiator_static_ip_v4_address + initiator_static_ip_v4_config
DHCPInitiator IP obtained from DHCP — no pool or static config needed

When initiator_ip_source: Static, the initiator IP address is set with initiator_static_ip_v4_address (a top-level field), and the network parameters (gateway, netmask, DNS) are set in the initiator_static_ip_v4_config block. These are separate fields:

initiator_ip_source: Static
initiator_static_ip_v4_address: 10.0.1.10
initiator_static_ip_v4_config:
subnet_mask: 255.255.255.0
default_gateway: 10.0.1.1
primary_dns: 10.0.0.53

Example-1: iSCSI boot policy using Auto target discovery (DHCP vendor option) with a DHCP initiator IP, with environment tags.

compute:
intersight:
organizations:
- name: MyOrganization
policies:
iscsi_boot:
- name: iscsi-boot-auto
description: iSCSI boot with DHCP-based target discovery
target_source_type: Auto
auto_targetvendor_name: true
initiator_ip_source: DHCP
iscsi_adapter_policy: iscsi-adapter-standard
tags:
- key: env
value: prod

Example-2: iSCSI boot policy using Static target discovery with an IP pool for the initiator address and CHAP authentication.

compute:
intersight:
organizations:
- name: MyOrganization
policies:
iscsi_boot:
- name: iscsi-boot-static
description: iSCSI boot with static target
target_source_type: Static
initiator_ip_source: Pool
ip_pool: inband-ip-pool
iscsi_adapter_policy: iscsi-adapter-standard
primary_target_policy: iscsi-target-primary
secondary_target_policy: iscsi-target-secondary
chap:
user_id: iscsi-initiator
password: !env ISCSI_CHAP_PASSWORD

Example-3: iSCSI boot policy using a static initiator IP address with explicit network configuration.

compute:
intersight:
organizations:
- name: MyOrganization
policies:
iscsi_boot:
- name: iscsi-boot-static-ip
target_source_type: Static
initiator_ip_source: Static
initiator_static_ip_v4_address: 10.0.1.10
initiator_static_ip_v4_config:
subnet_mask: 255.255.255.0
default_gateway: 10.0.1.1
primary_dns: 10.0.0.53
iscsi_adapter_policy: iscsi-adapter-standard
primary_target_policy: iscsi-target-primary