# 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                                                                        |
| Gallery      | [powershellgallery.com/packages/OSDeploy](https://www.powershellgallery.com/packages/OSDeploy/) |
| Platform     | Windows 11 25H2                                                                                 |
| Architecture | amd64 / arm64                                                                                   |
| Status       | Current / Recommended                                                                           |
| Required by  | OSDeploy deployment workflows                                                                   |

{% embed url="<https://www.powershellgallery.com/packages/OSDeploy/>" %}

## 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

```powershell
Install-Module -Name OSDeploy -Force -SkipPublisherCheck
```

***

## Related

* [OSDeploy on PowerShell Gallery](https://www.powershellgallery.com/packages/OSDeploy/)

***

## Functions

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

### Module Utilities

| Function                                                                               | Description                                                        |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [Get-OSDeployModulePath](/powershell-modules/osdeploy/get-osdeploymodulepath.md)       | Returns the file system path to the OSDeploy module root directory |
| [Get-OSDeployModuleVersion](/powershell-modules/osdeploy/get-osdeploymoduleversion.md) | Returns the currently loaded OSDeploy module version               |

### OSDeployCore

| Function                                                                         | Description                                                                      |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [Update-OSDeployCore](/powershell-modules/osdeploy/update-osdeploycore.md)       | Updates all OSDeployCore assets: ESD files, OS images, and WinPE driver packages |
| [Update-OSDeployCoreESD](/powershell-modules/osdeploy/update-osdeploycoreesd.md) | Downloads Windows Enterprise ESD files from the latest OSDeploy OS catalog       |
| [Update-OSDeployCoreOS](/powershell-modules/osdeploy/update-osdeploycoreos.md)   | Imports Windows OS images from cached Enterprise ESD files to OSDeployCore       |

### BootMedia

| Function                                                                             | Description                                                               |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| [Build-OSDeployBoot](/powershell-modules/osdeploy/build-osdeployboot.md)             | Builds a customized WinPE boot image from a WinRE or ADK WinPE source     |
| [Invoke-OSDeployHydration](/powershell-modules/osdeploy/invoke-osdeployhydration.md) | Runs the full OSDeploy hydration workflow end-to-end                      |
| [Update-OSDeployBootISO](/powershell-modules/osdeploy/update-osdeploybootiso.md)     | Rebuilds bootable ISO files for an existing BootImage build               |
| [Import-OSDeployCoreOS](/powershell-modules/osdeploy/import-osdeploycoreos.md)       | Imports Windows OS images from mounted installation media to OSDeployCore |

### MDT Integration

| Function                                                                   | Description                                                         |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [Install-OSDeployMDT](/powershell-modules/osdeploy/install-osdeploymdt.md) | Initializes an MDT Deployment Share for OSDeploy                    |
| [Invoke-OSDeployMDT](/powershell-modules/osdeploy/invoke-osdeploymdt.md)   | MDT LiteTouchPE exit script — runs on every Update Deployment Share |

### Software Installation

| Function                                                                             | Description                                             |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| [Install-OSDeploySoftware](/powershell-modules/osdeploy/install-osdeploysoftware.md) | Installs OS deployment prerequisite software on Windows |

### USB

| Function                                                                         | Description                                               |
| -------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [New-OSDeployBootUSB](/powershell-modules/osdeploy/new-osdeploybootusb.md)       | Creates a new bootable OSDeploy USB drive                 |
| [Update-OSDeployBootUSB](/powershell-modules/osdeploy/update-osdeploybootusb.md) | Updates an existing OSDeploy USB drive with new BootMedia |

### Virtual Machines

| Function                                                                   | Description                                              |
| -------------------------------------------------------------------------- | -------------------------------------------------------- |
| [New-OSDeployHyperVM](/powershell-modules/osdeploy/new-osdeployhypervm.md) | Creates a Hyper-V VM pre-configured for OSDeploy testing |

### WinPE Drivers

| Function                                                                                 | Description                                                   |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [Get-OSDeployCoreDrivers](/powershell-modules/osdeploy/get-osdeploycoredrivers.md)       | Returns WinPE driver folders from the OSDeployCore library    |
| [Update-OSDeployCoreDrivers](/powershell-modules/osdeploy/update-osdeploycoredrivers.md) | Downloads and expands WinPE driver packages into OSDeployCore |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://www.osdeploy.com/powershell-modules/osdeploy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.