From 4a2d8e63ea7cdc0901539f23459634c75d5c3c12 Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Tue, 7 Apr 2026 10:48:34 -0700
Subject: [PATCH 01/10] Add flexible device naming options to Unattend delivery
Introduces new parameters and UI controls to give users more choice over device naming when applying an Unattend.xml file.
Users can now specify a device name, use a static or template-based name with the `%serial%` variable, or continue using a list of prefixes.
The UI is updated with a new Device Naming expander to guide the user through the options and clearly indicate the requirements for each mode, ensuring that mutually exclusive options like Copy Unattend and Inject Unattend are not selected together.
Documentation is updated to reflect the new functionality.
---
FFUDevelopment/BuildFFUVM.ps1 | 224 +++++++++++++-
FFUDevelopment/BuildFFUVM_UI.ps1 | 54 ++++
FFUDevelopment/BuildFFUVM_UI.xaml | 46 ++-
.../FFUUI.Core/FFUUI.Core.Config.psm1 | 22 ++
.../FFUUI.Core/FFUUI.Core.Handlers.psm1 | 274 ++++++++++++++++++
.../FFUUI.Core/FFUUI.Core.Initialize.psm1 | 16 +
.../FFUUI.Core/FFUUI.Core.Shared.psm1 | 3 +
FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1 | 6 +
.../WinPEDeployFFUFiles/ApplyFFU.ps1 | 122 ++++++--
FFUDevelopment/config/Sample_default.json | Bin 6162 -> 6506 bytes
docs/build.md | 32 +-
docs/parameters_reference.md | 8 +-
docs/quickstart.md | 18 +-
13 files changed, 764 insertions(+), 61 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index 5055dbb..bb61540 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -72,6 +72,18 @@ When set to $true, will copy the provisioning package from the $FFUDevelopmentPa
.PARAMETER CopyUnattend
When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Default is $false.
+.PARAMETER DeviceNamingMode
+Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Supported values are Legacy, None, Template, and Prefixes.
+
+.PARAMETER DeviceNameTemplate
+Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when CopyUnattend is used.
+
+.PARAMETER DeviceNamePrefixes
+Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a line in prefixes.txt on the deployment media.
+
+.PARAMETER DeviceNamePrefixesPath
+Path to the source prefixes file used for legacy copy or when DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt.
+
.PARAMETER CreateDeploymentMedia
When set to $true, this will create WinPE deployment media for use when deploying to a physical device.
@@ -407,6 +419,11 @@ param(
[bool]$AllowVHDXCaching,
[bool]$CopyPPKG,
[bool]$CopyUnattend,
+ [ValidateSet('Legacy', 'None', 'Template', 'Prefixes')]
+ [string]$DeviceNamingMode = 'Legacy',
+ [string]$DeviceNameTemplate,
+ [string[]]$DeviceNamePrefixes,
+ [string]$DeviceNamePrefixesPath,
[bool]$CopyAutopilot,
[bool]$CompactOS = $true,
[bool]$CleanupDeployISO = $true,
@@ -505,6 +522,79 @@ if ($ConfigFile -and (Test-Path -Path $ConfigFile)) {
}
}
+function Get-UnattendSourcePath {
+ param(
+ [Parameter(Mandatory = $true)]
+ [string]$UnattendFolder,
+ [Parameter(Mandatory = $true)]
+ [string]$WindowsArch
+ )
+
+ $archSuffix = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
+ return Join-Path $UnattendFolder "unattend_$archSuffix.xml"
+}
+
+function Test-UnattendHasComputerNameElement {
+ param(
+ [Parameter(Mandatory = $true)]
+ [string]$Path
+ )
+
+ [xml]$unattendXml = Get-Content -Path $Path
+ foreach ($component in $unattendXml.unattend.settings.component) {
+ if ($component.ComputerName) {
+ return $true
+ }
+ }
+
+ return $false
+}
+
+function Save-StagedUnattendFile {
+ param(
+ [Parameter(Mandatory = $true)]
+ [string]$SourcePath,
+ [Parameter(Mandatory = $true)]
+ [string]$DestinationPath,
+ [Parameter(Mandatory = $true)]
+ [ValidateSet('Legacy', 'None', 'Template', 'Prefixes')]
+ [string]$DeviceNamingMode,
+ [string]$DeviceNameTemplate
+ )
+
+ if ($DeviceNamingMode -in @('Legacy', 'Prefixes')) {
+ Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
+ return
+ }
+
+ [xml]$unattendXml = Get-Content -Path $SourcePath
+ $computerNameComponent = $null
+ foreach ($component in $unattendXml.unattend.settings.component) {
+ if ($component.ComputerName) {
+ $computerNameComponent = $component
+ break
+ }
+ }
+
+ if ($null -eq $computerNameComponent) {
+ if ($DeviceNamingMode -eq 'None') {
+ Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
+ return
+ }
+
+ throw "ComputerName element not found in unattend source file: $SourcePath"
+ }
+
+ if ($DeviceNamingMode -eq 'None') {
+ $computerNameComponent.ComputerName = '*'
+ }
+ elseif ($DeviceNamingMode -eq 'Template') {
+ $computerNameComponent.ComputerName = $DeviceNameTemplate
+ }
+
+ $unattendXml.Save($DestinationPath)
+}
+
$vmSwitchWasExplicitlyBound = $PSBoundParameters.ContainsKey('VMSwitchName')
$enableVmNetworkingWasExplicitlyBound = $PSBoundParameters.ContainsKey('EnableVMNetworking')
if (-not $EnableVMNetworking -and $vmSwitchWasExplicitlyBound -and -not $enableVmNetworkingWasExplicitlyBound) {
@@ -512,6 +602,52 @@ if (-not $EnableVMNetworking -and $vmSwitchWasExplicitlyBound -and -not $enableV
WriteLog 'EnableVMNetworking not explicitly set. Enabling VM networking because -VMSwitchName was supplied on the command line.'
}
+$normalizedDeviceNameTemplate = if ($null -ne $DeviceNameTemplate) { $DeviceNameTemplate.Trim() } else { $null }
+$effectiveDeviceNamePrefixes = @($DeviceNamePrefixes | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
+$resolvedDeviceNamePrefixesPath = if ([string]::IsNullOrWhiteSpace($DeviceNamePrefixesPath)) {
+ Join-Path (Join-Path $FFUDevelopmentPath 'Unattend') 'prefixes.txt'
+}
+else {
+ $DeviceNamePrefixesPath
+}
+
+if (($DeviceNamingMode -eq 'Prefixes') -and ($effectiveDeviceNamePrefixes.Count -eq 0) -and (Test-Path -Path $resolvedDeviceNamePrefixesPath -PathType Leaf)) {
+ $effectiveDeviceNamePrefixes = @(Get-Content -Path $resolvedDeviceNamePrefixesPath | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
+ WriteLog "Loaded device name prefixes from $resolvedDeviceNamePrefixesPath"
+}
+
+if ($CopyUnattend -and $InjectUnattend) {
+ throw 'CopyUnattend and InjectUnattend cannot both be set to `$true. Select only one unattend delivery method.'
+}
+
+if ($DeviceNamingMode -eq 'Template') {
+ if ([string]::IsNullOrWhiteSpace($normalizedDeviceNameTemplate)) {
+ throw 'DeviceNamingMode Template requires DeviceNameTemplate.'
+ }
+
+ $templateWithoutSupportedVariables = $normalizedDeviceNameTemplate -replace '(?i)%serial%', ''
+ if ($templateWithoutSupportedVariables -match '%') {
+ throw 'Only the %serial% device name variable is supported.'
+ }
+
+ if (-not ($CopyUnattend -or $InjectUnattend)) {
+ throw 'DeviceNamingMode Template requires either CopyUnattend or InjectUnattend.'
+ }
+
+ if ($InjectUnattend -and (-not $CopyUnattend) -and $normalizedDeviceNameTemplate -match '(?i)%serial%') {
+ throw 'The %serial% device name variable is only supported when CopyUnattend is used.'
+ }
+}
+elseif ($DeviceNamingMode -eq 'Prefixes') {
+ if (-not $CopyUnattend) {
+ throw 'DeviceNamingMode Prefixes requires CopyUnattend. Prefix-based naming is not supported with InjectUnattend.'
+ }
+
+ if ($effectiveDeviceNamePrefixes.Count -eq 0) {
+ throw 'DeviceNamingMode Prefixes requires at least one DeviceNamePrefixes entry or a valid DeviceNamePrefixesPath.'
+ }
+}
+
# Validate that the selected Windows SKU is compatible with the chosen Windows release and ensure an ISO is provided for unsupported releases
$clientSKUs = @(
'Home',
@@ -4184,6 +4320,57 @@ Function New-DeploymentUSB {
Import-Module "$($using:PSScriptRoot)\FFU.Common" -Force
Set-CommonCoreLogPath -Path $using:LogFile
+ function Get-LocalUnattendSourcePath {
+ param(
+ [string]$UnattendFolder,
+ [string]$WindowsArch
+ )
+
+ $archSuffix = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
+ return Join-Path $UnattendFolder "unattend_$archSuffix.xml"
+ }
+
+ function Save-LocalStagedUnattendFile {
+ param(
+ [string]$SourcePath,
+ [string]$DestinationPath,
+ [string]$DeviceNamingMode,
+ [string]$DeviceNameTemplate
+ )
+
+ if ($DeviceNamingMode -in @('Legacy', 'Prefixes')) {
+ Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
+ return
+ }
+
+ [xml]$unattendXml = Get-Content -Path $SourcePath
+ $computerNameComponent = $null
+ foreach ($component in $unattendXml.unattend.settings.component) {
+ if ($component.ComputerName) {
+ $computerNameComponent = $component
+ break
+ }
+ }
+
+ if ($null -eq $computerNameComponent) {
+ if ($DeviceNamingMode -eq 'None') {
+ Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
+ return
+ }
+
+ throw "ComputerName element not found in unattend source file: $SourcePath"
+ }
+
+ if ($DeviceNamingMode -eq 'None') {
+ $computerNameComponent.ComputerName = '*'
+ }
+ elseif ($DeviceNamingMode -eq 'Template') {
+ $computerNameComponent.ComputerName = $DeviceNameTemplate
+ }
+
+ $unattendXml.Save($DestinationPath)
+ }
+
$DiskNumber = $USBDrive.DeviceID.Replace("\\.\PHYSICALDRIVE", "")
WriteLog "Thread $([System.Threading.Thread]::CurrentThread.ManagedThreadId) processing DiskNumber $DiskNumber ($($USBDrive.Model))"
@@ -4244,15 +4431,15 @@ Function New-DeploymentUSB {
$UnattendPathOnUSB = Join-Path $DeployPartitionDriveLetter "Unattend"
WriteLog "Copying unattend file to $UnattendPathOnUSB"
New-Item -Path $UnattendPathOnUSB -ItemType Directory -ErrorAction SilentlyContinue | Out-Null
- if ($using:WindowsArch -eq 'x64') {
- Copy-Item -Path (Join-Path $using:UnattendFolder 'unattend_x64.xml') -Destination (Join-Path $UnattendPathOnUSB 'Unattend.xml') -Force | Out-Null
+ $unattendSource = Get-LocalUnattendSourcePath -UnattendFolder $using:UnattendFolder -WindowsArch $using:WindowsArch
+ Save-LocalStagedUnattendFile -SourcePath $unattendSource -DestinationPath (Join-Path $UnattendPathOnUSB 'Unattend.xml') -DeviceNamingMode $using:DeviceNamingMode -DeviceNameTemplate $using:normalizedDeviceNameTemplate
+ if ($using:DeviceNamingMode -eq 'Prefixes') {
+ WriteLog "Writing prefixes.txt file to $UnattendPathOnUSB"
+ $using:effectiveDeviceNamePrefixes | Set-Content -Path (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Encoding UTF8
}
- elseif ($using:WindowsArch -eq 'arm64') {
- Copy-Item -Path (Join-Path $using:UnattendFolder 'unattend_arm64.xml') -Destination (Join-Path $UnattendPathOnUSB 'Unattend.xml') -Force | Out-Null
- }
- if (Test-Path (Join-Path $using:UnattendFolder 'prefixes.txt')) {
+ elseif (($using:DeviceNamingMode -eq 'Legacy') -and (Test-Path -Path $using:resolvedDeviceNamePrefixesPath -PathType Leaf)) {
WriteLog "Copying prefixes.txt file to $UnattendPathOnUSB"
- Copy-Item -Path (Join-Path $using:UnattendFolder 'prefixes.txt') -Destination (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Force | Out-Null
+ Copy-Item -Path $using:resolvedDeviceNamePrefixesPath -Destination (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Force | Out-Null
}
WriteLog 'Copy completed'
}
@@ -5518,9 +5705,26 @@ if ($CopyUnattend) {
WriteLog "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing a .XML file"
throw "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing a .XML file"
}
+
+ if ($DeviceNamingMode -eq 'Prefixes') {
+ $unattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
+ if (-not (Test-UnattendHasComputerNameElement -Path $unattendSourcePath)) {
+ throw "DeviceNamingMode Prefixes requires a ComputerName element in $unattendSourcePath"
+ }
+ }
+
WriteLog 'Unattend validation complete'
}
+if ($InjectUnattend -and $DeviceNamingMode -eq 'Template') {
+ $injectUnattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
+ if (Test-Path -Path $injectUnattendSourcePath -PathType Leaf) {
+ if (-not (Test-UnattendHasComputerNameElement -Path $injectUnattendSourcePath)) {
+ throw "DeviceNamingMode Template requires a ComputerName element in $injectUnattendSourcePath"
+ }
+ }
+}
+
#Override $InstallApps value if using ESD to build FFU. This is due to a strange issue where building the FFU
#from vhdx doesn't work (you get an older style OOBE screen and get stuck in an OOBE reboot loop when hitting next).
#This behavior doesn't happen with WIM files.
@@ -6418,9 +6622,7 @@ if ($InstallApps) {
#Create Apps ISO
# Inject Unattend.xml into Apps if requested and applicable
if ($InstallApps -and $InjectUnattend) {
- # Determine source unattend.xml based on architecture
- $archSuffix = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
- $unattendSource = Join-Path $UnattendFolder "unattend_$archSuffix.xml"
+ $unattendSource = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
# Ensure target folder exists under Apps
$targetFolder = Join-Path $AppsPath 'Unattend'
@@ -6431,7 +6633,7 @@ if ($InstallApps) {
# Copy if source exists; otherwise log and skip
if (Test-Path -Path $unattendSource -PathType Leaf) {
$destination = Join-Path $targetFolder 'Unattend.xml'
- Copy-Item -Path $unattendSource -Destination $destination -Force | Out-Null
+ Save-StagedUnattendFile -SourcePath $unattendSource -DestinationPath $destination -DeviceNamingMode $DeviceNamingMode -DeviceNameTemplate $normalizedDeviceNameTemplate
WriteLog "Injected unattend file into Apps: $unattendSource -> $destination"
}
else {
diff --git a/FFUDevelopment/BuildFFUVM_UI.ps1 b/FFUDevelopment/BuildFFUVM_UI.ps1
index 3bf3926..90b8e32 100644
--- a/FFUDevelopment/BuildFFUVM_UI.ps1
+++ b/FFUDevelopment/BuildFFUVM_UI.ps1
@@ -432,6 +432,60 @@ $script:uiState.Controls.btnRun.Add_Click({
return
}
+ if ($config.CopyUnattend -and $config.InjectUnattend) {
+ [System.Windows.MessageBox]::Show("Copy Unattend.xml and Inject Unattend.xml cannot both be selected. Choose only one unattend delivery method.", "Unattend Selection Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: choose only one unattend delivery method."
+ return
+ }
+
+ if ($config.DeviceNamingMode -eq 'Template') {
+ if ([string]::IsNullOrWhiteSpace([string]$config.DeviceNameTemplate)) {
+ [System.Windows.MessageBox]::Show("Specify a device name before using 'Specify Device Name'.", "Device Name Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: device name required."
+ return
+ }
+
+ if (-not ($config.CopyUnattend -or $config.InjectUnattend)) {
+ [System.Windows.MessageBox]::Show("Select Copy Unattend.xml or Inject Unattend.xml before using 'Specify Device Name'.", "Unattend Selection Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: unattend delivery method required for device naming."
+ return
+ }
+
+ $templateWithoutSupportedVariables = ([string]$config.DeviceNameTemplate) -replace '(?i)%serial%', ''
+ if ($templateWithoutSupportedVariables -match '%') {
+ [System.Windows.MessageBox]::Show("Only the %serial% device name variable is supported.", "Unsupported Device Name Variable", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: unsupported device name variable."
+ return
+ }
+
+ if ($config.InjectUnattend -and (-not $config.CopyUnattend) -and ([string]$config.DeviceNameTemplate -match '(?i)%serial%')) {
+ [System.Windows.MessageBox]::Show("The %serial% device name variable is only supported when Copy Unattend.xml is selected.", "Unsupported Inject Unattend Setting", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: %serial% requires Copy Unattend.xml."
+ return
+ }
+ }
+ elseif ($config.DeviceNamingMode -eq 'Prefixes') {
+ if (-not $config.CopyUnattend) {
+ [System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Specify a list of Prefixes'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: prefixes require Copy Unattend.xml."
+ return
+ }
+
+ $hasSavedPrefixesPath = -not [string]::IsNullOrWhiteSpace([string]$config.DeviceNamePrefixesPath) -and (Test-Path -Path $config.DeviceNamePrefixesPath -PathType Leaf)
+ if ((($null -eq $config.DeviceNamePrefixes) -or ($config.DeviceNamePrefixes.Count -eq 0)) -and -not $hasSavedPrefixesPath) {
+ [System.Windows.MessageBox]::Show("Enter at least one prefix or choose a valid prefixes file before using 'Specify a list of Prefixes'.", "Prefixes Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: prefixes required."
+ return
+ }
+ }
+
$configFilePath = Join-Path $config.FFUDevelopmentPath "\config\FFUConfig.json"
# Sort top-level keys alphabetically for consistent output
$sortedConfig = [ordered]@{}
diff --git a/FFUDevelopment/BuildFFUVM_UI.xaml b/FFUDevelopment/BuildFFUVM_UI.xaml
index de8f077..4d5f511 100644
--- a/FFUDevelopment/BuildFFUVM_UI.xaml
+++ b/FFUDevelopment/BuildFFUVM_UI.xaml
@@ -836,9 +836,11 @@
-
+
-
+
+
+
@@ -903,8 +905,40 @@
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -969,8 +1003,8 @@
-
-
+
+
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
index f8791b0..1d92654 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
@@ -36,6 +36,10 @@ function Get-UIConfig {
UseDriversAsPEDrivers = $State.Controls.chkUseDriversAsPEDrivers.IsChecked
CopyPPKG = $State.Controls.chkCopyPPKG.IsChecked
CopyUnattend = $State.Controls.chkCopyUnattend.IsChecked
+ DeviceNamingMode = Get-SelectedDeviceNamingMode -State $State
+ DeviceNameTemplate = $State.Controls.txtDeviceNameTemplate.Text
+ DeviceNamePrefixesPath = $State.Controls.txtDeviceNamePrefixesPath.Text
+ DeviceNamePrefixes = @(Get-DeviceNamePrefixes -State $State)
CopyAdditionalFFUFiles = $State.Controls.chkCopyAdditionalFFUFiles.IsChecked
CreateDeploymentMedia = $State.Controls.chkCreateDeploymentMedia.IsChecked
InjectUnattend = $State.Controls.chkInjectUnattend.IsChecked
@@ -456,6 +460,24 @@ function Update-UIFromConfig {
Set-UIValue -ControlName 'chkCopyAutopilot' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyAutopilot' -State $State
Set-UIValue -ControlName 'chkCopyUnattend' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyUnattend' -State $State
Set-UIValue -ControlName 'chkCopyPPKG' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyPPKG' -State $State
+ Set-UIValue -ControlName 'txtDeviceNamePrefixesPath' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNamePrefixesPath' -State $State
+ Set-UIValue -ControlName 'txtDeviceNameTemplate' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNameTemplate' -State $State
+ Set-UIValue -ControlName 'txtDeviceNamePrefixes' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNamePrefixes' -TransformValue { param($val) if ($val -is [System.Array]) { $val -join [System.Environment]::NewLine } else { [string]$val } } -State $State
+
+ if ([string]::IsNullOrWhiteSpace($State.Controls.txtDeviceNamePrefixesPath.Text)) {
+ $State.Controls.txtDeviceNamePrefixesPath.Text = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text
+ }
+
+ $deviceNamingMode = 'None'
+ if ($ConfigContent.PSObject.Properties.Name -contains 'DeviceNamingMode') {
+ $deviceNamingMode = [string]$ConfigContent.DeviceNamingMode
+ }
+ if ($deviceNamingMode -notin @('None', 'Template', 'Prefixes')) {
+ $deviceNamingMode = 'None'
+ }
+ Set-DeviceNamingMode -State $State -Mode $deviceNamingMode
+ Import-DeviceNamePrefixesFromConfiguredPath -State $State
+ Update-DeviceNamingControls -State $State
# Post Build Cleanup group (Build Tab)
Set-UIValue -ControlName 'chkCleanupAppsISO' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CleanupAppsISO' -State $State
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
index 32a13fb..5fa99e3 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
@@ -27,6 +27,172 @@ function Update-VMNetworkingControls {
}
}
+function Get-SelectedDeviceNamingMode {
+ param([PSCustomObject]$State)
+
+ if ($true -eq $State.Controls.rbDeviceNamingTemplate.IsChecked) {
+ return 'Template'
+ }
+
+ if ($true -eq $State.Controls.rbDeviceNamingPrefixes.IsChecked) {
+ return 'Prefixes'
+ }
+
+ return 'None'
+}
+
+function Set-DeviceNamingMode {
+ param(
+ [PSCustomObject]$State,
+ [ValidateSet('None', 'Template', 'Prefixes')]
+ [string]$Mode
+ )
+
+ $State.Controls.rbDeviceNamingNone.IsChecked = $Mode -eq 'None'
+ $State.Controls.rbDeviceNamingTemplate.IsChecked = $Mode -eq 'Template'
+ $State.Controls.rbDeviceNamingPrefixes.IsChecked = $Mode -eq 'Prefixes'
+}
+
+function Get-DeviceNamePrefixes {
+ param([PSCustomObject]$State)
+
+ if ($null -eq $State.Controls.txtDeviceNamePrefixes) {
+ return @()
+ }
+
+ return @(
+ $State.Controls.txtDeviceNamePrefixes.Text -split "\r?\n" |
+ Where-Object { -not [string]::IsNullOrWhiteSpace($_) } |
+ ForEach-Object { $_.Trim() }
+ )
+}
+
+function Import-DeviceNamePrefixesFile {
+ param(
+ [PSCustomObject]$State,
+ [string]$FilePath
+ )
+
+ if ([string]::IsNullOrWhiteSpace($FilePath) -or -not (Test-Path -Path $FilePath -PathType Leaf)) {
+ return $false
+ }
+
+ $prefixLines = @(Get-Content -Path $FilePath | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
+ if ($null -ne $State.Controls.txtDeviceNamePrefixesPath) {
+ $State.Controls.txtDeviceNamePrefixesPath.Text = $FilePath
+ }
+ $State.Controls.txtDeviceNamePrefixes.Text = $prefixLines -join [System.Environment]::NewLine
+ WriteLog "Imported device name prefixes from $FilePath"
+ return $true
+}
+
+function Get-DefaultDeviceNamePrefixesPath {
+ param([string]$FFUDevelopmentPath)
+
+ if ([string]::IsNullOrWhiteSpace($FFUDevelopmentPath)) {
+ return $null
+ }
+
+ return Join-Path (Join-Path $FFUDevelopmentPath 'unattend') 'prefixes.txt'
+}
+
+function Import-DeviceNamePrefixesFromConfiguredPath {
+ param(
+ [PSCustomObject]$State,
+ [switch]$SkipIfTextPresent
+ )
+
+ if ($SkipIfTextPresent -and -not [string]::IsNullOrWhiteSpace($State.Controls.txtDeviceNamePrefixes.Text)) {
+ return
+ }
+
+ $prefixFilePath = $State.Controls.txtDeviceNamePrefixesPath.Text
+ if ([string]::IsNullOrWhiteSpace($prefixFilePath)) {
+ $prefixFilePath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text
+ if (-not [string]::IsNullOrWhiteSpace($prefixFilePath) -and $null -ne $State.Controls.txtDeviceNamePrefixesPath) {
+ $State.Controls.txtDeviceNamePrefixesPath.Text = $prefixFilePath
+ }
+ }
+
+ if (Test-Path -Path $prefixFilePath -PathType Leaf) {
+ Import-DeviceNamePrefixesFile -State $State -FilePath $prefixFilePath | Out-Null
+ }
+}
+
+function Test-DeviceNameTemplateUsesSerialToken {
+ param([PSCustomObject]$State)
+
+ return ((Get-SelectedDeviceNamingMode -State $State) -eq 'Template') -and ($State.Controls.txtDeviceNameTemplate.Text -match '(?i)%serial%')
+}
+
+function Update-UnattendSelectionControls {
+ param([PSCustomObject]$State)
+
+ $selectedDeviceNamingMode = Get-SelectedDeviceNamingMode -State $State
+ $isCopyUnattendSelected = $true -eq $State.Controls.chkCopyUnattend.IsChecked
+ $isInjectUnattendSelected = $true -eq $State.Controls.chkInjectUnattend.IsChecked
+ $deviceNameTemplateUsesSerialToken = Test-DeviceNameTemplateUsesSerialToken -State $State
+
+ if ($isCopyUnattendSelected -and $isInjectUnattendSelected) {
+ if (($selectedDeviceNamingMode -eq 'Prefixes') -or $deviceNameTemplateUsesSerialToken) {
+ $State.Controls.chkInjectUnattend.IsChecked = $false
+ $isInjectUnattendSelected = $false
+ }
+ else {
+ $State.Controls.chkCopyUnattend.IsChecked = $false
+ $isCopyUnattendSelected = $false
+ }
+ }
+
+ if (($selectedDeviceNamingMode -eq 'Prefixes') -or $deviceNameTemplateUsesSerialToken) {
+ if (-not $isCopyUnattendSelected) {
+ $State.Controls.chkCopyUnattend.IsChecked = $true
+ $isCopyUnattendSelected = $true
+ }
+
+ if ($isInjectUnattendSelected) {
+ $State.Controls.chkInjectUnattend.IsChecked = $false
+ $isInjectUnattendSelected = $false
+ }
+
+ $State.Controls.chkCopyUnattend.IsEnabled = $false
+ $State.Controls.chkInjectUnattend.IsEnabled = $false
+ return
+ }
+
+ if ($isCopyUnattendSelected) {
+ $State.Controls.chkCopyUnattend.IsEnabled = $true
+ $State.Controls.chkInjectUnattend.IsEnabled = $false
+ }
+ elseif ($isInjectUnattendSelected) {
+ $State.Controls.chkCopyUnattend.IsEnabled = $false
+ $State.Controls.chkInjectUnattend.IsEnabled = $true
+ }
+ else {
+ $State.Controls.chkCopyUnattend.IsEnabled = $true
+ $State.Controls.chkInjectUnattend.IsEnabled = $true
+ }
+}
+
+function Update-DeviceNamingControls {
+ param([PSCustomObject]$State)
+
+ if (($true -eq $State.Controls.chkInjectUnattend.IsChecked) -and ($true -eq $State.Controls.rbDeviceNamingPrefixes.IsChecked)) {
+ $State.Controls.rbDeviceNamingNone.IsChecked = $true
+ }
+
+ $selectedDeviceNamingMode = Get-SelectedDeviceNamingMode -State $State
+ $State.Controls.deviceNameTemplatePanel.Visibility = if ($selectedDeviceNamingMode -eq 'Template') { 'Visible' } else { 'Collapsed' }
+ $State.Controls.deviceNamePrefixesPanel.Visibility = if ($selectedDeviceNamingMode -eq 'Prefixes') { 'Visible' } else { 'Collapsed' }
+ $State.Controls.rbDeviceNamingPrefixes.IsEnabled = -not ($true -eq $State.Controls.chkInjectUnattend.IsChecked)
+
+ if ($selectedDeviceNamingMode -eq 'Prefixes') {
+ Import-DeviceNamePrefixesFromConfiguredPath -State $State -SkipIfTextPresent
+ }
+
+ Update-UnattendSelectionControls -State $State
+}
+
function Register-EventHandlers {
param([PSCustomObject]$State)
WriteLog "Registering UI event handlers..."
@@ -242,7 +408,15 @@ function Register-EventHandlers {
$localState = $window.Tag
$selectedPath = Invoke-BrowseAction -Type 'Folder' -Title "Select FFU Development Path"
if ($selectedPath) {
+ $currentPrefixesPath = $localState.Controls.txtDeviceNamePrefixesPath.Text
+ $previousDefaultPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
$localState.Controls.txtFFUDevPath.Text = $selectedPath
+ $newDefaultPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $selectedPath
+ if ([string]::IsNullOrWhiteSpace($currentPrefixesPath) -or $currentPrefixesPath -ieq $previousDefaultPrefixesPath) {
+ $localState.Controls.txtDeviceNamePrefixesPath.Text = $newDefaultPrefixesPath
+ }
+ Import-DeviceNamePrefixesFromConfiguredPath -State $localState
+ Update-DeviceNamingControls -State $localState
}
})
@@ -256,6 +430,106 @@ function Register-EventHandlers {
}
})
+ $State.Controls.rbDeviceNamingNone.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ Update-DeviceNamingControls -State $window.Tag
+ })
+ $State.Controls.rbDeviceNamingTemplate.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ Update-DeviceNamingControls -State $window.Tag
+ })
+ $State.Controls.txtDeviceNameTemplate.Add_TextChanged({
+ param($eventSource, $textChangedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ if ($null -ne $window -and $null -ne $window.Tag) {
+ Update-DeviceNamingControls -State $window.Tag
+ }
+ })
+ $State.Controls.rbDeviceNamingPrefixes.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ Update-DeviceNamingControls -State $window.Tag
+ })
+ $State.Controls.btnBrowseDeviceNamePrefixesPath.Add_Click({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $currentPrefixesPath = $localState.Controls.txtDeviceNamePrefixesPath.Text
+ if ([string]::IsNullOrWhiteSpace($currentPrefixesPath)) {
+ $currentPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
+ }
+ $initialDirectory = if ([string]::IsNullOrWhiteSpace($currentPrefixesPath)) {
+ $null
+ }
+ else {
+ Split-Path $currentPrefixesPath -Parent
+ }
+ $fileName = if ([string]::IsNullOrWhiteSpace($currentPrefixesPath)) { 'prefixes.txt' } else { Split-Path $currentPrefixesPath -Leaf }
+ $selectedPath = Invoke-BrowseAction -Type 'OpenFile' -Title 'Select prefixes file path' -Filter 'Text files (*.txt)|*.txt|All files (*.*)|*.*' -InitialDirectory $initialDirectory -FileName $fileName
+ if (Import-DeviceNamePrefixesFile -State $localState -FilePath $selectedPath) {
+ Update-DeviceNamingControls -State $localState
+ }
+ })
+ $State.Controls.btnSaveDeviceNamePrefixes.Add_Click({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $prefixLines = @(Get-DeviceNamePrefixes -State $localState)
+
+ if ($prefixLines.Count -eq 0) {
+ [System.Windows.MessageBox]::Show("Enter at least one prefix before saving the prefixes file.", "Prefixes Required", "OK", "Warning") | Out-Null
+ return
+ }
+
+ $currentPrefixesPath = $localState.Controls.txtDeviceNamePrefixesPath.Text
+ if ([string]::IsNullOrWhiteSpace($currentPrefixesPath)) {
+ $currentPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
+ if (-not [string]::IsNullOrWhiteSpace($currentPrefixesPath)) {
+ $localState.Controls.txtDeviceNamePrefixesPath.Text = $currentPrefixesPath
+ }
+ }
+
+ if ([string]::IsNullOrWhiteSpace($currentPrefixesPath)) {
+ [System.Windows.MessageBox]::Show("Select a valid Prefixes File Path before saving prefixes.", "Prefixes File Path Required", "OK", "Warning") | Out-Null
+ return
+ }
+
+ try {
+ $prefixLines | Set-Content -Path $currentPrefixesPath -Encoding UTF8
+ $localState.Controls.txtDeviceNamePrefixesPath.Text = $currentPrefixesPath
+ WriteLog "Saved device name prefixes to $currentPrefixesPath"
+ }
+ catch {
+ [System.Windows.MessageBox]::Show("Saving prefixes failed for '$currentPrefixesPath'. $($_.Exception.Message)", "Save Prefixes Failed", "OK", "Error") | Out-Null
+ }
+ })
+ $State.Controls.chkCopyUnattend.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $localState.Controls.chkInjectUnattend.IsChecked = $false
+ Update-DeviceNamingControls -State $localState
+ })
+ $State.Controls.chkCopyUnattend.Add_Unchecked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ Update-DeviceNamingControls -State $window.Tag
+ })
+ $State.Controls.chkInjectUnattend.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $localState.Controls.chkCopyUnattend.IsChecked = $false
+ Update-DeviceNamingControls -State $localState
+ })
+ $State.Controls.chkInjectUnattend.Add_Unchecked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ Update-DeviceNamingControls -State $window.Tag
+ })
+
# Build USB Drive Settings Event Handlers
# The USB Expander is always visible; the checkbox controls child settings only
$State.Controls.chkBuildUSBDriveEnable.Add_Checked({
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
index 0d921af..e84e1f5 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
@@ -220,6 +220,16 @@ function Initialize-UIControls {
$State.Controls.chkAllowVHDXCaching = $window.FindName('chkAllowVHDXCaching')
$State.Controls.chkCreateDeploymentMedia = $window.FindName('chkCreateDeploymentMedia')
$State.Controls.chkInjectUnattend = $window.FindName('chkInjectUnattend')
+ $State.Controls.rbDeviceNamingNone = $window.FindName('rbDeviceNamingNone')
+ $State.Controls.rbDeviceNamingTemplate = $window.FindName('rbDeviceNamingTemplate')
+ $State.Controls.rbDeviceNamingPrefixes = $window.FindName('rbDeviceNamingPrefixes')
+ $State.Controls.deviceNameTemplatePanel = $window.FindName('deviceNameTemplatePanel')
+ $State.Controls.deviceNamePrefixesPanel = $window.FindName('deviceNamePrefixesPanel')
+ $State.Controls.txtDeviceNameTemplate = $window.FindName('txtDeviceNameTemplate')
+ $State.Controls.txtDeviceNamePrefixesPath = $window.FindName('txtDeviceNamePrefixesPath')
+ $State.Controls.btnBrowseDeviceNamePrefixesPath = $window.FindName('btnBrowseDeviceNamePrefixesPath')
+ $State.Controls.txtDeviceNamePrefixes = $window.FindName('txtDeviceNamePrefixes')
+ $State.Controls.btnSaveDeviceNamePrefixes = $window.FindName('btnSaveDeviceNamePrefixes')
$State.Controls.chkVerbose = $window.FindName('chkVerbose')
$State.Controls.chkCopyAutopilot = $window.FindName('chkCopyAutopilot')
$State.Controls.chkCopyUnattend = $window.FindName('chkCopyUnattend')
@@ -383,6 +393,12 @@ function Initialize-UIDefaults {
$State.Controls.chkCopyAutopilot.IsChecked = $State.Defaults.generalDefaults.CopyAutopilot
$State.Controls.chkCopyUnattend.IsChecked = $State.Defaults.generalDefaults.CopyUnattend
$State.Controls.chkCopyPPKG.IsChecked = $State.Defaults.generalDefaults.CopyPPKG
+ Set-DeviceNamingMode -State $State -Mode $State.Defaults.generalDefaults.DeviceNamingMode
+ $State.Controls.txtDeviceNameTemplate.Text = $State.Defaults.generalDefaults.DeviceNameTemplate
+ $State.Controls.txtDeviceNamePrefixesPath.Text = $State.Defaults.generalDefaults.DeviceNamePrefixesPath
+ $State.Controls.txtDeviceNamePrefixes.Text = ($State.Defaults.generalDefaults.DeviceNamePrefixes -join [System.Environment]::NewLine)
+ Import-DeviceNamePrefixesFromConfiguredPath -State $State
+ Update-DeviceNamingControls -State $State
$State.Controls.chkCleanupAppsISO.IsChecked = $State.Defaults.generalDefaults.CleanupAppsISO
$State.Controls.chkCleanupDeployISO.IsChecked = $State.Defaults.generalDefaults.CleanupDeployISO
$State.Controls.chkCleanupDrivers.IsChecked = $State.Defaults.generalDefaults.CleanupDrivers
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Shared.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Shared.psm1
index 2ccabde..3aef928 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Shared.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Shared.psm1
@@ -1173,6 +1173,9 @@ function Invoke-BrowseAction {
if (-not [string]::IsNullOrWhiteSpace($InitialDirectory)) {
$dialog.InitialDirectory = $InitialDirectory
}
+ if (-not [string]::IsNullOrWhiteSpace($FileName)) {
+ $dialog.FileName = $FileName
+ }
if ($dialog.ShowDialog()) {
return $dialog.FileName
}
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
index 6525348..a841359 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
@@ -106,10 +106,12 @@ function Get-GeneralDefaults {
$peDriversPath = Join-Path -Path $FFUDevelopmentPath -ChildPath "PEDrivers"
$vmLocationPath = Join-Path -Path $FFUDevelopmentPath -ChildPath "VM"
$ffuCapturePath = Join-Path -Path $FFUDevelopmentPath -ChildPath "FFU"
+ $unattendPath = Join-Path -Path $FFUDevelopmentPath -ChildPath "unattend"
$officePath = Join-Path -Path $appsPath -ChildPath "Office"
$appListJsonPath = Join-Path -Path $appsPath -ChildPath "AppList.json"
$userAppListPath = Join-Path -Path $appsPath -ChildPath "UserAppList.json"
$driversJsonPath = Join-Path -Path $driversPath -ChildPath "Drivers.json"
+ $deviceNamePrefixesPath = Join-Path -Path $unattendPath -ChildPath "prefixes.txt"
return [PSCustomObject]@{
# Build Tab Defaults
@@ -132,6 +134,10 @@ function Get-GeneralDefaults {
CopyUnattend = $false
CopyPPKG = $false
InjectUnattend = $false
+ DeviceNamingMode = 'None'
+ DeviceNameTemplate = ''
+ DeviceNamePrefixesPath = $deviceNamePrefixesPath
+ DeviceNamePrefixes = @()
CleanupAppsISO = $true
CleanupDeployISO = $true
CleanupDrivers = $false
diff --git a/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1 b/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
index 77b5878..ba94899 100644
--- a/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
+++ b/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
@@ -64,6 +64,68 @@ function Set-Computername($computername) {
return $computername
}
+function Get-UnattendComputerNameValue {
+ if ($null -eq $UnattendFile) {
+ return $null
+ }
+
+ [xml]$xml = Get-Content $UnattendFile
+ foreach ($component in $xml.unattend.settings.component) {
+ if ($component.ComputerName) {
+ return [string]$component.ComputerName
+ }
+ }
+
+ return $null
+}
+
+function Test-LegacyPromptComputerName($computername) {
+ if ([string]::IsNullOrWhiteSpace($computername)) {
+ return $false
+ }
+
+ $normalizedName = $computername.Trim().ToLowerInvariant()
+ return $normalizedName -in @('mycomputer', 'default')
+}
+
+function Get-NormalizedComputerName($computername) {
+ if ([string]::IsNullOrWhiteSpace($computername)) {
+ throw 'Computer name cannot be empty.'
+ }
+
+ $normalizedName = ($computername -replace "\s", '').Trim()
+ if ([string]::IsNullOrWhiteSpace($normalizedName)) {
+ throw 'Computer name cannot be empty after removing spaces.'
+ }
+
+ if ($normalizedName.Length -gt 15) {
+ $normalizedName = $normalizedName.Substring(0, 15)
+ }
+
+ return $normalizedName
+}
+
+function Resolve-ComputerNameTemplate($computerNameTemplate, $serialNumber) {
+ if ([string]::IsNullOrWhiteSpace($computerNameTemplate)) {
+ throw 'Computer name template cannot be empty.'
+ }
+
+ $resolvedName = $computerNameTemplate -replace '(?i)%serial%', $serialNumber
+ if ($resolvedName -match '%') {
+ throw 'Unsupported device name variable found. Only %serial% is supported.'
+ }
+
+ return Get-NormalizedComputerName($resolvedName)
+}
+
+function Set-ConfiguredComputerName($computername) {
+ $normalizedName = Get-NormalizedComputerName($computername)
+ $normalizedName = Set-Computername($normalizedName)
+ Writelog "Computer name will be set to $normalizedName"
+ Write-Host "Computer name will be set to $normalizedName"
+ return $normalizedName
+}
+
function Invoke-Process {
[CmdletBinding(SupportsShouldProcess)]
param
@@ -1023,8 +1085,19 @@ If (Test-Path -Path $UnattendComputerNamePath) {
}
}
-#Ask for device name if unattend exists
-If ($Unattend -or $UnattendPrefix -or $UnattendComputerName) {
+$UnattendConfiguredComputerName = $null
+$RequiresLegacyDeviceNamePrompt = $false
+$RequiresTemplateDeviceName = $false
+if ($Unattend) {
+ $UnattendConfiguredComputerName = Get-UnattendComputerNameValue
+ $RequiresLegacyDeviceNamePrompt = Test-LegacyPromptComputerName($UnattendConfiguredComputerName)
+ if (-not [string]::IsNullOrWhiteSpace($UnattendConfiguredComputerName) -and $UnattendConfiguredComputerName -match '(?i)%serial%') {
+ $RequiresTemplateDeviceName = $true
+ }
+}
+
+#Ask for device name if naming is explicitly required
+If ($UnattendPrefix -or $UnattendComputerName -or $RequiresTemplateDeviceName -or $RequiresLegacyDeviceNamePrompt) {
Write-SectionHeader 'Device Name Selection'
if ($Unattend -and $UnattendPrefix) {
Writelog 'Unattend file found with prefixes.txt. Getting prefixes.'
@@ -1060,17 +1133,8 @@ If ($Unattend -or $UnattendPrefix -or $UnattendComputerName) {
WriteLog "Will use $PrefixToUse as device name prefix"
Write-Host "Will use $PrefixToUse as device name prefix"
}
- #Get serial number to append. This can make names longer than 15 characters. Trim any leading or trailing whitespace
$serial = (Get-CimInstance -ClassName win32_bios).SerialNumber.Trim()
- #Combine prefix with serial
- $computername = ($PrefixToUse + $serial) -replace "\s", "" # Remove spaces because windows does not support spaces in the computer names
- #If computername is longer than 15 characters, reduce to 15. Sysprep/unattend doesn't like ComputerName being longer than 15 characters even though Windows accepts it
- If ($computername.Length -gt 15) {
- $computername = $computername.substring(0, 15)
- }
- $computername = Set-Computername($computername)
- Writelog "Computer name will be set to $computername"
- Write-Host "Computer name will be set to $computername"
+ $computername = Set-ConfiguredComputerName($PrefixToUse + $serial)
}
elseif ($Unattend -and $UnattendComputerName) {
Writelog 'Unattend file found with SerialComputerNames.csv. Getting name for current computer.'
@@ -1080,32 +1144,31 @@ If ($Unattend -or $UnattendPrefix -or $UnattendComputerName) {
$SCName = $SerialComputerNames | Where-Object { $_.SerialNumber -eq $SerialNumber }
If ($SCName) {
- [string]$computername = $SCName.ComputerName
- $computername = Set-Computername($computername)
- Writelog "Computer name will be set to $computername"
- Write-Host "Computer name will be set to $computername"
+ [string]$computername = Set-ConfiguredComputerName($SCName.ComputerName)
}
else {
Writelog 'No matching serial number found in SerialComputerNames.csv. Setting random computer name to complete setup.'
Write-Host 'No matching serial number found in SerialComputerNames.csv. Setting random computer name to complete setup.'
- [string]$computername = ("FFU-" + ( -join ((48..57) + (65..90) + (97..122) | Get-Random -Count 11 | ForEach-Object { [char]$_ })))
- $computername = Set-Computername($computername)
- Writelog "Computer name will be set to $computername"
- Write-Host "Computer name will be set to $computername"
+ [string]$computername = Set-ConfiguredComputerName(("FFU-" + ( -join ((48..57) + (65..90) + (97..122) | Get-Random -Count 11 | ForEach-Object { [char]$_ }))))
}
}
- elseif ($Unattend) {
+ elseif ($Unattend -and $RequiresTemplateDeviceName) {
+ Writelog 'Unattend file found with a %serial% computer name template. Resolving the template.'
+ $serialNumber = (Get-CimInstance -ClassName Win32_Bios).SerialNumber.Trim()
+ [string]$computername = Set-ConfiguredComputerName((Resolve-ComputerNameTemplate -computerNameTemplate $UnattendConfiguredComputerName -serialNumber $serialNumber))
+ }
+ elseif ($Unattend -and $RequiresLegacyDeviceNamePrompt) {
Writelog 'Unattend file found with no prefixes.txt, asking for name'
Write-Host 'Unattend file found but no prefixes.txt. Please enter a device name.'
- [string]$computername = Read-Host 'Enter device name'
- $computername = Set-Computername($computername)
- Writelog "Computer name will be set to $computername"
- Write-Host "Computer name will be set to $computername"
+ [string]$computername = Set-ConfiguredComputerName((Read-Host 'Enter device name'))
}
else {
WriteLog 'Device naming assets detected without unattend.xml. Skipping device naming prompts.'
}
}
+elseif ($Unattend) {
+ WriteLog 'Unattend file found. Device naming is not required, but unattend settings will still be applied.'
+}
else {
WriteLog 'No unattend folder found. Device name will be set via PPKG, AP JSON, or default OS name.'
}
@@ -1568,8 +1631,9 @@ If ($PPKGFileToInstall) {
}
}
#Set DeviceName
-If ($computername) {
- Write-SectionHeader -Title 'Applying Computer Name and Unattend Configuration'
+If ($Unattend) {
+ $unattendSectionTitle = if ($computername) { 'Applying Computer Name and Unattend Configuration' } else { 'Applying Unattend Configuration' }
+ Write-SectionHeader -Title $unattendSectionTitle
try {
$PantherDir = 'w:\windows\panther'
If (Test-Path -Path $PantherDir) {
@@ -1590,8 +1654,8 @@ If ($computername) {
}
}
catch {
- WriteLog "Copying Unattend.xml to name device failed"
- Stop-Script -Message "Copying Unattend.xml to name device failed with error: $_"
+ WriteLog 'Copying Unattend.xml to Panther failed'
+ Stop-Script -Message "Copying Unattend.xml to Panther failed with error: $_"
}
}
diff --git a/FFUDevelopment/config/Sample_default.json b/FFUDevelopment/config/Sample_default.json
index 689ef22c1cee97af442d0eee7acbba66f5e39a4d..af3cdb33d447449dc337a675b20442b2136b4d21 100644
GIT binary patch
delta 217
zcmbPa@XBbzG8TOohE#?!hD?TJAnnJH$dC(U=P{%+_%h@(qyWW~7_1l+fTSOgpU03o
zc_FJPCtSzm|164=d&Gp4F-=Kj2w*4z>Q4ijR{^ApC$6{DE(IEq$WQ`=sX$f=LktiW
mpekd~1Ikt~lz=SKhFb)68it`z=S4HbPG)2h-n@b(OBetJY%mxA
delta 12
TcmaE5G|6DYGM3H%SaXB{Cm{uH
diff --git a/docs/build.md b/docs/build.md
index b80c65f..b19fc83 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -199,24 +199,34 @@ This option is only available when **Build USB Drive** is checked.
When enabled, the build process copies:
- **unattend_x64.xml** (for x64 builds) or **unattend_arm64.xml** (for arm64 builds) → renamed to **Unattend.xml** on the USB drive
-- **prefixes.txt** (if present) → copied alongside the unattend file
+- **prefixes.txt** → created from the **Device Naming** prefixes list when that mode is selected
-During deployment, `ApplyFFU.ps1` detects the `Unattend` folder and uses these files to customize the device name and apply other Windows settings during OOBE.
+During deployment, `ApplyFFU.ps1` applies `Unattend.xml` whenever it is present. Device naming only happens when the **Device Naming** setting requires it, or when older media still uses the legacy prompt-based workflow.
#### Device Naming
-Device naming can be done from PE. The way this works is by leveraging an unattend.xml file to either take input from the user at imaging time or read a list of prefix values and append the serial number of the device. There are some major benefits to doing this:
+Use the **Device Naming** expander to decide whether `ComputerName` should be set at deployment time. There are some major benefits to doing this:
1. Total deployment time is reduced if naming is set at FFU deployment time since there is no additional reboot done during OOBE.
2. Reduces the need for multiple provisioning packages or autopilot profiles. This means you can use a single PPKG or autopilot profile.
-#### Prompt for Device Name
+#### No Device Name
-If you want to be prompted for the device name, simply check **Copy Unattend.xml.** This tells the build script to copy the appropriate architecture unattend_arch.xml file from the `C:\FFUDevelopment\Unattend` folder to the `.\unattend` folder on the deploy partition of the USB drive.
+This is the default option. The unattend file is still applied, but Windows generates a random computer name instead of forcing a prompt or a fixed name.
-#### Device Naming with prefixes.txt
+#### Specify Device Name
-If a `prefixes.txt` file exists in the `Unattend` folder and there are multiple prefixes in the file, the deployment script prompts the technician to select a prefix from the file. The prefix is combined with the device's serial number to create the computer name. If there is a single prefix, the technician is not prompted and the script will automatically select that prefix.
+Use this option when you want a static device name or a template such as `Comp-%serial%`.
+
+- With **Copy Unattend.xml**, `%serial%` is resolved during deployment in PE.
+- With **Inject Unattend.xml**, only static names are supported.
+- **Copy Unattend.xml** and **Inject Unattend.xml** are mutually exclusive. Select only one.
+
+#### Specify a list of Prefixes
+
+This option writes `prefixes.txt` from the list in the UI. Enter one prefix per line or import an existing prefixes file. The source file can use any name because the UI now tracks the path separately.
+
+If there is a single prefix, deployment uses it automatically. If there are multiple prefixes, the technician is prompted to select one. The selected prefix is combined with the device serial number to create the computer name.
For example, with a prefix of `CORP-` and a serial number of `ABC123`, the resulting computer name would be `CORP-ABC123` (truncated to 15 characters if necessary).
@@ -228,6 +238,10 @@ STORE-
KIOSK-
```
+#### Legacy Prompt Behavior
+
+Older deployment media that still has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
+
{: .warning-title}
> Warning
@@ -483,6 +497,8 @@ Controls the `-InjectUnattend` parameter. When checked, copies the architecture-
This option is only available when **Install Apps** is checked.
+`Copy Unattend.xml` and `Inject Unattend.xml` are mutually exclusive. Select only one.
+
### How It Works
When enabled, the build process:
@@ -522,7 +538,7 @@ This option is primarily intended for scenarios where:
| Limitation | Description |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **No prefixes.txt support** | Unlike the**Copy Unattend** option for USB drives, this method does not support `prefixes.txt` for dynamic device naming based on serial numbers |
+| **No prefixes.txt or %serial% support** | Unlike **Copy Unattend.xml**, this method does not support `prefixes.txt` or the `%serial%` variable for deployment-time device naming |
| **Fixed configuration** | The unattend settings are baked into the FFU at build time and cannot be changed at deployment time |
| **Requires VM to be built** | This option only works when**Install Apps** is `$true` because the unattend file is included in the Apps ISO |
diff --git a/docs/parameters_reference.md b/docs/parameters_reference.md
index 6daff1e..67912f0 100644
--- a/docs/parameters_reference.md
+++ b/docs/parameters_reference.md
@@ -38,9 +38,13 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -CopyDrivers | bool | Copy Drivers to USB drive | When set to $true, will copy the drivers from the $FFUDevelopmentPath\Drivers folder to the Drivers folder on the deploy partition of the USB drive. Default is $false. |
| -CopyPEDrivers | bool | Copy PE Drivers | When set to $true, enables adding WinPE drivers. By default copies drivers from $FFUDevelopmentPath\PEDrivers to the WinPE deployment media unless -UseDriversAsPEDrivers is also $true. |
| -CopyPPKG | bool | Copy Provisioning Package | When set to $true, will copy the provisioning package from the $FFUDevelopmentPath\PPKG folder to the Deployment partition of the USB drive. Default is $false. |
-| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Default is $false. |
+| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Cannot be used together with -InjectUnattend. Default is $false. |
| -CreateDeploymentMedia | bool | Create Deployment Media | When set to $true, this will create WinPE deployment media for use when deploying to a physical device. |
| -CustomFFUNameTemplate | string | Custom FFU Name Template | Sets a custom FFU output name with placeholders. Allowed placeholders are: {WindowsRelease}, {WindowsVersion}, {SKU}, {BuildDate}, {yyyy}, {MM}, {dd}, {H}, {hh}, {mm}, {tt}. |
+| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Template, and Prefixes. The UI uses None, Template, and Prefixes. |
+| -DeviceNameTemplate | string | Specify Device Name | Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when -CopyUnattend is used. |
+| -DeviceNamePrefixesPath | string | Prefixes File Path | Path to the source prefixes file used for legacy copy or when -DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt. |
+| -DeviceNamePrefixes | string[] | Specify a list of Prefixes | Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a line in prefixes.txt on the deployment media. |
| -Disksize | uint64 | Disk Size (GB) | Size of the virtual hard disk for the virtual machine. Default is a 50GB dynamic disk. |
| -DriversFolder | string | Drivers Folder | Path to the drivers folder. Default is $FFUDevelopmentPath\Drivers. |
| -DriversJsonPath | string | Drivers.json Path | Path to a JSON file that specifies which drivers to download. |
@@ -50,7 +54,7 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -FFUDevelopmentPath | string | FFU Development Path | Path to the FFU development folder. Default is $PSScriptRoot. |
| -FFUPrefix | string | VM Name Prefix | Prefix for the generated FFU file. Default is _FFU. |
| -Headers | hashtable | CLI only (no UI control) | Headers to use when downloading files. Not recommended to modify. |
-| -InjectUnattend | bool | Inject Unattend.xml | When set to $true and InstallApps is also $true, copies unattend_[arch].xml from $FFUDevelopmentPath\unattend to $FFUDevelopmentPath\Apps\Unattend\Unattend.xml so sysprep can use it inside the VM. Default is $false. |
+| -InjectUnattend | bool | Inject Unattend.xml | When set to $true and InstallApps is also $true, copies unattend_[arch].xml from $FFUDevelopmentPath\unattend to $FFUDevelopmentPath\Apps\Unattend\Unattend.xml so sysprep can use it inside the VM. Cannot be used together with -CopyUnattend. Default is $false. |
| -InstallApps | bool | Install Applications | When set to $true, the script will create an Apps.iso file from the $FFUDevelopmentPath\Apps folder. It will also create a VM, mount the Apps.iso, install the apps, sysprep, and capture the VM. When set to $false, the FFU is created from a VHDX file, and no VM is created. |
| -InstallDrivers | bool | Install Drivers to FFU | Install device drivers from the specified $FFUDevelopmentPath\Drivers folder if set to $true. Download the drivers and put them in the Drivers folder. The script will recurse the drivers folder and add the drivers to the FFU. |
| -InstallOffice | bool | Install Office | Install Microsoft Office if set to $true. The script will download the latest ODT and Office files in the $FFUDevelopmentPath\Apps\Office folder and install Office in the FFU via VM. |
diff --git a/docs/quickstart.md b/docs/quickstart.md
index add63bb..c1f5e29 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -186,18 +186,26 @@ Another safety measure is **Select Specific USB Drives**. When you check **Selec
**Device Naming**
-Device naming can be done from PE. The way this works is by leveraging an unattend.xml file to either take input from the user at imaging time or read a list of prefix values and append the serial number of the device. There are some major benefits to doing this:
+Use the **Device Naming** expander on the Build page to decide whether `ComputerName` should be set during deployment. There are some major benefits to doing this:
1. Total deployment time is reduced if naming is set at FFU deployment time since there is no additional reboot done during OOBE.
2. Reduces the need for multiple provisioning packages or autopilot profiles. This means you can use a single PPKG or autopilot profile.
-**Prompt for Device Name**
+**No Device Name**
-If you want to be prompted for the device name, simply check **Copy Unattend.xml.** This tells the build script to copy the appropriate architecture unattend_arch.xml file from the `C:\FFUDevelopment\Unattend` folder to the `.\unattend` folder on the deploy partition of the USB drive.
+This is the default option. The unattend file is still applied, but Windows generates a random computer name.
-**Specifying Multiple Name Prefixes**
+**Specify Device Name**
-If you have multiple device name prefixes for different locations or device use cases, or even a single prefix, you can specify a prefixes.txt file in the `C:\FFUDevelopment\unattend` folder. If the prefixes.txt file is detected and a single prefix is listed, the device will just use that prefix and append the serial number of the device. If there are multiple prefixes listed in the prefixes.txt file, you will be prompted to select which prefix you want to name the device and the serial number will be appended to that prefix. If you want a dash in the name, include the dash in the prefix (e.g. if ABCD- is in the prefixes.txt file, the device name will be ABCD-SerialNumber).
+Use this option when you want a static device name or a template such as `Comp-%serial%`.
+
+- With **Copy Unattend.xml**, `%serial%` is resolved during deployment in PE.
+- With **Inject Unattend.xml**, only static names are supported.
+- **Copy Unattend.xml** and **Inject Unattend.xml** are mutually exclusive. Select only one.
+
+**Specify a list of Prefixes**
+
+This option writes `prefixes.txt` from the list in the UI. Enter one prefix per line or import an existing prefixes file. The source file can use any name because the UI tracks the prefixes path separately. If there is one prefix, deployment uses it automatically. If there are multiple prefixes, the technician is prompted to select one and the serial number is appended to that prefix.
{: .warning-title}
From 1ea1ef6fd0594caeee47c4ef825a9465b119992c Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Wed, 8 Apr 2026 17:58:25 -0700
Subject: [PATCH 02/10] Improves FFU deployment menu selections and device
naming
Refactors the `ApplyFFU.ps1` script to use a new `Read-MenuSelection` function for standardized user prompts, improving input validation and allowing users to skip optional prompts (like prefix selection, AP JSON, and PPKG files). Updates sample unattend XML files to use `*` for the computer name, falling back to default Windows naming if not specified. Updates the documentation to reflect the new UI and script behaviors.
---
FFUDevelopment/BuildFFUVM_UI.xaml | 2 +-
.../WinPEDeployFFUFiles/ApplyFFU.ps1 | 212 ++---
.../unattend/SampleUnattend_x64.xml | 2 +-
FFUDevelopment/unattend/unattend_arm64.xml | 2 +-
FFUDevelopment/unattend/unattend_x64.xml | 2 +-
docs/build.md | 772 ++++++++++--------
docs/quickstart.md | 6 +
7 files changed, 535 insertions(+), 463 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM_UI.xaml b/FFUDevelopment/BuildFFUVM_UI.xaml
index 4d5f511..7ed2603 100644
--- a/FFUDevelopment/BuildFFUVM_UI.xaml
+++ b/FFUDevelopment/BuildFFUVM_UI.xaml
@@ -913,7 +913,7 @@
-
+
diff --git a/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1 b/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
index ba94899..9fd106a 100644
--- a/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
+++ b/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
@@ -41,6 +41,59 @@ function WriteLog($LogText) {
Add-Content -path $LogFile -value "$((Get-Date).ToString()) $LogText"
}
+function Read-MenuSelection {
+ param(
+ [Parameter(Mandatory = $true)]
+ [string]$Prompt,
+
+ [Parameter(Mandatory = $true)]
+ [string]$InvalidInputMessage,
+
+ [Parameter()]
+ [int[]]$ValidSelections,
+
+ [Parameter()]
+ [int]$Minimum = [int]::MinValue,
+
+ [Parameter()]
+ [int]$Maximum = [int]::MaxValue,
+
+ [Parameter()]
+ [switch]$AllowSkip
+ )
+
+ do {
+ $userInput = Read-Host $Prompt
+ if ([string]::IsNullOrWhiteSpace($userInput)) {
+ Write-Host $InvalidInputMessage
+ continue
+ }
+
+ $selection = 0
+ if (-not [int]::TryParse($userInput, [ref]$selection)) {
+ Write-Host $InvalidInputMessage
+ continue
+ }
+
+ if ($AllowSkip -and $selection -eq 0) {
+ return 0
+ }
+
+ if ($PSBoundParameters.ContainsKey('ValidSelections')) {
+ if ($ValidSelections -notcontains $selection) {
+ Write-Host $InvalidInputMessage
+ continue
+ }
+ }
+ elseif ($selection -lt $Minimum -or $selection -gt $Maximum) {
+ Write-Host $InvalidInputMessage
+ continue
+ }
+
+ return $selection
+ } until ($false)
+}
+
function Set-DiskpartAnswerFiles($DiskpartFile, $DiskID) {
(Get-Content $DiskpartFile).Replace('disk 0', "disk $DiskID") | Set-Content -Path $DiskpartFile
}
@@ -953,21 +1006,7 @@ else {
}
$displayList | Format-Table -AutoSize -Property Disk, 'Size (GB)', Sector, 'Bus Type', Model
- do {
- try {
- $var = $true
- [int]$diskSelection = Read-Host 'Enter the disk number to apply the FFU to'
- }
- catch {
- Write-Host 'Input was not in correct format. Please enter a valid disk number'
- $var = $false
- }
- # Validate selected disk is in the list of available disks
- if ($var -and $validDiskIndexes -notcontains $diskSelection) {
- Write-Host "Invalid disk number. Please select from the available disks."
- $var = $false
- }
- } until ($var)
+ $diskSelection = Read-MenuSelection -Prompt 'Enter the disk number to apply the FFU to' -InvalidInputMessage 'Invalid disk number. Please select from the available disks.' -ValidSelections $validDiskIndexes
$selectedDisk = $diskDriveCandidates | Where-Object { $_.Index -eq $diskSelection }
WriteLog "Disk selection: DiskNumber=$($selectedDisk.Index), Model=$($selectedDisk.Model), SizeGB=$([math]::Round(($selectedDisk.Size / 1GB), 2)), BusType=$($selectedDisk.InterfaceType)"
@@ -1011,18 +1050,8 @@ If ($FFUCount -gt 1) {
$array += New-Object PSObject -Property $Properties
}
$array | Format-Table -AutoSize -Property Number, FFUFile | Out-Host
- do {
- try {
- $var = $true
- [int]$FFUSelected = Read-Host 'Enter the FFU number to install'
- $FFUSelected = $FFUSelected - 1
- }
-
- catch {
- Write-Host 'Input was not in correct format. Please enter a valid FFU number'
- $var = $false
- }
- } until (($FFUSelected -le $FFUCount - 1) -and $var)
+ $FFUSelected = Read-MenuSelection -Prompt 'Enter the FFU number to install' -InvalidInputMessage 'Input was not in correct format. Please enter a valid FFU number.' -Minimum 1 -Maximum $FFUCount
+ $FFUSelected = $FFUSelected - 1
$FFUFileToInstall = $array[$FFUSelected].FFUFile
WriteLog "$FFUFileToInstall was selected"
@@ -1103,6 +1132,8 @@ If ($UnattendPrefix -or $UnattendComputerName -or $RequiresTemplateDeviceName -o
Writelog 'Unattend file found with prefixes.txt. Getting prefixes.'
$UnattendPrefixes = @(Get-content $UnattendPrefixFile)
$UnattendPrefixCount = $UnattendPrefixes.Count
+ $skipPrefixSelection = $false
+ $PrefixToUse = $null
If ($UnattendPrefixCount -gt 1) {
WriteLog "Found $UnattendPrefixCount Prefixes"
$array = @()
@@ -1111,20 +1142,18 @@ If ($UnattendPrefix -or $UnattendComputerName -or $RequiresTemplateDeviceName -o
$array += New-Object PSObject -Property $Properties
}
$array | Format-Table -AutoSize -Property Number, DeviceNamePrefix
- do {
- try {
- $var = $true
- [int]$PrefixSelected = Read-Host 'Enter the prefix number to use for the device name'
- $PrefixSelected = $PrefixSelected - 1
- }
- catch {
- Write-Host 'Input was not in correct format. Please enter a valid prefix number'
- $var = $false
- }
- } until (($PrefixSelected -le $UnattendPrefixCount - 1) -and $var)
- $PrefixToUse = $array[$PrefixSelected].DeviceNamePrefix
- WriteLog "$PrefixToUse was selected"
- Write-Host "`n$PrefixToUse was selected as device name prefix"
+ $prefixSelection = Read-MenuSelection -Prompt 'Enter the prefix number to use for the device name (0 to skip)' -InvalidInputMessage 'Input was not in correct format. Please enter 0 to skip or a valid prefix number.' -Minimum 1 -Maximum $UnattendPrefixCount -AllowSkip
+ if ($prefixSelection -eq 0) {
+ $skipPrefixSelection = $true
+ WriteLog 'User chose to skip device name prefix selection. Existing unattend computer name will remain unchanged.'
+ Write-Host "`nDevice name prefix selection was skipped. The existing unattend computer name will remain unchanged."
+ }
+ else {
+ $PrefixSelected = $prefixSelection - 1
+ $PrefixToUse = $array[$PrefixSelected].DeviceNamePrefix
+ WriteLog "$PrefixToUse was selected"
+ Write-Host "`n$PrefixToUse was selected as device name prefix"
+ }
}
elseif ($UnattendPrefixCount -eq 1) {
WriteLog "Found $UnattendPrefixCount Prefix"
@@ -1133,8 +1162,10 @@ If ($UnattendPrefix -or $UnattendComputerName -or $RequiresTemplateDeviceName -o
WriteLog "Will use $PrefixToUse as device name prefix"
Write-Host "Will use $PrefixToUse as device name prefix"
}
- $serial = (Get-CimInstance -ClassName win32_bios).SerialNumber.Trim()
- $computername = Set-ConfiguredComputerName($PrefixToUse + $serial)
+ if (-not $skipPrefixSelection) {
+ $serial = (Get-CimInstance -ClassName win32_bios).SerialNumber.Trim()
+ $computername = Set-ConfiguredComputerName($PrefixToUse + $serial)
+ }
}
elseif ($Unattend -and $UnattendComputerName) {
Writelog 'Unattend file found with SerialComputerNames.csv. Getting name for current computer.'
@@ -1177,17 +1208,7 @@ else {
If ($autopilot -eq $true -and $PPKG -eq $true) {
WriteLog 'Both PPKG and Autopilot json files found'
Write-Host 'Both Autopilot JSON files and Provisioning packages were found.'
- do {
- try {
- $var = $true
- [int]$APorPPKG = Read-Host 'Enter 1 for Autopilot or 2 for Provisioning Package'
- }
-
- catch {
- Write-Host 'Incorrect value. Please enter 1 for Autopilot or 2 for Provisioning Package'
- $var = $false
- }
- } until (($APorPPKG -gt 0 -and $APorPPKG -lt 3) -and $var)
+ $APorPPKG = Read-MenuSelection -Prompt 'Enter 1 for Autopilot or 2 for Provisioning Package' -InvalidInputMessage 'Incorrect value. Please enter 1 for Autopilot or 2 for Provisioning Package.' -Minimum 1 -Maximum 2
If ($APorPPKG -eq 1) {
$PPKG = $false
}
@@ -1206,22 +1227,20 @@ If ($APFilesCount -gt 1 -and $autopilot -eq $true) {
$array += New-Object PSObject -Property $Properties
}
$array | Format-Table -AutoSize -Property Number, APFileName
- do {
- try {
- $var = $true
- [int]$APFileSelected = Read-Host 'Enter the AP json file number to install'
- $APFileSelected = $APFileSelected - 1
- }
+ $APFileSelection = Read-MenuSelection -Prompt 'Enter the AP json file number to install (0 to skip)' -InvalidInputMessage 'Input was not in correct format. Please enter 0 to skip or a valid AP json file number.' -Minimum 1 -Maximum $APFilesCount -AllowSkip
- catch {
- Write-Host 'Input was not in correct format. Please enter a valid AP json file number'
- $var = $false
- }
- } until (($APFileSelected -le $APFilesCount - 1) -and $var)
-
- $APFileToInstall = $array[$APFileSelected].APFile
- $APFileName = $array[$APFileSelected].APFileName
- WriteLog "$APFileToInstall was selected"
+ if ($APFileSelection -eq 0) {
+ $APFileToInstall = $null
+ $APFileName = $null
+ WriteLog 'User chose to skip Autopilot JSON selection.'
+ Write-Host "`nAutopilot JSON selection was skipped."
+ }
+ else {
+ $APFileSelected = $APFileSelection - 1
+ $APFileToInstall = $array[$APFileSelected].APFile
+ $APFileName = $array[$APFileSelected].APFileName
+ WriteLog "$APFileToInstall was selected"
+ }
}
elseif ($APFilesCount -eq 1 -and $autopilot -eq $true) {
WriteLog "Found $APFilesCount AP File"
@@ -1244,22 +1263,19 @@ If ($PPKGFilesCount -gt 1 -and $PPKG -eq $true) {
$array += New-Object PSObject -Property $Properties
}
$array | Format-Table -AutoSize -Property Number, PPKGFileName
- do {
- try {
- $var = $true
- [int]$PPKGFileSelected = Read-Host 'Enter the PPKG file number to install'
- $PPKGFileSelected = $PPKGFileSelected - 1
- }
+ $PPKGFileSelection = Read-MenuSelection -Prompt 'Enter the PPKG file number to install (0 to skip)' -InvalidInputMessage 'Input was not in correct format. Please enter 0 to skip or a valid PPKG file number.' -Minimum 1 -Maximum $PPKGFilesCount -AllowSkip
- catch {
- Write-Host 'Input was not in correct format. Please enter a valid PPKG file number'
- $var = $false
- }
- } until (($PPKGFileSelected -le $PPKGFilesCount - 1) -and $var)
-
- $PPKGFileToInstall = $array[$PPKGFileSelected].PPKGFile
- WriteLog "$PPKGFileToInstall was selected"
- Write-Host "`n$PPKGFileToInstall will be used"
+ if ($PPKGFileSelection -eq 0) {
+ $PPKGFileToInstall = $null
+ WriteLog 'User chose to skip Provisioning Package selection.'
+ Write-Host "`nProvisioning Package selection was skipped."
+ }
+ else {
+ $PPKGFileSelected = $PPKGFileSelection - 1
+ $PPKGFileToInstall = $array[$PPKGFileSelected].PPKGFile
+ WriteLog "$PPKGFileToInstall was selected"
+ Write-Host "`n$PPKGFileToInstall will be used"
+ }
}
elseif ($PPKGFilesCount -eq 1 -and $PPKG -eq $true) {
Write-SectionHeader -Title 'Provisioning Package Selection'
@@ -1375,7 +1391,7 @@ if ($null -eq $DriverSourcePath) {
if ([string]::IsNullOrWhiteSpace($relativeSegment)) {
return Split-Path -Path $normalizedPath -Leaf
}
- return $relativePath = $relativeSegment
+ return $relativeSegment
}
return $normalizedPath
}
@@ -1451,25 +1467,17 @@ if ($null -eq $DriverSourcePath) {
}
}
$displayArray | Format-Table -Property Number, Type, RelativePath -AutoSize
-
+
$DriverSelected = -1
$skipDriverInstall = $false
- do {
- try {
- $var = $true
- [int]$userSelection = Read-Host 'Enter the number of the driver source to install (0 to skip)'
- if ($userSelection -eq 0) {
- $skipDriverInstall = $true
- break
- }
- $DriverSelected = $userSelection - 1
- }
- catch {
- Write-Host 'Input was not in correct format. Please enter a valid number.'
- $var = $false
- }
- } until ((($DriverSelected -ge 0 -and $DriverSelected -lt $DriverSourcesCount) -or $skipDriverInstall) -and $var)
-
+ $userSelection = Read-MenuSelection -Prompt 'Enter the number of the driver source to install (0 to skip)' -InvalidInputMessage 'Input was not in correct format. Please enter 0 to skip or a valid number.' -Minimum 1 -Maximum $DriverSourcesCount -AllowSkip
+ if ($userSelection -eq 0) {
+ $skipDriverInstall = $true
+ }
+ else {
+ $DriverSelected = $userSelection - 1
+ }
+
if ($skipDriverInstall) {
$DriverSourcePath = $null
$DriverSourceType = $null
diff --git a/FFUDevelopment/unattend/SampleUnattend_x64.xml b/FFUDevelopment/unattend/SampleUnattend_x64.xml
index 0a85e64..b601ce5 100644
--- a/FFUDevelopment/unattend/SampleUnattend_x64.xml
+++ b/FFUDevelopment/unattend/SampleUnattend_x64.xml
@@ -3,7 +3,7 @@
- MYCOMPUTER
+ *Eastern Standard Time
diff --git a/FFUDevelopment/unattend/unattend_arm64.xml b/FFUDevelopment/unattend/unattend_arm64.xml
index ae61894..a9c2043 100644
--- a/FFUDevelopment/unattend/unattend_arm64.xml
+++ b/FFUDevelopment/unattend/unattend_arm64.xml
@@ -3,7 +3,7 @@
- MyComputer
+ *
diff --git a/FFUDevelopment/unattend/unattend_x64.xml b/FFUDevelopment/unattend/unattend_x64.xml
index 4023587..4f5014c 100644
--- a/FFUDevelopment/unattend/unattend_x64.xml
+++ b/FFUDevelopment/unattend/unattend_x64.xml
@@ -3,7 +3,7 @@
- MyComputer
+ *
diff --git a/docs/build.md b/docs/build.md
index b19fc83..abaad01 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -121,9 +121,322 @@ Controls the `-BitsPriority` parameter, which determines the priority level for
If you want faster downloads, change the priority to Foreground. Normal priority will significantly slow down downloads since BITS treats non-Foreground downloads as synchronous and queues each download. This means multiple driver or winget application downloads will go much slower than using Foreground. Normal is default as per Microsoft best practice guidance for using BITS.
-## Build USB Drive
+## General Build Options Expander
-The following sub-options control how the USB drive is created
+This expander groups the core build behaviors that affect how the FFU is created, optimized, cached, and prepared for deployment.
+
+### Compact OS
+
+Controls the `-CompactOS` parameter. When checked, the Windows image is applied using compressed files. The default is **checked**.
+
+#### How It Works
+
+When enabled, the build script uses the `-Compact` switch with `Expand-WindowsImage` when applying the Windows image to the OS partition. This compresses Windows system files using Compact OS compression, which reduces the disk footprint of the operating system. On an x64 image, space savings is ~3.5-4GB.
+
+#### Benefits
+
+| Benefit | Description |
+| ------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| **Reduced Disk Space** | Windows files are stored in a compressed state, saving several gigabytes of storage |
+| **Smaller FFU Size** | The captured FFU file is smaller because the OS partition contains compressed files |
+| **Faster Deployment** | Smaller FFU files transfer more quickly to USB drives and deploy faster to target devices |
+| **No Performance Impact** | Modern CPUs decompress files faster than they can be read from storage, so performance is maintained |
+
+#### When to Disable
+
+You may want to disable Compact OS in the following scenarios:
+
+- **Windows Server builds**: The script automatically disables Compact OS for Windows Server operating systems because the Windows Overlay Filter (wof.sys) is not included in Server SKUs
+- **Troubleshooting**: If you experience issues with specific applications that are incompatible with compressed files
+- **Maximum performance requirements**: In rare cases where every CPU cycle matters
+
+{: .note-title}
+
+> Note
+>
+> Compact OS is automatically disabled when building Windows Server images, regardless of this setting. The script detects Server operating systems and applies the Windows image without compression.
+
+### Update ADK
+
+Controls the `-UpdateADK` parameter. When checked, the script checks for and installs or updates to the latest Windows ADK and WinPE add-on before starting the build. The default is **checked**.
+
+#### How It Works
+
+When enabled, the build process performs the following checks before starting:
+
+1. **Version Check**: Queries the [Microsoft ADK installation page](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install) to determine the latest available ADK version
+2. **Compare Versions**: Compares the installed ADK and WinPE add-on versions (if present) against the latest available version
+3. **Update if Needed**: If an older version is detected:
+ - Uninstalls the existing Windows ADK
+ - Uninstalls the existing WinPE add-on
+ - Downloads and installs the latest Windows ADK with Deployment Tools feature
+ - Downloads and installs the latest WinPE add-on
+
+#### Features Installed
+
+When installing or updating the ADK, the following features are included:
+
+| Component | Feature ID | Description |
+| ---------------------------------- | ---------------------------------------------- | --------------------------------------------------------------- |
+| **Windows Deployment Tools** | `OptionId.DeploymentTools` | Includes DISM, Oscdimg, and other deployment-related tools |
+| **WinPE Environment** | `OptionId.WindowsPreinstallationEnvironment` | Windows Preinstallation Environment used for capture and deploy |
+
+#### Installation Location
+
+The ADK is installed to the default location: `C:\Program Files (x86)\Windows Kits\10`
+
+#### When to Disable
+
+You may want to disable Update ADK in the following scenarios:
+
+- **Offline or air-gapped environments**: When internet access is not available to download the latest ADK
+- **Controlled ADK versions**: When you need to maintain a specific ADK version for compatibility or compliance reasons
+- **Faster builds**: When you have already verified you are running the latest ADK version and want to skip the version check
+
+{: .warning-title}
+
+> Warning
+>
+> If Update ADK is disabled and the Windows ADK or WinPE add-on is not installed, the build will fail. Ensure you have manually installed the required components before disabling this option.
+
+#### Manual ADK Installation
+
+If you prefer to manually install the ADK, visit:
+
+[Download and install the Windows ADK](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install)
+
+You must install both:
+
+- Windows Assessment and Deployment Kit (with Deployment Tools feature)
+- Windows PE add-on for the Windows ADK
+
+### Optimize
+
+Controls the `-Optimize` parameter. When enabled, FFU Builder runs the Windows ADK version of DISM to optimize the captured `.ffu` file:
+
+- `DISM /Optimize-FFU /ImageFile:`
+
+This post-processing step typically takes a few minutes and is intended to make FFU images faster to deploy and easier to deploy to differently-sized disks (by allowing the Windows partition to expand or shrink during apply).
+
+**Default:** Enabled (`-Optimize $true`)
+
+#### When to Disable
+
+You may want to disable Optimize (`-Optimize $false`) if you are troubleshooting, or if you want to skip the extra post-processing time.
+
+{: .warning-title}
+
+> Warning
+>
+> If you plan to deploy the same FFU to devices with different storage sizes (especially smaller disks), keep `-Optimize` enabled. Non-optimized FFUs are more likely to require additional partition management during deployment.
+
+{: .note-title}
+
+> Note
+>
+> FFU Builder also performs a separate “optimize VHDX before capture” step. That VHDX optimization is independent of `-Optimize`, so you may still see “Optimizing VHDX before capture…” even when `-Optimize` is disabled.
+
+### Allow VHDX Caching
+
+Controls the `-AllowVHDXCaching` parameter. When enabled, FFU Builder caches the base VHDX it creates in `$FFUDevelopmentPath\VHDXCache` and writes a matching `*_config.json` file alongside it. On later builds, if a cached VHDX exists that matches your selected Windows settings and update set, the script reuses it to avoid re-applying the base image and integrating updates again.
+
+**Default:** Disabled (`-AllowVHDXCaching $false`)
+
+#### Cache Matching
+
+A cached VHDX is reused only when the cache metadata matches your current build inputs, including:
+
+- Windows release, version, and SKU
+- Logical sector size (512 vs 4096)
+- Optional features selection
+- The exact set of update payload file names downloaded for that run (SSU/CU/.NET/etc.)
+
+#### Disk Usage and Cleanup
+
+VHDX caching trades disk space for speed. The `VHDXCache` folder can grow over time as you build different combinations. Periodically check the folder and remove old cached vhdx and config json files as necessary.
+
+{: .note-title}
+
+> Note
+>
+> To force a full rebuild, delete the contents of `$FFUDevelopmentPath\VHDXCache` (or disable **Allow VHDX Caching**) and run the build again.
+
+### Create Deployment Media
+
+Controls the `-CreateDeploymentMedia` parameter.
+
+When enabled, FFU Builder creates WinPE deployment media that is used to deploy an FFU image to a physical device. This media contains the WinPE environment and deployment scripts needed to boot a target machine and apply the FFU image.
+
+The deployment media is saved as an ISO file at `$FFUDevelopmentPath\WinPE_FFU_Deploy_x64.iso` (or `WinPE_FFU_Deploy_arm64.iso` for ARM64 builds). This ISO can then be used with the **Build USB Drive** option to create bootable USB media for physical deployments.
+
+**Default:** Enabled (`-CreateDeploymentMedia $true`)
+
+{: .note-title}
+
+> Note
+>
+> If you only need to capture FFUs from VMs and do not plan to deploy to physical devices, you can disable this option to save time during the build process. However, most scenarios require deployment media for the final step of applying the FFU to target hardware.
+
+{: .tip-title}
+
+> Tip
+>
+> If you just need to re-create deployment media, you can use the `Create-PEMedia.ps1` script to regenerate the deploy ISO without running a full build.
+
+### Inject Unattend.xml
+
+Controls the `-InjectUnattend` parameter. When checked, copies the architecture-specific unattend XML file from `.\FFUDevelopment\unattend` into the Apps ISO so it's baked into the FFU during the VM build process. The default is **unchecked**.
+
+This option is only available when **Install Apps** is checked.
+
+`Copy Unattend.xml` and `Inject Unattend.xml` are mutually exclusive. Select only one.
+
+#### How It Works
+
+When enabled, the build process:
+
+1. Determines the correct unattend file based on the target architecture:
+ * **unattend_x64.xml** for x64 builds
+ * **unattend_arm64.xml** for arm64 builds
+2. Creates an `Unattend` folder inside `.\FFUDevelopment\Apps` if it doesn't exist
+3. Copies the architecture-specific unattend file to `.\FFUDevelopment\Apps\Unattend\Unattend.xml`
+4. Includes the unattend file in the Apps ISO, making it available to sysprep during the VM build
+
+The unattend file is then used by sysprep during the specialize phase and/or other OOBE phases when the FFU is deployed.
+
+#### Creating Your Unattend Files
+
+Modify the architecture-specific unattend file in the `.\FFUDevelopment\unattend` folder:
+
+| File | Description |
+| ---------------------------- | ----------------------------------- |
+| **unattend_x64.xml** | Unattend file used for x64 builds |
+| **unattend_arm64.xml** | Unattend file used for arm64 builds |
+
+{: .warning-title}
+
+> Important
+>
+> Keep the file names with the architecture suffix (e.g., unattend_x64.xml). The script handles renaming the file to `Unattend.xml` when copying it to the Apps folder.
+
+#### When to Use This Option
+
+This option is primarily intended for scenarios where:
+
+* You are **not using the USB drive** to deploy the FFU and use other deployment methods (e.g., network deployment, disk cloning, etc)
+* You want the unattend configuration **baked directly into the FFU** rather than applied at deployment time
+
+#### Limitations
+
+| Limitation | Description |
+| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **No prefixes.txt or %serial% support** | Unlike **Copy Unattend.xml**, this method does not support `prefixes.txt` or the `%serial%` variable for deployment-time device naming |
+| **Fixed configuration** | The unattend settings are baked into the FFU at build time and cannot be changed at deployment time |
+| **Requires VM to be built** | This option only works when**Install Apps** is `$true` because the unattend file is included in the Apps ISO |
+
+{: .note-title}
+
+> Note
+>
+> Most users should continue using the **Copy Unattend** option via the USB drive, which provides more flexibility including support for `prefixes.txt` device naming. Use **Inject Unattend.xml** only when you won't be using the USB drive for deployment.
+
+{: .tip-title}
+
+> Tip
+>
+> If you're using this option, you can disable **Build Deploy ISO** to save time during the build process since the deployment ISO is not needed when you're not using the USB drive method.
+
+### Verbose
+
+Controls the `-Verbose` common parameter. When checked, enables detailed verbose output during the build process. The default is **unchecked**.
+
+In prior builds it was necessary to enable `-verbose` output to track in real-time the build process if you didn't have `cmtrace.exe` or some other log-monitoring tool. With the UI, you can now watch the build in real-time using the monitor tab. Enabling verbose shouldn't be necessary but is available for those who wish to use it.
+
+## Device Naming Expander
+
+Use the **Device Naming** expander to decide whether `ComputerName` should be set at deployment time when unattend is applied. There are some major benefits to doing this:
+
+1. Total deployment time is reduced if naming is set at FFU deployment time since there is no additional reboot done during OOBE.
+2. Reduces the need for multiple provisioning packages or autopilot profiles. This means you can use a single PPKG or autopilot profile.
+
+### No Device Name
+
+This is the default option. The unattend file is still applied, but Windows generates a random computer name instead of forcing a prompt or a fixed name.
+
+### Specify Device Name
+
+Use this option when you want a static device name or a template such as `Comp-%serial%`.
+
+- With **Copy Unattend.xml**, `%serial%` is resolved during deployment in PE.
+- With **Inject Unattend.xml**, only static names are supported.
+- **Copy Unattend.xml** and **Inject Unattend.xml** are mutually exclusive. Select only one.
+
+### Specify a list of Prefixes
+
+This option writes `prefixes.txt` from the list in the UI. Enter one prefix per line in the multiline prefixes box. If there is a single prefix, deployment uses it automatically. If there are multiple prefixes, the technician is prompted to select one. The selected prefix is combined with the device serial number to create the computer name.
+
+For example, with a prefix of `CORP-` and a serial number of `ABC123`, the resulting computer name would be `CORP-ABC123` (truncated to 15 characters if necessary).
+
+Sample `prefixes.txt` content:
+
+```plaintext
+CORP-
+STORE-
+KIOSK-
+```
+
+{: .note-title}
+
+> Note
+>
+> If the technician skips prefix selection when multiple prefixes are available, `ApplyFFU.ps1` leaves the existing unattend `ComputerName` value unchanged. With the current unattend samples set to `*`, Windows falls back to its default random computer-name behavior, typically resulting in a name such as `WIN-*`.
+
+### Prefixes File Path
+
+Use **Prefixes File Path** to point the UI at the source text file for the prefixes list. The file can use any name. When you browse to a prefixes file in the UI, or when a saved configuration references a valid prefixes path, the UI loads that file and populates the multiline prefixes box from its contents.
+
+### Save Prefixes
+
+Use **Save Prefixes** to write the current multiline prefixes list back to the file specified in **Prefixes File Path**.
+
+### Legacy Prompt Behavior
+
+Older deployment media that still has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
+
+{: .warning-title}
+
+> Warning
+>
+> If using a provisioning package or autopilot json file, DO NOT specify a name in either of these. They will overwrite the name you have specified in the unattend.xml.
+
+### Creating Your Unattend Files
+
+The `.\FFUDevelopment\Unattend` folder includes sample files you can customize:
+
+| File | Description |
+| -------------------------------- | ------------------------------------------ |
+| **SampleUnattend_x64.xml** | Example unattend file for x64 systems |
+| **unattend_x64.xml** | Active unattend file used for x64 builds |
+| **unattend_arm64.xml** | Active unattend file used for arm64 builds |
+| **SamplePrefixes.txt** | Example prefixes file for device naming |
+
+Copy and customize the sample files to create your own `unattend_x64.xml`, `unattend_arm64.xml`, and `prefixes.txt` files.
+
+{: .note-title}
+
+> Note
+>
+> The unattend file must contain a `` element in the `Microsoft-Windows-Shell-Setup` component for device naming to work. See the sample files for the correct structure.
+
+## Build USB Drive Options Expander
+
+This expander groups the settings used to create deployment USB drives after the FFU and deployment media are ready.
+
+### Build USB Drive
+
+Controls the `-BuildUSBDrive` parameter. When checked, FFU Builder partitions and formats selected USB drives and copies the captured FFU plus the enabled deployment assets to them. The default is **unchecked**.
+
+The remaining settings in this expander apply only when **Build USB Drive** is enabled.
### Allow External Hard Disk Media
@@ -184,7 +497,7 @@ Use the **Select All** checkbox in the column header to quickly select or desele
### Copy Autopilot Profile
-Controls the `-CopyAutopilot` parameter. When checked, copies the contents of the `.\FFUDevelopment\Autopilot` folder to the `Autopilot` folder on the Deployment partition of the USB drive. The default is **unchecked**.
+Controls the `-CopyAutopilot` parameter. When checked, copies the contents of `.\FFUDevelopment\Autopilot` to the `Autopilot` folder on the Deployment partition of the USB drive. The default is **unchecked**.
This option is only available when **Build USB Drive** is checked.
@@ -203,73 +516,11 @@ When enabled, the build process copies:
During deployment, `ApplyFFU.ps1` applies `Unattend.xml` whenever it is present. Device naming only happens when the **Device Naming** setting requires it, or when older media still uses the legacy prompt-based workflow.
-#### Device Naming
-
-Use the **Device Naming** expander to decide whether `ComputerName` should be set at deployment time. There are some major benefits to doing this:
-
-1. Total deployment time is reduced if naming is set at FFU deployment time since there is no additional reboot done during OOBE.
-2. Reduces the need for multiple provisioning packages or autopilot profiles. This means you can use a single PPKG or autopilot profile.
-
-#### No Device Name
-
-This is the default option. The unattend file is still applied, but Windows generates a random computer name instead of forcing a prompt or a fixed name.
-
-#### Specify Device Name
-
-Use this option when you want a static device name or a template such as `Comp-%serial%`.
-
-- With **Copy Unattend.xml**, `%serial%` is resolved during deployment in PE.
-- With **Inject Unattend.xml**, only static names are supported.
-- **Copy Unattend.xml** and **Inject Unattend.xml** are mutually exclusive. Select only one.
-
-#### Specify a list of Prefixes
-
-This option writes `prefixes.txt` from the list in the UI. Enter one prefix per line or import an existing prefixes file. The source file can use any name because the UI now tracks the path separately.
-
-If there is a single prefix, deployment uses it automatically. If there are multiple prefixes, the technician is prompted to select one. The selected prefix is combined with the device serial number to create the computer name.
-
-For example, with a prefix of `CORP-` and a serial number of `ABC123`, the resulting computer name would be `CORP-ABC123` (truncated to 15 characters if necessary).
-
-Sample `prefixes.txt` content:
-
-```plaintext
-CORP-
-STORE-
-KIOSK-
-```
-
-#### Legacy Prompt Behavior
-
-Older deployment media that still has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
-
-{: .warning-title}
-
-> Warning
->
-> If using a provisioning package or autopilot json file, DO NOT specify a name in either of these. They will overwrite the name you have specified in the unattend.xml.
-
-#### Creating Your Unattend Files
-
-The `.\FFUDevelopment\Unattend` folder includes sample files you can customize:
-
-| File | Description |
-| -------------------------------- | ------------------------------------------ |
-| **SampleUnattend_x64.xml** | Example unattend file for x64 systems |
-| **unattend_x64.xml** | Active unattend file used for x64 builds |
-| **unattend_arm64.xml** | Active unattend file used for arm64 builds |
-| **SamplePrefixes.txt** | Example prefixes file for device naming |
-
-Copy and customize the sample files to create your own `unattend_x64.xml`, `unattend_arm64.xml`, and `prefixes.txt` files.
-
-{: .note-title}
-
-> Note
->
-> The unattend file must contain a `` element in the `Microsoft-Windows-Shell-Setup` component for device naming to work. See the sample files for the correct structure.
+See **Device Naming Expander** above for the available computer-name modes and prefixes-file behavior.
### Copy Provisioning Package
-Controls the `-CopyPPKG` parameter. When checked, copies the contents of the `.\FFUDevelopment\PPKG` folder to the `PPKG` folder on the Deployment partition of the USB drive. The default is **unchecked**.
+Controls the `-CopyPPKG` parameter. When checked, copies the contents of `.\FFUDevelopment\PPKG` to the `PPKG` folder on the Deployment partition of the USB drive. The default is **unchecked**.
This option is only available when **Build USB Drive** is checked.
@@ -333,248 +584,23 @@ This option is only available when **Build USB Drive** is checked.
When building USB drives, the script processes multiple drives concurrently to speed up imaging. This setting controls how many drives are formatted and copied to simultaneously.
-## Compact OS
+## Post-Build Cleanup Expander
-Controls the `-CompactOS` parameter. When checked, the Windows image is applied using compressed files. The default is **checked**.
+This expander groups the cleanup settings that run after a successful build completes.
-### How It Works
-
-When enabled, the build script uses the `-Compact` switch with `Expand-WindowsImage` when applying the Windows image to the OS partition. This compresses Windows system files using Compact OS compression, which reduces the disk footprint of the operating system. On an x64 image, space savings is ~3.5-4GB.
-
-### Benefits
-
-| Benefit | Description |
-| ------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| **Reduced Disk Space** | Windows files are stored in a compressed state, saving several gigabytes of storage |
-| **Smaller FFU Size** | The captured FFU file is smaller because the OS partition contains compressed files |
-| **Faster Deployment** | Smaller FFU files transfer more quickly to USB drives and deploy faster to target devices |
-| **No Performance Impact** | Modern CPUs decompress files faster than they can be read from storage, so performance is maintained |
-
-### When to Disable
-
-You may want to disable Compact OS in the following scenarios:
-
-- **Windows Server builds**: The script automatically disables Compact OS for Windows Server operating systems because the Windows Overlay Filter (wof.sys) is not included in Server SKUs
-- **Troubleshooting**: If you experience issues with specific applications that are incompatible with compressed files
-- **Maximum performance requirements**: In rare cases where every CPU cycle matters
-
-{: .note-title}
-
-> Note
->
-> Compact OS is automatically disabled when building Windows Server images, regardless of this setting. The script detects Server operating systems and applies the Windows image without compression.
-
-## Update ADK
-
-Controls the `-UpdateADK` parameter. When checked, the script checks for and installs or updates to the latest Windows ADK and WinPE add-on before starting the build. The default is **checked**.
-
-### How It Works
-
-When enabled, the build process performs the following checks before starting:
-
-1. **Version Check**: Queries the [Microsoft ADK installation page](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install) to determine the latest available ADK version
-2. **Compare Versions**: Compares the installed ADK and WinPE add-on versions (if present) against the latest available version
-3. **Update if Needed**: If an older version is detected:
- - Uninstalls the existing Windows ADK
- - Uninstalls the existing WinPE add-on
- - Downloads and installs the latest Windows ADK with Deployment Tools feature
- - Downloads and installs the latest WinPE add-on
-
-### Features Installed
-
-When installing or updating the ADK, the following features are included:
-
-| Component | Feature ID | Description |
-| ---------------------------------- | ---------------------------------------------- | --------------------------------------------------------------- |
-| **Windows Deployment Tools** | `OptionId.DeploymentTools` | Includes DISM, Oscdimg, and other deployment-related tools |
-| **WinPE Environment** | `OptionId.WindowsPreinstallationEnvironment` | Windows Preinstallation Environment used for capture and deploy |
-
-### Installation Location
-
-The ADK is installed to the default location: `C:\Program Files (x86)\Windows Kits\10`
-
-### When to Disable
-
-You may want to disable Update ADK in the following scenarios:
-
-- **Offline or air-gapped environments**: When internet access is not available to download the latest ADK
-- **Controlled ADK versions**: When you need to maintain a specific ADK version for compatibility or compliance reasons
-- **Faster builds**: When you have already verified you are running the latest ADK version and want to skip the version check
-
-{: .warning-title}
-
-> Warning
->
-> If Update ADK is disabled and the Windows ADK or WinPE add-on is not installed, the build will fail. Ensure you have manually installed the required components before disabling this option.
-
-### Manual ADK Installation
-
-If you prefer to manually install the ADK, visit:
-
-[Download and install the Windows ADK](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install)
-
-You must install both:
-
-- Windows Assessment and Deployment Kit (with Deployment Tools feature)
-- Windows PE add-on for the Windows ADK
-
-## Optimize
-
-Controls the `-Optimize` parameter. When enabled, FFU Builder runs the Windows ADK version of DISM to optimize the captured `.ffu` file:
-
-- `DISM /Optimize-FFU /ImageFile:`
-
-This post-processing step typically takes a few minutes and is intended to make FFU images faster to deploy and easier to deploy to differently-sized disks (by allowing the Windows partition to expand or shrink during apply).
-
-**Default:** Enabled (`-Optimize $true`)
-
-### When to Disable
-
-You may want to disable Optimize (`-Optimize $false`) if you are troubleshooting, or if you want to skip the extra post-processing time.
-
-{: .warning-title}
-
-> Warning
->
-> If you plan to deploy the same FFU to devices with different storage sizes (especially smaller disks), keep `-Optimize` enabled. Non-optimized FFUs are more likely to require additional partition management during deployment.
-
-{: .note-title}
-
-> Note
->
-> FFU Builder also performs a separate “optimize VHDX before capture” step. That VHDX optimization is independent of `-Optimize`, so you may still see “Optimizing VHDX before capture…” even when `-Optimize` is disabled.
-
-## Allow VHDX Caching
-
-Controls the `-AllowVHDXCaching` parameter. When enabled, FFU Builder caches the base VHDX it creates in `$FFUDevelopmentPath\VHDXCache` and writes a matching `*_config.json` file alongside it. On later builds, if a cached VHDX exists that matches your selected Windows settings and update set, the script reuses it to avoid re-applying the base image and integrating updates again.
-
-**Default:** Disabled (`-AllowVHDXCaching $false`)
-
-### Cache Matching
-
-A cached VHDX is reused only when the cache metadata matches your current build inputs, including:
-
-- Windows release, version, and SKU
-- Logical sector size (512 vs 4096)
-- Optional features selection
-- The exact set of update payload file names downloaded for that run (SSU/CU/.NET/etc.)
-
-### Disk Usage and Cleanup
-
-VHDX caching trades disk space for speed. The `VHDXCache` folder can grow over time as you build different combinations. Periodically check the folder and remove old cached vhdx and config json files as necessary.
-
-{: .note-title}
-
-> Note
->
-> To force a full rebuild, delete the contents of `$FFUDevelopmentPath\VHDXCache` (or disable **Allow VHDX Caching**) and run the build again.
-
-## Create Deployment Media
-
-Controls the `-CreateDeploymentMedia` parameter.
-
-When enabled, FFU Builder creates WinPE deployment media that is used to deploy an FFU image to a physical device. This media contains the WinPE environment and deployment scripts needed to boot a target machine and apply the FFU image.
-
-The deployment media is saved as an ISO file at `$FFUDevelopmentPath\WinPE_FFU_Deploy_x64.iso` (or `WinPE_FFU_Deploy_arm64.iso` for ARM64 builds). This ISO can then be used with the **Build USB Drive** option to create bootable USB media for physical deployments.
-
-**Default:** Enabled (`-CreateDeploymentMedia $true`)
-
-{: .note-title}
-
-> Note
->
-> If you only need to capture FFUs from VMs and do not plan to deploy to physical devices, you can disable this option to save time during the build process. However, most scenarios require deployment media for the final step of applying the FFU to target hardware.
-
-{: .tip-title}
-
-> Tip
->
-> If you just need to re-create deployment media, you can use the `Create-PEMedia.ps1` script to regenerate the deploy ISO without running a full build.
-
-## Inject Unattend.xml
-
-Controls the `-InjectUnattend` parameter. When checked, copies the architecture-specific unattend XML file from `.\FFUDevelopment\unattend` into the Apps ISO so it's baked into the FFU during the VM build process. The default is **unchecked**.
-
-This option is only available when **Install Apps** is checked.
-
-`Copy Unattend.xml` and `Inject Unattend.xml` are mutually exclusive. Select only one.
-
-### How It Works
-
-When enabled, the build process:
-
-1. Determines the correct unattend file based on the target architecture:
- * **unattend_x64.xml** for x64 builds
- * **unattend_arm64.xml** for arm64 builds
-2. Creates an `Unattend` folder inside `.\FFUDevelopment\Apps` if it doesn't exist
-3. Copies the architecture-specific unattend file to `.\FFUDevelopment\Apps\Unattend\Unattend.xml`
-4. Includes the unattend file in the Apps ISO, making it available to sysprep during the VM build
-
-The unattend file is then used by sysprep during the specialize phase and/or other OOBE phases when the FFU is deployed.
-
-### Creating Your Unattend Files
-
-Modify the architecture-specific unattend file in the `.\FFUDevelopment\unattend` folder:
-
-| File | Description |
-| ---------------------------- | ----------------------------------- |
-| **unattend_x64.xml** | Unattend file used for x64 builds |
-| **unattend_arm64.xml** | Unattend file used for arm64 builds |
-
-{: .warning-title}
-
-> Important
->
-> Keep the file names with the architecture suffix (e.g., unattend_x64.xml). The script handles renaming the file to `Unattend.xml` when copying it to the Apps folder.
-
-### When to Use This Option
-
-This option is primarily intended for scenarios where:
-
-* You are **not using the USB drive** to deploy the FFU and use other deployment methods (e.g., network deployment, disk cloning, etc)
-* You want the unattend configuration **baked directly into the FFU** rather than applied at deployment time
-
-### Limitations
-
-| Limitation | Description |
-| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **No prefixes.txt or %serial% support** | Unlike **Copy Unattend.xml**, this method does not support `prefixes.txt` or the `%serial%` variable for deployment-time device naming |
-| **Fixed configuration** | The unattend settings are baked into the FFU at build time and cannot be changed at deployment time |
-| **Requires VM to be built** | This option only works when**Install Apps** is `$true` because the unattend file is included in the Apps ISO |
-
-{: .note-title}
-
-> Note
->
-> Most users should continue using the **Copy Unattend** option via the USB drive, which provides more flexibility including support for `prefixes.txt` device naming. Use **Inject Unattend.xml** only when you won't be using the USB drive for deployment.
-
-{: .tip-title}
-
-> Tip
->
-> If you're using this option, you can disable **Build Deploy ISO** to save time during the build process since the deployment ISO is not needed when you're not using the USB drive method.
-
-## Verbose
-
-Controls the `-Verbose` common parameter. When checked, enables detailed verbose output during the build process. The default is **unchecked**.
-
-In prior builds it was necessary to enable `-verbose` output to track in real-time the build process if you didn't have `cmtrace.exe` or some other log-monitoring tool. With the UI, you can now watch the build in real-time using the monitor tab. Enabling verbose shouldn't be necessary but is available for those who wish to use it.
-
-# Post-Build Cleanup
-
-## Cleanup Apps ISO
+### Cleanup Apps ISO
Controls the `-CleanupAppsISO` parameter. When checked, the Apps ISO file is automatically deleted after the FFU has been successfully captured. The default is **checked**.
-During the build process, when apps are being installed, the script creates an `Apps.iso` file in the FFU Development Path (e.g., `.\FFUDevelopment\Apps.iso`). This ISO contains the contents of the `.\FFUDevelopment\Apps` folder—including application installers, Office deployment files, and orchestration scripts—and is mounted to the VM during the build to install applications.
+During the build process, when apps are being installed, the script creates an `Apps.iso` file in the FFU Development Path (for example, `.\FFUDevelopment\Apps.iso`). This ISO contains the contents of the `.\FFUDevelopment\Apps` folder, including application installers, Office deployment files, and orchestration scripts, and is mounted to the VM during the build to install applications.
-### When to Disable
+#### When to Disable
You may want to disable Cleanup Apps ISO in the following scenarios:
-* **Debugging app installations**: When troubleshooting application installation issues and you want to manually inspect the ISO contents
-* **Multiple builds with same apps**: If you're running consecutive builds with identical app configurations and want to reuse the existing ISO to save time (the script will recreate it if missing)
-* **Archival purposes**: When you need to retain a copy of the exact Apps ISO used for a specific FFU build
+- **Debugging app installations**: When troubleshooting application installation issues and you want to manually inspect the ISO contents
+- **Multiple builds with same apps**: If you're running consecutive builds with identical app configurations and want to reuse the existing ISO to save time (the script will recreate it if missing)
+- **Archival purposes**: When you need to retain a copy of the exact Apps ISO used for a specific FFU build
{: .note-title}
@@ -582,69 +608,69 @@ You may want to disable Cleanup Apps ISO in the following scenarios:
>
> The Apps ISO is only created when applications are configured for installation. If no apps are being installed in the FFU, this option has no effect. Keeping this option enabled helps conserve disk space by removing temporary build artifacts.
-## Cleanup Deploy ISO
+### Cleanup Deploy ISO
Controls the `-CleanupDeployISO` parameter. When checked, the WinPE deployment ISO file is automatically deleted after the FFU has been successfully captured. The default is **checked**.
-During the build process, when **Build Deploy ISO** is enabled, the script creates a `WinPE_FFU_Deploy.iso` file (e.g., `.\FFUDevelopment\WinPE_FFU_Deploy.iso`). This ISO contains a customized Windows PE environment used to deploy captured FFU images to target devices. The deployment ISO is typically copied to a bootable USB drive along with the FFU files for field deployment.
+During the build process, when **Build Deploy ISO** is enabled, the script creates a `WinPE_FFU_Deploy.iso` file (for example, `.\FFUDevelopment\WinPE_FFU_Deploy.iso`). This ISO contains a customized Windows PE environment used to deploy captured FFU images to target devices. The deployment ISO is typically copied to a bootable USB drive along with the FFU files for field deployment.
-### When to Disable
+#### When to Disable
You may want to disable Cleanup Deploy ISO in the following scenarios:
-* **Creating deployment media separately**: When you want to create USB deployment drives at a later time, see [USB Imaging Tool Creator](/FFU/usb_imaging_tool_creator.html) for a staged workflow using `USBImagingToolCreator.ps1` with a deploy ISO, `FFU`, and `Drivers` folder (local path or network share).
-* **Testing in Hyper-V**: When deploying FFU images to Hyper-V VMs for testing, you can attach the deploy ISO directly to a VM as a DVD drive
+- **Creating deployment media separately**: When you want to create USB deployment drives at a later time, see [USB Imaging Tool Creator](/FFU/usb_imaging_tool_creator.html) for a staged workflow using `USBImagingToolCreator.ps1` with a deploy ISO, `FFU`, and `Drivers` folder (local path or network share)
+- **Testing in Hyper-V**: When deploying FFU images to Hyper-V VMs for testing, you can attach the deploy ISO directly to a VM as a DVD drive
-## Cleanup Drivers
+### Cleanup Drivers
Controls the `-CleanupDrivers` parameter. When checked, the contents of the Drivers folder are automatically deleted after the FFU has been successfully captured. The default is **unchecked**.
-During the build process, when drivers are configured for installation, the script downloads and extracts driver packages into manufacturer-specific subfolders within the Drivers folder (e.g., `.\FFUDevelopment\Drivers\HP`, `.\FFUDevelopment\Drivers\Dell`). These drivers are then injected into the FFU during the build.
+During the build process, when drivers are configured for installation, the script downloads and extracts driver packages into manufacturer-specific subfolders within the Drivers folder (for example, `.\FFUDevelopment\Drivers\HP`, `.\FFUDevelopment\Drivers\Dell`). These drivers are then injected into the FFU during the build.
-### When to Enable
+#### When to Enable
You may want to enable Cleanup Drivers in the following scenarios:
-* **Conserving disk space**: Driver packages can be large (several gigabytes per manufacturer), and removing them after a successful build frees up storage
-* **Ensuring fresh drivers**: When you want each build to download the latest available drivers rather than reusing previously downloaded versions
-* **Single-use builds**: When building an FFU for a one-time deployment and you don't need to retain the driver files
+- **Conserving disk space**: Driver packages can be large (several gigabytes per manufacturer), and removing them after a successful build frees up storage
+- **Ensuring fresh drivers**: When you want each build to download the latest available drivers rather than reusing previously downloaded versions
+- **Single-use builds**: When building an FFU for a one-time deployment and you don't need to retain the driver files
-### When to Disable
+#### When to Disable
You may want to keep Cleanup Drivers disabled in the following scenarios:
-* **Multiple builds with same drivers**: If you're running consecutive builds targeting the same hardware models, keeping drivers avoids re-downloading them each time
-* **Debugging driver issues**: When troubleshooting driver injection problems and you want to manually inspect the downloaded driver contents
-* **Offline builds**: When building in an environment with limited or no internet access, retaining drivers allows reuse across builds
-* **Bring Your Own Drivers:** When you download and bring your own set of drivers from another source and don't want FFU Builder to remove them
+- **Multiple builds with same drivers**: If you're running consecutive builds targeting the same hardware models, keeping drivers avoids re-downloading them each time
+- **Debugging driver issues**: When troubleshooting driver injection problems and you want to manually inspect the downloaded driver contents
+- **Offline builds**: When building in an environment with limited or no internet access, retaining drivers allows reuse across builds
+- **Bring Your Own Drivers**: When you download and bring your own set of drivers from another source and don't want FFU Builder to remove them
{: .note-title}
> Note
>
-> Only the contents within the Drivers folder are removed—the folder itself is preserved. If no drivers were downloaded during the build, this option has no effect.
+> Only the contents within the Drivers folder are removed. The folder itself is preserved. If no drivers were downloaded during the build, this option has no effect.
-## Remove FFU
+### Remove FFU
Controls the `-RemoveFFU` parameter. When checked, all FFU files in the FFU Capture Location are automatically deleted after the build completes successfully. The default is **unchecked**.
-During the build process, the captured FFU image is written to the FFU Capture Location (e.g., `.\FFUDevelopment\FFU`). This option removes all `.ffu` files from that folder after the build finishes, including any previously captured FFU files that may exist in the folder.
+During the build process, the captured FFU image is written to the FFU Capture Location (for example, `.\FFUDevelopment\FFU`). This option removes all `.ffu` files from that folder after the build finishes, including any previously captured FFU files that may exist in the folder.
-### When to Enable
+#### When to Enable
You may want to enable Remove FFU in the following scenarios:
-* **USB-only workflow**: When you're using **Build USB Drive** to copy the FFU directly to a USB drive and don't need to retain the FFU file on the host machine
-* **Conserving disk space**: FFU files can be very large depending on what you're installing, and removing them after copying to USB frees up storage
-* **Automated build pipelines**: When running automated builds where the FFU is immediately transferred to another location (such as a network share or deployment server) and no longer needed locally
+- **USB-only workflow**: When you're using **Build USB Drive** to copy the FFU directly to a USB drive and don't need to retain the FFU file on the host machine
+- **Conserving disk space**: FFU files can be very large depending on what you're installing, and removing them after copying to USB frees up storage
+- **Automated build pipelines**: When running automated builds where the FFU is immediately transferred to another location (such as a network share or deployment server) and no longer needed locally
-### When to Disable
+#### When to Disable
You may want to keep Remove FFU disabled in the following scenarios:
-* **Archival purposes**: When you want to retain captured FFU images for future deployments or as a backup
-* **Multiple USB drives**: When you need to create additional USB deployment drives at a later time
-* **Testing and validation**: When you want to test the FFU in Hyper-V or other environments before deploying to physical hardware
+- **Archival purposes**: When you want to retain captured FFU images for future deployments or as a backup
+- **Multiple USB drives**: When you need to create additional USB deployment drives at a later time
+- **Testing and validation**: When you want to test the FFU in Hyper-V or other environments before deploying to physical hardware
{: .warning-title}
@@ -652,15 +678,15 @@ You may want to keep Remove FFU disabled in the following scenarios:
>
> This option removes **all** FFU files in the FFU Capture Location folder, not just the FFU from the current build. If you have previously captured FFU files stored in this folder that you want to keep, do not enable this option or move those files to a different location before building.
-## Remove Apps Folder Content
+### Remove Apps Folder Content
-Controls the `-RemoveApps` parameter. When checked, application content in the Apps folder is automatically deleted after the FFU has been successfully captured. The default is **un****checked**.
+Controls the `-RemoveApps` parameter. When checked, application content in the Apps folder is automatically deleted after the FFU has been successfully captured. The default is **unchecked**.
-During the build process, application content accumulates in several subfolders within the Apps folder (e.g., `.\FFUDevelopment\Apps`):
+During the build process, application content accumulates in several subfolders within the Apps folder (for example, `.\FFUDevelopment\Apps`):
| Folder | Contents |
| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `Win32` | Winget source applications and Bring Your Own Apps content copied using the**Copy Apps** button or manually copied |
+| `Win32` | Winget source applications and Bring Your Own Apps content copied using the **Copy Apps** button or manually copied |
| `MSStore` | Microsoft Store applications downloaded via Winget |
| `Office` | Microsoft 365 Apps installer files downloaded by the Office Deployment Tool |
@@ -668,34 +694,34 @@ Additionally, the `WinGetWin32Apps.json` orchestration file in `.\FFUDevelopment
When this option is enabled, the cleanup process removes:
-* The entire `Win32` folder and its contents
-* The entire `MSStore` folder and its contents
-* The Office download subfolder (`Office\Office`) and the `setup.exe` file within the `Office` folder
+- The entire `Win32` folder and its contents
+- The entire `MSStore` folder and its contents
+- The Office download subfolder (`Office\Office`) and the `setup.exe` file within the `Office` folder
-### When to Enable
+#### When to Enable
You may want to keep Remove Apps Folder Content enabled in the following scenarios:
-* **Conserving disk space**: Downloaded application installers can consume significant storage, and removing them after a successful build frees up space
-* **Ensuring fresh downloads**: When you want each build to download the latest available application versions rather than reusing previously downloaded content
-* **Single-use builds**: When building an FFU for a one-time deployment and you don't need to retain the application files
+- **Conserving disk space**: Downloaded application installers can consume significant storage, and removing them after a successful build frees up space
+- **Ensuring fresh downloads**: When you want each build to download the latest available application versions rather than reusing previously downloaded content
+- **Single-use builds**: When building an FFU for a one-time deployment and you don't need to retain the application files
-### When to Disable
+#### When to Disable
You may want to disable Remove Apps Folder Content in the following scenarios:
-* **Multiple builds with same apps**: If you're running consecutive builds with identical application configurations, keeping the downloaded content avoids re-downloading applications each time
-* **Debugging app installations**: When troubleshooting application installation issues and you want to manually inspect the downloaded content
-* **Offline builds**: When building in an environment with limited or no internet access, retaining downloaded applications allows reuse across builds
-* **Preserving Bring Your Own Apps**: When you've manually copied application content into the `Win32` folder and don't want FFU Builder to remove it
+- **Multiple builds with same apps**: If you're running consecutive builds with identical application configurations, keeping the downloaded content avoids re-downloading applications each time
+- **Debugging app installations**: When troubleshooting application installation issues and you want to manually inspect the downloaded content
+- **Offline builds**: When building in an environment with limited or no internet access, retaining downloaded applications allows reuse across builds
+- **Preserving Bring Your Own Apps**: When you've manually copied application content into the `Win32` folder and don't want FFU Builder to remove it
{: .note-title}
> Note
>
-> Only the application content subfolders are removed—the `Apps` folder itself and configuration files such as `AppList.json` and `UserAppList.json` are preserved. If no applications were configured for the build, this option has no effect.
+> Only the application content subfolders are removed. The `Apps` folder itself and configuration files such as `AppList.json` and `UserAppList.json` are preserved. If no applications were configured for the build, this option has no effect.
-## Remove Downloaded Update Files
+### Remove Downloaded Update Files
Controls the `-RemoveUpdates` parameter. When checked, downloaded Windows updates and application update payloads are automatically deleted after the FFU has been successfully captured. The default is **unchecked**.
@@ -711,28 +737,60 @@ During the build process, update files are downloaded to specific locations with
When this option is enabled, the cleanup process removes the entire `KB` folder and the specific update subfolders within the `Apps` directory.
-### When to Enable
+#### When to Enable
You may want to keep Remove Downloaded Update Files enabled in the following scenarios:
-* **Conserving disk space**: Windows Cumulative Updates can be several gigabytes in size, and removing them after a successful build frees up significant storage
-* **Ensuring latest updates**: When you want each build to download the absolute latest available updates rather than potentially reusing older cached versions
+- **Conserving disk space**: Windows Cumulative Updates can be several gigabytes in size, and removing them after a successful build frees up significant storage
+- **Ensuring latest updates**: When you want each build to download the absolute latest available updates rather than potentially reusing older cached versions
-### When to Disable
+#### When to Disable
You may want to disable Remove Downloaded Update Files in the following scenarios:
-* **Multiple builds**: If you're running consecutive builds, keeping the downloaded updates avoids re-downloading large Cumulative Update files each time
-* **Offline builds**: When building in an environment with limited or no internet access, retaining downloaded updates allows reuse across builds
-* **Testing and validation**: When you want to manually inspect the update files that were included in the build
+- **Multiple builds**: If you're running consecutive builds, keeping the downloaded updates avoids re-downloading large Cumulative Update files each time
+- **Offline builds**: When building in an environment with limited or no internet access, retaining downloaded updates allows reuse across builds
+- **Testing and validation**: When you want to manually inspect the update files that were included in the build
{: .note-title}
> Note
>
-> Only the update-specific subfolders are removed-the `Apps` folder itself and other application content (unless **Remove Apps Folder Content** is also selected) are preserved.
+> Only the update-specific subfolders are removed. The `Apps` folder itself and other application content, unless **Remove Apps Folder Content** is also selected, are preserved.
-## Restore Defaults
+### Remove Downloaded ESD file(s)
+
+Controls the `-RemoveDownloadedESD` parameter. When checked, downloaded Windows ESD files are automatically deleted after they have been applied. The default is **checked**.
+
+This setting applies to builds that use downloaded Windows ESD media instead of a provided ISO. When enabled, the build removes the downloaded `.esd` file after it has been used. When disabled, the downloaded `.esd` is kept for reuse on later builds.
+
+#### When to Enable
+
+You may want to keep Remove Downloaded ESD file(s) enabled in the following scenarios:
+
+- **Conserving disk space**: Downloaded ESD files can be large, and removing them after a successful build frees up storage
+- **Ensuring fresh media**: When you want each build to download the latest available ESD for the selected release and version
+- **Single-use builds**: When you do not expect to reuse the same downloaded source media again
+
+#### When to Disable
+
+You may want to disable Remove Downloaded ESD file(s) in the following scenarios:
+
+- **Multiple builds with the same source media**: Keeping the ESD avoids re-downloading it each time
+- **Offline or bandwidth-constrained environments**: Retaining the ESD allows reuse across builds
+- **Troubleshooting source-media issues**: When you want to preserve the downloaded ESD for inspection or repeat testing
+
+{: .note-title}
+
+> Note
+>
+> This option only applies when the build used a downloaded `.esd` file. If you provide a Windows ISO instead, this setting has no effect.
+
+## Build Page Actions
+
+These buttons sit below the Build tab expanders and operate on the overall page state rather than a single expander.
+
+### Restore Defaults
Use this to restore FFU Builder to its default state. When clicked:
@@ -750,7 +808,7 @@ Use this to restore FFU Builder to its default state. When clicked:
>
> If you want to keep any content prior to restoring defaults, copy it out first.
-## Save Config File
+### Save Config File
Saves all current UI selections to a JSON file so you can reload the same settings later or run `BuildFFUVM.ps1` from the command line with `-configFile` (e.g. `BuildFFUVM.ps1 -configFile C:\FFUDevelopment\config\FFUConfig.json`)
@@ -760,7 +818,7 @@ Saves all current UI selections to a JSON file so you can reload the same settin
- Defaults the save location to `FFUDevelopmentPath\config` and suggests `FFUConfig.json` as the file name. You can browse and pick a different file name or folder.
- Creates the `config` folder if it does not exist and confirms the save when finished.
-## Load Config File
+### Load Config File
Loads a previously saved configuration JSON and repopulates the UI.
@@ -771,7 +829,7 @@ Loads a previously saved configuration JSON and repopulates the UI.
- Supplemental files referenced in the config (Winget `AppList.json`, BYO `UserAppList.json`, `Drivers.json`) are also imported if they exist. Missing helper files are treated as optional and noted for you.
- If the file is empty, unreadable, or invalid JSON, the load is stopped and an error message is shown.
-## Build FFU
+### Build FFU
Use **Build FFU** to run `BuildFFUVM.ps1` with the current UI selections.
diff --git a/docs/quickstart.md b/docs/quickstart.md
index c1f5e29..5bd292d 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -207,6 +207,12 @@ Use this option when you want a static device name or a template such as `Comp-%
This option writes `prefixes.txt` from the list in the UI. Enter one prefix per line or import an existing prefixes file. The source file can use any name because the UI tracks the prefixes path separately. If there is one prefix, deployment uses it automatically. If there are multiple prefixes, the technician is prompted to select one and the serial number is appended to that prefix.
+{: .note-title}
+
+> Note
+>
+> If the technician skips prefix selection when multiple prefixes are available, `ApplyFFU.ps1` leaves the existing unattend `ComputerName` value unchanged. With the current unattend samples set to `*`, Windows falls back to its default random computer-name behavior, typically resulting in a name such as `WIN-*`.
+
{: .warning-title}
> Warning
From 82bac17b38fefd2c3a49cdac6d9aaaaff6dc7133 Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Thu, 9 Apr 2026 13:33:37 -0700
Subject: [PATCH 03/10] Adds Prompt option to device naming mode
Introduces an explicit "Prompt" option for device naming to allow technicians to enter the device name during deployment. This replaces the implicit legacy behavior, providing clear UI controls and validation to ensure that Unattend.xml is copied, which is required for prompt-based naming. Relevant documentation is updated to reflect this new workflow capability.
---
FFUDevelopment/BuildFFUVM.ps1 | 21 ++++++++++++++-----
FFUDevelopment/BuildFFUVM_UI.ps1 | 10 ++++++++-
FFUDevelopment/BuildFFUVM_UI.xaml | 1 +
.../FFUUI.Core/FFUUI.Core.Config.psm1 | 5 ++++-
.../FFUUI.Core/FFUUI.Core.Handlers.psm1 | 20 ++++++++++++++----
.../FFUUI.Core/FFUUI.Core.Initialize.psm1 | 1 +
docs/build.md | 15 +++++++++++--
docs/parameters_reference.md | 2 +-
docs/quickstart.md | 8 +++++--
9 files changed, 67 insertions(+), 16 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index bb61540..ba73768 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -73,7 +73,7 @@ When set to $true, will copy the provisioning package from the $FFUDevelopmentPa
When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Default is $false.
.PARAMETER DeviceNamingMode
-Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Supported values are Legacy, None, Template, and Prefixes.
+Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Supported values are Legacy, None, Prompt, Template, and Prefixes.
.PARAMETER DeviceNameTemplate
Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when CopyUnattend is used.
@@ -419,7 +419,7 @@ param(
[bool]$AllowVHDXCaching,
[bool]$CopyPPKG,
[bool]$CopyUnattend,
- [ValidateSet('Legacy', 'None', 'Template', 'Prefixes')]
+ [ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')]
[string]$DeviceNamingMode = 'Legacy',
[string]$DeviceNameTemplate,
[string[]]$DeviceNamePrefixes,
@@ -557,7 +557,7 @@ function Save-StagedUnattendFile {
[Parameter(Mandatory = $true)]
[string]$DestinationPath,
[Parameter(Mandatory = $true)]
- [ValidateSet('Legacy', 'None', 'Template', 'Prefixes')]
+ [ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')]
[string]$DeviceNamingMode,
[string]$DeviceNameTemplate
)
@@ -588,6 +588,9 @@ function Save-StagedUnattendFile {
if ($DeviceNamingMode -eq 'None') {
$computerNameComponent.ComputerName = '*'
}
+ elseif ($DeviceNamingMode -eq 'Prompt') {
+ $computerNameComponent.ComputerName = 'MyComputer'
+ }
elseif ($DeviceNamingMode -eq 'Template') {
$computerNameComponent.ComputerName = $DeviceNameTemplate
}
@@ -638,6 +641,11 @@ if ($DeviceNamingMode -eq 'Template') {
throw 'The %serial% device name variable is only supported when CopyUnattend is used.'
}
}
+elseif ($DeviceNamingMode -eq 'Prompt') {
+ if (-not $CopyUnattend) {
+ throw 'DeviceNamingMode Prompt requires CopyUnattend. Prompt-based naming is not supported with InjectUnattend.'
+ }
+}
elseif ($DeviceNamingMode -eq 'Prefixes') {
if (-not $CopyUnattend) {
throw 'DeviceNamingMode Prefixes requires CopyUnattend. Prefix-based naming is not supported with InjectUnattend.'
@@ -4364,6 +4372,9 @@ Function New-DeploymentUSB {
if ($DeviceNamingMode -eq 'None') {
$computerNameComponent.ComputerName = '*'
}
+ elseif ($DeviceNamingMode -eq 'Prompt') {
+ $computerNameComponent.ComputerName = 'MyComputer'
+ }
elseif ($DeviceNamingMode -eq 'Template') {
$computerNameComponent.ComputerName = $DeviceNameTemplate
}
@@ -5706,10 +5717,10 @@ if ($CopyUnattend) {
throw "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing a .XML file"
}
- if ($DeviceNamingMode -eq 'Prefixes') {
+ if ($DeviceNamingMode -in @('Prompt', 'Prefixes')) {
$unattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
if (-not (Test-UnattendHasComputerNameElement -Path $unattendSourcePath)) {
- throw "DeviceNamingMode Prefixes requires a ComputerName element in $unattendSourcePath"
+ throw "DeviceNamingMode $DeviceNamingMode requires a ComputerName element in $unattendSourcePath"
}
}
diff --git a/FFUDevelopment/BuildFFUVM_UI.ps1 b/FFUDevelopment/BuildFFUVM_UI.ps1
index 90b8e32..b0771cc 100644
--- a/FFUDevelopment/BuildFFUVM_UI.ps1
+++ b/FFUDevelopment/BuildFFUVM_UI.ps1
@@ -439,7 +439,15 @@ $script:uiState.Controls.btnRun.Add_Click({
return
}
- if ($config.DeviceNamingMode -eq 'Template') {
+ if ($config.DeviceNamingMode -eq 'Prompt') {
+ if (-not $config.CopyUnattend) {
+ [System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Prompt for Device Name'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: prompt naming requires Copy Unattend.xml."
+ return
+ }
+ }
+ elseif ($config.DeviceNamingMode -eq 'Template') {
if ([string]::IsNullOrWhiteSpace([string]$config.DeviceNameTemplate)) {
[System.Windows.MessageBox]::Show("Specify a device name before using 'Specify Device Name'.", "Device Name Required", "OK", "Warning") | Out-Null
$btnRun.IsEnabled = $true
diff --git a/FFUDevelopment/BuildFFUVM_UI.xaml b/FFUDevelopment/BuildFFUVM_UI.xaml
index 7ed2603..038e261 100644
--- a/FFUDevelopment/BuildFFUVM_UI.xaml
+++ b/FFUDevelopment/BuildFFUVM_UI.xaml
@@ -910,6 +910,7 @@
+
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
index 1d92654..f31c69f 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
@@ -472,7 +472,10 @@ function Update-UIFromConfig {
if ($ConfigContent.PSObject.Properties.Name -contains 'DeviceNamingMode') {
$deviceNamingMode = [string]$ConfigContent.DeviceNamingMode
}
- if ($deviceNamingMode -notin @('None', 'Template', 'Prefixes')) {
+ if ($deviceNamingMode -eq 'Legacy') {
+ $deviceNamingMode = 'Prompt'
+ }
+ if ($deviceNamingMode -notin @('None', 'Prompt', 'Template', 'Prefixes')) {
$deviceNamingMode = 'None'
}
Set-DeviceNamingMode -State $State -Mode $deviceNamingMode
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
index 5fa99e3..0fe70fc 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
@@ -30,6 +30,10 @@ function Update-VMNetworkingControls {
function Get-SelectedDeviceNamingMode {
param([PSCustomObject]$State)
+ if ($true -eq $State.Controls.rbDeviceNamingPrompt.IsChecked) {
+ return 'Prompt'
+ }
+
if ($true -eq $State.Controls.rbDeviceNamingTemplate.IsChecked) {
return 'Template'
}
@@ -44,11 +48,12 @@ function Get-SelectedDeviceNamingMode {
function Set-DeviceNamingMode {
param(
[PSCustomObject]$State,
- [ValidateSet('None', 'Template', 'Prefixes')]
+ [ValidateSet('None', 'Prompt', 'Template', 'Prefixes')]
[string]$Mode
)
$State.Controls.rbDeviceNamingNone.IsChecked = $Mode -eq 'None'
+ $State.Controls.rbDeviceNamingPrompt.IsChecked = $Mode -eq 'Prompt'
$State.Controls.rbDeviceNamingTemplate.IsChecked = $Mode -eq 'Template'
$State.Controls.rbDeviceNamingPrefixes.IsChecked = $Mode -eq 'Prefixes'
}
@@ -132,9 +137,10 @@ function Update-UnattendSelectionControls {
$isCopyUnattendSelected = $true -eq $State.Controls.chkCopyUnattend.IsChecked
$isInjectUnattendSelected = $true -eq $State.Controls.chkInjectUnattend.IsChecked
$deviceNameTemplateUsesSerialToken = Test-DeviceNameTemplateUsesSerialToken -State $State
+ $requiresCopiedUnattend = ($selectedDeviceNamingMode -in @('Prompt', 'Prefixes')) -or $deviceNameTemplateUsesSerialToken
if ($isCopyUnattendSelected -and $isInjectUnattendSelected) {
- if (($selectedDeviceNamingMode -eq 'Prefixes') -or $deviceNameTemplateUsesSerialToken) {
+ if ($requiresCopiedUnattend) {
$State.Controls.chkInjectUnattend.IsChecked = $false
$isInjectUnattendSelected = $false
}
@@ -144,7 +150,7 @@ function Update-UnattendSelectionControls {
}
}
- if (($selectedDeviceNamingMode -eq 'Prefixes') -or $deviceNameTemplateUsesSerialToken) {
+ if ($requiresCopiedUnattend) {
if (-not $isCopyUnattendSelected) {
$State.Controls.chkCopyUnattend.IsChecked = $true
$isCopyUnattendSelected = $true
@@ -177,13 +183,14 @@ function Update-UnattendSelectionControls {
function Update-DeviceNamingControls {
param([PSCustomObject]$State)
- if (($true -eq $State.Controls.chkInjectUnattend.IsChecked) -and ($true -eq $State.Controls.rbDeviceNamingPrefixes.IsChecked)) {
+ if (($true -eq $State.Controls.chkInjectUnattend.IsChecked) -and (($true -eq $State.Controls.rbDeviceNamingPrompt.IsChecked) -or ($true -eq $State.Controls.rbDeviceNamingPrefixes.IsChecked))) {
$State.Controls.rbDeviceNamingNone.IsChecked = $true
}
$selectedDeviceNamingMode = Get-SelectedDeviceNamingMode -State $State
$State.Controls.deviceNameTemplatePanel.Visibility = if ($selectedDeviceNamingMode -eq 'Template') { 'Visible' } else { 'Collapsed' }
$State.Controls.deviceNamePrefixesPanel.Visibility = if ($selectedDeviceNamingMode -eq 'Prefixes') { 'Visible' } else { 'Collapsed' }
+ $State.Controls.rbDeviceNamingPrompt.IsEnabled = -not ($true -eq $State.Controls.chkInjectUnattend.IsChecked)
$State.Controls.rbDeviceNamingPrefixes.IsEnabled = -not ($true -eq $State.Controls.chkInjectUnattend.IsChecked)
if ($selectedDeviceNamingMode -eq 'Prefixes') {
@@ -435,6 +442,11 @@ function Register-EventHandlers {
$window = [System.Windows.Window]::GetWindow($eventSource)
Update-DeviceNamingControls -State $window.Tag
})
+ $State.Controls.rbDeviceNamingPrompt.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ Update-DeviceNamingControls -State $window.Tag
+ })
$State.Controls.rbDeviceNamingTemplate.Add_Checked({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
index e84e1f5..62cac40 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
@@ -221,6 +221,7 @@ function Initialize-UIControls {
$State.Controls.chkCreateDeploymentMedia = $window.FindName('chkCreateDeploymentMedia')
$State.Controls.chkInjectUnattend = $window.FindName('chkInjectUnattend')
$State.Controls.rbDeviceNamingNone = $window.FindName('rbDeviceNamingNone')
+ $State.Controls.rbDeviceNamingPrompt = $window.FindName('rbDeviceNamingPrompt')
$State.Controls.rbDeviceNamingTemplate = $window.FindName('rbDeviceNamingTemplate')
$State.Controls.rbDeviceNamingPrefixes = $window.FindName('rbDeviceNamingPrefixes')
$State.Controls.deviceNameTemplatePanel = $window.FindName('deviceNameTemplatePanel')
diff --git a/docs/build.md b/docs/build.md
index abaad01..3c5849a 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -363,6 +363,17 @@ Use the **Device Naming** expander to decide whether `ComputerName` should be se
This is the default option. The unattend file is still applied, but Windows generates a random computer name instead of forcing a prompt or a fixed name.
+The active `unattend_*.xml` files in `FFUDevelopment\Unattend` use `*` for this default behavior.
+
+### Prompt for Device Name
+
+Use this option when you want the technician to enter the computer name during deployment.
+
+- This option requires **Copy Unattend.xml**.
+- The source `unattend_*.xml` files can stay at `*`.
+- During the build, FFU Builder rewrites only the staged deployment copy of `Unattend.xml` to the legacy prompt placeholder that `ApplyFFU.ps1` already recognizes.
+- **Inject Unattend.xml** is not supported with this option.
+
### Specify Device Name
Use this option when you want a static device name or a template such as `Comp-%serial%`.
@@ -399,9 +410,9 @@ Use **Prefixes File Path** to point the UI at the source text file for the prefi
Use **Save Prefixes** to write the current multiline prefixes list back to the file specified in **Prefixes File Path**.
-### Legacy Prompt Behavior
+### Deployment Prompt Compatibility
-Older deployment media that still has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
+Older deployment media that already has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
{: .warning-title}
diff --git a/docs/parameters_reference.md b/docs/parameters_reference.md
index 67912f0..661c20b 100644
--- a/docs/parameters_reference.md
+++ b/docs/parameters_reference.md
@@ -41,7 +41,7 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Cannot be used together with -InjectUnattend. Default is $false. |
| -CreateDeploymentMedia | bool | Create Deployment Media | When set to $true, this will create WinPE deployment media for use when deploying to a physical device. |
| -CustomFFUNameTemplate | string | Custom FFU Name Template | Sets a custom FFU output name with placeholders. Allowed placeholders are: {WindowsRelease}, {WindowsVersion}, {SKU}, {BuildDate}, {yyyy}, {MM}, {dd}, {H}, {hh}, {mm}, {tt}. |
-| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Template, and Prefixes. The UI uses None, Template, and Prefixes. |
+| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Prompt, Template, and Prefixes. The UI uses None, Prompt, Template, and Prefixes. Prompt rewrites the staged deployment unattend to the existing manual prompt placeholder and requires -CopyUnattend. |
| -DeviceNameTemplate | string | Specify Device Name | Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when -CopyUnattend is used. |
| -DeviceNamePrefixesPath | string | Prefixes File Path | Path to the source prefixes file used for legacy copy or when -DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt. |
| -DeviceNamePrefixes | string[] | Specify a list of Prefixes | Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a line in prefixes.txt on the deployment media. |
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 5bd292d..8ed8fe7 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -286,18 +286,22 @@ And the Unattend folder should have an unattend.xml file with the following cont
- MyComputer
+ *
```
+Keep `*` if you want Windows to generate a random device name by default.
+
+If you want the technician to be prompted for the device name during deployment, select **Prompt for Device Name** in the Build tab and enable **Copy Unattend.xml**. FFU Builder will rewrite only the staged deployment copy of `Unattend.xml` for that workflow.
+
Now you're ready to deploy the FFU to your device.
## Deployment
-Deployment should be fairly straight forward: boot off the USB device, get prompted for a device name, and the deployment of the FFU and drivers should happen automatically.
+Deployment should be fairly straight forward: boot off the USB device and the deployment of the FFU and drivers should happen automatically. If you selected **Prompt for Device Name** or another supported device naming option, that naming step will happen during deployment.
If you have any questions or run into any issues, [open a discussion in the Github repo](https://github.com/rbalsleyMSFT/FFU/discussions).
From f1f1957c4352ee397683ad580066b223b0850ebd Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Thu, 9 Apr 2026 15:14:00 -0700
Subject: [PATCH 04/10] Auto-generate ComputerName in Unattend XML
Replaces the strict validation for an existing ComputerName element with dynamic XML initialization. Automatically creates the specialize settings block, the Microsoft-Windows-Shell-Setup component, and the ComputerName element if they are missing from the provided Unattend XML file. This improves script robustness and simplifies the requirements for custom unattended setup templates by patching in the necessary device naming structure on the fly.
---
FFUDevelopment/BuildFFUVM.ps1 | 272 ++++++++++++++++++++++++++--------
1 file changed, 213 insertions(+), 59 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index ba73768..dfe1b92 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -534,20 +534,79 @@ function Get-UnattendSourcePath {
return Join-Path $UnattendFolder "unattend_$archSuffix.xml"
}
-function Test-UnattendHasComputerNameElement {
+function Initialize-UnattendComputerNamePath {
param(
[Parameter(Mandatory = $true)]
- [string]$Path
+ [xml]$UnattendXml,
+ [Parameter(Mandatory = $true)]
+ [string]$WindowsArch
)
- [xml]$unattendXml = Get-Content -Path $Path
- foreach ($component in $unattendXml.unattend.settings.component) {
- if ($component.ComputerName) {
- return $true
- }
+ $unattendRoot = $UnattendXml.DocumentElement
+ if (($null -eq $unattendRoot) -or ($unattendRoot.LocalName -ne 'unattend')) {
+ throw 'Unattend XML is missing the unattend root element.'
}
- return $false
+ $unattendNamespace = $unattendRoot.NamespaceURI
+ if ([string]::IsNullOrWhiteSpace($unattendNamespace)) {
+ throw 'Unattend XML is missing the default unattend namespace.'
+ }
+
+ $namespaceManager = New-Object System.Xml.XmlNamespaceManager($UnattendXml.NameTable)
+ $namespaceManager.AddNamespace('un', $unattendNamespace)
+
+ $specializeSettings = $unattendRoot.SelectSingleNode("un:settings[@pass='specialize']", $namespaceManager)
+ $createdSpecializeSettings = $false
+ if ($null -eq $specializeSettings) {
+ $specializeSettings = $UnattendXml.CreateElement('settings', $unattendNamespace)
+ $null = $specializeSettings.SetAttribute('pass', 'specialize')
+ $firstSettingsNode = $unattendRoot.SelectSingleNode('un:settings', $namespaceManager)
+ if ($null -ne $firstSettingsNode) {
+ $null = $unattendRoot.InsertBefore($specializeSettings, $firstSettingsNode)
+ }
+ else {
+ $null = $unattendRoot.AppendChild($specializeSettings)
+ }
+ $createdSpecializeSettings = $true
+ }
+
+ $shellSetupComponent = $specializeSettings.SelectSingleNode("un:component[@name='Microsoft-Windows-Shell-Setup']", $namespaceManager)
+ $createdShellSetupComponent = $false
+ if ($null -eq $shellSetupComponent) {
+ $processorArchitecture = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'amd64' }
+ $shellSetupComponent = $UnattendXml.CreateElement('component', $unattendNamespace)
+ $null = $shellSetupComponent.SetAttribute('name', 'Microsoft-Windows-Shell-Setup')
+ $null = $shellSetupComponent.SetAttribute('processorArchitecture', $processorArchitecture)
+ $null = $shellSetupComponent.SetAttribute('publicKeyToken', '31bf3856ad364e35')
+ $null = $shellSetupComponent.SetAttribute('language', 'neutral')
+ $null = $shellSetupComponent.SetAttribute('versionScope', 'nonSxS')
+ $null = $shellSetupComponent.SetAttribute('xmlns:wcm', 'http://www.w3.org/2000/xmlns/', 'http://schemas.microsoft.com/WMIConfig/2002/State')
+ $null = $shellSetupComponent.SetAttribute('xmlns:xsi', 'http://www.w3.org/2000/xmlns/', 'http://www.w3.org/2001/XMLSchema-instance')
+
+ $firstComponentNode = $specializeSettings.SelectSingleNode('un:component', $namespaceManager)
+ if ($null -ne $firstComponentNode) {
+ $null = $specializeSettings.InsertBefore($shellSetupComponent, $firstComponentNode)
+ }
+ else {
+ $null = $specializeSettings.AppendChild($shellSetupComponent)
+ }
+ $createdShellSetupComponent = $true
+ }
+
+ $computerNameElement = $shellSetupComponent.SelectSingleNode('un:ComputerName', $namespaceManager)
+ $createdComputerNameElement = $false
+ if ($null -eq $computerNameElement) {
+ $computerNameElement = $UnattendXml.CreateElement('ComputerName', $unattendNamespace)
+ $null = $shellSetupComponent.AppendChild($computerNameElement)
+ $createdComputerNameElement = $true
+ }
+
+ return [PSCustomObject]@{
+ ComputerNameElement = $computerNameElement
+ CreatedSpecializeSettings = $createdSpecializeSettings
+ CreatedShellSetupComponent = $createdShellSetupComponent
+ CreatedComputerNameElement = $createdComputerNameElement
+ }
}
function Save-StagedUnattendFile {
@@ -559,40 +618,47 @@ function Save-StagedUnattendFile {
[Parameter(Mandatory = $true)]
[ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')]
[string]$DeviceNamingMode,
- [string]$DeviceNameTemplate
+ [string]$DeviceNameTemplate,
+ [Parameter(Mandatory = $true)]
+ [string]$WindowsArch,
+ [bool]$LegacyPrefixesWillBeStaged = $false
)
- if ($DeviceNamingMode -in @('Legacy', 'Prefixes')) {
+ if ($DeviceNamingMode -eq 'None') {
Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
return
}
[xml]$unattendXml = Get-Content -Path $SourcePath
- $computerNameComponent = $null
- foreach ($component in $unattendXml.unattend.settings.component) {
- if ($component.ComputerName) {
- $computerNameComponent = $component
- break
+ $computerNamePath = Initialize-UnattendComputerNamePath -UnattendXml $unattendXml -WindowsArch $WindowsArch
+
+ if ($computerNamePath.CreatedSpecializeSettings -or $computerNamePath.CreatedShellSetupComponent -or $computerNamePath.CreatedComputerNameElement) {
+ $createdParts = @()
+ if ($computerNamePath.CreatedSpecializeSettings) {
+ $createdParts += 'specialize settings'
}
- }
-
- if ($null -eq $computerNameComponent) {
- if ($DeviceNamingMode -eq 'None') {
- Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
- return
+ if ($computerNamePath.CreatedShellSetupComponent) {
+ $createdParts += 'Microsoft-Windows-Shell-Setup component'
}
-
- throw "ComputerName element not found in unattend source file: $SourcePath"
+ if ($computerNamePath.CreatedComputerNameElement) {
+ $createdParts += 'ComputerName element'
+ }
+ WriteLog "Created $($createdParts -join ', ') while staging unattend file $DestinationPath"
}
- if ($DeviceNamingMode -eq 'None') {
- $computerNameComponent.ComputerName = '*'
- }
- elseif ($DeviceNamingMode -eq 'Prompt') {
- $computerNameComponent.ComputerName = 'MyComputer'
+ if ($DeviceNamingMode -eq 'Prompt') {
+ $computerNamePath.ComputerNameElement.InnerText = 'MyComputer'
}
elseif ($DeviceNamingMode -eq 'Template') {
- $computerNameComponent.ComputerName = $DeviceNameTemplate
+ $computerNamePath.ComputerNameElement.InnerText = $DeviceNameTemplate
+ }
+ elseif ($DeviceNamingMode -eq 'Prefixes') {
+ if ($computerNamePath.CreatedComputerNameElement) {
+ $computerNamePath.ComputerNameElement.InnerText = '*'
+ }
+ }
+ elseif (($DeviceNamingMode -eq 'Legacy') -and $computerNamePath.CreatedComputerNameElement) {
+ $computerNamePath.ComputerNameElement.InnerText = if ($LegacyPrefixesWillBeStaged) { '*' } else { 'MyComputer' }
}
$unattendXml.Save($DestinationPath)
@@ -4338,45 +4404,124 @@ Function New-DeploymentUSB {
return Join-Path $UnattendFolder "unattend_$archSuffix.xml"
}
+ function Initialize-UnattendComputerNamePath {
+ param(
+ [xml]$UnattendXml,
+ [string]$WindowsArch
+ )
+
+ $unattendRoot = $UnattendXml.DocumentElement
+ if (($null -eq $unattendRoot) -or ($unattendRoot.LocalName -ne 'unattend')) {
+ throw 'Unattend XML is missing the unattend root element.'
+ }
+
+ $unattendNamespace = $unattendRoot.NamespaceURI
+ if ([string]::IsNullOrWhiteSpace($unattendNamespace)) {
+ throw 'Unattend XML is missing the default unattend namespace.'
+ }
+
+ $namespaceManager = New-Object System.Xml.XmlNamespaceManager($UnattendXml.NameTable)
+ $namespaceManager.AddNamespace('un', $unattendNamespace)
+
+ $specializeSettings = $unattendRoot.SelectSingleNode("un:settings[@pass='specialize']", $namespaceManager)
+ $createdSpecializeSettings = $false
+ if ($null -eq $specializeSettings) {
+ $specializeSettings = $UnattendXml.CreateElement('settings', $unattendNamespace)
+ $null = $specializeSettings.SetAttribute('pass', 'specialize')
+ $firstSettingsNode = $unattendRoot.SelectSingleNode('un:settings', $namespaceManager)
+ if ($null -ne $firstSettingsNode) {
+ $null = $unattendRoot.InsertBefore($specializeSettings, $firstSettingsNode)
+ }
+ else {
+ $null = $unattendRoot.AppendChild($specializeSettings)
+ }
+ $createdSpecializeSettings = $true
+ }
+
+ $shellSetupComponent = $specializeSettings.SelectSingleNode("un:component[@name='Microsoft-Windows-Shell-Setup']", $namespaceManager)
+ $createdShellSetupComponent = $false
+ if ($null -eq $shellSetupComponent) {
+ $processorArchitecture = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'amd64' }
+ $shellSetupComponent = $UnattendXml.CreateElement('component', $unattendNamespace)
+ $null = $shellSetupComponent.SetAttribute('name', 'Microsoft-Windows-Shell-Setup')
+ $null = $shellSetupComponent.SetAttribute('processorArchitecture', $processorArchitecture)
+ $null = $shellSetupComponent.SetAttribute('publicKeyToken', '31bf3856ad364e35')
+ $null = $shellSetupComponent.SetAttribute('language', 'neutral')
+ $null = $shellSetupComponent.SetAttribute('versionScope', 'nonSxS')
+ $null = $shellSetupComponent.SetAttribute('xmlns:wcm', 'http://www.w3.org/2000/xmlns/', 'http://schemas.microsoft.com/WMIConfig/2002/State')
+ $null = $shellSetupComponent.SetAttribute('xmlns:xsi', 'http://www.w3.org/2000/xmlns/', 'http://www.w3.org/2001/XMLSchema-instance')
+
+ $firstComponentNode = $specializeSettings.SelectSingleNode('un:component', $namespaceManager)
+ if ($null -ne $firstComponentNode) {
+ $null = $specializeSettings.InsertBefore($shellSetupComponent, $firstComponentNode)
+ }
+ else {
+ $null = $specializeSettings.AppendChild($shellSetupComponent)
+ }
+ $createdShellSetupComponent = $true
+ }
+
+ $computerNameElement = $shellSetupComponent.SelectSingleNode('un:ComputerName', $namespaceManager)
+ $createdComputerNameElement = $false
+ if ($null -eq $computerNameElement) {
+ $computerNameElement = $UnattendXml.CreateElement('ComputerName', $unattendNamespace)
+ $null = $shellSetupComponent.AppendChild($computerNameElement)
+ $createdComputerNameElement = $true
+ }
+
+ return [PSCustomObject]@{
+ ComputerNameElement = $computerNameElement
+ CreatedSpecializeSettings = $createdSpecializeSettings
+ CreatedShellSetupComponent = $createdShellSetupComponent
+ CreatedComputerNameElement = $createdComputerNameElement
+ }
+ }
+
function Save-LocalStagedUnattendFile {
param(
[string]$SourcePath,
[string]$DestinationPath,
[string]$DeviceNamingMode,
- [string]$DeviceNameTemplate
+ [string]$DeviceNameTemplate,
+ [string]$WindowsArch,
+ [bool]$LegacyPrefixesWillBeStaged = $false
)
- if ($DeviceNamingMode -in @('Legacy', 'Prefixes')) {
+ if ($DeviceNamingMode -eq 'None') {
Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
return
}
[xml]$unattendXml = Get-Content -Path $SourcePath
- $computerNameComponent = $null
- foreach ($component in $unattendXml.unattend.settings.component) {
- if ($component.ComputerName) {
- $computerNameComponent = $component
- break
+ $computerNamePath = Initialize-UnattendComputerNamePath -UnattendXml $unattendXml -WindowsArch $WindowsArch
+
+ if ($computerNamePath.CreatedSpecializeSettings -or $computerNamePath.CreatedShellSetupComponent -or $computerNamePath.CreatedComputerNameElement) {
+ $createdParts = @()
+ if ($computerNamePath.CreatedSpecializeSettings) {
+ $createdParts += 'specialize settings'
}
- }
-
- if ($null -eq $computerNameComponent) {
- if ($DeviceNamingMode -eq 'None') {
- Copy-Item -Path $SourcePath -Destination $DestinationPath -Force | Out-Null
- return
+ if ($computerNamePath.CreatedShellSetupComponent) {
+ $createdParts += 'Microsoft-Windows-Shell-Setup component'
}
-
- throw "ComputerName element not found in unattend source file: $SourcePath"
+ if ($computerNamePath.CreatedComputerNameElement) {
+ $createdParts += 'ComputerName element'
+ }
+ WriteLog "Created $($createdParts -join ', ') while staging unattend file $DestinationPath"
}
- if ($DeviceNamingMode -eq 'None') {
- $computerNameComponent.ComputerName = '*'
- }
- elseif ($DeviceNamingMode -eq 'Prompt') {
- $computerNameComponent.ComputerName = 'MyComputer'
+ if ($DeviceNamingMode -eq 'Prompt') {
+ $computerNamePath.ComputerNameElement.InnerText = 'MyComputer'
}
elseif ($DeviceNamingMode -eq 'Template') {
- $computerNameComponent.ComputerName = $DeviceNameTemplate
+ $computerNamePath.ComputerNameElement.InnerText = $DeviceNameTemplate
+ }
+ elseif ($DeviceNamingMode -eq 'Prefixes') {
+ if ($computerNamePath.CreatedComputerNameElement) {
+ $computerNamePath.ComputerNameElement.InnerText = '*'
+ }
+ }
+ elseif (($DeviceNamingMode -eq 'Legacy') -and $computerNamePath.CreatedComputerNameElement) {
+ $computerNamePath.ComputerNameElement.InnerText = if ($LegacyPrefixesWillBeStaged) { '*' } else { 'MyComputer' }
}
$unattendXml.Save($DestinationPath)
@@ -4443,12 +4588,13 @@ Function New-DeploymentUSB {
WriteLog "Copying unattend file to $UnattendPathOnUSB"
New-Item -Path $UnattendPathOnUSB -ItemType Directory -ErrorAction SilentlyContinue | Out-Null
$unattendSource = Get-LocalUnattendSourcePath -UnattendFolder $using:UnattendFolder -WindowsArch $using:WindowsArch
- Save-LocalStagedUnattendFile -SourcePath $unattendSource -DestinationPath (Join-Path $UnattendPathOnUSB 'Unattend.xml') -DeviceNamingMode $using:DeviceNamingMode -DeviceNameTemplate $using:normalizedDeviceNameTemplate
+ $legacyPrefixesWillBeStaged = ($using:DeviceNamingMode -eq 'Legacy') -and (Test-Path -Path $using:resolvedDeviceNamePrefixesPath -PathType Leaf)
+ Save-LocalStagedUnattendFile -SourcePath $unattendSource -DestinationPath (Join-Path $UnattendPathOnUSB 'Unattend.xml') -DeviceNamingMode $using:DeviceNamingMode -DeviceNameTemplate $using:normalizedDeviceNameTemplate -WindowsArch $using:WindowsArch -LegacyPrefixesWillBeStaged $legacyPrefixesWillBeStaged
if ($using:DeviceNamingMode -eq 'Prefixes') {
WriteLog "Writing prefixes.txt file to $UnattendPathOnUSB"
$using:effectiveDeviceNamePrefixes | Set-Content -Path (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Encoding UTF8
}
- elseif (($using:DeviceNamingMode -eq 'Legacy') -and (Test-Path -Path $using:resolvedDeviceNamePrefixesPath -PathType Leaf)) {
+ elseif ($legacyPrefixesWillBeStaged) {
WriteLog "Copying prefixes.txt file to $UnattendPathOnUSB"
Copy-Item -Path $using:resolvedDeviceNamePrefixesPath -Destination (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Force | Out-Null
}
@@ -5717,21 +5863,29 @@ if ($CopyUnattend) {
throw "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing a .XML file"
}
- if ($DeviceNamingMode -in @('Prompt', 'Prefixes')) {
+ if ($DeviceNamingMode -ne 'None') {
$unattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
- if (-not (Test-UnattendHasComputerNameElement -Path $unattendSourcePath)) {
- throw "DeviceNamingMode $DeviceNamingMode requires a ComputerName element in $unattendSourcePath"
+ try {
+ [xml]$validationUnattendXml = Get-Content -Path $unattendSourcePath
+ $null = Initialize-UnattendComputerNamePath -UnattendXml $validationUnattendXml -WindowsArch $WindowsArch
+ }
+ catch {
+ throw "DeviceNamingMode $DeviceNamingMode requires a valid specialize/Microsoft-Windows-Shell-Setup/ComputerName path in $unattendSourcePath. $($_.Exception.Message)"
}
}
WriteLog 'Unattend validation complete'
}
-if ($InjectUnattend -and $DeviceNamingMode -eq 'Template') {
+if ($InjectUnattend -and ($DeviceNamingMode -ne 'None')) {
$injectUnattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
if (Test-Path -Path $injectUnattendSourcePath -PathType Leaf) {
- if (-not (Test-UnattendHasComputerNameElement -Path $injectUnattendSourcePath)) {
- throw "DeviceNamingMode Template requires a ComputerName element in $injectUnattendSourcePath"
+ try {
+ [xml]$validationUnattendXml = Get-Content -Path $injectUnattendSourcePath
+ $null = Initialize-UnattendComputerNamePath -UnattendXml $validationUnattendXml -WindowsArch $WindowsArch
+ }
+ catch {
+ throw "DeviceNamingMode $DeviceNamingMode requires a valid specialize/Microsoft-Windows-Shell-Setup/ComputerName path in $injectUnattendSourcePath. $($_.Exception.Message)"
}
}
}
@@ -6644,7 +6798,7 @@ if ($InstallApps) {
# Copy if source exists; otherwise log and skip
if (Test-Path -Path $unattendSource -PathType Leaf) {
$destination = Join-Path $targetFolder 'Unattend.xml'
- Save-StagedUnattendFile -SourcePath $unattendSource -DestinationPath $destination -DeviceNamingMode $DeviceNamingMode -DeviceNameTemplate $normalizedDeviceNameTemplate
+ Save-StagedUnattendFile -SourcePath $unattendSource -DestinationPath $destination -DeviceNamingMode $DeviceNamingMode -DeviceNameTemplate $normalizedDeviceNameTemplate -WindowsArch $WindowsArch
WriteLog "Injected unattend file into Apps: $unattendSource -> $destination"
}
else {
From 7bd5decc627a925527b0b8ba9559d73bddcb0f76 Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Thu, 9 Apr 2026 16:44:39 -0700
Subject: [PATCH 05/10] Adds custom unattend XML file selection paths
Adds parameters for x64 and arm64 unattend XML file paths.
Updates the BuildFFUVM_UI to let the user pick specific XML files to copy or inject instead of requiring them to exist in the `unattend` folder.
Adds validation to ensure the selected unattend XML files are not empty.
Updates documentation to reflect the new functionality.
---
FFUDevelopment/BuildFFUVM.ps1 | 105 ++++++++++++------
FFUDevelopment/BuildFFUVM_UI.ps1 | 32 ++++++
FFUDevelopment/BuildFFUVM_UI.xaml | 49 ++++++--
.../FFUUI.Core/FFUUI.Core.Config.psm1 | 12 ++
.../FFUUI.Core/FFUUI.Core.Handlers.psm1 | 67 +++++++++++
.../FFUUI.Core/FFUUI.Core.Initialize.psm1 | 6 +
FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1 | 4 +
FFUDevelopment/config/Sample_default.json | Bin 6506 -> 6826 bytes
docs/build.md | 34 ++++--
docs/parameters_reference.md | 6 +-
10 files changed, 258 insertions(+), 57 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index dfe1b92..305f56c 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -70,7 +70,7 @@ When set to $true, enables adding WinPE drivers. By default copies drivers from
When set to $true, will copy the provisioning package from the $FFUDevelopmentPath\PPKG folder to the Deployment partition of the USB drive. Default is $false.
.PARAMETER CopyUnattend
-When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Default is $false.
+When set to $true, stages the selected architecture-specific unattend XML file as Unattend.xml on the deployment partition of the USB drive. Default is $false.
.PARAMETER DeviceNamingMode
Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Supported values are Legacy, None, Prompt, Template, and Prefixes.
@@ -84,6 +84,12 @@ Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a l
.PARAMETER DeviceNamePrefixesPath
Path to the source prefixes file used for legacy copy or when DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt.
+.PARAMETER UnattendX64FilePath
+Path to the x64 unattend XML source file. Default is $FFUDevelopmentPath\Unattend\unattend_x64.xml.
+
+.PARAMETER UnattendArm64FilePath
+Path to the arm64 unattend XML source file. Default is $FFUDevelopmentPath\Unattend\unattend_arm64.xml.
+
.PARAMETER CreateDeploymentMedia
When set to $true, this will create WinPE deployment media for use when deploying to a physical device.
@@ -118,7 +124,7 @@ Prefix for the generated FFU file. Default is _FFU.
Headers to use when downloading files. Not recommended to modify.
.PARAMETER InjectUnattend
-When set to $true and InstallApps is also $true, copies unattend_[arch].xml from $FFUDevelopmentPath\unattend to $FFUDevelopmentPath\Apps\Unattend\Unattend.xml so sysprep can use it inside the VM. Default is $false.
+When set to $true and InstallApps is also $true, stages the selected architecture-specific unattend XML file to $FFUDevelopmentPath\Apps\Unattend\Unattend.xml so sysprep can use it inside the VM. Default is $false.
.PARAMETER InstallApps
When set to $true, the script will create an Apps.iso file from the $FFUDevelopmentPath\Apps folder. It will also create a VM, mount the Apps.iso, install the apps, sysprep, and capture the VM. When set to $false, the FFU is created from a VHDX file, and no VM is created.
@@ -424,6 +430,8 @@ param(
[string]$DeviceNameTemplate,
[string[]]$DeviceNamePrefixes,
[string]$DeviceNamePrefixesPath,
+ [string]$UnattendX64FilePath,
+ [string]$UnattendArm64FilePath,
[bool]$CopyAutopilot,
[bool]$CompactOS = $true,
[bool]$CleanupDeployISO = $true,
@@ -527,11 +535,31 @@ function Get-UnattendSourcePath {
[Parameter(Mandatory = $true)]
[string]$UnattendFolder,
[Parameter(Mandatory = $true)]
- [string]$WindowsArch
+ [string]$WindowsArch,
+ [string]$UnattendX64FilePath,
+ [string]$UnattendArm64FilePath
)
- $archSuffix = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
- return Join-Path $UnattendFolder "unattend_$archSuffix.xml"
+ $resolvedArch = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
+ $resolvedSourcePath = if ($resolvedArch -eq 'arm64') {
+ if ([string]::IsNullOrWhiteSpace($UnattendArm64FilePath)) {
+ Join-Path $UnattendFolder 'unattend_arm64.xml'
+ }
+ else {
+ $UnattendArm64FilePath
+ }
+ }
+ else {
+ if ([string]::IsNullOrWhiteSpace($UnattendX64FilePath)) {
+ Join-Path $UnattendFolder 'unattend_x64.xml'
+ }
+ else {
+ $UnattendX64FilePath
+ }
+ }
+
+ WriteLog "Resolved unattend source path for ${resolvedArch}: $resolvedSourcePath"
+ return $resolvedSourcePath
}
function Initialize-UnattendComputerNamePath {
@@ -915,6 +943,8 @@ if (-not $EdgePath) { $EdgePath = "$AppsPath\Edge" }
if (-not $DriversFolder) { $DriversFolder = "$FFUDevelopmentPath\Drivers" }
if (-not $PPKGFolder) { $PPKGFolder = "$FFUDevelopmentPath\PPKG" }
if (-not $UnattendFolder) { $UnattendFolder = "$FFUDevelopmentPath\Unattend" }
+if ([string]::IsNullOrWhiteSpace($UnattendX64FilePath)) { $UnattendX64FilePath = Join-Path $UnattendFolder 'unattend_x64.xml' }
+if ([string]::IsNullOrWhiteSpace($UnattendArm64FilePath)) { $UnattendArm64FilePath = Join-Path $UnattendFolder 'unattend_arm64.xml' }
if (-not $AutopilotFolder) { $AutopilotFolder = "$FFUDevelopmentPath\Autopilot" }
if (-not $PEDriversFolder) { $PEDriversFolder = "$FFUDevelopmentPath\PEDrivers" }
if (-not $VHDXCacheFolder) { $VHDXCacheFolder = "$FFUDevelopmentPath\VHDXCache" }
@@ -4397,11 +4427,31 @@ Function New-DeploymentUSB {
function Get-LocalUnattendSourcePath {
param(
[string]$UnattendFolder,
- [string]$WindowsArch
+ [string]$WindowsArch,
+ [string]$UnattendX64FilePath,
+ [string]$UnattendArm64FilePath
)
- $archSuffix = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
- return Join-Path $UnattendFolder "unattend_$archSuffix.xml"
+ $resolvedArch = if ($WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
+ $resolvedSourcePath = if ($resolvedArch -eq 'arm64') {
+ if ([string]::IsNullOrWhiteSpace($UnattendArm64FilePath)) {
+ Join-Path $UnattendFolder 'unattend_arm64.xml'
+ }
+ else {
+ $UnattendArm64FilePath
+ }
+ }
+ else {
+ if ([string]::IsNullOrWhiteSpace($UnattendX64FilePath)) {
+ Join-Path $UnattendFolder 'unattend_x64.xml'
+ }
+ else {
+ $UnattendX64FilePath
+ }
+ }
+
+ WriteLog "Resolved unattend source path for ${resolvedArch}: $resolvedSourcePath"
+ return $resolvedSourcePath
}
function Initialize-UnattendComputerNamePath {
@@ -4587,7 +4637,7 @@ Function New-DeploymentUSB {
$UnattendPathOnUSB = Join-Path $DeployPartitionDriveLetter "Unattend"
WriteLog "Copying unattend file to $UnattendPathOnUSB"
New-Item -Path $UnattendPathOnUSB -ItemType Directory -ErrorAction SilentlyContinue | Out-Null
- $unattendSource = Get-LocalUnattendSourcePath -UnattendFolder $using:UnattendFolder -WindowsArch $using:WindowsArch
+ $unattendSource = Get-LocalUnattendSourcePath -UnattendFolder $using:UnattendFolder -WindowsArch $using:WindowsArch -UnattendX64FilePath $using:UnattendX64FilePath -UnattendArm64FilePath $using:UnattendArm64FilePath
$legacyPrefixesWillBeStaged = ($using:DeviceNamingMode -eq 'Legacy') -and (Test-Path -Path $using:resolvedDeviceNamePrefixesPath -PathType Leaf)
Save-LocalStagedUnattendFile -SourcePath $unattendSource -DestinationPath (Join-Path $UnattendPathOnUSB 'Unattend.xml') -DeviceNamingMode $using:DeviceNamingMode -DeviceNameTemplate $using:normalizedDeviceNameTemplate -WindowsArch $using:WindowsArch -LegacyPrefixesWillBeStaged $legacyPrefixesWillBeStaged
if ($using:DeviceNamingMode -eq 'Prefixes') {
@@ -5850,21 +5900,23 @@ if ($CopyAutopilot) {
WriteLog 'Autopilot validation complete'
}
-#Validate Unattend folder
-if ($CopyUnattend) {
+# Validate unattend source file
+if ($CopyUnattend -or $InjectUnattend) {
WriteLog 'Doing Unattend validation'
- if (!(Test-Path -Path $UnattendFolder)) {
- WriteLog "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing"
- throw "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing"
+ $selectedUnattendMode = if ($CopyUnattend) { 'CopyUnattend' } else { 'InjectUnattend' }
+ $unattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch -UnattendX64FilePath $UnattendX64FilePath -UnattendArm64FilePath $UnattendArm64FilePath
+ if (!(Test-Path -Path $unattendSourcePath -PathType Leaf)) {
+ WriteLog "-$selectedUnattendMode is set to `$true, but the selected unattend XML file is missing: $unattendSourcePath"
+ throw "-$selectedUnattendMode is set to `$true, but the selected unattend XML file is missing: $unattendSourcePath"
}
- #Check for .XML file
- if (!(Get-ChildItem -Path $UnattendFolder -Filter unattend_*.xml)) {
- WriteLog "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing a .XML file"
- throw "-CopyUnattend is set to `$true, but the $UnattendFolder folder is missing a .XML file"
+
+ $selectedUnattendFile = Get-Item -Path $unattendSourcePath -ErrorAction SilentlyContinue
+ if (($null -eq $selectedUnattendFile) -or ($selectedUnattendFile.Length -le 0)) {
+ WriteLog "-$selectedUnattendMode is set to `$true, but the selected unattend XML file is empty: $unattendSourcePath"
+ throw "-$selectedUnattendMode is set to `$true, but the selected unattend XML file is empty: $unattendSourcePath"
}
if ($DeviceNamingMode -ne 'None') {
- $unattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
try {
[xml]$validationUnattendXml = Get-Content -Path $unattendSourcePath
$null = Initialize-UnattendComputerNamePath -UnattendXml $validationUnattendXml -WindowsArch $WindowsArch
@@ -5877,19 +5929,6 @@ if ($CopyUnattend) {
WriteLog 'Unattend validation complete'
}
-if ($InjectUnattend -and ($DeviceNamingMode -ne 'None')) {
- $injectUnattendSourcePath = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
- if (Test-Path -Path $injectUnattendSourcePath -PathType Leaf) {
- try {
- [xml]$validationUnattendXml = Get-Content -Path $injectUnattendSourcePath
- $null = Initialize-UnattendComputerNamePath -UnattendXml $validationUnattendXml -WindowsArch $WindowsArch
- }
- catch {
- throw "DeviceNamingMode $DeviceNamingMode requires a valid specialize/Microsoft-Windows-Shell-Setup/ComputerName path in $injectUnattendSourcePath. $($_.Exception.Message)"
- }
- }
-}
-
#Override $InstallApps value if using ESD to build FFU. This is due to a strange issue where building the FFU
#from vhdx doesn't work (you get an older style OOBE screen and get stuck in an OOBE reboot loop when hitting next).
#This behavior doesn't happen with WIM files.
@@ -6787,7 +6826,7 @@ if ($InstallApps) {
#Create Apps ISO
# Inject Unattend.xml into Apps if requested and applicable
if ($InstallApps -and $InjectUnattend) {
- $unattendSource = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch
+ $unattendSource = Get-UnattendSourcePath -UnattendFolder $UnattendFolder -WindowsArch $WindowsArch -UnattendX64FilePath $UnattendX64FilePath -UnattendArm64FilePath $UnattendArm64FilePath
# Ensure target folder exists under Apps
$targetFolder = Join-Path $AppsPath 'Unattend'
diff --git a/FFUDevelopment/BuildFFUVM_UI.ps1 b/FFUDevelopment/BuildFFUVM_UI.ps1
index b0771cc..6f2c462 100644
--- a/FFUDevelopment/BuildFFUVM_UI.ps1
+++ b/FFUDevelopment/BuildFFUVM_UI.ps1
@@ -439,6 +439,38 @@ $script:uiState.Controls.btnRun.Add_Click({
return
}
+ if ($config.CopyUnattend -or $config.InjectUnattend) {
+ $selectedUnattendArch = if ($config.WindowsArch -ieq 'arm64') { 'arm64' } else { 'x64' }
+ $selectedUnattendSourcePath = if ($selectedUnattendArch -eq 'arm64') {
+ [string]$config.UnattendArm64FilePath
+ }
+ else {
+ [string]$config.UnattendX64FilePath
+ }
+
+ if ([string]::IsNullOrWhiteSpace($selectedUnattendSourcePath)) {
+ [System.Windows.MessageBox]::Show("Select a valid $selectedUnattendArch unattend XML file before using Copy Unattend.xml or Inject Unattend.xml.", "Unattend File Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: unattend file path required."
+ return
+ }
+
+ if (-not (Test-Path -Path $selectedUnattendSourcePath -PathType Leaf)) {
+ [System.Windows.MessageBox]::Show("The selected $selectedUnattendArch unattend XML file was not found:`n$selectedUnattendSourcePath", "Unattend File Missing", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: unattend file missing."
+ return
+ }
+
+ $selectedUnattendFileInfo = Get-Item -Path $selectedUnattendSourcePath -ErrorAction SilentlyContinue
+ if (($null -eq $selectedUnattendFileInfo) -or ($selectedUnattendFileInfo.Length -le 0)) {
+ [System.Windows.MessageBox]::Show("The selected $selectedUnattendArch unattend XML file is empty:`n$selectedUnattendSourcePath", "Unattend File Empty", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: unattend file empty."
+ return
+ }
+ }
+
if ($config.DeviceNamingMode -eq 'Prompt') {
if (-not $config.CopyUnattend) {
[System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Prompt for Device Name'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
diff --git a/FFUDevelopment/BuildFFUVM_UI.xaml b/FFUDevelopment/BuildFFUVM_UI.xaml
index 038e261..e1977cb 100644
--- a/FFUDevelopment/BuildFFUVM_UI.xaml
+++ b/FFUDevelopment/BuildFFUVM_UI.xaml
@@ -836,11 +836,13 @@
-
+
-
+
-
+
+
+
@@ -900,13 +902,39 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -938,8 +966,8 @@
-
-
+
+
@@ -947,7 +975,6 @@
-
@@ -1004,8 +1031,8 @@
-
-
+
+
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
index f31c69f..f9e24de 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
@@ -43,6 +43,8 @@ function Get-UIConfig {
CopyAdditionalFFUFiles = $State.Controls.chkCopyAdditionalFFUFiles.IsChecked
CreateDeploymentMedia = $State.Controls.chkCreateDeploymentMedia.IsChecked
InjectUnattend = $State.Controls.chkInjectUnattend.IsChecked
+ UnattendX64FilePath = $State.Controls.txtUnattendX64FilePath.Text
+ UnattendArm64FilePath = $State.Controls.txtUnattendArm64FilePath.Text
CustomFFUNameTemplate = $State.Controls.txtCustomFFUNameTemplate.Text
Disksize = [int64]$State.Controls.txtDiskSize.Text * 1GB
DownloadDrivers = $State.Controls.chkDownloadDrivers.IsChecked
@@ -454,8 +456,18 @@ function Update-UIFromConfig {
Set-UIValue -ControlName 'chkCopyAdditionalFFUFiles' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyAdditionalFFUFiles' -State $State
Set-UIValue -ControlName 'chkCreateDeploymentMedia' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CreateDeploymentMedia' -State $State
Set-UIValue -ControlName 'chkInjectUnattend' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'InjectUnattend' -State $State
+ Set-UIValue -ControlName 'txtUnattendX64FilePath' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'UnattendX64FilePath' -State $State
+ Set-UIValue -ControlName 'txtUnattendArm64FilePath' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'UnattendArm64FilePath' -State $State
Set-UIValue -ControlName 'chkVerbose' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'Verbose' -State $State
+ if ([string]::IsNullOrWhiteSpace($State.Controls.txtUnattendX64FilePath.Text)) {
+ $State.Controls.txtUnattendX64FilePath.Text = Get-DefaultUnattendFilePath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text -WindowsArch 'x64'
+ }
+
+ if ([string]::IsNullOrWhiteSpace($State.Controls.txtUnattendArm64FilePath.Text)) {
+ $State.Controls.txtUnattendArm64FilePath.Text = Get-DefaultUnattendFilePath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text -WindowsArch 'arm64'
+ }
+
# USB Drive Modification group (Build Tab)
Set-UIValue -ControlName 'chkCopyAutopilot' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyAutopilot' -State $State
Set-UIValue -ControlName 'chkCopyUnattend' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyUnattend' -State $State
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
index 0fe70fc..37a0c96 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
@@ -101,6 +101,21 @@ function Get-DefaultDeviceNamePrefixesPath {
return Join-Path (Join-Path $FFUDevelopmentPath 'unattend') 'prefixes.txt'
}
+function Get-DefaultUnattendFilePath {
+ param(
+ [string]$FFUDevelopmentPath,
+ [ValidateSet('x64', 'arm64')]
+ [string]$WindowsArch
+ )
+
+ if ([string]::IsNullOrWhiteSpace($FFUDevelopmentPath)) {
+ return $null
+ }
+
+ $fileName = if ($WindowsArch -ieq 'arm64') { 'unattend_arm64.xml' } else { 'unattend_x64.xml' }
+ return Join-Path (Join-Path $FFUDevelopmentPath 'unattend') $fileName
+}
+
function Import-DeviceNamePrefixesFromConfiguredPath {
param(
[PSCustomObject]$State,
@@ -416,12 +431,24 @@ function Register-EventHandlers {
$selectedPath = Invoke-BrowseAction -Type 'Folder' -Title "Select FFU Development Path"
if ($selectedPath) {
$currentPrefixesPath = $localState.Controls.txtDeviceNamePrefixesPath.Text
+ $currentUnattendX64FilePath = $localState.Controls.txtUnattendX64FilePath.Text
+ $currentUnattendArm64FilePath = $localState.Controls.txtUnattendArm64FilePath.Text
$previousDefaultPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
+ $previousDefaultUnattendX64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text -WindowsArch 'x64'
+ $previousDefaultUnattendArm64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text -WindowsArch 'arm64'
$localState.Controls.txtFFUDevPath.Text = $selectedPath
$newDefaultPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $selectedPath
+ $newDefaultUnattendX64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $selectedPath -WindowsArch 'x64'
+ $newDefaultUnattendArm64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $selectedPath -WindowsArch 'arm64'
if ([string]::IsNullOrWhiteSpace($currentPrefixesPath) -or $currentPrefixesPath -ieq $previousDefaultPrefixesPath) {
$localState.Controls.txtDeviceNamePrefixesPath.Text = $newDefaultPrefixesPath
}
+ if ([string]::IsNullOrWhiteSpace($currentUnattendX64FilePath) -or $currentUnattendX64FilePath -ieq $previousDefaultUnattendX64FilePath) {
+ $localState.Controls.txtUnattendX64FilePath.Text = $newDefaultUnattendX64FilePath
+ }
+ if ([string]::IsNullOrWhiteSpace($currentUnattendArm64FilePath) -or $currentUnattendArm64FilePath -ieq $previousDefaultUnattendArm64FilePath) {
+ $localState.Controls.txtUnattendArm64FilePath.Text = $newDefaultUnattendArm64FilePath
+ }
Import-DeviceNamePrefixesFromConfiguredPath -State $localState
Update-DeviceNamingControls -State $localState
}
@@ -484,6 +511,46 @@ function Register-EventHandlers {
Update-DeviceNamingControls -State $localState
}
})
+ $State.Controls.btnBrowseUnattendX64FilePath.Add_Click({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $currentUnattendX64FilePath = $localState.Controls.txtUnattendX64FilePath.Text
+ if ([string]::IsNullOrWhiteSpace($currentUnattendX64FilePath)) {
+ $currentUnattendX64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text -WindowsArch 'x64'
+ }
+ $initialDirectory = if ([string]::IsNullOrWhiteSpace($currentUnattendX64FilePath)) {
+ $null
+ }
+ else {
+ Split-Path $currentUnattendX64FilePath -Parent
+ }
+ $fileName = if ([string]::IsNullOrWhiteSpace($currentUnattendX64FilePath)) { 'unattend_x64.xml' } else { Split-Path $currentUnattendX64FilePath -Leaf }
+ $selectedPath = Invoke-BrowseAction -Type 'OpenFile' -Title 'Select x64 unattend XML file' -Filter 'XML files (*.xml)|*.xml|All files (*.*)|*.*' -InitialDirectory $initialDirectory -FileName $fileName
+ if (-not [string]::IsNullOrWhiteSpace($selectedPath)) {
+ $localState.Controls.txtUnattendX64FilePath.Text = $selectedPath
+ }
+ })
+ $State.Controls.btnBrowseUnattendArm64FilePath.Add_Click({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $currentUnattendArm64FilePath = $localState.Controls.txtUnattendArm64FilePath.Text
+ if ([string]::IsNullOrWhiteSpace($currentUnattendArm64FilePath)) {
+ $currentUnattendArm64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text -WindowsArch 'arm64'
+ }
+ $initialDirectory = if ([string]::IsNullOrWhiteSpace($currentUnattendArm64FilePath)) {
+ $null
+ }
+ else {
+ Split-Path $currentUnattendArm64FilePath -Parent
+ }
+ $fileName = if ([string]::IsNullOrWhiteSpace($currentUnattendArm64FilePath)) { 'unattend_arm64.xml' } else { Split-Path $currentUnattendArm64FilePath -Leaf }
+ $selectedPath = Invoke-BrowseAction -Type 'OpenFile' -Title 'Select arm64 unattend XML file' -Filter 'XML files (*.xml)|*.xml|All files (*.*)|*.*' -InitialDirectory $initialDirectory -FileName $fileName
+ if (-not [string]::IsNullOrWhiteSpace($selectedPath)) {
+ $localState.Controls.txtUnattendArm64FilePath.Text = $selectedPath
+ }
+ })
$State.Controls.btnSaveDeviceNamePrefixes.Add_Click({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
index 62cac40..62dcdc0 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
@@ -220,6 +220,10 @@ function Initialize-UIControls {
$State.Controls.chkAllowVHDXCaching = $window.FindName('chkAllowVHDXCaching')
$State.Controls.chkCreateDeploymentMedia = $window.FindName('chkCreateDeploymentMedia')
$State.Controls.chkInjectUnattend = $window.FindName('chkInjectUnattend')
+ $State.Controls.txtUnattendX64FilePath = $window.FindName('txtUnattendX64FilePath')
+ $State.Controls.btnBrowseUnattendX64FilePath = $window.FindName('btnBrowseUnattendX64FilePath')
+ $State.Controls.txtUnattendArm64FilePath = $window.FindName('txtUnattendArm64FilePath')
+ $State.Controls.btnBrowseUnattendArm64FilePath = $window.FindName('btnBrowseUnattendArm64FilePath')
$State.Controls.rbDeviceNamingNone = $window.FindName('rbDeviceNamingNone')
$State.Controls.rbDeviceNamingPrompt = $window.FindName('rbDeviceNamingPrompt')
$State.Controls.rbDeviceNamingTemplate = $window.FindName('rbDeviceNamingTemplate')
@@ -387,6 +391,8 @@ function Initialize-UIDefaults {
$State.Controls.chkOptimize.IsChecked = $State.Defaults.generalDefaults.Optimize
$State.Controls.chkAllowVHDXCaching.IsChecked = $State.Defaults.generalDefaults.AllowVHDXCaching
$State.Controls.chkInjectUnattend.IsChecked = $State.Defaults.generalDefaults.InjectUnattend
+ $State.Controls.txtUnattendX64FilePath.Text = $State.Defaults.generalDefaults.UnattendX64FilePath
+ $State.Controls.txtUnattendArm64FilePath.Text = $State.Defaults.generalDefaults.UnattendArm64FilePath
$State.Controls.chkCreateDeploymentMedia.IsChecked = $State.Defaults.generalDefaults.CreateDeploymentMedia
$State.Controls.chkAllowExternalHardDiskMedia.IsChecked = $State.Defaults.generalDefaults.AllowExternalHardDiskMedia
$State.Controls.chkPromptExternalHardDiskMedia.IsChecked = $State.Defaults.generalDefaults.PromptExternalHardDiskMedia
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
index a841359..8957f4a 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
@@ -112,6 +112,8 @@ function Get-GeneralDefaults {
$userAppListPath = Join-Path -Path $appsPath -ChildPath "UserAppList.json"
$driversJsonPath = Join-Path -Path $driversPath -ChildPath "Drivers.json"
$deviceNamePrefixesPath = Join-Path -Path $unattendPath -ChildPath "prefixes.txt"
+ $unattendX64FilePath = Join-Path -Path $unattendPath -ChildPath "unattend_x64.xml"
+ $unattendArm64FilePath = Join-Path -Path $unattendPath -ChildPath "unattend_arm64.xml"
return [PSCustomObject]@{
# Build Tab Defaults
@@ -134,6 +136,8 @@ function Get-GeneralDefaults {
CopyUnattend = $false
CopyPPKG = $false
InjectUnattend = $false
+ UnattendX64FilePath = $unattendX64FilePath
+ UnattendArm64FilePath = $unattendArm64FilePath
DeviceNamingMode = 'None'
DeviceNameTemplate = ''
DeviceNamePrefixesPath = $deviceNamePrefixesPath
diff --git a/FFUDevelopment/config/Sample_default.json b/FFUDevelopment/config/Sample_default.json
index af3cdb33d447449dc337a675b20442b2136b4d21..dcc97ea59f3b218479d5eb387e6e203bfa03be38 100644
GIT binary patch
delta 170
zcmaE5w90hDG8WlThCGHuh7ur51+r2YA{fjVOc>l4G8u9hQYWsroZQ4JB43K8D4wAL
stV|C`=Q89>Ze$i#L^sHhp$I64X_zvmVTo|1NCr+mz$&zP2g@cA0At)I_W%F@
delta 15
XcmZ2w`pRg-GL}i~LYsfEZV~|iH)sZT
diff --git a/docs/build.md b/docs/build.md
index 3c5849a..4e92747 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -283,11 +283,23 @@ The deployment media is saved as an ISO file at `$FFUDevelopmentPath\WinPE_FFU_D
>
> If you just need to re-create deployment media, you can use the `Create-PEMedia.ps1` script to regenerate the deploy ISO without running a full build.
+## Unattend.xml Options Expander
+
+Use the **Unattend.xml Options** expander to choose how unattend content is staged and which source XML file FFU Builder should use for x64 and arm64 builds.
+
+### x64 Unattend File Path
+
+Use **x64 Unattend File Path** to browse to the source XML file for x64 builds. The default path is `.\FFUDevelopment\unattend\unattend_x64.xml`.
+
+### arm64 Unattend File Path
+
+Use **arm64 Unattend File Path** to browse to the source XML file for arm64 builds. The default path is `.\FFUDevelopment\unattend\unattend_arm64.xml`.
+
### Inject Unattend.xml
-Controls the `-InjectUnattend` parameter. When checked, copies the architecture-specific unattend XML file from `.\FFUDevelopment\unattend` into the Apps ISO so it's baked into the FFU during the VM build process. The default is **unchecked**.
+Controls the `-InjectUnattend` parameter. When checked, stages the XML file selected for the current architecture in **Unattend.xml Options** into the Apps ISO so it's baked into the FFU during the VM build process. The default is **unchecked**.
-This option is only available when **Install Apps** is checked.
+This option is used only when **Install Apps** is checked.
`Copy Unattend.xml` and `Inject Unattend.xml` are mutually exclusive. Select only one.
@@ -295,18 +307,16 @@ This option is only available when **Install Apps** is checked.
When enabled, the build process:
-1. Determines the correct unattend file based on the target architecture:
- * **unattend_x64.xml** for x64 builds
- * **unattend_arm64.xml** for arm64 builds
+1. Uses the x64 or arm64 source file selected in **Unattend.xml Options** for the current build architecture
2. Creates an `Unattend` folder inside `.\FFUDevelopment\Apps` if it doesn't exist
-3. Copies the architecture-specific unattend file to `.\FFUDevelopment\Apps\Unattend\Unattend.xml`
+3. Copies that file to `.\FFUDevelopment\Apps\Unattend\Unattend.xml`
4. Includes the unattend file in the Apps ISO, making it available to sysprep during the VM build
The unattend file is then used by sysprep during the specialize phase and/or other OOBE phases when the FFU is deployed.
#### Creating Your Unattend Files
-Modify the architecture-specific unattend file in the `.\FFUDevelopment\unattend` folder:
+You can keep the default architecture-specific files in the `.\FFUDevelopment\unattend` folder or browse to another XML file in the UI:
| File | Description |
| ---------------------------- | ----------------------------------- |
@@ -317,7 +327,7 @@ Modify the architecture-specific unattend file in the `.\FFUDevelopment\unattend
> Important
>
-> Keep the file names with the architecture suffix (e.g., unattend_x64.xml). The script handles renaming the file to `Unattend.xml` when copying it to the Apps folder.
+> The default paths use the architecture suffix file names shown above. FFU Builder still renames the selected file to `Unattend.xml` when it stages it into the Apps folder.
#### When to Use This Option
@@ -516,15 +526,17 @@ This leverages the Autopilot for existing devices json file. It's not recommende
### Copy Unattend.xml
-Controls the `-CopyUnattend` parameter. When checked, copies the architecture-appropriate unattend XML file from `.\FFUDevelopment\Unattend` to an `Unattend` folder on the Deployment partition of the USB drive. The default is **unchecked**.
+Controls the `-CopyUnattend` parameter. When checked, stages the XML file selected for the current architecture in **Unattend.xml Options** to an `Unattend` folder on the Deployment partition of the USB drive. The default is **unchecked**.
-This option is only available when **Build USB Drive** is checked.
+Use this option when you plan to build deployment USB media.
When enabled, the build process copies:
-- **unattend_x64.xml** (for x64 builds) or **unattend_arm64.xml** (for arm64 builds) → renamed to **Unattend.xml** on the USB drive
+- The selected x64 or arm64 unattend XML file → renamed to **Unattend.xml** on the USB drive
- **prefixes.txt** → created from the **Device Naming** prefixes list when that mode is selected
+If you keep the default file paths in place, FFU Builder uses `unattend_x64.xml` for x64 builds and `unattend_arm64.xml` for arm64 builds.
+
During deployment, `ApplyFFU.ps1` applies `Unattend.xml` whenever it is present. Device naming only happens when the **Device Naming** setting requires it, or when older media still uses the legacy prompt-based workflow.
See **Device Naming Expander** above for the available computer-name modes and prefixes-file behavior.
diff --git a/docs/parameters_reference.md b/docs/parameters_reference.md
index 661c20b..ec31da0 100644
--- a/docs/parameters_reference.md
+++ b/docs/parameters_reference.md
@@ -38,12 +38,14 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -CopyDrivers | bool | Copy Drivers to USB drive | When set to $true, will copy the drivers from the $FFUDevelopmentPath\Drivers folder to the Drivers folder on the deploy partition of the USB drive. Default is $false. |
| -CopyPEDrivers | bool | Copy PE Drivers | When set to $true, enables adding WinPE drivers. By default copies drivers from $FFUDevelopmentPath\PEDrivers to the WinPE deployment media unless -UseDriversAsPEDrivers is also $true. |
| -CopyPPKG | bool | Copy Provisioning Package | When set to $true, will copy the provisioning package from the $FFUDevelopmentPath\PPKG folder to the Deployment partition of the USB drive. Default is $false. |
-| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, will copy the $FFUDevelopmentPath\Unattend folder to the Deployment partition of the USB drive. Cannot be used together with -InjectUnattend. Default is $false. |
+| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, stages the selected architecture-specific unattend XML file as Unattend.xml on the Deployment partition of the USB drive. Cannot be used together with -InjectUnattend. Default is $false. |
| -CreateDeploymentMedia | bool | Create Deployment Media | When set to $true, this will create WinPE deployment media for use when deploying to a physical device. |
| -CustomFFUNameTemplate | string | Custom FFU Name Template | Sets a custom FFU output name with placeholders. Allowed placeholders are: {WindowsRelease}, {WindowsVersion}, {SKU}, {BuildDate}, {yyyy}, {MM}, {dd}, {H}, {hh}, {mm}, {tt}. |
| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Prompt, Template, and Prefixes. The UI uses None, Prompt, Template, and Prefixes. Prompt rewrites the staged deployment unattend to the existing manual prompt placeholder and requires -CopyUnattend. |
| -DeviceNameTemplate | string | Specify Device Name | Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when -CopyUnattend is used. |
| -DeviceNamePrefixesPath | string | Prefixes File Path | Path to the source prefixes file used for legacy copy or when -DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt. |
+| -UnattendX64FilePath | string | x64 Unattend File Path | Path to the x64 unattend XML source file used by Copy Unattend.xml and Inject Unattend.xml. Default is $FFUDevelopmentPath\Unattend\unattend_x64.xml. |
+| -UnattendArm64FilePath | string | arm64 Unattend File Path | Path to the arm64 unattend XML source file used by Copy Unattend.xml and Inject Unattend.xml. Default is $FFUDevelopmentPath\Unattend\unattend_arm64.xml. |
| -DeviceNamePrefixes | string[] | Specify a list of Prefixes | Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a line in prefixes.txt on the deployment media. |
| -Disksize | uint64 | Disk Size (GB) | Size of the virtual hard disk for the virtual machine. Default is a 50GB dynamic disk. |
| -DriversFolder | string | Drivers Folder | Path to the drivers folder. Default is $FFUDevelopmentPath\Drivers. |
@@ -54,7 +56,7 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -FFUDevelopmentPath | string | FFU Development Path | Path to the FFU development folder. Default is $PSScriptRoot. |
| -FFUPrefix | string | VM Name Prefix | Prefix for the generated FFU file. Default is _FFU. |
| -Headers | hashtable | CLI only (no UI control) | Headers to use when downloading files. Not recommended to modify. |
-| -InjectUnattend | bool | Inject Unattend.xml | When set to $true and InstallApps is also $true, copies unattend_[arch].xml from $FFUDevelopmentPath\unattend to $FFUDevelopmentPath\Apps\Unattend\Unattend.xml so sysprep can use it inside the VM. Cannot be used together with -CopyUnattend. Default is $false. |
+| -InjectUnattend | bool | Inject Unattend.xml | When set to $true and InstallApps is also $true, stages the selected architecture-specific unattend XML file to $FFUDevelopmentPath\Apps\Unattend\Unattend.xml so sysprep can use it inside the VM. Cannot be used together with -CopyUnattend. Default is $false. |
| -InstallApps | bool | Install Applications | When set to $true, the script will create an Apps.iso file from the $FFUDevelopmentPath\Apps folder. It will also create a VM, mount the Apps.iso, install the apps, sysprep, and capture the VM. When set to $false, the FFU is created from a VHDX file, and no VM is created. |
| -InstallDrivers | bool | Install Drivers to FFU | Install device drivers from the specified $FFUDevelopmentPath\Drivers folder if set to $true. Download the drivers and put them in the Drivers folder. The script will recurse the drivers folder and add the drivers to the FFU. |
| -InstallOffice | bool | Install Office | Install Microsoft Office if set to $true. The script will download the latest ODT and Office files in the $FFUDevelopmentPath\Apps\Office folder and install Office in the FFU via VM. |
From 28297f3a0e43691e26063b3d6bf62d484265010d Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Tue, 14 Apr 2026 14:56:02 -0700
Subject: [PATCH 06/10] Switches to Windows ADK DISM CLI for adding Windows
packages
Replaces the native PowerShell command for adding Windows packages with direct command-line invocations of the Deployment Image Servicing and Management (DISM) tool. This fixes an issue introduced by the March 31, 2026 OOB update that persists in the April 2026 2B update where Add-WindowsPackage fails due to issues with CBS. Using native dism fixes the issue.
---
FFUDevelopment/BuildFFUVM.ps1 | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index 305f56c..5d52cbb 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -3708,7 +3708,8 @@ function New-PEMedia {
foreach ($Package in $Packages) {
$PackagePath = Join-Path $PackagePathBase $Package
WriteLog "Adding Package $Package"
- Add-WindowsPackage -Path "$WinPEFFUPath\mount" -PackagePath $PackagePath | Out-Null
+ # Add-WindowsPackage -Path "$WinPEFFUPath\mount" -PackagePath $PackagePath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WinPEFFUPath\mount /Add-Package /PackagePath:$PackagePath" | Out-Null
WriteLog "Adding package complete"
}
WriteLog "Copying $FFUDevelopmentPath\WinPEDeployFFUFiles\* to WinPE deploy media"
@@ -7404,10 +7405,8 @@ try {
if ($WindowsRelease -eq 2016 -and $installationType -eq "Server") {
WriteLog 'WindowsRelease is 2016, adding SSU first'
WriteLog "Adding SSU to $WindowsPartition"
- # Add-WindowsPackage -Path $WindowsPartition -PackagePath $SSUFilePath -PreventPending | Out-Null
- # Commenting out -preventpending as it causes an issue with the SSU being applied
- # Seems to be because of the registry being mounted per dism.log
- Add-WindowsPackage -Path $WindowsPartition -PackagePath $SSUFilePath | Out-Null
+ # Add-WindowsPackage -Path $WindowsPartition -PackagePath $SSUFilePath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WindowsPartition /Add-Package /PackagePath:$SSUFilePath" | Out-Null
WriteLog "SSU added to $WindowsPartition"
# WriteLog "Removing $SSUFilePath"
# Remove-Item -Path $SSUFilePath -Force | Out-Null
@@ -7416,7 +7415,8 @@ try {
if ($WindowsRelease -in 2016, 2019, 2021 -and $isLTSC) {
WriteLog "WindowsRelease is $WindowsRelease and is $WindowsSKU, adding SSU first"
WriteLog "Adding SSU to $WindowsPartition"
- Add-WindowsPackage -Path $WindowsPartition -PackagePath $SSUFilePath | Out-Null
+ # Add-WindowsPackage -Path $WindowsPartition -PackagePath $SSUFilePath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WindowsPartition /Add-Package /PackagePath:$SSUFilePath" | Out-Null
WriteLog "SSU added to $WindowsPartition"
# WriteLog "Removing $SSUFilePath"
# Remove-Item -Path $SSUFilePath -Force | Out-Null
@@ -7429,23 +7429,27 @@ try {
}
else {
WriteLog "Adding $CUPath to $WindowsPartition"
- Add-WindowsPackage -Path $WindowsPartition -PackagePath $CUPath | Out-Null
+ # Add-WindowsPackage -Path $WindowsPartition -PackagePath $CUPath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WindowsPartition /Add-Package /PackagePath:$CUPath" | Out-Null
WriteLog "$CUPath added to $WindowsPartition"
}
}
if ($UpdatePreviewCU) {
WriteLog "Adding $CUPPath to $WindowsPartition"
- Add-WindowsPackage -Path $WindowsPartition -PackagePath $CUPPath | Out-Null
+ # Add-WindowsPackage -Path $WindowsPartition -PackagePath $CUPPath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WindowsPartition /Add-Package /PackagePath:$CUPPath" | Out-Null
WriteLog "$CUPPath added to $WindowsPartition"
}
if ($UpdateLatestNet) {
WriteLog "Adding $NETPath to $WindowsPartition"
- Add-WindowsPackage -Path $WindowsPartition -PackagePath $NETPath | Out-Null
+ # Add-WindowsPackage -Path $WindowsPartition -PackagePath $NETPath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WindowsPartition /Add-Package /PackagePath:$NETPath" | Out-Null
WriteLog "$NETPath added to $WindowsPartition"
}
if ($UpdateLatestMicrocode -and $WindowsRelease -in 2016, 2019) {
WriteLog "Adding $MicrocodePath to $WindowsPartition"
- Add-WindowsPackage -Path $WindowsPartition -PackagePath $MicrocodePath | Out-Null
+ # Add-WindowsPackage -Path $WindowsPartition -PackagePath $MicrocodePath | Out-Null
+ Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WindowsPartition /Add-Package /PackagePath:$MicrocodePath" | Out-Null
WriteLog "$MicrocodePath added to $WindowsPartition"
}
WriteLog "KBs added to $WindowsPartition"
From 0607cf53868f1200e6b0f96976e3fe676dfe0473 Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Tue, 14 Apr 2026 18:18:53 -0700
Subject: [PATCH 07/10] Updates package addition to use native cmdlet
Replaces the direct invocation of DISM via cmd with the native Windows PowerShell cmdlet to streamline and simplify the package installation process during WinPE media creation.
---
FFUDevelopment/BuildFFUVM.ps1 | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index 5d52cbb..fe09363 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -3708,8 +3708,7 @@ function New-PEMedia {
foreach ($Package in $Packages) {
$PackagePath = Join-Path $PackagePathBase $Package
WriteLog "Adding Package $Package"
- # Add-WindowsPackage -Path "$WinPEFFUPath\mount" -PackagePath $PackagePath | Out-Null
- Invoke-Process cmd "/c ""$DandIEnv"" && dism /Image:$WinPEFFUPath\mount /Add-Package /PackagePath:$PackagePath" | Out-Null
+ Add-WindowsPackage -Path "$WinPEFFUPath\mount" -PackagePath $PackagePath | Out-Null
WriteLog "Adding package complete"
}
WriteLog "Copying $FFUDevelopmentPath\WinPEDeployFFUFiles\* to WinPE deploy media"
From 24f10b89b0934cbd8e60141577cf3e648de0852c Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Wed, 15 Apr 2026 13:04:12 -0700
Subject: [PATCH 08/10] Fixes DeviceNamingMode UI state tracking and defaults
Updates the FFU UI core to better track the loaded `DeviceNamingMode` configuration.
Introduces flags to detect explicit user changes versus default states.
Ensures that if the user does not explicitly set the device naming mode, it defaults gracefully and preserves legacy script behaviors.
Updates documentation to reflect the actual behavior of not writing the `DeviceNamingMode` key unless modified.
---
FFUDevelopment/BuildFFUVM_UI.ps1 | 7 +-
.../FFUUI.Core/FFUUI.Core.Config.psm1 | 19 +++--
.../FFUUI.Core/FFUUI.Core.Handlers.psm1 | 77 +++++++++++++++++-
.../FFUUI.Core/FFUUI.Core.Initialize.psm1 | 8 +-
FFUDevelopment/config/Sample_default.json | Bin 6826 -> 6760 bytes
docs/build.md | 7 +-
docs/parameters_reference.md | 2 +-
7 files changed, 102 insertions(+), 18 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM_UI.ps1 b/FFUDevelopment/BuildFFUVM_UI.ps1
index 6f2c462..f2503d6 100644
--- a/FFUDevelopment/BuildFFUVM_UI.ps1
+++ b/FFUDevelopment/BuildFFUVM_UI.ps1
@@ -46,7 +46,8 @@ $script:uiState = [PSCustomObject]@{
logStreamReader = $null;
pollTimer = $null;
currentBuildProcess = $null;
- lastConfigFilePath = $null
+ lastConfigFilePath = $null;
+ loadedDeviceNamingMode = $null
};
Flags = @{
installAppsForcedByUpdates = $false;
@@ -56,7 +57,9 @@ $script:uiState = [PSCustomObject]@{
lastSortAscending = $true;
isBuilding = $false;
isCleanupRunning = $false;
- isFluentSupported = $false
+ isFluentSupported = $false;
+ deviceNamingModeWasExplicitlyChanged = $false;
+ suppressDeviceNamingChangeTracking = $false
};
Defaults = @{};
LogFilePath = "$FFUDevelopmentPath\FFUDevelopment_UI.log"
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
index f9e24de..a7a5d6d 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
@@ -36,7 +36,7 @@ function Get-UIConfig {
UseDriversAsPEDrivers = $State.Controls.chkUseDriversAsPEDrivers.IsChecked
CopyPPKG = $State.Controls.chkCopyPPKG.IsChecked
CopyUnattend = $State.Controls.chkCopyUnattend.IsChecked
- DeviceNamingMode = Get-SelectedDeviceNamingMode -State $State
+ DeviceNamingMode = Get-ConfiguredDeviceNamingMode -State $State
DeviceNameTemplate = $State.Controls.txtDeviceNameTemplate.Text
DeviceNamePrefixesPath = $State.Controls.txtDeviceNamePrefixesPath.Text
DeviceNamePrefixes = @(Get-DeviceNamePrefixes -State $State)
@@ -480,17 +480,20 @@ function Update-UIFromConfig {
$State.Controls.txtDeviceNamePrefixesPath.Text = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text
}
- $deviceNamingMode = 'None'
+ $loadedDeviceNamingMode = $null
if ($ConfigContent.PSObject.Properties.Name -contains 'DeviceNamingMode') {
- $deviceNamingMode = [string]$ConfigContent.DeviceNamingMode
+ $candidateDeviceNamingMode = [string]$ConfigContent.DeviceNamingMode
+ if ($candidateDeviceNamingMode -in @('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')) {
+ $loadedDeviceNamingMode = $candidateDeviceNamingMode
+ }
}
- if ($deviceNamingMode -eq 'Legacy') {
- $deviceNamingMode = 'Prompt'
+ $displayDeviceNamingMode = if ($loadedDeviceNamingMode -in @('Prompt', 'Template', 'Prefixes')) {
+ $loadedDeviceNamingMode
}
- if ($deviceNamingMode -notin @('None', 'Prompt', 'Template', 'Prefixes')) {
- $deviceNamingMode = 'None'
+ else {
+ 'None'
}
- Set-DeviceNamingMode -State $State -Mode $deviceNamingMode
+ Set-DeviceNamingModeState -State $State -DisplayMode $displayDeviceNamingMode -LoadedMode $loadedDeviceNamingMode
Import-DeviceNamePrefixesFromConfiguredPath -State $State
Update-DeviceNamingControls -State $State
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
index 37a0c96..6b86f6f 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
@@ -58,6 +58,55 @@ function Set-DeviceNamingMode {
$State.Controls.rbDeviceNamingPrefixes.IsChecked = $Mode -eq 'Prefixes'
}
+function Set-DeviceNamingModeState {
+ param(
+ [PSCustomObject]$State,
+ [ValidateSet('None', 'Prompt', 'Template', 'Prefixes')]
+ [string]$DisplayMode,
+ [AllowNull()]
+ [string]$LoadedMode
+ )
+
+ if ($null -eq $State.Flags) {
+ $State.Flags = @{}
+ }
+
+ if ($null -eq $State.Data) {
+ $State.Data = @{}
+ }
+
+ $previousSuppressionState = $true -eq $State.Flags.suppressDeviceNamingChangeTracking
+ $State.Flags.suppressDeviceNamingChangeTracking = $true
+ try {
+ Set-DeviceNamingMode -State $State -Mode $DisplayMode
+ }
+ finally {
+ $State.Flags.suppressDeviceNamingChangeTracking = $previousSuppressionState
+ }
+
+ $State.Data.loadedDeviceNamingMode = if ([string]::IsNullOrWhiteSpace($LoadedMode)) {
+ $null
+ }
+ else {
+ $LoadedMode.Trim()
+ }
+ $State.Flags.deviceNamingModeWasExplicitlyChanged = $false
+}
+
+function Get-ConfiguredDeviceNamingMode {
+ param([PSCustomObject]$State)
+
+ if (($null -ne $State.Flags) -and ($true -eq $State.Flags.deviceNamingModeWasExplicitlyChanged)) {
+ return Get-SelectedDeviceNamingMode -State $State
+ }
+
+ if (($null -ne $State.Data) -and -not [string]::IsNullOrWhiteSpace([string]$State.Data.loadedDeviceNamingMode)) {
+ return [string]$State.Data.loadedDeviceNamingMode
+ }
+
+ return $null
+}
+
function Get-DeviceNamePrefixes {
param([PSCustomObject]$State)
@@ -467,17 +516,32 @@ function Register-EventHandlers {
$State.Controls.rbDeviceNamingNone.Add_Checked({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
- Update-DeviceNamingControls -State $window.Tag
+ $localState = $window.Tag
+ if (-not ($true -eq $localState.Flags.suppressDeviceNamingChangeTracking)) {
+ $localState.Flags.deviceNamingModeWasExplicitlyChanged = $true
+ $localState.Data.loadedDeviceNamingMode = $null
+ }
+ Update-DeviceNamingControls -State $localState
})
$State.Controls.rbDeviceNamingPrompt.Add_Checked({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
- Update-DeviceNamingControls -State $window.Tag
+ $localState = $window.Tag
+ if (-not ($true -eq $localState.Flags.suppressDeviceNamingChangeTracking)) {
+ $localState.Flags.deviceNamingModeWasExplicitlyChanged = $true
+ $localState.Data.loadedDeviceNamingMode = $null
+ }
+ Update-DeviceNamingControls -State $localState
})
$State.Controls.rbDeviceNamingTemplate.Add_Checked({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
- Update-DeviceNamingControls -State $window.Tag
+ $localState = $window.Tag
+ if (-not ($true -eq $localState.Flags.suppressDeviceNamingChangeTracking)) {
+ $localState.Flags.deviceNamingModeWasExplicitlyChanged = $true
+ $localState.Data.loadedDeviceNamingMode = $null
+ }
+ Update-DeviceNamingControls -State $localState
})
$State.Controls.txtDeviceNameTemplate.Add_TextChanged({
param($eventSource, $textChangedEventArgs)
@@ -489,7 +553,12 @@ function Register-EventHandlers {
$State.Controls.rbDeviceNamingPrefixes.Add_Checked({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
- Update-DeviceNamingControls -State $window.Tag
+ $localState = $window.Tag
+ if (-not ($true -eq $localState.Flags.suppressDeviceNamingChangeTracking)) {
+ $localState.Flags.deviceNamingModeWasExplicitlyChanged = $true
+ $localState.Data.loadedDeviceNamingMode = $null
+ }
+ Update-DeviceNamingControls -State $localState
})
$State.Controls.btnBrowseDeviceNamePrefixesPath.Add_Click({
param($eventSource, $routedEventArgs)
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
index 62dcdc0..43530b8 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
@@ -400,7 +400,13 @@ function Initialize-UIDefaults {
$State.Controls.chkCopyAutopilot.IsChecked = $State.Defaults.generalDefaults.CopyAutopilot
$State.Controls.chkCopyUnattend.IsChecked = $State.Defaults.generalDefaults.CopyUnattend
$State.Controls.chkCopyPPKG.IsChecked = $State.Defaults.generalDefaults.CopyPPKG
- Set-DeviceNamingMode -State $State -Mode $State.Defaults.generalDefaults.DeviceNamingMode
+ $defaultDeviceNamingMode = if ($State.Defaults.generalDefaults.DeviceNamingMode -in @('None', 'Prompt', 'Template', 'Prefixes')) {
+ $State.Defaults.generalDefaults.DeviceNamingMode
+ }
+ else {
+ 'None'
+ }
+ Set-DeviceNamingModeState -State $State -DisplayMode $defaultDeviceNamingMode -LoadedMode $null
$State.Controls.txtDeviceNameTemplate.Text = $State.Defaults.generalDefaults.DeviceNameTemplate
$State.Controls.txtDeviceNamePrefixesPath.Text = $State.Defaults.generalDefaults.DeviceNamePrefixesPath
$State.Controls.txtDeviceNamePrefixes.Text = ($State.Defaults.generalDefaults.DeviceNamePrefixes -join [System.Environment]::NewLine)
diff --git a/FFUDevelopment/config/Sample_default.json b/FFUDevelopment/config/Sample_default.json
index dcc97ea59f3b218479d5eb387e6e203bfa03be38..09ee3809718125cf9310f12a19e6e85eae76fc66 100644
GIT binary patch
delta 12
TcmZ2w`od(x57y0AYy~0!Cjtc^
delta 44
zcmaE1vdVPB4_5I^hCGIJ249AJh7^WW1|*` for this default behavior.
+- If you leave device naming untouched, FFU Builder does not write `DeviceNamingMode` to the generated config. This preserves the script's `Legacy` default, so an existing `FFUDevelopment\Unattend\prefixes.txt` file is still copied to deployment media when present.
+- If you explicitly select this option, FFU Builder writes `DeviceNamingMode = None`. The unattend file is still applied, but Windows generates a random computer name instead of forcing a prompt or a fixed name.
+
+The active `unattend_*.xml` files in `FFUDevelopment\Unattend` use `*` in the current sample files.
### Prompt for Device Name
diff --git a/docs/parameters_reference.md b/docs/parameters_reference.md
index ec31da0..400f89b 100644
--- a/docs/parameters_reference.md
+++ b/docs/parameters_reference.md
@@ -41,7 +41,7 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, stages the selected architecture-specific unattend XML file as Unattend.xml on the Deployment partition of the USB drive. Cannot be used together with -InjectUnattend. Default is $false. |
| -CreateDeploymentMedia | bool | Create Deployment Media | When set to $true, this will create WinPE deployment media for use when deploying to a physical device. |
| -CustomFFUNameTemplate | string | Custom FFU Name Template | Sets a custom FFU output name with placeholders. Allowed placeholders are: {WindowsRelease}, {WindowsVersion}, {SKU}, {BuildDate}, {yyyy}, {MM}, {dd}, {H}, {hh}, {mm}, {tt}. |
-| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Prompt, Template, and Prefixes. The UI uses None, Prompt, Template, and Prefixes. Prompt rewrites the staged deployment unattend to the existing manual prompt placeholder and requires -CopyUnattend. |
+| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Prompt, Template, and Prefixes. The UI shows None, Prompt, Template, and Prefixes. When device naming is left untouched in the UI, the generated config does not write DeviceNamingMode, which preserves the script default of Legacy. Prompt rewrites the staged deployment unattend to the existing manual prompt placeholder and requires -CopyUnattend. |
| -DeviceNameTemplate | string | Specify Device Name | Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when -CopyUnattend is used. |
| -DeviceNamePrefixesPath | string | Prefixes File Path | Path to the source prefixes file used for legacy copy or when -DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt. |
| -UnattendX64FilePath | string | x64 Unattend File Path | Path to the x64 unattend XML source file used by Copy Unattend.xml and Inject Unattend.xml. Default is $FFUDevelopmentPath\Unattend\unattend_x64.xml. |
From 38323e6be1a8ff0df8f7c54450ea2ad7d37fcef1 Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Wed, 15 Apr 2026 14:39:14 -0700
Subject: [PATCH 09/10] Add support for SerialComputerNames CSV mapping
Introduces a new `SerialComputerNames` device naming mode that allows automated device naming during deployment based on the BIOS serial number. The mapping is provided via a CSV file with `SerialNumber` and `ComputerName` columns.
This feature requires `CopyUnattend` and writes a `SerialComputerNames.csv` file to the USB deployment media, replacing the need for manual prompts or prefix selection when device serial numbers are known in advance. The UI has been updated to support creating, loading, and saving the CSV mapping content.
---
FFUDevelopment/BuildFFUVM.ps1 | 72 +++++++-
FFUDevelopment/BuildFFUVM_UI.ps1 | 16 ++
FFUDevelopment/BuildFFUVM_UI.xaml | 18 ++
.../FFUUI.Core/FFUUI.Core.Config.psm1 | 13 +-
.../FFUUI.Core/FFUUI.Core.Handlers.psm1 | 154 +++++++++++++++++-
.../FFUUI.Core/FFUUI.Core.Initialize.psm1 | 11 +-
FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1 | 3 +
FFUDevelopment/config/Sample_default.json | Bin 6760 -> 7042 bytes
.../unattend/SampleSerialComputerNames.csv | 4 +
docs/build.md | 41 ++++-
docs/parameters_reference.md | 4 +-
docs/quickstart.md | 14 ++
12 files changed, 335 insertions(+), 15 deletions(-)
create mode 100644 FFUDevelopment/unattend/SampleSerialComputerNames.csv
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index fe09363..d37ff13 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -73,7 +73,7 @@ When set to $true, will copy the provisioning package from the $FFUDevelopmentPa
When set to $true, stages the selected architecture-specific unattend XML file as Unattend.xml on the deployment partition of the USB drive. Default is $false.
.PARAMETER DeviceNamingMode
-Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Supported values are Legacy, None, Prompt, Template, and Prefixes.
+Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Supported values are Legacy, None, Prompt, Template, Prefixes, and SerialComputerNames.
.PARAMETER DeviceNameTemplate
Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when CopyUnattend is used.
@@ -84,6 +84,12 @@ Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a l
.PARAMETER DeviceNamePrefixesPath
Path to the source prefixes file used for legacy copy or when DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt.
+.PARAMETER DeviceNameSerialComputerNames
+Sets the CSV content used when DeviceNamingMode is SerialComputerNames. The CSV must include SerialNumber and ComputerName headers.
+
+.PARAMETER DeviceNameSerialComputerNamesPath
+Path to the source CSV file used when DeviceNamingMode is SerialComputerNames and DeviceNameSerialComputerNames is not supplied. Default is $FFUDevelopmentPath\Unattend\SerialComputerNames.csv.
+
.PARAMETER UnattendX64FilePath
Path to the x64 unattend XML source file. Default is $FFUDevelopmentPath\Unattend\unattend_x64.xml.
@@ -425,11 +431,13 @@ param(
[bool]$AllowVHDXCaching,
[bool]$CopyPPKG,
[bool]$CopyUnattend,
- [ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')]
+ [ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')]
[string]$DeviceNamingMode = 'Legacy',
[string]$DeviceNameTemplate,
[string[]]$DeviceNamePrefixes,
[string]$DeviceNamePrefixesPath,
+ [string[]]$DeviceNameSerialComputerNames,
+ [string]$DeviceNameSerialComputerNamesPath,
[string]$UnattendX64FilePath,
[string]$UnattendArm64FilePath,
[bool]$CopyAutopilot,
@@ -644,7 +652,7 @@ function Save-StagedUnattendFile {
[Parameter(Mandatory = $true)]
[string]$DestinationPath,
[Parameter(Mandatory = $true)]
- [ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')]
+ [ValidateSet('Legacy', 'None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')]
[string]$DeviceNamingMode,
[string]$DeviceNameTemplate,
[Parameter(Mandatory = $true)]
@@ -685,6 +693,11 @@ function Save-StagedUnattendFile {
$computerNamePath.ComputerNameElement.InnerText = '*'
}
}
+ elseif ($DeviceNamingMode -eq 'SerialComputerNames') {
+ if ($computerNamePath.CreatedComputerNameElement) {
+ $computerNamePath.ComputerNameElement.InnerText = '*'
+ }
+ }
elseif (($DeviceNamingMode -eq 'Legacy') -and $computerNamePath.CreatedComputerNameElement) {
$computerNamePath.ComputerNameElement.InnerText = if ($LegacyPrefixesWillBeStaged) { '*' } else { 'MyComputer' }
}
@@ -707,12 +720,24 @@ $resolvedDeviceNamePrefixesPath = if ([string]::IsNullOrWhiteSpace($DeviceNamePr
else {
$DeviceNamePrefixesPath
}
+$effectiveDeviceNameSerialComputerNames = @($DeviceNameSerialComputerNames | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
+$resolvedDeviceNameSerialComputerNamesPath = if ([string]::IsNullOrWhiteSpace($DeviceNameSerialComputerNamesPath)) {
+ Join-Path (Join-Path $FFUDevelopmentPath 'Unattend') 'SerialComputerNames.csv'
+}
+else {
+ $DeviceNameSerialComputerNamesPath
+}
if (($DeviceNamingMode -eq 'Prefixes') -and ($effectiveDeviceNamePrefixes.Count -eq 0) -and (Test-Path -Path $resolvedDeviceNamePrefixesPath -PathType Leaf)) {
$effectiveDeviceNamePrefixes = @(Get-Content -Path $resolvedDeviceNamePrefixesPath | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
WriteLog "Loaded device name prefixes from $resolvedDeviceNamePrefixesPath"
}
+if (($DeviceNamingMode -eq 'SerialComputerNames') -and ($effectiveDeviceNameSerialComputerNames.Count -eq 0) -and (Test-Path -Path $resolvedDeviceNameSerialComputerNamesPath -PathType Leaf)) {
+ $effectiveDeviceNameSerialComputerNames = @(Get-Content -Path $resolvedDeviceNameSerialComputerNamesPath | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
+ WriteLog "Loaded serial computer-name mappings from $resolvedDeviceNameSerialComputerNamesPath"
+}
+
if ($CopyUnattend -and $InjectUnattend) {
throw 'CopyUnattend and InjectUnattend cannot both be set to `$true. Select only one unattend delivery method.'
}
@@ -749,6 +774,38 @@ elseif ($DeviceNamingMode -eq 'Prefixes') {
throw 'DeviceNamingMode Prefixes requires at least one DeviceNamePrefixes entry or a valid DeviceNamePrefixesPath.'
}
}
+elseif ($DeviceNamingMode -eq 'SerialComputerNames') {
+ if (-not $CopyUnattend) {
+ throw 'DeviceNamingMode SerialComputerNames requires CopyUnattend. Serial-to-computer-name mapping is not supported with InjectUnattend.'
+ }
+
+ if ($effectiveDeviceNameSerialComputerNames.Count -eq 0) {
+ throw 'DeviceNamingMode SerialComputerNames requires DeviceNameSerialComputerNames content or a valid DeviceNameSerialComputerNamesPath.'
+ }
+
+ try {
+ $serialComputerNameMappings = @($effectiveDeviceNameSerialComputerNames | ConvertFrom-Csv -ErrorAction Stop)
+ }
+ catch {
+ throw "DeviceNamingMode SerialComputerNames requires valid CSV content with SerialNumber and ComputerName headers. $($_.Exception.Message)"
+ }
+
+ if ($serialComputerNameMappings.Count -eq 0) {
+ throw 'DeviceNamingMode SerialComputerNames requires at least one CSV data row.'
+ }
+
+ $serialComputerNameHeaders = @($serialComputerNameMappings[0].PSObject.Properties.Name)
+ if ((-not ($serialComputerNameHeaders -contains 'SerialNumber')) -or (-not ($serialComputerNameHeaders -contains 'ComputerName'))) {
+ throw 'DeviceNamingMode SerialComputerNames requires SerialNumber and ComputerName headers.'
+ }
+
+ $validSerialComputerNameMappings = @($serialComputerNameMappings | Where-Object {
+ -not [string]::IsNullOrWhiteSpace([string]$_.SerialNumber) -and -not [string]::IsNullOrWhiteSpace([string]$_.ComputerName)
+ })
+ if ($validSerialComputerNameMappings.Count -eq 0) {
+ throw 'DeviceNamingMode SerialComputerNames requires at least one row with both SerialNumber and ComputerName values.'
+ }
+}
# Validate that the selected Windows SKU is compatible with the chosen Windows release and ensure an ISO is provided for unsupported releases
$clientSKUs = @(
@@ -4570,6 +4627,11 @@ Function New-DeploymentUSB {
$computerNamePath.ComputerNameElement.InnerText = '*'
}
}
+ elseif ($DeviceNamingMode -eq 'SerialComputerNames') {
+ if ($computerNamePath.CreatedComputerNameElement) {
+ $computerNamePath.ComputerNameElement.InnerText = '*'
+ }
+ }
elseif (($DeviceNamingMode -eq 'Legacy') -and $computerNamePath.CreatedComputerNameElement) {
$computerNamePath.ComputerNameElement.InnerText = if ($LegacyPrefixesWillBeStaged) { '*' } else { 'MyComputer' }
}
@@ -4644,6 +4706,10 @@ Function New-DeploymentUSB {
WriteLog "Writing prefixes.txt file to $UnattendPathOnUSB"
$using:effectiveDeviceNamePrefixes | Set-Content -Path (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Encoding UTF8
}
+ elseif ($using:DeviceNamingMode -eq 'SerialComputerNames') {
+ WriteLog "Writing SerialComputerNames.csv file to $UnattendPathOnUSB"
+ $using:effectiveDeviceNameSerialComputerNames | Set-Content -Path (Join-Path $UnattendPathOnUSB 'SerialComputerNames.csv') -Encoding UTF8
+ }
elseif ($legacyPrefixesWillBeStaged) {
WriteLog "Copying prefixes.txt file to $UnattendPathOnUSB"
Copy-Item -Path $using:resolvedDeviceNamePrefixesPath -Destination (Join-Path $UnattendPathOnUSB 'prefixes.txt') -Force | Out-Null
diff --git a/FFUDevelopment/BuildFFUVM_UI.ps1 b/FFUDevelopment/BuildFFUVM_UI.ps1
index f2503d6..2dd3c1e 100644
--- a/FFUDevelopment/BuildFFUVM_UI.ps1
+++ b/FFUDevelopment/BuildFFUVM_UI.ps1
@@ -528,6 +528,22 @@ $script:uiState.Controls.btnRun.Add_Click({
return
}
}
+ elseif ($config.DeviceNamingMode -eq 'SerialComputerNames') {
+ if (-not $config.CopyUnattend) {
+ [System.Windows.MessageBox]::Show("Select Copy Unattend.xml before using 'Specify Serial to Device Name Mapping'.", "Copy Unattend Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: serial computer-name mapping requires Copy Unattend.xml."
+ return
+ }
+
+ $hasSavedSerialComputerNamesPath = -not [string]::IsNullOrWhiteSpace([string]$config.DeviceNameSerialComputerNamesPath) -and (Test-Path -Path $config.DeviceNameSerialComputerNamesPath -PathType Leaf)
+ if ((($null -eq $config.DeviceNameSerialComputerNames) -or ($config.DeviceNameSerialComputerNames.Count -eq 0)) -and -not $hasSavedSerialComputerNamesPath) {
+ [System.Windows.MessageBox]::Show("Enter CSV content or choose a valid SerialComputerNames.csv file before using 'Specify Serial to Device Name Mapping'.", "Serial Mapping Required", "OK", "Warning") | Out-Null
+ $btnRun.IsEnabled = $true
+ $script:uiState.Controls.txtStatus.Text = "Build canceled: serial computer-name mapping required."
+ return
+ }
+ }
$configFilePath = Join-Path $config.FFUDevelopmentPath "\config\FFUConfig.json"
# Sort top-level keys alphabetically for consistent output
diff --git a/FFUDevelopment/BuildFFUVM_UI.xaml b/FFUDevelopment/BuildFFUVM_UI.xaml
index e1977cb..7de9f6d 100644
--- a/FFUDevelopment/BuildFFUVM_UI.xaml
+++ b/FFUDevelopment/BuildFFUVM_UI.xaml
@@ -963,6 +963,24 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
index a7a5d6d..90616a4 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Config.psm1
@@ -40,6 +40,8 @@ function Get-UIConfig {
DeviceNameTemplate = $State.Controls.txtDeviceNameTemplate.Text
DeviceNamePrefixesPath = $State.Controls.txtDeviceNamePrefixesPath.Text
DeviceNamePrefixes = @(Get-DeviceNamePrefixes -State $State)
+ DeviceNameSerialComputerNamesPath = $State.Controls.txtDeviceNameSerialComputerNamesPath.Text
+ DeviceNameSerialComputerNames = @(Get-SerialComputerNamesLines -State $State)
CopyAdditionalFFUFiles = $State.Controls.chkCopyAdditionalFFUFiles.IsChecked
CreateDeploymentMedia = $State.Controls.chkCreateDeploymentMedia.IsChecked
InjectUnattend = $State.Controls.chkInjectUnattend.IsChecked
@@ -473,21 +475,27 @@ function Update-UIFromConfig {
Set-UIValue -ControlName 'chkCopyUnattend' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyUnattend' -State $State
Set-UIValue -ControlName 'chkCopyPPKG' -PropertyName 'IsChecked' -ConfigObject $ConfigContent -ConfigKey 'CopyPPKG' -State $State
Set-UIValue -ControlName 'txtDeviceNamePrefixesPath' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNamePrefixesPath' -State $State
+ Set-UIValue -ControlName 'txtDeviceNameSerialComputerNamesPath' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNameSerialComputerNamesPath' -State $State
Set-UIValue -ControlName 'txtDeviceNameTemplate' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNameTemplate' -State $State
Set-UIValue -ControlName 'txtDeviceNamePrefixes' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNamePrefixes' -TransformValue { param($val) if ($val -is [System.Array]) { $val -join [System.Environment]::NewLine } else { [string]$val } } -State $State
+ Set-UIValue -ControlName 'txtDeviceNameSerialComputerNames' -PropertyName 'Text' -ConfigObject $ConfigContent -ConfigKey 'DeviceNameSerialComputerNames' -TransformValue { param($val) if ($val -is [System.Array]) { $val -join [System.Environment]::NewLine } else { [string]$val } } -State $State
if ([string]::IsNullOrWhiteSpace($State.Controls.txtDeviceNamePrefixesPath.Text)) {
$State.Controls.txtDeviceNamePrefixesPath.Text = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text
}
+ if ([string]::IsNullOrWhiteSpace($State.Controls.txtDeviceNameSerialComputerNamesPath.Text)) {
+ $State.Controls.txtDeviceNameSerialComputerNamesPath.Text = Get-DefaultSerialComputerNamesPath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text
+ }
+
$loadedDeviceNamingMode = $null
if ($ConfigContent.PSObject.Properties.Name -contains 'DeviceNamingMode') {
$candidateDeviceNamingMode = [string]$ConfigContent.DeviceNamingMode
- if ($candidateDeviceNamingMode -in @('Legacy', 'None', 'Prompt', 'Template', 'Prefixes')) {
+ if ($candidateDeviceNamingMode -in @('Legacy', 'None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')) {
$loadedDeviceNamingMode = $candidateDeviceNamingMode
}
}
- $displayDeviceNamingMode = if ($loadedDeviceNamingMode -in @('Prompt', 'Template', 'Prefixes')) {
+ $displayDeviceNamingMode = if ($loadedDeviceNamingMode -in @('Prompt', 'Template', 'Prefixes', 'SerialComputerNames')) {
$loadedDeviceNamingMode
}
else {
@@ -495,6 +503,7 @@ function Update-UIFromConfig {
}
Set-DeviceNamingModeState -State $State -DisplayMode $displayDeviceNamingMode -LoadedMode $loadedDeviceNamingMode
Import-DeviceNamePrefixesFromConfiguredPath -State $State
+ Import-SerialComputerNamesFromConfiguredPath -State $State
Update-DeviceNamingControls -State $State
# Post Build Cleanup group (Build Tab)
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
index 6b86f6f..c77825d 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Handlers.psm1
@@ -42,13 +42,17 @@ function Get-SelectedDeviceNamingMode {
return 'Prefixes'
}
+ if ($true -eq $State.Controls.rbDeviceNamingSerialComputerNames.IsChecked) {
+ return 'SerialComputerNames'
+ }
+
return 'None'
}
function Set-DeviceNamingMode {
param(
[PSCustomObject]$State,
- [ValidateSet('None', 'Prompt', 'Template', 'Prefixes')]
+ [ValidateSet('None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')]
[string]$Mode
)
@@ -56,12 +60,13 @@ function Set-DeviceNamingMode {
$State.Controls.rbDeviceNamingPrompt.IsChecked = $Mode -eq 'Prompt'
$State.Controls.rbDeviceNamingTemplate.IsChecked = $Mode -eq 'Template'
$State.Controls.rbDeviceNamingPrefixes.IsChecked = $Mode -eq 'Prefixes'
+ $State.Controls.rbDeviceNamingSerialComputerNames.IsChecked = $Mode -eq 'SerialComputerNames'
}
function Set-DeviceNamingModeState {
param(
[PSCustomObject]$State,
- [ValidateSet('None', 'Prompt', 'Template', 'Prefixes')]
+ [ValidateSet('None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')]
[string]$DisplayMode,
[AllowNull()]
[string]$LoadedMode
@@ -121,6 +126,20 @@ function Get-DeviceNamePrefixes {
)
}
+function Get-SerialComputerNamesLines {
+ param([PSCustomObject]$State)
+
+ if ($null -eq $State.Controls.txtDeviceNameSerialComputerNames) {
+ return @()
+ }
+
+ return @(
+ $State.Controls.txtDeviceNameSerialComputerNames.Text -split "\r?\n" |
+ Where-Object { -not [string]::IsNullOrWhiteSpace($_) } |
+ ForEach-Object { $_.Trim() }
+ )
+}
+
function Import-DeviceNamePrefixesFile {
param(
[PSCustomObject]$State,
@@ -140,6 +159,25 @@ function Import-DeviceNamePrefixesFile {
return $true
}
+function Import-SerialComputerNamesFile {
+ param(
+ [PSCustomObject]$State,
+ [string]$FilePath
+ )
+
+ if ([string]::IsNullOrWhiteSpace($FilePath) -or -not (Test-Path -Path $FilePath -PathType Leaf)) {
+ return $false
+ }
+
+ $serialMappingLines = @(Get-Content -Path $FilePath | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | ForEach-Object { $_.Trim() })
+ if ($null -ne $State.Controls.txtDeviceNameSerialComputerNamesPath) {
+ $State.Controls.txtDeviceNameSerialComputerNamesPath.Text = $FilePath
+ }
+ $State.Controls.txtDeviceNameSerialComputerNames.Text = $serialMappingLines -join [System.Environment]::NewLine
+ WriteLog "Imported serial computer-name mappings from $FilePath"
+ return $true
+}
+
function Get-DefaultDeviceNamePrefixesPath {
param([string]$FFUDevelopmentPath)
@@ -150,6 +188,16 @@ function Get-DefaultDeviceNamePrefixesPath {
return Join-Path (Join-Path $FFUDevelopmentPath 'unattend') 'prefixes.txt'
}
+function Get-DefaultSerialComputerNamesPath {
+ param([string]$FFUDevelopmentPath)
+
+ if ([string]::IsNullOrWhiteSpace($FFUDevelopmentPath)) {
+ return $null
+ }
+
+ return Join-Path (Join-Path $FFUDevelopmentPath 'unattend') 'SerialComputerNames.csv'
+}
+
function Get-DefaultUnattendFilePath {
param(
[string]$FFUDevelopmentPath,
@@ -188,6 +236,29 @@ function Import-DeviceNamePrefixesFromConfiguredPath {
}
}
+function Import-SerialComputerNamesFromConfiguredPath {
+ param(
+ [PSCustomObject]$State,
+ [switch]$SkipIfTextPresent
+ )
+
+ if ($SkipIfTextPresent -and -not [string]::IsNullOrWhiteSpace($State.Controls.txtDeviceNameSerialComputerNames.Text)) {
+ return
+ }
+
+ $serialComputerNamesPath = $State.Controls.txtDeviceNameSerialComputerNamesPath.Text
+ if ([string]::IsNullOrWhiteSpace($serialComputerNamesPath)) {
+ $serialComputerNamesPath = Get-DefaultSerialComputerNamesPath -FFUDevelopmentPath $State.Controls.txtFFUDevPath.Text
+ if (-not [string]::IsNullOrWhiteSpace($serialComputerNamesPath) -and $null -ne $State.Controls.txtDeviceNameSerialComputerNamesPath) {
+ $State.Controls.txtDeviceNameSerialComputerNamesPath.Text = $serialComputerNamesPath
+ }
+ }
+
+ if (Test-Path -Path $serialComputerNamesPath -PathType Leaf) {
+ Import-SerialComputerNamesFile -State $State -FilePath $serialComputerNamesPath | Out-Null
+ }
+}
+
function Test-DeviceNameTemplateUsesSerialToken {
param([PSCustomObject]$State)
@@ -201,7 +272,7 @@ function Update-UnattendSelectionControls {
$isCopyUnattendSelected = $true -eq $State.Controls.chkCopyUnattend.IsChecked
$isInjectUnattendSelected = $true -eq $State.Controls.chkInjectUnattend.IsChecked
$deviceNameTemplateUsesSerialToken = Test-DeviceNameTemplateUsesSerialToken -State $State
- $requiresCopiedUnattend = ($selectedDeviceNamingMode -in @('Prompt', 'Prefixes')) -or $deviceNameTemplateUsesSerialToken
+ $requiresCopiedUnattend = ($selectedDeviceNamingMode -in @('Prompt', 'Prefixes', 'SerialComputerNames')) -or $deviceNameTemplateUsesSerialToken
if ($isCopyUnattendSelected -and $isInjectUnattendSelected) {
if ($requiresCopiedUnattend) {
@@ -247,19 +318,24 @@ function Update-UnattendSelectionControls {
function Update-DeviceNamingControls {
param([PSCustomObject]$State)
- if (($true -eq $State.Controls.chkInjectUnattend.IsChecked) -and (($true -eq $State.Controls.rbDeviceNamingPrompt.IsChecked) -or ($true -eq $State.Controls.rbDeviceNamingPrefixes.IsChecked))) {
+ if (($true -eq $State.Controls.chkInjectUnattend.IsChecked) -and (($true -eq $State.Controls.rbDeviceNamingPrompt.IsChecked) -or ($true -eq $State.Controls.rbDeviceNamingPrefixes.IsChecked) -or ($true -eq $State.Controls.rbDeviceNamingSerialComputerNames.IsChecked))) {
$State.Controls.rbDeviceNamingNone.IsChecked = $true
}
$selectedDeviceNamingMode = Get-SelectedDeviceNamingMode -State $State
$State.Controls.deviceNameTemplatePanel.Visibility = if ($selectedDeviceNamingMode -eq 'Template') { 'Visible' } else { 'Collapsed' }
$State.Controls.deviceNamePrefixesPanel.Visibility = if ($selectedDeviceNamingMode -eq 'Prefixes') { 'Visible' } else { 'Collapsed' }
+ $State.Controls.deviceNameSerialComputerNamesPanel.Visibility = if ($selectedDeviceNamingMode -eq 'SerialComputerNames') { 'Visible' } else { 'Collapsed' }
$State.Controls.rbDeviceNamingPrompt.IsEnabled = -not ($true -eq $State.Controls.chkInjectUnattend.IsChecked)
$State.Controls.rbDeviceNamingPrefixes.IsEnabled = -not ($true -eq $State.Controls.chkInjectUnattend.IsChecked)
+ $State.Controls.rbDeviceNamingSerialComputerNames.IsEnabled = -not ($true -eq $State.Controls.chkInjectUnattend.IsChecked)
if ($selectedDeviceNamingMode -eq 'Prefixes') {
Import-DeviceNamePrefixesFromConfiguredPath -State $State -SkipIfTextPresent
}
+ elseif ($selectedDeviceNamingMode -eq 'SerialComputerNames') {
+ Import-SerialComputerNamesFromConfiguredPath -State $State -SkipIfTextPresent
+ }
Update-UnattendSelectionControls -State $State
}
@@ -480,18 +556,24 @@ function Register-EventHandlers {
$selectedPath = Invoke-BrowseAction -Type 'Folder' -Title "Select FFU Development Path"
if ($selectedPath) {
$currentPrefixesPath = $localState.Controls.txtDeviceNamePrefixesPath.Text
+ $currentSerialComputerNamesPath = $localState.Controls.txtDeviceNameSerialComputerNamesPath.Text
$currentUnattendX64FilePath = $localState.Controls.txtUnattendX64FilePath.Text
$currentUnattendArm64FilePath = $localState.Controls.txtUnattendArm64FilePath.Text
$previousDefaultPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
+ $previousDefaultSerialComputerNamesPath = Get-DefaultSerialComputerNamesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
$previousDefaultUnattendX64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text -WindowsArch 'x64'
$previousDefaultUnattendArm64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text -WindowsArch 'arm64'
$localState.Controls.txtFFUDevPath.Text = $selectedPath
$newDefaultPrefixesPath = Get-DefaultDeviceNamePrefixesPath -FFUDevelopmentPath $selectedPath
+ $newDefaultSerialComputerNamesPath = Get-DefaultSerialComputerNamesPath -FFUDevelopmentPath $selectedPath
$newDefaultUnattendX64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $selectedPath -WindowsArch 'x64'
$newDefaultUnattendArm64FilePath = Get-DefaultUnattendFilePath -FFUDevelopmentPath $selectedPath -WindowsArch 'arm64'
if ([string]::IsNullOrWhiteSpace($currentPrefixesPath) -or $currentPrefixesPath -ieq $previousDefaultPrefixesPath) {
$localState.Controls.txtDeviceNamePrefixesPath.Text = $newDefaultPrefixesPath
}
+ if ([string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath) -or $currentSerialComputerNamesPath -ieq $previousDefaultSerialComputerNamesPath) {
+ $localState.Controls.txtDeviceNameSerialComputerNamesPath.Text = $newDefaultSerialComputerNamesPath
+ }
if ([string]::IsNullOrWhiteSpace($currentUnattendX64FilePath) -or $currentUnattendX64FilePath -ieq $previousDefaultUnattendX64FilePath) {
$localState.Controls.txtUnattendX64FilePath.Text = $newDefaultUnattendX64FilePath
}
@@ -499,6 +581,7 @@ function Register-EventHandlers {
$localState.Controls.txtUnattendArm64FilePath.Text = $newDefaultUnattendArm64FilePath
}
Import-DeviceNamePrefixesFromConfiguredPath -State $localState
+ Import-SerialComputerNamesFromConfiguredPath -State $localState
Update-DeviceNamingControls -State $localState
}
})
@@ -560,6 +643,16 @@ function Register-EventHandlers {
}
Update-DeviceNamingControls -State $localState
})
+ $State.Controls.rbDeviceNamingSerialComputerNames.Add_Checked({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ if (-not ($true -eq $localState.Flags.suppressDeviceNamingChangeTracking)) {
+ $localState.Flags.deviceNamingModeWasExplicitlyChanged = $true
+ $localState.Data.loadedDeviceNamingMode = $null
+ }
+ Update-DeviceNamingControls -State $localState
+ })
$State.Controls.btnBrowseDeviceNamePrefixesPath.Add_Click({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
@@ -580,6 +673,26 @@ function Register-EventHandlers {
Update-DeviceNamingControls -State $localState
}
})
+ $State.Controls.btnBrowseDeviceNameSerialComputerNamesPath.Add_Click({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $currentSerialComputerNamesPath = $localState.Controls.txtDeviceNameSerialComputerNamesPath.Text
+ if ([string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath)) {
+ $currentSerialComputerNamesPath = Get-DefaultSerialComputerNamesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
+ }
+ $initialDirectory = if ([string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath)) {
+ $null
+ }
+ else {
+ Split-Path $currentSerialComputerNamesPath -Parent
+ }
+ $fileName = if ([string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath)) { 'SerialComputerNames.csv' } else { Split-Path $currentSerialComputerNamesPath -Leaf }
+ $selectedPath = Invoke-BrowseAction -Type 'OpenFile' -Title 'Select SerialComputerNames.csv file path' -Filter 'CSV files (*.csv)|*.csv|All files (*.*)|*.*' -InitialDirectory $initialDirectory -FileName $fileName
+ if (Import-SerialComputerNamesFile -State $localState -FilePath $selectedPath) {
+ Update-DeviceNamingControls -State $localState
+ }
+ })
$State.Controls.btnBrowseUnattendX64FilePath.Add_Click({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
@@ -653,6 +766,39 @@ function Register-EventHandlers {
[System.Windows.MessageBox]::Show("Saving prefixes failed for '$currentPrefixesPath'. $($_.Exception.Message)", "Save Prefixes Failed", "OK", "Error") | Out-Null
}
})
+ $State.Controls.btnSaveDeviceNameSerialComputerNames.Add_Click({
+ param($eventSource, $routedEventArgs)
+ $window = [System.Windows.Window]::GetWindow($eventSource)
+ $localState = $window.Tag
+ $serialComputerNameLines = @(Get-SerialComputerNamesLines -State $localState)
+
+ if ($serialComputerNameLines.Count -eq 0) {
+ [System.Windows.MessageBox]::Show("Enter CSV content before saving the serial mapping file.", "Serial Mapping Required", "OK", "Warning") | Out-Null
+ return
+ }
+
+ $currentSerialComputerNamesPath = $localState.Controls.txtDeviceNameSerialComputerNamesPath.Text
+ if ([string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath)) {
+ $currentSerialComputerNamesPath = Get-DefaultSerialComputerNamesPath -FFUDevelopmentPath $localState.Controls.txtFFUDevPath.Text
+ if (-not [string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath)) {
+ $localState.Controls.txtDeviceNameSerialComputerNamesPath.Text = $currentSerialComputerNamesPath
+ }
+ }
+
+ if ([string]::IsNullOrWhiteSpace($currentSerialComputerNamesPath)) {
+ [System.Windows.MessageBox]::Show("Select a valid SerialComputerNames.csv file path before saving the serial mapping.", "Serial Mapping File Path Required", "OK", "Warning") | Out-Null
+ return
+ }
+
+ try {
+ $serialComputerNameLines | Set-Content -Path $currentSerialComputerNamesPath -Encoding UTF8
+ $localState.Controls.txtDeviceNameSerialComputerNamesPath.Text = $currentSerialComputerNamesPath
+ WriteLog "Saved serial computer-name mappings to $currentSerialComputerNamesPath"
+ }
+ catch {
+ [System.Windows.MessageBox]::Show("Saving serial mapping failed for '$currentSerialComputerNamesPath'. $($_.Exception.Message)", "Save Serial Mapping Failed", "OK", "Error") | Out-Null
+ }
+ })
$State.Controls.chkCopyUnattend.Add_Checked({
param($eventSource, $routedEventArgs)
$window = [System.Windows.Window]::GetWindow($eventSource)
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
index 43530b8..ca8f396 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.Initialize.psm1
@@ -228,13 +228,19 @@ function Initialize-UIControls {
$State.Controls.rbDeviceNamingPrompt = $window.FindName('rbDeviceNamingPrompt')
$State.Controls.rbDeviceNamingTemplate = $window.FindName('rbDeviceNamingTemplate')
$State.Controls.rbDeviceNamingPrefixes = $window.FindName('rbDeviceNamingPrefixes')
+ $State.Controls.rbDeviceNamingSerialComputerNames = $window.FindName('rbDeviceNamingSerialComputerNames')
$State.Controls.deviceNameTemplatePanel = $window.FindName('deviceNameTemplatePanel')
$State.Controls.deviceNamePrefixesPanel = $window.FindName('deviceNamePrefixesPanel')
+ $State.Controls.deviceNameSerialComputerNamesPanel = $window.FindName('deviceNameSerialComputerNamesPanel')
$State.Controls.txtDeviceNameTemplate = $window.FindName('txtDeviceNameTemplate')
$State.Controls.txtDeviceNamePrefixesPath = $window.FindName('txtDeviceNamePrefixesPath')
$State.Controls.btnBrowseDeviceNamePrefixesPath = $window.FindName('btnBrowseDeviceNamePrefixesPath')
$State.Controls.txtDeviceNamePrefixes = $window.FindName('txtDeviceNamePrefixes')
$State.Controls.btnSaveDeviceNamePrefixes = $window.FindName('btnSaveDeviceNamePrefixes')
+ $State.Controls.txtDeviceNameSerialComputerNamesPath = $window.FindName('txtDeviceNameSerialComputerNamesPath')
+ $State.Controls.btnBrowseDeviceNameSerialComputerNamesPath = $window.FindName('btnBrowseDeviceNameSerialComputerNamesPath')
+ $State.Controls.txtDeviceNameSerialComputerNames = $window.FindName('txtDeviceNameSerialComputerNames')
+ $State.Controls.btnSaveDeviceNameSerialComputerNames = $window.FindName('btnSaveDeviceNameSerialComputerNames')
$State.Controls.chkVerbose = $window.FindName('chkVerbose')
$State.Controls.chkCopyAutopilot = $window.FindName('chkCopyAutopilot')
$State.Controls.chkCopyUnattend = $window.FindName('chkCopyUnattend')
@@ -400,7 +406,7 @@ function Initialize-UIDefaults {
$State.Controls.chkCopyAutopilot.IsChecked = $State.Defaults.generalDefaults.CopyAutopilot
$State.Controls.chkCopyUnattend.IsChecked = $State.Defaults.generalDefaults.CopyUnattend
$State.Controls.chkCopyPPKG.IsChecked = $State.Defaults.generalDefaults.CopyPPKG
- $defaultDeviceNamingMode = if ($State.Defaults.generalDefaults.DeviceNamingMode -in @('None', 'Prompt', 'Template', 'Prefixes')) {
+ $defaultDeviceNamingMode = if ($State.Defaults.generalDefaults.DeviceNamingMode -in @('None', 'Prompt', 'Template', 'Prefixes', 'SerialComputerNames')) {
$State.Defaults.generalDefaults.DeviceNamingMode
}
else {
@@ -410,7 +416,10 @@ function Initialize-UIDefaults {
$State.Controls.txtDeviceNameTemplate.Text = $State.Defaults.generalDefaults.DeviceNameTemplate
$State.Controls.txtDeviceNamePrefixesPath.Text = $State.Defaults.generalDefaults.DeviceNamePrefixesPath
$State.Controls.txtDeviceNamePrefixes.Text = ($State.Defaults.generalDefaults.DeviceNamePrefixes -join [System.Environment]::NewLine)
+ $State.Controls.txtDeviceNameSerialComputerNamesPath.Text = $State.Defaults.generalDefaults.DeviceNameSerialComputerNamesPath
+ $State.Controls.txtDeviceNameSerialComputerNames.Text = ($State.Defaults.generalDefaults.DeviceNameSerialComputerNames -join [System.Environment]::NewLine)
Import-DeviceNamePrefixesFromConfiguredPath -State $State
+ Import-SerialComputerNamesFromConfiguredPath -State $State
Update-DeviceNamingControls -State $State
$State.Controls.chkCleanupAppsISO.IsChecked = $State.Defaults.generalDefaults.CleanupAppsISO
$State.Controls.chkCleanupDeployISO.IsChecked = $State.Defaults.generalDefaults.CleanupDeployISO
diff --git a/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1 b/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
index 8957f4a..5f41546 100644
--- a/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
+++ b/FFUDevelopment/FFUUI.Core/FFUUI.Core.psm1
@@ -112,6 +112,7 @@ function Get-GeneralDefaults {
$userAppListPath = Join-Path -Path $appsPath -ChildPath "UserAppList.json"
$driversJsonPath = Join-Path -Path $driversPath -ChildPath "Drivers.json"
$deviceNamePrefixesPath = Join-Path -Path $unattendPath -ChildPath "prefixes.txt"
+ $deviceNameSerialComputerNamesPath = Join-Path -Path $unattendPath -ChildPath "SerialComputerNames.csv"
$unattendX64FilePath = Join-Path -Path $unattendPath -ChildPath "unattend_x64.xml"
$unattendArm64FilePath = Join-Path -Path $unattendPath -ChildPath "unattend_arm64.xml"
@@ -142,6 +143,8 @@ function Get-GeneralDefaults {
DeviceNameTemplate = ''
DeviceNamePrefixesPath = $deviceNamePrefixesPath
DeviceNamePrefixes = @()
+ DeviceNameSerialComputerNamesPath = $deviceNameSerialComputerNamesPath
+ DeviceNameSerialComputerNames = @()
CleanupAppsISO = $true
CleanupDeployISO = $true
CleanupDrivers = $false
diff --git a/FFUDevelopment/config/Sample_default.json b/FFUDevelopment/config/Sample_default.json
index 09ee3809718125cf9310f12a19e6e85eae76fc66..49192e40e14e1bea8cc293d813b00522e6187fa1 100644
GIT binary patch
delta 146
zcmaE1(qz8j58LE@Y$B?`45JE
delta 12
TcmZoNe_^uW58GxjjvQeCB*z5U
diff --git a/FFUDevelopment/unattend/SampleSerialComputerNames.csv b/FFUDevelopment/unattend/SampleSerialComputerNames.csv
new file mode 100644
index 0000000..58e390a
--- /dev/null
+++ b/FFUDevelopment/unattend/SampleSerialComputerNames.csv
@@ -0,0 +1,4 @@
+SerialNumber,ComputerName
+ABC12345,CORP-001
+DEF67890,KIOSK-010
+XYZ24680,STORE-015
\ No newline at end of file
diff --git a/docs/build.md b/docs/build.md
index 99f7b20..1e7bd04 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -340,7 +340,7 @@ This option is primarily intended for scenarios where:
| Limitation | Description |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **No prefixes.txt or %serial% support** | Unlike **Copy Unattend.xml**, this method does not support `prefixes.txt` or the `%serial%` variable for deployment-time device naming |
+| **No prefixes.txt, SerialComputerNames.csv, or %serial% support** | Unlike **Copy Unattend.xml**, this method does not support `prefixes.txt`, `SerialComputerNames.csv`, or the `%serial%` variable for deployment-time device naming |
| **Fixed configuration** | The unattend settings are baked into the FFU at build time and cannot be changed at deployment time |
| **Requires VM to be built** | This option only works when**Install Apps** is `$true` because the unattend file is included in the Apps ISO |
@@ -348,7 +348,7 @@ This option is primarily intended for scenarios where:
> Note
>
-> Most users should continue using the **Copy Unattend** option via the USB drive, which provides more flexibility including support for `prefixes.txt` device naming. Use **Inject Unattend.xml** only when you won't be using the USB drive for deployment.
+> Most users should continue using the **Copy Unattend** option via the USB drive, which provides more flexibility including support for `prefixes.txt`, `SerialComputerNames.csv`, and `%serial%` device naming. Use **Inject Unattend.xml** only when you won't be using the USB drive for deployment.
{: .tip-title}
@@ -423,6 +423,37 @@ Use **Prefixes File Path** to point the UI at the source text file for the prefi
Use **Save Prefixes** to write the current multiline prefixes list back to the file specified in **Prefixes File Path**.
+### Specify Serial to Device Name Mapping
+
+This option writes `SerialComputerNames.csv` from the CSV content in the UI. Use `SerialNumber,ComputerName` as the header row, then add one row per device. During deployment, `ApplyFFU.ps1` compares the current BIOS serial number to the `SerialNumber` column and uses the matching `ComputerName` value.
+
+Sample `SerialComputerNames.csv` content:
+
+```plaintext
+SerialNumber,ComputerName
+ABC12345,CORP-001
+DEF67890,KIOSK-010
+XYZ24680,STORE-015
+```
+
+- This option requires **Copy Unattend.xml**.
+- **Inject Unattend.xml** is not supported with this option.
+- If no matching serial number is found during deployment, `ApplyFFU.ps1` falls back to a random `FFU-*` computer name so setup can finish.
+
+{: .note-title}
+
+> Note
+>
+> If `prefixes.txt` and `SerialComputerNames.csv` are both staged manually on the same deployment media, `ApplyFFU.ps1` checks `prefixes.txt` first. FFU Builder avoids this conflict by only staging the naming file for the selected device-naming mode.
+
+### SerialComputerNames.csv File Path
+
+Use **SerialComputerNames.csv File Path** to point the UI at the source CSV file for the serial-to-device-name mapping. The file can use any name. When you browse to a mapping file in the UI, or when a saved configuration references a valid CSV path, the UI loads that file and populates the multiline CSV box from its contents.
+
+### Save Serial Mapping
+
+Use **Save Serial Mapping** to write the current CSV content back to the file specified in **SerialComputerNames.csv File Path**.
+
### Deployment Prompt Compatibility
Older deployment media that already has an unattend file with `ComputerName` set to the legacy placeholder value and no `prefixes.txt` file will still prompt for a device name during deployment.
@@ -443,8 +474,9 @@ The `.\FFUDevelopment\Unattend` folder includes sample files you can customize:
| **unattend_x64.xml** | Active unattend file used for x64 builds |
| **unattend_arm64.xml** | Active unattend file used for arm64 builds |
| **SamplePrefixes.txt** | Example prefixes file for device naming |
+| **SampleSerialComputerNames.csv** | Example serial-to-device-name CSV file |
-Copy and customize the sample files to create your own `unattend_x64.xml`, `unattend_arm64.xml`, and `prefixes.txt` files.
+Copy and customize the sample files to create your own `unattend_x64.xml`, `unattend_arm64.xml`, `prefixes.txt`, and `SerialComputerNames.csv` files.
{: .note-title}
@@ -537,12 +569,13 @@ When enabled, the build process copies:
- The selected x64 or arm64 unattend XML file → renamed to **Unattend.xml** on the USB drive
- **prefixes.txt** → created from the **Device Naming** prefixes list when that mode is selected
+- **SerialComputerNames.csv** → created from the **Device Naming** serial mapping list when that mode is selected
If you keep the default file paths in place, FFU Builder uses `unattend_x64.xml` for x64 builds and `unattend_arm64.xml` for arm64 builds.
During deployment, `ApplyFFU.ps1` applies `Unattend.xml` whenever it is present. Device naming only happens when the **Device Naming** setting requires it, or when older media still uses the legacy prompt-based workflow.
-See **Device Naming Expander** above for the available computer-name modes and prefixes-file behavior.
+See **Device Naming Expander** above for the available computer-name modes and naming-file behavior.
### Copy Provisioning Package
diff --git a/docs/parameters_reference.md b/docs/parameters_reference.md
index 400f89b..a87d625 100644
--- a/docs/parameters_reference.md
+++ b/docs/parameters_reference.md
@@ -41,12 +41,14 @@ This table lists all top-level parameters in BuildFFUVM.ps1.
| -CopyUnattend | bool | Copy Unattend.xml | When set to $true, stages the selected architecture-specific unattend XML file as Unattend.xml on the Deployment partition of the USB drive. Cannot be used together with -InjectUnattend. Default is $false. |
| -CreateDeploymentMedia | bool | Create Deployment Media | When set to $true, this will create WinPE deployment media for use when deploying to a physical device. |
| -CustomFFUNameTemplate | string | Custom FFU Name Template | Sets a custom FFU output name with placeholders. Allowed placeholders are: {WindowsRelease}, {WindowsVersion}, {SKU}, {BuildDate}, {yyyy}, {MM}, {dd}, {H}, {hh}, {mm}, {tt}. |
-| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Prompt, Template, and Prefixes. The UI shows None, Prompt, Template, and Prefixes. When device naming is left untouched in the UI, the generated config does not write DeviceNamingMode, which preserves the script default of Legacy. Prompt rewrites the staged deployment unattend to the existing manual prompt placeholder and requires -CopyUnattend. |
+| -DeviceNamingMode | string | Device Naming expander | Controls how device naming is handled when unattend content is copied to USB media or injected into the FFU. Accepted values are Legacy, None, Prompt, Template, Prefixes, and SerialComputerNames. The UI shows None, Prompt, Template, Prefixes, and SerialComputerNames. When device naming is left untouched in the UI, the generated config does not write DeviceNamingMode, which preserves the script default of Legacy. Prompt rewrites the staged deployment unattend to the existing manual prompt placeholder and requires -CopyUnattend. Prefixes writes prefixes.txt and requires -CopyUnattend. SerialComputerNames writes SerialComputerNames.csv and requires -CopyUnattend. |
| -DeviceNameTemplate | string | Specify Device Name | Sets the device name used when DeviceNamingMode is Template. Supports a static name or the %serial% token when -CopyUnattend is used. |
| -DeviceNamePrefixesPath | string | Prefixes File Path | Path to the source prefixes file used for legacy copy or when -DeviceNamePrefixes is not supplied. Default is $FFUDevelopmentPath\Unattend\prefixes.txt. |
+| -DeviceNameSerialComputerNamesPath | string | SerialComputerNames.csv File Path | Path to the source CSV file used when DeviceNamingMode is SerialComputerNames and -DeviceNameSerialComputerNames is not supplied. Default is $FFUDevelopmentPath\Unattend\SerialComputerNames.csv. |
| -UnattendX64FilePath | string | x64 Unattend File Path | Path to the x64 unattend XML source file used by Copy Unattend.xml and Inject Unattend.xml. Default is $FFUDevelopmentPath\Unattend\unattend_x64.xml. |
| -UnattendArm64FilePath | string | arm64 Unattend File Path | Path to the arm64 unattend XML source file used by Copy Unattend.xml and Inject Unattend.xml. Default is $FFUDevelopmentPath\Unattend\unattend_arm64.xml. |
| -DeviceNamePrefixes | string[] | Specify a list of Prefixes | Sets the prefixes used when DeviceNamingMode is Prefixes. Each entry becomes a line in prefixes.txt on the deployment media. |
+| -DeviceNameSerialComputerNames | string[] | Specify Serial to Device Name Mapping | Sets the CSV content used when DeviceNamingMode is SerialComputerNames. The content must include SerialNumber and ComputerName headers, and the staged file is written as SerialComputerNames.csv on the deployment media. |
| -Disksize | uint64 | Disk Size (GB) | Size of the virtual hard disk for the virtual machine. Default is a 50GB dynamic disk. |
| -DriversFolder | string | Drivers Folder | Path to the drivers folder. Default is $FFUDevelopmentPath\Drivers. |
| -DriversJsonPath | string | Drivers.json Path | Path to a JSON file that specifies which drivers to download. |
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 8ed8fe7..01d8c1d 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -213,6 +213,20 @@ This option writes `prefixes.txt` from the list in the UI. Enter one prefix per
>
> If the technician skips prefix selection when multiple prefixes are available, `ApplyFFU.ps1` leaves the existing unattend `ComputerName` value unchanged. With the current unattend samples set to `*`, Windows falls back to its default random computer-name behavior, typically resulting in a name such as `WIN-*`.
+**Specify Serial to Device Name Mapping**
+
+This option writes `SerialComputerNames.csv` from the CSV content in the UI. Use `SerialNumber,ComputerName` as the header row, then add one row per device. During deployment, `ApplyFFU.ps1` compares the current BIOS serial number to the CSV and applies the matching computer name.
+
+- This option requires **Copy Unattend.xml**.
+- **Inject Unattend.xml** is not supported with this option.
+- If no matching serial number is found during deployment, `ApplyFFU.ps1` falls back to a random `FFU-*` computer name.
+
+{: .note-title}
+
+> Note
+>
+> If `prefixes.txt` and `SerialComputerNames.csv` are both present on the same deployment media, `ApplyFFU.ps1` checks `prefixes.txt` first. FFU Builder stages only the naming file for the selected device-naming mode.
+
{: .warning-title}
> Warning
From 14811e3f9c7469b48e379fae47eeb9e3455e00cf Mon Sep 17 00:00:00 2001
From: rbalsleyMSFT <53497092+rbalsleyMSFT@users.noreply.github.com>
Date: Wed, 15 Apr 2026 14:42:23 -0700
Subject: [PATCH 10/10] Updates version to 2604.1
Increments the script version identifiers to reflect the new release cycle.
---
FFUDevelopment/BuildFFUVM.ps1 | 2 +-
FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1 | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/FFUDevelopment/BuildFFUVM.ps1 b/FFUDevelopment/BuildFFUVM.ps1
index d37ff13..a692f13 100644
--- a/FFUDevelopment/BuildFFUVM.ps1
+++ b/FFUDevelopment/BuildFFUVM.ps1
@@ -480,7 +480,7 @@ param(
[switch]$Cleanup
)
$ProgressPreference = 'SilentlyContinue'
-$version = '2603.2'
+$version = '2604.1'
# Remove any existing modules to avoid conflicts
if (Get-Module -Name 'FFU.Common.Core' -ErrorAction SilentlyContinue) {
diff --git a/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1 b/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
index 9fd106a..49b93ba 100644
--- a/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
+++ b/FFUDevelopment/WinPEDeployFFUFiles/ApplyFFU.ps1
@@ -950,7 +950,7 @@ $LogFileName = 'ScriptLog.txt'
$USBDrive = Get-USBDrive
New-item -Path $USBDrive -Name $LogFileName -ItemType "file" -Force | Out-Null
$LogFile = $USBDrive + $LogFilename
-$version = '2603.2'
+$version = '2604.1'
WriteLog 'Begin Logging'
WriteLog "Script version: $version"