> For the complete documentation index, see [llms.txt](https://www.osdeploy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.osdeploy.com/command-reference/osdeploy.md).

# OSDeploy Module

The **OSDeploy** module runs on Windows 11 25H2 to create and maintain WinPE boot media. It runs in a full Windows environment, not in WinPE.

| Property       | Value                                                                                           |
| -------------- | ----------------------------------------------------------------------------------------------- |
| Module version | 26.9.11                                                                                         |
| Gallery        | [powershellgallery.com/packages/OSDeploy](https://www.powershellgallery.com/packages/OSDeploy/) |
| Platform       | Windows 11 25H2                                                                                 |
| Architecture   | amd64 / arm64                                                                                   |
| Status         | Preview                                                                                         |

{% hint style="warning" %}
A valid Recast Software Community License is required for direct calls to the gated Core update, boot-profile update, and boot ISO update commands. Complete [Community Registration](https://www.osdeploy.com/guide/registration.md) before using those workflows.
{% endhint %}

## Install

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

## Functions

OSDeploy 26.9.11 exports 20 public functions.

### Module and License

| Function                                                                                                      | Description                                                 |
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [Get-OSDeployModulePath](https://www.osdeploy.com/command-reference/osdeploy/get-osdeploymodulepath.md)       | Return the loaded OSDeploy module path.                     |
| [Get-OSDeployModuleVersion](https://www.osdeploy.com/command-reference/osdeploy/get-osdeploymoduleversion.md) | Return the loaded OSDeploy module version.                  |
| [Import-OSDeployLicense](https://www.osdeploy.com/command-reference/osdeploy/import-osdeploylicense.md)       | Import and reconcile a Recast Software license.             |
| [Show-OSDeployLicense](https://www.osdeploy.com/command-reference/osdeploy/show-osdeploylicense.md)           | Return the selected valid license or registration guidance. |

### Hydration and Software

| Function                                                                                                    | Description                                             |
| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [Invoke-OSDeployHydration](https://www.osdeploy.com/command-reference/osdeploy/invoke-osdeployhydration.md) | Run the workstation hydration workflow.                 |
| [Install-OSDeploySoftware](https://www.osdeploy.com/command-reference/osdeploy/install-osdeploysoftware.md) | Inspect, download, or install deployment prerequisites. |

### OSDeploy Core

| Function                                                                                                        | Description                                           |
| --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [Update-OSDeployCore](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploycore.md)               | Run the ESD, recovery, and driver update stages.      |
| [Update-OSDeployCoreESD](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploycoreesd.md)         | Download and verify Enterprise ESD files.             |
| [Update-OSDeployCoreRE](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploycorere.md)           | Export WinRE and stage supporting Windows OS content. |
| [Update-OSDeployCoreDrivers](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploycoredrivers.md) | Download and expand WinPE driver packages.            |

### OSDeploy Boot

| Function                                                                                                                      | Description                                           |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [Build-OSDeployBoot](https://www.osdeploy.com/command-reference/osdeploy/build-osdeployboot.md)                               | Build customized WinPE media from WinRE or ADK WinPE. |
| [New-OSDeployBootProfilePreview](https://www.osdeploy.com/command-reference/osdeploy/new-osdeploybootprofilepreview.md)       | Create a persistent boot profile.                     |
| [Update-OSDeployBootProfilePreview](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploybootprofilepreview.md) | Update a persistent boot profile.                     |
| [Delete-OSDeployBootProfilePreview](https://www.osdeploy.com/command-reference/osdeploy/delete-osdeploybootprofilepreview.md) | Delete a persistent boot profile.                     |

### Boot Media

| Function                                                                                                | Description                                 |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [Update-OSDeployBootISO](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploybootiso.md) | Rebuild ISO files for completed boot media. |
| [New-OSDeployBootUSB](https://www.osdeploy.com/command-reference/osdeploy/new-osdeploybootusb.md)       | Prepare a new bootable USB disk.            |
| [Update-OSDeployBootUSB](https://www.osdeploy.com/command-reference/osdeploy/update-osdeploybootusb.md) | Refresh an existing boot USB.               |

### Hyper-V

| Function                                                                                          | Description                                    |
| ------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| [New-OSDeployHyperVM](https://www.osdeploy.com/command-reference/osdeploy/new-osdeployhypervm.md) | Create a Hyper-V test VM from an OSDeploy ISO. |

### MDT Integration

| Function                                                                                          | Description                                      |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| [Install-OSDeployMDT](https://www.osdeploy.com/command-reference/osdeploy/install-osdeploymdt.md) | Initialize an MDT deployment share for OSDeploy. |
| [Invoke-OSDeployMDT](https://www.osdeploy.com/command-reference/osdeploy/invoke-osdeploymdt.md)   | Run the OSDeploy MDT integration stages.         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.osdeploy.com/command-reference/osdeploy.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
