> 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/guide/cmdlets.md). # 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](/guide/basic.md) for the shortest workstation setup workflow. Use the [OSDeploy command reference](/command-reference/osdeploy.md) for compact syntax and output lookup. {% 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](/guide/registration.md) before using those workflows. Review each command guide for its exact requirement. {% endhint %} ## Workstation Setup | Guide | Use it to | | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | | [Get-OSDeployModulePath](/guide/cmdlets/get-osdeploymodulepath.md) | Locate resources in the OSDeploy module that is loaded in the current session. | | [Get-OSDeployModuleVersion](/guide/cmdlets/get-osdeploymoduleversion.md) | Return or compare the loaded OSDeploy module version. | | [Import-OSDeployLicense](/guide/cmdlets/import-osdeploylicense.md) | Import and reconcile a Recast Software license file or ZIP archive. | | [Show-OSDeployLicense](/guide/cmdlets/show-osdeploylicense.md) | Inspect the selected Recast Software license candidate or display registration guidance. | | [Invoke-OSDeployHydration](/guide/cmdlets/invoke-osdeployhydration.md) | Prepare a workstation, refresh Windows and driver content, build boot media, and optionally test it in Hyper-V. | | [Install-OSDeploySoftware](/guide/cmdlets/install-osdeploysoftware.md) | Install individual OSDeploy workstation prerequisites and tools. | ## Core Content and Boot Media | Guide | Use it to | | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | [Update-OSDeployCore](/guide/cmdlets/update-osdeploycore.md) | Coordinate the Windows ESD, imported Windows image, and WinPE driver updates. | | [Update-OSDeployCoreESD](/guide/cmdlets/update-osdeploycoreesd.md) | Download and verify Windows Enterprise ESD content. | | [Update-OSDeployCoreRE](/guide/cmdlets/update-osdeploycorere.md) | Export Windows RE and stage supporting Windows OS content from cached ESD files. | | [Update-OSDeployCoreDrivers](/guide/cmdlets/update-osdeploycoredrivers.md) | Download and expand WinPE driver packages. | | [Build-OSDeployBoot](/guide/cmdlets/build-osdeployboot.md) | Build customized WinPE media from imported WinRE or Windows ADK WinPE. | | [New-OSDeployBootProfilePreview](/guide/cmdlets/new-osdeploybootprofilepreview.md) | Create a persistent architecture-specific boot profile without building media. | | [Update-OSDeployBootProfilePreview](/guide/cmdlets/update-osdeploybootprofilepreview.md) | Update an existing boot profile's settings and shared-content selections. | | [Delete-OSDeployBootProfilePreview](/guide/cmdlets/delete-osdeploybootprofilepreview.md) | Delete a profile and its profile-local content. | | [Update-OSDeployBootISO](/guide/cmdlets/update-osdeploybootiso.md) | Rebuild ISO files for an existing OSDeploy boot-media build. | ## USB, Hyper-V, and MDT | Guide | Use it to | | ------------------------------------------------------------------ | ------------------------------------------------------------- | | [New-OSDeployBootUSB](/guide/cmdlets/new-osdeploybootusb.md) | Prepare a bootable USB disk from completed OSDeploy media. | | [Update-OSDeployBootUSB](/guide/cmdlets/update-osdeploybootusb.md) | Refresh an existing OSDeploy USB volume from completed media. | | [New-OSDeployHyperVM](/guide/cmdlets/new-osdeployhypervm.md) | Create and start a Hyper-V test VM from an OSDeploy ISO. | | [Install-OSDeployMDT](/guide/cmdlets/install-osdeploymdt.md) | Add OSDeploy integration to an MDT deployment share. | | [Invoke-OSDeployMDT](/guide/cmdlets/invoke-osdeploymdt.md) | Run the OSDeploy MDT integration stages. | {% hint style="warning" %} 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. {% endhint %} --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://www.osdeploy.com/guide/cmdlets.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.