Cmdlets

Use task-oriented guides for the public commands in the OSDeploy PowerShell module.

Use these guides to run OSDeploy commands and understand their requirements, prompts, selection behavior, side effects, and output. Start with Basic Setup for the shortest workstation setup workflow. Use the OSDeploy command reference for compact syntax and output lookup.

A valid Recast Software Community License is required while the OSDeploy module is in preview. Complete Community Registration before running OSDeploy commands.

Workstation Setup

Guide	Use it to
Get-OSDeployModulePath	Locate resources in the OSDeploy module that is loaded in the current session.
Get-OSDeployModuleVersion	Return or compare the loaded OSDeploy module version.
Import-OSDeployLicense	Import and reconcile a Recast Software license file or ZIP archive.
Show-OSDeployLicense	Inspect the selected Recast Software license candidate or display registration guidance.
Invoke-OSDeployHydration	Prepare a workstation, refresh Windows and driver content, build boot media, and optionally test it in Hyper-V.
Install-OSDeploySoftware	Install individual OSDeploy workstation prerequisites and tools.

Core Content and Boot Media

Guide	Use it to
Update-OSDeployCore	Coordinate the Windows ESD, imported Windows image, and WinPE driver updates.
Update-OSDeployCoreESD	Download and verify Windows Enterprise ESD content.
Update-OSDeployCoreRE	Export Windows RE and stage supporting Windows OS content from cached ESD files.
Update-OSDeployCoreDrivers	Download and expand WinPE driver packages.
Build-OSDeployBoot	Build customized WinPE media from imported WinRE or Windows ADK WinPE.
Update-OSDeployBootISO	Rebuild ISO files for an existing OSDeploy boot-media build.

USB, Hyper-V, and MDT

Guide	Use it to
New-OSDeployBootUSB	Prepare a bootable USB disk from completed OSDeploy media.
Update-OSDeployBootUSB	Refresh an existing OSDeploy USB volume from completed media.
New-OSDeployHyperVM	Create and start a Hyper-V test VM from an OSDeploy ISO.
Install-OSDeployMDT	Add OSDeploy integration to an MDT deployment share.
Invoke-OSDeployMDT	Run the OSDeploy MDT integration stages.

Several commands install software, download large files, service Windows images, modify USB disks, or create virtual machines. Review each guide's requirements, confirmation behavior, and side effects before running it in production.