OSD Module

The OSD module is a maintained PowerShell module that provides WinPE-based Windows deployment and is the original home of OSDCloud (v1).

For OSDCloud deployments, use the OSDCloud module instead of OSD. The OSDCloud module supersedes the OSDCloud v1 implementation in OSD. The OSD module is maintained but the OSDCloud module is preferred for all new work.

Property	Value
Publisher	Community / David Segura
Gallery	powershellgallery.com/packages/OSD
Platform	WinPE
Architecture	amd64 / arm64
Status	Maintained (OSDCloud v1 / legacy)
Functions Documented	346

OSD 26.8.1.1nuget

Overview

The OSD module was the original host of OSDCloud. The OSDCloud functionality was later extracted into the dedicated OSDCloud module, which is the current, recommended choice for all new deployments. The OSD module continues to be maintained and is required for environments that have existing OSDCloud v1 workflows or scripts built against it. For any new deployment project, start with the OSDCloud module.

When to Use the OSD Module

• Your existing scripts use Start-OSDCloud or other OSD-based OSDCloud v1 commands
• Your WinPE image was built with OSD-based tooling and you have not yet migrated
• You have a specific OSD function dependency outside of OSDCloud v1

Install

---

Related

• OSD on PowerShell Gallery
• OSDCloud Module — Current, recommended module for OSDCloud deployments
• OSDeploy Module — Boot image creation on Windows 11

---

Functions

The OSD module exports a large public function set. Use the groups below to find each function reference page.

Add Functions

Function	Description
Add-7Zip2BootImage	Adds 7-Zip command-line binaries to a mounted Windows image.
Add-WindowsPackageSSU	Adds a Servicing Stack Update package to Windows.

Backup Functions

Function	Description
Backup-DiskToFFU	Captures a physical disk to a Full Flash Update (FFU) image.
Backup-MyBitLockerKeys	Saves available BitLocker key materials to one or more folders.

Block Functions

Function	Description
Block-AdminUser	Blocks execution if the current user has Administrator rights
Block-ManufacturerNeLenovo	Blocks execution if the computer is not manufactured by Lenovo
Block-NoCurl	Blocks execution if curl.exe is not available
Block-NoInternet	Blocks execution if internet connectivity is not available
Block-PowerShellVersionLt5	Blocks execution if PowerShell version is less than 5
Block-StandardUser	Blocks execution if the current user does not have Administrator rights
Block-WindowsReleaseIdLt1703	Blocks execution if Windows ReleaseId is less than 1703
Block-WindowsVersionNe10	Blocks execution if Windows major version is not 10
Block-WinOS	Blocks execution if the system is not running WinPE
Block-WinPE	Blocks execution if the system is running WinPE

Clear Functions

Function	Description
Clear-LocalDisk	Clears LocalDisk data or state.
Clear-USBDisk	Clears USBDisk data or state.

Connect Functions

Function	Description
Connect-OSDCloudAzure	Connect to Azure and initialize OSDCloudAzure session state.

Convert Functions

Function	Description
Convert-EsdToFolder	Expands an ESD file into a Windows setup folder structure.
Convert-EsdToIso	Converts an ESD file into an ISO image.
Convert-EsdToWim	Converts an ESD file into a WIM image.
Convert-FolderToIso	Creates an ISO file from a source folder.
Convert-PNPDeviceIDtoGuid	Extracts GUID values from a PNP Device ID string.

ConvertTo Functions

Function	Description
ConvertTo-PSKeyVaultSecret	Converts a value to an Azure Key Vault Secret

Copy Functions

Function	Description
Copy-IsoToUsb	Creates a bootable USB drive from a Windows ISO.
Copy-PSModuleToFolder	Copies PowerShell modules to a destination module path.
Copy-PSModuleToWim	Copies PowerShell modules into an offline Windows image.
Copy-PSModuleToWindowsImage	Copies PowerShell modules to a mounted Windows image
Copy-WinREWIM	Copies the Windows Recovery Environment WIM to the specified DestinationDirectory

Dismount Functions

Function	Description
Dismount-MyWindowsImage	Dismounts MyWindowsImage and finalizes changes.

Edit Functions

Function	Description
Edit-AdkWinPEWIM	Adds PowerShell and PowerShell Gallery support to ADK's x64 winpe.wim
Edit-MyWindowsImage	Edits MyWindowsImage content.
Edit-MyWinPE	Mounts and edits a WinPE WIM file
Edit-OSDCloudWinPE	Edits content by using Edit-OSDCloudWinPE.

Enable Functions

Function	Description
Enable-OSDCloudODT	Enables ODT Support in an OSDCloud Workspace
Enable-PEWimPSGallery	Enables PowerShell Gallery functionality in a WinPE WIM file
Enable-PEWindowsImagePSGallery	Enables PowerShell Gallery in a mounted Windows image
Enable-SpecializeDriverPack	Configures driver pack expansion during Windows Specialize phase

Expand Functions

Function	Description
Expand-StagedDriverPack	Expands staged driver pack archives during Windows Setup
Expand-ZTIDriverPack	Expands driver packs during Lite Touch or Zero Touch deployment

Export Functions

Function	Description
Export-OSDCertificatesAsReg	Exports selected LocalMachine certificates as .reg files.

Find Functions

Function	Description
Find-OSDCloudFile	No synopsis provided.
Find-OSDCloudODTFile	No synopsis provided.
Find-OSDCloudOfflineFile	No synopsis provided.
Find-OSDCloudOfflinePath	No synopsis provided.
Find-TextInFile	Searches files for matching text and displays selectable results.
Find-TextInModule	Searches module files for matching text.

Get Functions

Function	Description
Get-AzClipboard	Read a secret value from the Azure clipboard Key Vault.
Get-AzOSDCloud	Initialize the local OSDCloud Azure workspace.
Get-AzOSDTechId	Find Azure AD users for an OSD tech identifier prefix.
Get-CimVideoControllerResolution	Returns CIM video controller resolution entries for the system display adapter.
Get-CloudSecret	Read a secret from Azure Key Vault.
Get-ComObjects	Lists registered COM ProgIDs from the local machine registry.
Get-ComObjMicrosoftUpdateAutoUpdate	Gets Microsoft Update automatic update settings through COM.
Get-ComObjMicrosoftUpdateInstaller	Creates and returns the Microsoft Update installer COM object.
Get-ComObjMicrosoftUpdateServiceManager	Gets Windows Update service registration details through COM.
Get-DataDisk	Gets DataDisk information.
Get-DellApplicationCatalog	Returns the Application Component of the Dell System Catalog
Get-DellBiosCatalog	Returns the BIOS Component of the Dell System Catalog
Get-DellDriverCatalog	Returns the Driver Component of the Dell System Catalog
Get-DellDriverPackCatalog	Returns the Dell DriverPack Catalog
Get-DellFirmwareCatalog	Returns the Firmware Component of the Dell System Catalog
Get-DellSystemCatalog	Builds the Dell System Catalog
Get-DellWinPE10DriverPack	Returns the URL of the latest Dell WinPE 10 Driver Pack
Get-DellWinPEDriverPack	Returns the URL of the latest Dell WinPE 11 Driver Pack
Get-DisplayAllScreens	Returns all display screens on the system
Get-DisplayPrimaryBitmapSize	Returns the primary display bitmap size accounting for DPI scaling
Get-DisplayPrimaryMonitorSize	Returns the primary display monitor size in pixels
Get-DisplayPrimaryScaling	Returns the DPI scaling percentage of the primary display
Get-DisplayVirtualScreen	Returns the virtual screen dimensions covering all displays
Get-DownLinks	Gets a list of links to download
Get-EnablementPackage	Returns the latest matching Windows enablement package metadata.
Get-FeatureUpdate	Returns the latest matching Windows client feature update record.
Get-GithubRawContent	Retrieves content from GitHub or Gist raw URLs.
Get-GithubRawUrl	Resolves a GitHub or Gist URL to one or more raw content URLs.
Get-HPAccessoryCatalog	Returns the 'Accessories Firmware and Driver' Component of the HP System Catalog
Get-HPBiosCatalog	Returns the BIOS Component of the HP System Catalog
Get-HPDeviceFamilyPlatformDetails	No synopsis provided.
Get-HPDriverCatalog	Returns the Driver Component of the HP System Catalog
Get-HPDriverPackCatalog	Returns the HP DriverPack Catalog
Get-HPDriverPackLatest	Gets the latest available HP driver pack for a platform.
Get-HPFirmwareCatalog	Returns the Firmware Component of the HP System Catalog
Get-HPIAJSONResult	No synopsis provided.
Get-HPIALatestVersion	No synopsis provided.
Get-HPIAXMLResult	No synopsis provided.
Get-HPOSSupport	Gets supported Windows releases for an HP platform from the HPIA catalog.
Get-HPPlatformCatalog	Converts the HP Platform list to a PowerShell Object.
Get-HPSoftPaqItems	Gets HPIA SoftPaq items for a specific HP platform and OS release.
Get-HPSoftpaqListLatest	Gets the latest HPIA SoftPaq list for an HP platform.
Get-HPSoftwareCatalog	Returns the Software Component of the HP System Catalog
Get-HPSystemCatalog	Converts the HP Client Catalog for Microsoft System Center Product to a PowerShell Object
Get-HPTPMDetermine	Determines which HP TPM firmware update package is required for the current device.
Get-HpWinPEDriverPack	Returns the URL of the latest HP WinPE 10 Driver Pack
Get-HyperVName	No synopsis provided.
Get-IntelEthernetDriverPack	Returns the Intel Ethernet Driver Object
Get-IntelGraphicsDriverPack	Returns the Intel Graphics Driver Object
Get-IntelRadeonDriverPack	Returns the Intel Radeon Graphics Driver Object
Get-IntelWirelessDriverPack	Returns the Intel Wireless Driver Object
Get-LenovoBiosCatalog	Builds the Lenovo Bios Catalog
Get-LenovoDriverPackCatalog	Returns the Lenovo DriverPack Catalog
Get-LocalDisk	Gets LocalDisk information.
Get-LocalDiskPartition	Gets LocalDiskPartition information.
Get-LocalDiskVolume	Gets LocalDiskVolume information.
Get-MsUpCat	Retrieves Microsoft updates from the Microsoft Update Catalog
Get-MsUpCatUpdate	Retrieves updates for a specific Windows operating system version from Microsoft Update Catalog
Get-MyBiosSerialNumber	Gets MyBiosSerialNumber information.
Get-MyBiosUpdate	Gets MyBiosUpdate information.
Get-MyBiosVersion	Gets MyBiosVersion information.
Get-MyBitLockerKeyProtectors	Returns BitLocker key protector details for encrypted volumes.
Get-MyComputerManufacturer	Gets MyComputerManufacturer information.
Get-MyComputerModel	Gets MyComputerModel information.
Get-MyComputerProduct	Gets MyComputerProduct information.
Get-MyDefaultAUService	Returns the Default AU Service from Microsoft.Update.ServiceManager
Get-MyDellBios	Returns the latest compatible Dell BIOS update for the current system.
Get-MyDriverPack	Retrieves the driver pack for the current computer from OSDCloud
Get-MyWindowsCapability	Gets MyWindowsCapability information.
Get-MyWindowsPackage	Gets MyWindowsPackage information.
Get-NativeMatchineImage	Gets NativeMatchineImage information.
Get-OSD	Displays information about the OSD Module
Get-OSDClass	Returns CimInstance information from common OSD Classes
Get-OSDCloudAzureResources	Discover OSDCloud Azure Storage resources.
Get-OSDCloudDriverPack	Gets the OSDCloud DriverPack for the current or specified computer model
Get-OSDCloudDriverPacks	Returns the DriverPacks used by OSDCloud
Get-OSDCloudOperatingSystems	Gets OSDCloud operating system entries for a specific architecture.
Get-OSDCloudOperatingSystemsIndexes	Returns OSDCloud operating system index entries by architecture.
Get-OSDCloudOperatingSystemsIndexMap	Returns OSDCloud operating system index map entries by architecture.
Get-OSDCloudOSNames	Returns the Operating Systems names used by OSDCloud
Get-OSDCloudTemplate	Gets information returned by Get-OSDCloudTemplate.
Get-OSDCloudTemplateNames	Gets information returned by Get-OSDCloudTemplateNames.
Get-OSDCloudVMDefaults	Gets the OSDCloudVM Module defaults from $Global:OSDModuleResource.NewOSDCloudVM
Get-OSDCloudVMSettings	Gets information returned by Get-OSDCloudVMSettings.
Get-OSDCloudWorkspace	Gets information returned by Get-OSDCloudWorkspace.
Get-OSDCoreCacheContent	Returns cached OSDCloud content found on local file system drives.
Get-OSDCoreCacheDrive	Returns OSDCloud cache drive metadata from local file system drives.
Get-OSDCoreCacheUSBPath	Returns OSDCloud cache paths located on USB drives.
Get-OSDCoreDeploymentDisk	Retrieves disk objects suitable for OS deployment with enhanced filtering capabilities.
Get-OSDCoreDriverPackCatalogDell	Downloads and parses the Dell driver pack catalog for Windows 11.
Get-OSDCoreDriverPackCatalogHP	Downloads and parses the HP driver pack catalog for Windows 11.
Get-OSDCoreDriverPackCatalogLenovo	Downloads and parses the Lenovo driver pack catalog for Windows 11.
Get-OSDCoreDriverPackCatalogPanasonic	No synopsis provided.
Get-OSDCoreDriverPackCatalogSurface	Retrieves the Microsoft Surface driver pack catalog, enriching entries from live download pages.
Get-OSDCoreDriverPacks	Retrieves driver pack information for the specified manufacturer and operating system architecture.
Get-OSDCoreLicense	Returns a single Recast Core license object.
Get-OSDCoreOperatingSystems	Gets the core operating system catalog entries that OSD uses for offline media selection.
Get-OSDDisk	Gets OSDDisk information.
Get-OSDGather	Returns common OSD information as an ordered hash table
Get-OSDHelp	Gets OSDHelp information.
Get-OSDMetrics	Retrieves metrics for the OSD PowerShell module and OSDCloud deployment methods.
Get-OSDModuleCache	Returns the OSD module cache directory path.
Get-OSDModulePath	Returns the base path of the loaded OSD module.
Get-OSDModuleVersion	Returns the version of the loaded OSD module.
Get-OSDPad	Gets information returned by Get-OSDPad.
Get-OSDPartition	Gets OSDPartition information.
Get-OSDPower	Displays Power Plan information using powercfg /LIST
Get-OSDVolume	Gets OSDVolume information.
Get-OSDWinEvent	Gets OSDWinEvent information.
Get-PowerSettingSleepAfter	No synopsis provided.
Get-PowerSettingTurnMonitorOffAfter	Gets the active power plan monitor-off timeout in minutes.
Get-PSCloudScript	Development function to get the contents of a PSCloudScript.
Get-ReAgentXml	Returns information from the Windows Recovery Agent XML file
Get-RegCurrentVersion	Returns the Registry Key values from HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion
Get-ScreenPNG	Gets ScreenPNG information.
Get-SessionsXml	Returns the Session.xml Updates that have been applied to an Operating System
Get-SetupCompleteOSDCloudUSB	This function checks for the presence of an OSDCloud SetupComplete Folder on any drive other than 'C'.
Get-SurfaceDriverPackCatalog	Returns the Microsoft Surface DriverPack Catalog
Get-SystemFirmwareDevice	Returns the system firmware device
Get-SystemFirmwareResource	Returns the GUID of the system firmware resource
Get-SystemFirmwareUpdate	Retrieves the latest system firmware update from Microsoft Update Catalog
Get-TimeZoneFromIP	No synopsis provided.
Get-USBDisk	Gets USBDisk information.
Get-USBPartition	Gets USBPartition information.
Get-USBVolume	Gets USBVolume information.
Get-WiFiActiveProfileSSID	No synopsis provided.
Get-WiFiProfileKey	No synopsis provided.
Get-Win11Readiness	No synopsis provided.
Get-WindowsAdkInstallPath	Retrieves the installation path of the Windows Assessment and Deployment Kit (ADK)
Get-WindowsAdkInstallVersion	Retrieves the installed version of the Windows Assessment and Deployment Kit (ADK)
Get-WindowsAdkPaths	Retrieves the command paths of the Windows Assessment and Deployment Kit (ADK).
Get-WindowsKitsInstallPath	Retrieves the installation path of the Windows Kit directory.
Get-WindowsOEMProductKey	No synopsis provided.
Get-WindowsUpdateDriver	No synopsis provided.
Get-WindowsUpdateManifests	Returns an Array of Microsoft Updates from the Microsoft Update Catalog
Get-WinREPartition	Retrieves the Windows Recovery Environment partition information
Get-WSUSXML	Returns an Array of Microsoft Updates

Import Functions

Function	Description
Import-MDTWinPECloudDriver	Imports OSDCloud CloudDrivers into an MDT Deployment Share
Import-OSDCloudWinPEDriverMDT	Imports OSDCloud CloudDrivers into an MDT Deployment Share

Initialize Functions

Function	Description
Initialize-OSDCloudStartnet	Initializes the OSDCloud startnet environment.
Initialize-OSDCloudStartnetUpdate	No synopsis provided.
Initialize-OSDCoreDevice	Collects local hardware, firmware, TPM, and network details for OSDCloud.

Install Functions

Function	Description
Install-AzOSDIacTools	Install prerequisite IaC tooling for OSDCloud Azure.
Install-BuildUpdatesFromOSCloudUSB	No synopsis provided.
Install-HPIA	No synopsis provided.
Install-ModuleHPCMSL	Installs or updates the HP Client Management Script Library (HPCMSL) PowerShell module.
Install-SystemFirmwareUpdate	Downloads and installs the system firmware update

Invoke Functions

Function	Description
Invoke-AzOSDAzureConfig	Deploy OSDCloud Azure infrastructure with Bicep or Terraform.
Invoke-CloudSecret	Invoke a secret retrieved from Azure Key Vault.
Invoke-Exe	Runs an external command.
Invoke-HPAnalyzer	No synopsis provided.
Invoke-HPDriverUpdate	No synopsis provided.
Invoke-HPIA	No synopsis provided.
Invoke-HPIAOfflineSync	Creates and synchronizes an offline HPIA repository for the local HP platform.
Invoke-HPTPMDowngrade	Downloads and applies the HP SP94937 softpaq to downgrade a TPM from 2.0 to 1.2.
Invoke-HPTPMDownload	Downloads and extracts the required HP TPM firmware update softpaq using HPCMSL.
Invoke-HPTPMEXEDownload	Downloads the required HP TPM firmware EXE to C:\OSDCloud\HP\TPM.
Invoke-HPTPMEXEInstall	Extracts and installs the HP TPM firmware update from C:\OSDCloud\HP\TPM.
Invoke-MSCatalogParseDate	Parses a date string from Microsoft Update Catalog format
Invoke-OSDCloud	This is the master OSDCloud Task Sequence
Invoke-OSDCloudDriverPackCM	Downloads a matching DriverPack to %OSDisk%\Drivers
Invoke-OSDCloudDriverPackMDT	Downloads a matching DriverPack to %OSDisk%\Drivers
Invoke-OSDCloudDriverPackPPKG	Uses DISM in WinPE to expand and apply Driver Packs
Invoke-OSDCloudIPU	Starts an OSDCloud in-place upgrade workflow.
Invoke-OSDInfo	Displays OSD information, useful in an OS Deployment
Invoke-OSDSpecialize	No synopsis provided.
Invoke-OSDSpecializeDev	No synopsis provided.
Invoke-SelectDataDisk	Invokes SelectDataDisk actions.
Invoke-SelectFFUDisk	Invokes SelectFFUDisk actions.
Invoke-SelectLocalDisk	Invokes SelectLocalDisk actions.
Invoke-SelectLocalVolume	Invokes SelectLocalVolume actions.
Invoke-SelectOSDDisk	Invokes SelectOSDDisk actions.
Invoke-SelectOSDVolume	Invokes SelectOSDVolume actions.
Invoke-SelectUSBDisk	Invokes SelectUSBDisk actions.
Invoke-SelectUSBVolume	Invokes SelectUSBVolume actions.
Invoke-WebPSScript	Executes a PowerShell script from a URL.

Mount Functions

Function	Description
Mount-MyWindowsImage	Mounts MyWindowsImage for servicing.

New Functions

Function	Description
New-AdkCopyPE	Creates an ADK CopyPE working directory
New-AdkISO	Creates an ISO file from a bootable media directory using ADK tools
New-BootableUSBDrive	Creates BootableUSBDrive resources.
New-CAB	Creates a CAB file from a Directory
New-OSDCloudISO	Creates an OSDCloud bootable ISO from an OSDCloud workspace.
New-OSDCloudOSWimFile	Builds Windows setup media content for an OSDCloud feature update.
New-OSDCloudTemplate	Creates resources by using New-OSDCloudTemplate.
New-OSDCloudUSB	Creates resources by using New-OSDCloudUSB.
New-OSDCloudUSBSetupCompleteTemplate	Creates resources by using New-OSDCloudUSBSetupCompleteTemplate.
New-OSDCloudVM	Creates resources by using New-OSDCloudVM.
New-OSDCloudWorkspace	Creates resources by using New-OSDCloudWorkspace.
New-OSDCloudWorkspaceSetupCompleteTemplate	Creates resources by using New-OSDCloudWorkspaceSetupCompleteTemplate.
New-OSDisk	Creates System | OS | Recovery Partitions for MBR or UEFI Drives in WinPE
New-WindowsAdkISO	Creates an ISO file from a bootable media directory using ADK

Remove Functions

Function	Description
Remove-AppxOnline	Removes AppxOnline items.

Reset Functions

Function	Description
Reset-OSDCloudVMSettings	Resets configuration by using Reset-OSDCloudVMSettings.

Resolve Functions

Function	Description
Resolve-MsUrl	Resolves a short Microsoft aka.ms or fwlink URL.

Save Functions

Function	Description
Save-ClipboardImage	Saves ClipboardImage content.
Save-EnablementPackage	Downloads a matching Windows enablement package.
Save-FeatureUpdate	Downloads the latest matching Windows client feature update package.
Save-MsUpCatDriver	Downloads driver updates from Microsoft Update Catalog
Save-MsUpCatUpdate	Downloads updates from Microsoft Update Catalog for a specific Windows version
Save-MyBitLockerExternalKey	Saves BitLocker external key protectors (.BEK) to destination folders.
Save-MyBitLockerKeyPackage	Saves BitLocker key packages to destination folders.
Save-MyBitLockerRecoveryPassword	Saves BitLocker recovery passwords to text files.
Save-MyDellBios	Downloads the latest compatible Dell BIOS update to a local folder.
Save-MyDellBiosFlash64W	Downloads and extracts the Dell Flash64W BIOS utility.
Save-MyDriverPack	Downloads and optionally expands the driver pack for the current computer
Save-SystemFirmwareUpdate	Downloads and extracts the latest system firmware update.
Save-WebFile	Downloads a file from the internet and returns a Get-Item Object
Save-WinPECloudDriver	Download and expand WinPE Drivers
Save-ZTIDriverPack	Downloads the driver pack for a computer during MDT/ConfigMgr task sequence

Select Functions

Function	Description
Select-OSDCloudAutopilotJsonItem	Selects Autopilot Profiles
Select-OSDCloudFileWim	Selects Office Configuration Profiles
Select-OSDCloudImageIndex	No synopsis provided.
Select-OSDCloudODTFile	Selects Office Configuration Profiles

Set Functions

Function	Description
Set-AzClipboard	Write the current clipboard text to the Azure clipboard Key Vault.
Set-BitlockerRegValuesXTS256	No synopsis provided.
Set-BootmgrTimeout	Sets the Windows Boot Manager timeout value in BCD.
Set-ClipboardScreenshot	Captures a screenshot and copies it to the clipboard
Set-CloudSecret	Convert content to an Azure Key Vault secret.
Set-DisRes	Sets the primary display screen resolution.
Set-HPBIOSSetting	No synopsis provided.
Set-HPTPMBIOSSettings	No synopsis provided.
Set-HyperVName	No synopsis provided.
Set-LatestUpdatesASAPEnabled	No synopsis provided.
Set-OSDCloudTemplate	Sets configuration values by using Set-OSDCloudTemplate.
Set-OSDCloudUnattendAuditMode	No synopsis provided.
Set-OSDCloudUnattendAuditModeAutopilot	No synopsis provided.
Set-OSDCloudUnattendSpecialize	No synopsis provided.
Set-OSDCloudUnattendSpecializeDev	No synopsis provided.
Set-OSDCloudVMSettings	Sets configuration values by using Set-OSDCloudVMSettings.
Set-OSDCloudWorkspace	Sets configuration values by using Set-OSDCloudWorkspace.
Set-OSDxCloudUnattendSpecialize	No synopsis provided.