OSDeploy PSModule and site pages are currently in preview until mid-September
For the complete documentation index, see llms.txt. This page is also available as Markdown.

PowerShell Modules

Install the PowerShell modules required for current OSDeploy and OSDCloud workflows.

Install OSDeploy and OSDCloud from PowerShell Gallery on the OSDeploy PC.

Install OSD only when a workflow requires legacy OSD or OSDCloud v1 commands. Use the OSDCloud module for current OSDCloud deployments.

Install the Modules

1

Confirm the Requirements

Run the commands on a Windows 11 OSDeploy PC from an elevated PowerShell 7.6 or later session. Confirm that the current session uses PowerShell Core:

$PSVersionTable | Select-Object PSEdition, PSVersion

Confirm that PSEdition is Core and PSVersion is 7.6 or later before continuing.

2

Install the Required Modules

Install the latest OSDeploy and OSDCloud releases from PowerShell Gallery:

Install-Module -Name OSDeploy -Force -SkipPublisherCheck
Install-Module -Name OSDCloud -Force -SkipPublisherCheck

OSDeploy creates and maintains OSDeploy Core and builds OSDCloud boot images on the OSDeploy PC. OSDCloud provides the current deployment commands used in Windows PE. The commands also update an existing installation when PowerShell Gallery contains a newer release.

3

Install the Optional Legacy Module

Install OSD only when a deployment workflow requires commands that are not included in the current OSDCloud module:

Install-Module -Name OSD -Force -SkipPublisherCheck

See the detailed guides for Get-OSDeployModulePath and Get-OSDeployModuleVersion, or use their compact path and version command references. A valid Recast Software Community License is required while the OSDeploy module is in preview. Complete Community Registration before running OSDeploy commands.

Last updated

Was this helpful?