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

Install-OSDeploySoftware

Installs OS deployment prerequisite software on Windows.

Property
Value

Module

OSDeploy

Platform

Windows 11 (amd64 / arm64)

Requires

PowerShell 7.6; Administrator rights for ADK, MDT, and Hyper-V installs; winget for Git and VS Code

Output

System.Management.Automation.PSCustomObject

Description

Single entry point for setting up a Windows workstation with all tools commonly required for OS deployment work.

Without -Force, the function runs in preview mode: it returns a table showing each requested component's name, download source, documentation link, and the exact command needed to install it.

Add -Force to perform the actual installation.

Supported components:

Name
Full Name
Install Method

adk-25h2

Windows ADK 10.1.26100.2454 + WinPE add-on

curl.exe download

adk-26h1

Windows ADK 10.1.28000.1 + WinPE add-on

curl.exe download

mdt

Microsoft Deployment Toolkit 6.3.8456.1000

curl.exe download

git

Git for Windows

winget

code

Visual Studio Code (stable)

winget

code-insiders

Visual Studio Code Insiders (pre-release)

winget

hyperv

Hyper-V Windows optional feature

Enable-WindowsOptionalFeature

7zip

7-Zip

winget

When -Name is omitted, the function returns a list of all available components and the exact command to install each one. No changes are made.

Syntax

Parameters

Parameter
Type
Required
Description

-Name

String[]

No

One or more component names to inspect or install. Accepts alias -Component. When omitted, lists all available components.

-Force

Switch

No

Performs the installation. Without this switch the command runs in preview mode only.

-DownloadOnly

Switch

No

Downloads installers to the cache without installing. Not supported for winget- or feature-based components (git, code, code-insiders, hyperv).

Examples

Last updated

Was this helpful?