### Example of Starting OOBEDeploy with .NET FX 3.5 and RSAT Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OOBEDeploy.md This example shows how to start an OOBE deployment while also enabling the installation of .NET Framework 3.5 and Remote Server Administration Tools (RSAT). ```powershell PS C:\> Start-OOBEDeploy -AddNetFX3 -AddRSAT ``` -------------------------------- ### Example of Starting OOBEDeploy with Product Key and Edition Set Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OOBEDeploy.md This example demonstrates starting an OOBE deployment with a specific product key and setting the Windows edition to Enterprise. Ensure the product key is valid. ```powershell PS C:\> Start-OOBEDeploy -ProductKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -SetEdition "Enterprise" ``` -------------------------------- ### Example of Starting OOBEDeploy with Driver and Windows Updates Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OOBEDeploy.md This example initiates an OOBE deployment and includes steps to update device drivers and Windows. This ensures the system is up-to-date upon completion. ```powershell PS C:\> Start-OOBEDeploy -UpdateDrivers -UpdateWindows ``` -------------------------------- ### Example of Starting OOBEDeploy and Removing AppX Packages Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OOBEDeploy.md This example shows how to start an OOBE deployment while also removing specified AppX packages. Provide the exact package names to be removed. ```powershell PS C:\> Start-OOBEDeploy -RemoveAppx @("Microsoft.BingWeather_8.1.0.21277.0_neutral__8wekyb3d8bbwe", "Microsoft.WindowsCalculator_8.1.0.21277.0_neutral__8wekyb3d8bbwe") ``` -------------------------------- ### Example of Starting OOBEDeploy with Custom Profile Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OOBEDeploy.md This example demonstrates how to initiate an OOBE deployment using a custom profile. Ensure the specified profile path is correct. ```powershell PS C:\> Start-OOBEDeploy -CustomProfile "C:\Path\To\Your\CustomProfile.ps1" ``` -------------------------------- ### Example: Get Installed Language Packs Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-MyWindowsPackage.md This example demonstrates how to retrieve all installed language packs. It utilizes the -PackageState and -Category parameters to filter the results. ```powershell PS C:\> Get-MyWindowsPackage -PackageState Installed -Category LanguagePack ``` -------------------------------- ### Get Dell Driver Catalog Example Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-DellDriverCatalog.md This example retrieves the driver component of the Dell System Catalog. No specific setup is required beyond having the OSD module imported. ```powershell PS C:\> Get-DellDriverCatalog ``` -------------------------------- ### Example of Starting OOBEDeploy with Autopilot Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OOBEDeploy.md This example initiates an OOBE deployment configured for Windows Autopilot. This is useful for modern device provisioning scenarios. ```powershell PS C:\> Start-OOBEDeploy -Autopilot ``` -------------------------------- ### Start Windows Update Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-WindowsUpdate.md This is a basic example of how to start Windows Update using the Start-WindowsUpdate cmdlet. No parameters are specified, so default behavior will be used. ```powershell Start-WindowsUpdate ``` -------------------------------- ### Get Compatible Dell Driver Catalog Example Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-DellDriverCatalog.md This example retrieves only the driver components that are compatible with the current system. Use the -Compatible switch to filter results. ```powershell PS C:\> Get-DellDriverCatalog -Compatible ``` -------------------------------- ### Get Windows ADK Install Version Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-WindowsAdkInstallVersion.md This example shows how to retrieve the installed version of the Windows ADK. No specific setup or imports are required beyond having the cmdlet available. ```powershell Get-WindowsAdkInstallVersion ``` -------------------------------- ### Get Examples for New-OSDCloudTemplate Function Source: https://github.com/osdeploy/osd/blob/master/README.md Displays usage examples for the New-OSDCloudTemplate function. This is helpful for understanding how to create new OSDCloud templates. ```powershell Get-Help New-OSDCloudTemplate -Examples ``` -------------------------------- ### Build Lenovo Bios Catalog Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-LenovoBiosCatalog.md This example demonstrates how to build the Lenovo Bios Catalog. Ensure you have the OSD module installed. ```powershell PS C:\> Get-LenovoBiosCatalog ``` -------------------------------- ### Start-OSDCloudAzure Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloudAzure.md Installs the OSDCloudAzure Module and starts OS Deployment from Azure Storage. The -Force parameter can be used to reset everything to initial settings. ```APIDOC ## Start-OSDCloudAzure ### Description Installs the OSDCloudAzure Module and starts OS Deployment from Azure Storage. ### Syntax ```powershell Start-OSDCloudAzure [-Force] [] ``` ### Parameters #### -Force Resets everything to initial settings. - Type: SwitchParameter - Required: False - Position: Named - Default value: False #### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, and -WarningAction. ### Examples #### Example 1: Basic Usage ```powershell Start-OSDCloudAzure ``` #### Example 2: Using the -Force parameter ```powershell Start-OSDCloudAzure -Force ``` ``` -------------------------------- ### Run Set-SetupCompleteDefenderUpdate Source: https://github.com/osdeploy/osd/blob/master/Docs/Set-SetupCompleteDefenderUpdate.md This example shows how to execute the Set-SetupCompleteDefenderUpdate cmdlet. No parameters are required. ```powershell Set-SetupCompleteDefenderUpdate ``` -------------------------------- ### Get-HPOSSupport Example Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-HPOSSupport.md This example shows how to retrieve supported operating system information using the Get-HPOSSupport cmdlet. No specific parameters are used, so it will likely return all supported OS information. ```powershell PS C:\> Get-HPOSSupport ``` -------------------------------- ### Get HP Softpaq List Latest Example Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-HPSoftpaqListLatest.md This example demonstrates how to retrieve the latest HP SoftPaQ list. No specific parameters are provided, so it will likely fetch all available latest SoftPaQs. ```powershell PS C:\> Get-HPSoftpaqListLatest ``` -------------------------------- ### Get USB Disk Information Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-USBDisk.md This example shows how to retrieve information about connected USB disks using the Get-USBDisk cmdlet. No specific setup or imports are required beyond having the OSD module loaded. ```powershell PS C:\> Get-USBDisk ``` -------------------------------- ### Get All Display Screens Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-DisplayAllScreens.md This example shows how to retrieve all connected display screens using the Get-DisplayAllScreens cmdlet. No specific parameters are required for basic usage. ```powershell PS C:\> Get-DisplayAllScreens ``` -------------------------------- ### Get BIOS Version Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-MyBiosVersion.md This example shows how to retrieve the BIOS version of the system using the Get-MyBiosVersion cmdlet. No specific parameters are required for basic usage. ```powershell PS C:\> Get-MyBiosVersion ``` -------------------------------- ### Start OSDCloudAzure Deployment Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloudAzure.md Use this command to install the OSDCloudAzure module and begin OS deployment from Azure Storage. No parameters are required for a basic deployment. ```powershell Start-OSDCloudAzure ``` -------------------------------- ### Retrieve Windows Kits Path Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-WindowsKitsInstallPath.md This example shows how to use the Get-WindowsKitsInstallPath cmdlet to retrieve the installation path of the Windows Kits. No parameters are required for basic usage. ```powershell Get-WindowsKitsInstallPath ``` -------------------------------- ### Get Display Virtual Screen Information Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-DisplayVirtualScreen.md This example shows how to retrieve information about display virtual screens using the Get-DisplayVirtualScreen cmdlet. No parameters are required for basic usage. ```powershell PS C:\> Get-DisplayVirtualScreen ``` -------------------------------- ### Get System Firmware Resource Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-SystemFirmwareResource.md This is a basic example of how to call the Get-SystemFirmwareResource cmdlet. No specific parameters are provided, so it will attempt to retrieve all available firmware resources. ```powershell PS C:\> Get-SystemFirmwareResource ``` -------------------------------- ### Start-OSDDiskPart Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDDiskPart.md Starts the OSD disk partitioning process. ```APIDOC ## Start-OSDDiskPart ### Description Starts the OSD disk partitioning process. ### Method Cmdlet ### Syntax ```powershell Start-OSDDiskPart [-ProgressAction ] [] ``` ### Parameters #### Common Parameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, and -WarningAction. #### -ProgressAction Specifies how this cmdlet responds to a non-terminating error on the command line. - **Type**: ActionPreference - **Required**: False - **Position**: Named - **Default value**: None - **Accept pipeline input**: False - **Accept wildcard characters**: False ### Input None ### Output System.Object ### Examples #### Example 1 ```powershell PS C:\> Start-OSDDiskPart ``` This example shows how to call the Start-OSDDiskPart cmdlet without any parameters. ``` -------------------------------- ### Clear Local Disk Example Source: https://github.com/osdeploy/osd/blob/master/Docs/Clear-LocalDisk.md This example demonstrates how to clear a local disk. Ensure you understand the implications before running this command. ```powershell PS C:\> Clear-LocalDisk -DiskNumber 1 ``` -------------------------------- ### Retrieve OSD Metrics Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-OSDMetrics.md This example retrieves metrics for the OSD PowerShell module and OSDCloud deployment methods. Ensure the OSD PowerShell module and OSDCloud modules are installed. ```powershell Get-OSDMetrics ``` -------------------------------- ### Setup OSDCloud Workspace and Template Source: https://github.com/osdeploy/osd/blob/master/FAQ.md This script sets up the OSDCloud workspace, creates a new template, and configures WinPE to include the HPCMSL module. It's used for initial setup or after updating the ADK. ```PowerShell #Setup WorkSpace Location Import-Module -name OSD -force $OSDCloudWorkspace = "C:\OSDCloudWinPE" [void][System.IO.Directory]::CreateDirectory($OSDCloudWorkspace) #New Template (After you've updated ADK to lastest Version) New-OSDCloudTemplate -Name "OSDCloudWinPE" #New WorkSpace New-OSDCloudWorkspace -WorkspacePath $OSDCloudWorkspace New-OSDCloudWorkSpaceSetupCompleteTemplate #Creates Sample SetupComplete templates in Workspace #Added HPCMSL into WinPE Edit-OSDCloudWinPE -PSModuleInstall HPCMSL #Create Cloud USB New-OSDCloudUSB ``` -------------------------------- ### Save-MsUpCatUpdate Example Source: https://github.com/osdeploy/osd/blob/master/Docs/Save-MsUpCatUpdate.md This example demonstrates how to use the Save-MsUpCatUpdate cmdlet to download the latest cumulative update for Windows 10 x64 architecture. ```powershell Save-MsUpCatUpdate -OS "Windows 10" -Arch "x64" -Category "LCU" -Latest ``` -------------------------------- ### Get Windows ADK Install Path Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-WindowsAdkInstallPath.md This example shows how to use the Get-WindowsAdkInstallPath cmdlet to retrieve the installation path of the Windows ADK. This is useful for scripting and automation tasks that require locating ADK components. ```powershell PS C:\> Get-WindowsAdkInstallPath ``` -------------------------------- ### Start-WindowsUpdateDriver Syntax Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-WindowsUpdateDriver.md Shows the basic syntax for the Start-WindowsUpdateDriver cmdlet. No parameters are shown in this basic example. ```powershell Start-WindowsUpdateDriver ``` -------------------------------- ### Display Help for New-OSDisk Source: https://github.com/osdeploy/osd/blob/master/Docs/New-OSDisk.md This example shows how to display the help information for the New-OSDisk cmdlet. This is useful for understanding all available parameters and their usage. ```powershell New-OSDisk Displays Get-Help New-OSDisk ``` -------------------------------- ### Get Display Primary Bitmap Size Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-DisplayPrimaryBitmapSize.md This example shows how to retrieve the primary bitmap size. No specific setup or imports are required beyond the cmdlet itself. ```powershell PS C:\> Get-DisplayPrimaryBitmapSize ``` -------------------------------- ### Basic Usage of Set-SetupCompleteStartWindowsUpdate Source: https://github.com/osdeploy/osd/blob/master/Docs/Set-SetupCompleteStartWindowsUpdate.md This example shows the basic syntax for calling the Set-SetupCompleteStartWindowsUpdate cmdlet. No parameters are specified, indicating default behavior. ```powershell Set-SetupCompleteStartWindowsUpdate ``` -------------------------------- ### Download Driver Pack Source: https://github.com/osdeploy/osd/blob/master/Docs/Invoke-OSDCloudDriverPackMDT.md This example demonstrates how to download a driver pack for the current computer's manufacturer and product. Ensure the OSD module is imported before running. ```powershell Invoke-OSDCloudDriverPackMDT ``` -------------------------------- ### Start-OSDeployPad Cmdlet Syntax Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDeployPad.md This is the basic syntax for the Start-OSDeployPad cmdlet. It accepts an optional RepoFolder and OAuth token. ```powershell Start-OSDeployPad [[-RepoFolder] ] [-OAuth ] [-ProgressAction ] [] ``` -------------------------------- ### Get Full Help for Start-OSDCloud Function Source: https://github.com/osdeploy/osd/blob/master/README.md Retrieves comprehensive help documentation for the Start-OSDCloud function. This includes detailed explanations, syntax, and parameters. ```powershell # Get help for a specific function Get-Help Start-OSDCloud -Full ``` -------------------------------- ### Start-OSDeployPad Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDeployPad.md The Start-OSDeployPad cmdlet is used to launch the OS Deploy Pad. It accepts an optional repository folder path and an OAuth token for authentication. ```APIDOC ## Start-OSDeployPad ### Description Launches the OS Deploy Pad. ### Syntax ```powershell Start-OSDeployPad [[-RepoFolder] ] [-OAuth ] [-ProgressAction ] [] ``` ### Parameters #### -OAuth An OAuth token for authentication. - **Type**: String - **Required**: False - **Position**: Named #### -RepoFolder Specifies the path to the repository folder. - **Type**: String - **Required**: False - **Position**: 0 #### -ProgressAction Specifies how the cmdlet responds to the progress activity. - **Type**: ActionPreference - **Required**: False - **Position**: Named ### CommonParameters Supports common parameters like -Debug, -ErrorAction, -Verbose, etc. ### Example 1 ```powershell PS C:\> Start-OSDeployPad -RepoFolder "C:\OSD\Repo" -OAuth "your_oauth_token" ``` This example starts the OS Deploy Pad with a specified repository folder and OAuth token. ``` -------------------------------- ### Convert PnP Device ID to GUID Source: https://github.com/osdeploy/osd/blob/master/Docs/Convert-PNPDeviceIDtoGuid.md This example demonstrates how to use the Convert-PNPDeviceIDtoGuid cmdlet to convert a PnP device ID string to its associated GUID. Ensure the cmdlet is available in your PowerShell session. ```powershell Convert-PNPDeviceIDtoGuid -PNPDeviceID "PCI\VEN_8086&DEV_A72F&SUBSYS_380217AA&REV_31\3&11583659&0&A0" ``` -------------------------------- ### Build Lenovo Bios Catalog with Download Path Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-LenovoBiosCatalog.md This example shows how to build the Lenovo Bios Catalog and specify a download path for results. The results will be displayed in Out-GridView. ```powershell PS C:\> Get-LenovoBiosCatalog -DownloadPath "C:\BiosCatalog" ``` -------------------------------- ### Get Windows Update Driver Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-WindowsUpdateDriver.md Retrieves information about Windows Update drivers. This is a basic usage example. ```powershell Get-WindowsUpdateDriver ``` -------------------------------- ### Basic Usage of Start-OSDCloudGUI Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloudGUI.md Initiates the OSDCloud imaging process with default settings. This is the simplest way to start the GUI. ```powershell Start-OSDCloudGUI ``` -------------------------------- ### Get System Firmware Update Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-SystemFirmwareUpdate.md Retrieves available system firmware updates. This is a basic usage example. ```powershell Get-SystemFirmwareUpdate ``` -------------------------------- ### Get OSD Module Version Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-OSDModuleVersion.md Run this command to retrieve the installed version of the OSD module. No parameters are required. ```powershell PS C:\> Get-OSDModuleVersion ``` -------------------------------- ### Get Local Disk Volumes Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-LocalDiskVolume.md This example retrieves all local disk volumes on the system. No specific parameters are required for basic usage. ```powershell Get-LocalDiskVolume ``` -------------------------------- ### Set-SetupCompleteOEMActivation Cmdlet Syntax Source: https://github.com/osdeploy/osd/blob/master/Docs/Set-SetupCompleteOEMActivation.md This snippet shows the basic syntax for the Set-SetupCompleteOEMActivation cmdlet. It is used to configure OEM activation settings during the setup process. ```powershell Set-SetupCompleteOEMActivation ``` -------------------------------- ### Get Technical Identifier Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-AzOSDTechId.md This example shows how to retrieve a technical identifier using the Get-AzOSDTechId cmdlet by providing the Azure AD username. ```powershell PS C:\> Get-AzOSDTechId -AzureAdUserName "user@domain.com" ``` -------------------------------- ### Get OSDCloud Workspace Path Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-OSDCloudWorkspace.md This example shows how to retrieve the path to the OSDCloud Workspace. Ensure the workspace.json file exists in the specified location. ```powershell PS C:\> Get-OSDCloudWorkspace ``` -------------------------------- ### Start-OSDPad GitHub Syntax Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDPad.md This syntax is used when deploying an OS from a GitHub repository. It requires repository owner and name, and optionally accepts a folder within the repo and an OAuth token. ```powershell Start-OSDPad [-RepoOwner] [-RepoName] [[-RepoFolder] ] [-OAuth ] [-Brand ] [-Color ] [-Hide ] [-ProgressAction ] [] ``` -------------------------------- ### Start-OSDCloudGUIDev Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloudGUIDev.md Initiates OSDCloud imaging using command-line parameters. This cmdlet allows for customization of branding and computer identification. ```APIDOC ## Start-OSDCloudGUIDev ### Description OSDCloud imaging using the command line. ### Syntax ```powershell Start-OSDCloudGUIDev [[-BrandName] ] [[-BrandColor] ] [[-ComputerManufacturer] ] [[-ComputerProduct] ] [-ProgressAction ] [] ``` ### Parameters #### -BrandName - **Type**: String - **Required**: False - **Position**: 1 - **Aliases**: Brand - **Description**: The custom Brand for OSDCloudGUI. #### -BrandColor - **Type**: String - **Required**: False - **Position**: 2 - **Aliases**: Color - **Description**: Color for the OSDCloudGUI Brand. #### -ComputerManufacturer - **Type**: String - **Required**: False - **Position**: 3 - **Description**: Temporary Parameter. #### -ComputerProduct - **Type**: String - **Required**: False - **Position**: 4 - **Description**: Temporary Parameter. #### -ProgressAction - **Type**: ActionPreference - **Required**: False - **Position**: Named - **Aliases**: proga - **Description**: {{ Fill ProgressAction Description }} ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, and -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ### Example ```powershell Start-OSDCloudGUIDev ``` ``` -------------------------------- ### Create a Default OSDCloud VM Source: https://github.com/osdeploy/osd/blob/master/Docs/New-OSDCloudVM.md This example shows how to create a new Hyper-V VM with default settings for OSDCloud. No parameters are specified, so all default values will be used. ```powershell New-OSDCloudVM ``` -------------------------------- ### Add Specific Drivers to WinPE Source: https://github.com/osdeploy/osd/blob/master/Docs/Edit-MyWinPE.md This example shows how to mount a WinPE WIM and add drivers by their Hardware IDs and from a specified local path. The changes are then saved. ```powershell Edit-MyWinPE -ImagePath "C:\WinPE_amd64\media\sources\boot.wim" -DriverHWID "PCI\VEN_8086&DEV_15BC" -DriverPath "C:\Drivers\" -DismountSave ``` -------------------------------- ### Start-OSDCloudGUI Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloudGUI.md Initiates the OSDCloud imaging process using command-line arguments. Allows customization of branding and computer information. ```APIDOC ## Start-OSDCloudGUI ### Description OSDCloud imaging using the command line. ### Syntax ```powershell Start-OSDCloudGUI [[-BrandName] ] [[-BrandColor] ] [[-ComputerManufacturer] ] [[-ComputerProduct] ] [-v2] [-ProgressAction ] [] ``` ### Parameters #### -BrandName - Type: String - Required: False - Aliases: Brand - Description: The custom Brand for OSDCloudGUI. #### -BrandColor - Type: String - Required: False - Aliases: Color - Description: Color for the OSDCloudGUI Brand. #### -ComputerManufacturer - Type: String - Required: False - Description: Temporary Parameter. #### -ComputerProduct - Type: String - Required: False - Description: Temporary Parameter. #### -v2 - Type: SwitchParameter - Required: False - Description: Fill v2 Description. #### -ProgressAction - Type: ActionPreference - Required: False - Aliases: proga - Description: Fill ProgressAction Description. ### Examples #### EXAMPLE 1 ```powershell Start-OSDCloudGUI ``` ``` -------------------------------- ### Get OSD Catalog Driver Packs Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-OSDCatalogDriverPacks.md This example shows how to retrieve the list of DriverPacks utilized by OSDCloud. No specific parameters are required for this basic operation. ```powershell PS C:\> Get-OSDCatalogDriverPacks ``` -------------------------------- ### Set-SetupCompleteBitlocker Cmdlet Syntax Source: https://github.com/osdeploy/osd/blob/master/Docs/Set-SetupCompleteBitlocker.md This snippet shows the basic syntax for the Set-SetupCompleteBitlocker cmdlet. No parameters are shown, indicating it might be used without arguments or with default settings. ```powershell Set-SetupCompleteBitlocker ``` -------------------------------- ### Start OSDCloud with Parameters Source: https://github.com/osdeploy/osd/blob/master/Docs/Edit-OSDCloudWinPE.md Initiates the OSDCloud process within WinPE with specific operating system parameters. Use this to automate OS deployment with predefined settings. ```powershell Edit-OSDCloudWinPE -StartOSDCloud '-OSBuild 22H2 -OSEdition Pro -OSLanguage en-us -OSActivation Retail' ``` -------------------------------- ### New-BootableUSBDrive Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/New-BootableUSBDrive.md Creates a bootable USB drive with specified labels for boot and data partitions. ```APIDOC ## New-BootableUSBDrive ### Description Creates a bootable USB drive. This cmdlet allows specifying labels for the boot and data partitions of the USB drive. ### Syntax ```powershell New-BootableUSBDrive [[-BootLabel] ] [[-DataLabel] ] [-ProgressAction ] [] ``` ### Parameters #### -BootLabel Specifies the label for the boot partition of the USB drive. - **Type**: String - **Required**: False - **Position**: 0 #### -DataLabel Specifies the label for the data partition of the USB drive. - **Type**: String - **Required**: False - **Position**: 1 #### -ProgressAction Specifies how this cmdlet responds to a progress error. Possible values are SilentlyContinue, Continue, Inquire, Suspend, Skip, Stop, and Trace. - **Type**: ActionPreference - **Required**: False - **Position**: Named ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, and -WarningAction. ### Inputs None ### Outputs System.Object ``` -------------------------------- ### Get HP Software Catalog Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-HPSoftwareCatalog.md This example retrieves the software component of the HP System Catalog. Ensure you are in a PowerShell environment where the OSD module is available. ```powershell PS C:\> Get-HPSoftwareCatalog ``` -------------------------------- ### New-AdkISO Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/New-AdkISO.md Creates an .iso file from a bootable media directory. The Windows ADK is required for this operation. ```APIDOC ## New-AdkISO ### Description Creates a .iso file from a bootable media directory. ADK is required. ### Syntax ```powershell New-AdkISO [[-WindowsAdkRoot] ] [-MediaPath] [-isoFileName] [-isoLabel] [-OpenExplorer] [-ProgressAction ] [] ``` ### Parameters #### Path Parameters - **WindowsAdkRoot** (String) - Optional - The root directory of the Windows ADK installation. Aliases: AdkRoot. - **MediaPath** (String) - Required - Directory containing the bootable media. - **isoFileName** (String) - Required - File Name of the ISO. - **isoLabel** (String) - Required - Label of the ISO. Limited to 16 characters. #### Switch Parameters - **OpenExplorer** - Optional - Opens Windows Explorer to the parent directory of the ISO File. #### Common Parameters Supports common parameters like -Debug, -ErrorAction, -Verbose, etc. ### Example ```powershell # Example usage would go here, but is not provided in the source. ``` ### Notes - Requires Windows ADK. - The `isoLabel` parameter is limited to 16 characters. ``` -------------------------------- ### Block Windows Release ID Less Than 1703 with Warning Source: https://github.com/osdeploy/osd/blob/master/Docs/Block-WindowsReleaseIdLt1703.md This example demonstrates using the Block-WindowsReleaseIdLt1703 cmdlet with the -Warn parameter. This will issue a warning before blocking installations. ```powershell PS C:\> Block-WindowsReleaseIdLt1703 -Warn ``` -------------------------------- ### Retrieve HP Accessory Catalog Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-HPAccessoryCatalog.md This example shows how to retrieve the HP accessory catalog. No specific setup or imports are required beyond having the OSD module available. ```powershell Get-HPAccessoryCatalog ``` -------------------------------- ### Start-OSDCloud Cmdlet Documentation Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloud.md Documentation for the Start-OSDCloud cmdlet, including its various parameter sets for different build configurations. ```APIDOC ## Start-OSDCloud ### Description Starts the OSDCloud Windows 10 or 11 Build Process from the OSD Module or a GitHub Repository. ### Syntax #### Default (Default) ```powershell Start-OSDCloud [-Manufacturer ] [-Product ] [-Firmware] [-Restart] [-Shutdown] [-Screenshot] [-SkipAutopilot] [-SkipODT] [-ZTI] [-OSName ] [-OSEdition ] [-OSLanguage ] [-OSActivation ] [-Preview] [-ProgressAction ] [] ``` #### Legacy ```powershell Start-OSDCloud [-Manufacturer ] [-Product ] [-Firmware] [-Restart] [-Shutdown] [-Screenshot] [-SkipAutopilot] [-SkipODT] [-ZTI] [-OSVersion ] [-OSBuild ] [-OSEdition ] [-OSLanguage ] [-OSActivation ] [-Preview] [-ProgressAction ] [] ``` #### CustomImage ```powershell Start-OSDCloud [-Manufacturer ] [-Product ] [-Firmware] [-Restart] [-Shutdown] [-Screenshot] [-SkipAutopilot] [-SkipODT] [-ZTI] [-FindImageFile] [-ImageFileUrl ] [-OSImageIndex ] [-Preview] [-ProgressAction ] [] ``` ### Parameters #### -Manufacturer Automatically populated from Get-MyComputerManufacturer -Brief - Type: String - Parameter Sets: (All) - Required: False - Position: Named - Default value: (Get-MyComputerManufacturer -Brief) #### -Product Automatically populated from Get-MyComputerProduct - Type: String - Parameter Sets: (All) - Required: False - Position: Named - Default value: (Get-MyComputerProduct) #### -Firmware $Global:StartOSDCloud.MSCatalogFirmware = $true - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -Restart Restart the computer after Invoke-OSDCloud to OOBE - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -Shutdown Shutdown the computer after Invoke-OSDCloud - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -Screenshot Captures screenshots during OSDCloud WinPE - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -SkipAutopilot Skips the Autopilot Task routine - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -SkipODT Skips the ODT Task routine - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -ZTI Skip prompting to wipe Disks - Type: SwitchParameter - Parameter Sets: (All) - Required: False - Position: Named - Default value: False #### -OSName {{ Fill OSName Description }} - Type: String - Parameter Sets: Default - Required: False - Position: Named - Default value: None #### -OSVersion Operating System Version of the Windows installation - Type: String - Parameter Sets: Legacy - Required: False - Position: Named - Default value: None #### -OSBuild Operating System Build of the Windows installation Alias = Build - Type: String - Parameter Sets: Legacy - Aliases: Build - Required: False - Position: Named - Default value: None #### -OSEdition Operating System Edition of the Windows installation Alias = Edition - Type: String - Parameter Sets: Default, Legacy - Aliases: Edition - Required: False - Position: Named - Default value: None #### -OSLanguage - Type: String - Parameter Sets: Default, Legacy - Required: False - Position: Named - Default value: None #### -OSActivation - Type: String - Parameter Sets: Default, Legacy - Required: False - Position: Named - Default value: None #### -Preview - Type: SwitchParameter - Parameter Sets: Default, Legacy, CustomImage - Required: False - Position: Named - Default value: False #### -FindImageFile - Type: SwitchParameter - Parameter Sets: CustomImage - Required: False - Position: Named - Default value: False #### -ImageFileUrl - Type: String - Parameter Sets: CustomImage - Required: False - Position: Named - Default value: None #### -OSImageIndex - Type: String - Parameter Sets: CustomImage - Required: False - Position: Named - Default value: None #### -ProgressAction - Type: ActionPreference - Parameter Sets: (All) - Required: False - Position: Named - Default value: None ``` -------------------------------- ### Get Power Setting for Monitor Off Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-PowerSettingTurnMonitorOffAfter.md This example shows how to retrieve the power setting that controls when the monitor turns off due to inactivity. No parameters are required for this basic retrieval. ```powershell Get-PowerSettingTurnMonitorOffAfter ``` -------------------------------- ### Basic Test-DCUSupport Usage Source: https://github.com/osdeploy/osd/blob/master/Docs/Test-DCUSupport.md This example shows the basic syntax for running the Test-DCUSupport cmdlet. No parameters are specified, indicating a default or system-wide check. ```powershell Test-DCUSupport ``` -------------------------------- ### Add SSU with Logging Source: https://github.com/osdeploy/osd/blob/master/Docs/Add-WindowsPackageSSU.md This example demonstrates adding an SSU package to an offline image while specifying a custom log file path. This is useful for troubleshooting installation issues. ```powershell Add-WindowsPackageSSU -PackagePath "C:\Updates\ServicingStackUpdate.msu" -Path "C:\Mount\Windows" -LogPath "C:\Logs\Dism.log" ``` -------------------------------- ### Get ADK Paths Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-WindowsAdkPaths.md Retrieves the command paths for the Windows ADK. This example shows a basic usage without specifying architecture or root path, relying on defaults. ```powershell PS C:\> Get-WindowsAdkPaths ``` -------------------------------- ### Start-OSDPad GitLab Syntax Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDPad.md This syntax is used when deploying an OS from a GitLab repository. It requires the repository name and domain, and optionally accepts a folder within the repo and an OAuth token. ```powershell Start-OSDPad [-RepoName] [[-RepoFolder] ] -RepoDomain [-OAuth ] [-Brand ] [-Color ] [-Hide ] [-ProgressAction ] [] ``` -------------------------------- ### Get Time Zone from IP Address Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-TimeZoneFromIP.md This is a basic example of how to use the Get-TimeZoneFromIP cmdlet. No parameters are required as it uses the current machine's IP address by default. ```powershell Get-TimeZoneFromIP ``` -------------------------------- ### Get Microsoft Update Service Manager Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-ComObjMicrosoftUpdateServiceManager.md This example demonstrates how to retrieve the Microsoft Update Service Manager COM object. No specific parameters are required for basic retrieval. ```powershell Get-ComObjMicrosoftUpdateServiceManager ``` -------------------------------- ### Block Windows Release ID Less Than 1703 Source: https://github.com/osdeploy/osd/blob/master/Docs/Block-WindowsReleaseIdLt1703.md This example shows how to use the Block-WindowsReleaseIdLt1703 cmdlet. The cmdlet is used to block Windows installations with release IDs less than 1703. ```powershell PS C:\> Block-WindowsReleaseIdLt1703 ``` -------------------------------- ### Mount a WIM file Source: https://github.com/osdeploy/osd/blob/master/Docs/Mount-MyWindowsImage.md This example demonstrates mounting a WIM file. Replace 'C:\path\to\your\image.wim' with the actual path to your WIM file. ```powershell Mount-MyWindowsImage -ImagePath "C:\path\to\your\image.wim" ``` -------------------------------- ### Get OSDCloud Operating Systems Indexes Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-OSDCloudOperatingSystemsIndexes.md This example shows how to retrieve the operating systems used by OSDCloud. No specific parameters are required, and it will return all available operating system indexes. ```powershell Get-OSDCloudOperatingSystemsIndexes ``` -------------------------------- ### Create an ISO from Bootable Media Source: https://github.com/osdeploy/osd/blob/master/Docs/New-AdkISO.md Use this cmdlet to create an ISO file from a directory containing bootable media. The Windows ADK must be installed. Specify the root of the ADK, the media path, the desired ISO file name, and a label for the ISO. ```powershell New-AdkISO -WindowsAdkRoot "C:\Program Files (x86)\Windows Kits\10" -MediaPath "C:\OSD\Boot" -isoFileName "OSD.iso" -isoLabel "OSD" ``` -------------------------------- ### Get Compatible HP Software Catalog Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-HPSoftwareCatalog.md This example filters the results to include only software components compatible with the HP System's Baseboard Product. This requires the `-Compatible` switch. ```powershell PS C:\> Get-HPSoftwareCatalog -Compatible ``` -------------------------------- ### Configure PowerShell in WinPE Source: https://github.com/osdeploy/osd/blob/master/Docs/Edit-MyWinPE.md This example demonstrates how to configure PowerShell within WinPE by setting the execution policy to 'Bypass', enabling the PowerShell Gallery, and installing specific modules. Changes are saved after configuration. ```powershell Edit-MyWinPE -ImagePath "C:\WinPE_amd64\media\sources\boot.wim" -ExecutionPolicy "Bypass" -PSGallery -PSModuleInstall "PSReadline,PackageManagement" -DismountSave ``` -------------------------------- ### Set WinPE Wallpaper Source: https://github.com/osdeploy/osd/blob/master/Docs/Edit-MyWinPE.md This example demonstrates how to set a custom wallpaper for the WinPE environment by specifying the path to a JPG file. The changes are then saved to the WIM. ```powershell Edit-MyWinPE -ImagePath "C:\WinPE_amd64\media\sources\boot.wim" -Wallpaper "C:\Wallpapers\MyWallpaper.jpg" -DismountSave ``` -------------------------------- ### Set-SetupCompleteCreateFinish Cmdlet Source: https://github.com/osdeploy/osd/blob/master/Docs/Set-SetupCompleteCreateFinish.md This cmdlet finalizes the setup completion process. It can be used to control whether a restart is performed after completion. ```APIDOC ## Set-SetupCompleteCreateFinish ### Description Finalizes the setup completion process. Optionally prevents a restart. ### Syntax ```powershell Set-SetupCompleteCreateFinish [-NoRestart] [-ProgressAction ] [] ``` ### Parameters #### -NoRestart Controls whether a restart is performed after setup completion. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` #### -ProgressAction Specifies how to respond to a progress cmdlet. ```yaml Type: ActionPreference Parameter Sets: (All) Aliases: proga Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, and -WarningVariable. ### Input None ### Output System.Object ``` -------------------------------- ### Get Latest Compatible Dell BIOS Update Source: https://github.com/osdeploy/osd/blob/master/Docs/Get-MyDellBios.md This example demonstrates how to use the Get-MyDellBios cmdlet to retrieve the latest compatible BIOS update for your system. No specific parameters are required for basic usage. ```powershell Get-MyDellBios ``` -------------------------------- ### Selecting a Single Volume with Invoke-SelectOSDVolume Source: https://github.com/osdeploy/osd/blob/master/Docs/Invoke-SelectOSDVolume.md This example shows how to select only a single volume using the -SelectOne parameter. This is useful when you require a unique volume to be selected, for instance, the primary OS installation drive. The cmdlet will return only one volume that matches the criteria. ```powershell Invoke-SelectOSDVolume -MinimumSizeGB 50 -SelectOne ``` -------------------------------- ### Example Usage of Block-NoCurl Source: https://github.com/osdeploy/osd/blob/master/Docs/Block-NoCurl.md This example demonstrates how to use the Block-NoCurl cmdlet. Add specific example code to illustrate its functionality. ```powershell PS C:\> {{ Add example code here }} ``` -------------------------------- ### Start-OSDCloudToolbox Cmdlet Reference Source: https://github.com/osdeploy/osd/blob/master/Docs/Start-OSDCloudToolbox.md This section provides detailed information about the Start-OSDCloudToolbox cmdlet, its parameters, and how to use it. ```APIDOC ## Start-OSDCloudToolbox ### Description {{ Fill in the Description }} ### Syntax ```powershell Start-OSDCloudToolbox [[-RepoFolder] ] [-OAuth ] [-ProgressAction ] [] ``` ### Parameters #### -OAuth {{ Fill OAuth Description }} - **Type**: String - **Parameter Sets**: (All) - **Aliases**: OAuthToken - **Required**: False - **Position**: Named - **Default value**: None - **Accept pipeline input**: False - **Accept wildcard characters**: False #### -RepoFolder {{ Fill RepoFolder Description }} - **Type**: String - **Parameter Sets**: (All) - **Aliases**: - **Required**: False - **Position**: 0 - **Default value**: None - **Accept pipeline input**: False - **Accept wildcard characters**: False #### -ProgressAction {{ Fill ProgressAction Description }} - **Type**: ActionPreference - **Parameter Sets**: (All) - **Aliases**: proga - **Required**: False - **Position**: Named - **Default value**: None - **Accept pipeline input**: False - **Accept wildcard characters**: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ### Inputs None ### Outputs System.Object ### Examples #### Example 1 ```powershell PS C:\> {{ Add example code here }} ``` {{ Add example description here }} ```