For the complete documentation index, see llms.txt. This page is also available as Markdown.

OSDeploy Module

The OSDeploy module is used on Windows 11 25H2 to create WinPE boot images. It runs in a full Windows OS environment — not in WinPE.

Property
Value

Publisher

Community / David Segura

Platform

Windows 11 25H2

Architecture

amd64 / arm64

Status

Current / Recommended

Required by

OSDeploy deployment workflows

Overview

The OSDeploy module is the build-time counterpart to OSDCloud. It runs on a full Windows 11 25H2 or later installation — not inside WinPE — and is responsible for creating and customizing WinPE boot images. The module automates the entire boot image pipeline: pulling in Windows ADK optional components and language packs, injecting WinPE drivers, embedding the OSDCloud PowerShell module, adding WinPE apps and console configuration, and generating bootable ISO files and USB drives.

Use Invoke-OSDeployHydration for a fully automated end-to-end build, or use Build-OSDeployBoot directly for fine-grained control over individual boot image builds.

Install



Functions

The OSDeploy module (version 26.5.1.1) exports 17 public functions across seven functional areas.

Module Utilities

Function
Description

Returns the file system path to the OSDeploy module root directory

Returns the currently loaded OSDeploy module version

OSDeployCore

Function
Description

Updates all OSDeployCore assets: ESD files, OS images, and WinPE driver packages

Downloads Windows Enterprise ESD files from the latest OSDeploy OS catalog

Imports Windows OS images from cached Enterprise ESD files to OSDeployCore

BootMedia

Function
Description

Builds a customized WinPE boot image from a WinRE or ADK WinPE source

Runs the full OSDeploy hydration workflow end-to-end

Rebuilds bootable ISO files for an existing BootImage build

Imports Windows OS images from mounted installation media to OSDeployCore

MDT Integration

Function
Description

Initializes an MDT Deployment Share for OSDeploy

MDT LiteTouchPE exit script — runs on every Update Deployment Share

Software Installation

Function
Description

Installs OS deployment prerequisite software on Windows

USB

Function
Description

Creates a new bootable OSDeploy USB drive

Updates an existing OSDeploy USB drive with new BootMedia

Virtual Machines

Function
Description

Creates a Hyper-V VM pre-configured for OSDeploy testing

WinPE Drivers

Function
Description

Returns WinPE driver folders from the OSDeployCore library

Downloads and expands WinPE driver packages into OSDeployCore

Last updated

Was this helpful?