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
Name Type Constraint Mandatory Default Value intersight Class intersight No
Name Type Constraint Mandatory Default Value organizations List organizations No
Name Type Constraint Mandatory Default Value policies Class policies No
Name Type Constraint Mandatory Default Value iscsi_boot List iscsi_boot No
Name Type Constraint Mandatory Default Value name String Regex: ^[a-zA-Z0-9_ . :-] {1, 64}$ Yes description String No managed Boolean true, falseNo truetags List tags No target_ source_ type Choice Static, AutoNo Autoinitiator_ ip_ source Choice Pool, Static, DHCPNo DHCPinitiator_ static_ ip_ v4_ address IP No auto_ targetvendor_ name Boolean true, falseNo ip_pool String No iscsi_ adapter_ policy String No primary_ target_ policy String No secondary_ target_ policy String No chap Class chap No mutual_chap Class mutual_chap No initiator_ static_ ip_ v4_ config Class initiator_ static_ ip_ v4_ config No
Name Type Constraint Mandatory Default Value key String Yes value String No type Choice KeyValue, PathTagNo
Name Type Constraint Mandatory Default Value user_id String No password String No
Name Type Constraint Mandatory Default Value user_id String No password String No
Name Type Constraint Mandatory Default Value subnet_mask IP No default_gateway IP No primary_dns IP No secondary_dns IP No
The target_source_type field controls how iSCSI targets are discovered and has two valid values with distinct requirements:
Value Behaviour Required fields StaticTargets are defined explicitly via iSCSI Static Target Policies primary_ target_ policy (mandatory), secondary_ target_ policy (optional)AutoTargets are discovered automatically via DHCP vendor option auto_ 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.
Value Behaviour 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
Example-1: iSCSI boot policy using Auto target discovery (DHCP vendor option) with a DHCP initiator IP, with environment tags.
description : iSCSI boot with DHCP-based target discovery
auto_targetvendor_name : true
initiator_ip_source : DHCP
iscsi_adapter_policy : iscsi-adapter-standard
Example-2: iSCSI boot policy using Static target discovery with an IP pool for the initiator address and CHAP authentication.
- name : iscsi-boot-static
description : iSCSI boot with static target
target_source_type : Static
initiator_ip_source : Pool
iscsi_adapter_policy : iscsi-adapter-standard
primary_target_policy : iscsi-target-primary
secondary_target_policy : iscsi-target-secondary
password : !env ISCSI_CHAP_PASSWORD
Example-3: iSCSI boot policy using a static initiator IP address with explicit network configuration.
- 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
iscsi_adapter_policy : iscsi-adapter-standard
primary_target_policy : iscsi-target-primary