Share via


IoT Core Add-ons Powershell Commands

Note

IoT Core Add-ons command-line is deprecated. Refer to IoT Core Add-ons command-line options for the old list of commands.

The Powershell version of the Windows 10 IoT Core (IoT Core) ADK Add-Ons supports the following commands. These are part of the powershell module IoTCoreImaging. To learn more about these tools, see What's in the Windows ADK IoT Core Add-ons.

Powershell Commands with Alias

Add-IoTAppxPackage (newappxpkg)

Adds an Appx package directory to the workspace and generates the required wm.xml and customizations.xml files

Add-IoTBitLocker

Generates the Bitlocker package (Security.BitLocker) contents based on the workspace specifications.

Add-IoTBSP (newbsp)

Generates a BSP directory under Source-arch\BSP\ using a BSP directory template.

Add-IoTCEPAL (addcepal)

Chain CEPALFM.xml into the IoT Core packaging process for a specific product

Add-IoTCommonPackage (newcommonpkg)

Adds a common(generic) package directory to the workspace and generates the required wm.xml file.

Add-IoTDeviceGuard

Generates the device guard package (Security.DeviceGuard) contents based on the workspace specifications.

Add-IoTDirPackage (adddir)

Adds the directory contents into a IoT file package definition.

Add-IoTDriverPackage (newdrvpkg)

Adds a driver package directory to the workspace and generates the required wm.xml file.

Add-IoTEnvironment (addenv)

Adds a new architecture to the workspace

Add-IoTFilePackage (addfile)

Adds a file package directory to the workspace and generates the required wm.xml file.

Add-IoTProduct (newproduct)

Generates a new product directory under Source-arch\Products.

Add-IoTProductFeature (addfid)

Adds feature id to the specified product's oeminput xml file.

Add-IoTProvisioningPackage (newprovpkg)

Adds a provisioning package directory to the workspace and generates the required wm.xml file, customizations.xml file and the icdproject file.

Add-IoTRegistryPackage (addreg)

Adds a registry package directory to the workspace and generates the required wm.xml file.

Add-IoTSecureBoot

Generates the secure boot package (Security.SecureBoot) contents based on the workspace specifications. If Test is specified, then it includes test certificates from the specification.

Add-IoTSecurityPackages

Creates the security packages based on the settings in workspace configuration.

Add-IoTSignature (signbinaries)

Signs the files with the certificate selected via Set-IoTSignature

Add-IoTZipPackage (addzip)

Adds the zip file contents into a IoT file package definition.

Convert-IoTPkg2Wm (convertpkg)

Converts the existing pkg.xml files to wm.xml files.

Copy-IoTBSP (copybsp)

Copies a BSP folder to the destination workspace from a source workspace or a source bsp directory.

Copy-IoTOEMPackage (copypkg)

Copies an OEM package to the destination workspace from a source workspace.

Copy-IoTProduct (copyproduct)

Copies a product folder to the destination workspace from a source workspace.

Dismount-IoTFFUImage (ffud)

Dismounts the mounted ffu image and saves it as a new ffu if an ffuname is specified.

Export-IoTDeviceModel (exportidm)

Exports the DeviceModel XML file required to register the device in the Device Update Center portal.

Export-IoTDUCCab (exportpkgs)

Exports the update cab file required to upload on the Device Update Center

Export-IoTFFUAsWims (ffue)

Extracts the mounted partitions as wim files

Get-IoTFFUDrives (ffugd)

Returns a hashtable of the drive letters of the mounted partitions

Get-IoTProductFeatureIDs (gpfids)

Returns the list of supported feature IDs in the Windows 10 IoT Core OS release defined in the workspace.

Get-IoTProductPackagesForFeature (gpfidpkgs)

Returns the list of supported feature IDs in the Windows 10 IoT Core OS release defined in the workspace.

Get-IoTWorkspaceBSPs (gwsbsps)

Returns the list of BSP names in the workspace.

Get-IoTWorkspaceProducts (gwsproducts)

Returns the list of product names in the workspace.

Import-IoTBSP (importbsp)

Imports a BSP folder in to the current workspace from a source workspace or a source bsp directory or a source zip file.

Import-IoTCEPAL (importcepal)

Import a flat release directory and prepare for packaging into IoT Core

Import-IoTCertificate

Imports an certificate and adds to the Workspace security specification.

Import-IoTDUCConfig (importcfg)

Imports the Device Update Center Configuration files into the product directory

Import-IoTOEMPackage (importpkg)

Imports an OEM package in to the current workspace from a source workspace.

Import-IoTProduct (importproduct)

Imports a product folder in to the current workspace from a source workspace.

Import-PSCoreRelease (importps)

Import Powershell Core Release into your workspace and update the wm xml files.

Import-QCBSP

Import QC BSP into your workspace and update the bsp files as required by the latest tools.

Install-IoTOEMCerts

Installs the OEM certs (pfx files) in the certs\private folder

Mount-IoTFFUImage (ffum)

Mounts the specifed FFU, parses the device layout and assigns drive letters for the partitions with file system defined.

New-IoTCabPackage (buildpkg)

Creates a Cab package file for the specified wm.xml file or the wm.xml files in the specified directory.

New-IoTDeviceLayout

Factory method to create a new object of class IoTDeviceLayout

New-IoTFFUCIPolicy (ffus)

This function scans the mounted FFU Main OS partition and creates a CI policy.

New-IoTFFUImage (buildimage)

Creates the IoT FFU image for the specified product / configuration. Returns boolean true for success and false for failure.

New-IoTFIPPackage (buildfm)

Creates Feature Identifier Packages (FIP packages) for the given feature manifest files and updates the feature manifest files with the generated FIP packages. Returns boolean true for success and false for failure.

New-IoTFMXML

Factory method to create a new object of class IoTFMXML

New-IoTInf2Cab (inf2cab)

Creates a cab file for the given inf.

New-IoTOEMCerts

Generates the required OEM certificates.

New-IoTOemInputXML

Factory method to create a new object of class IoTOemInputXML

New-IoTProduct

Factory method to create a new object of class IoTProduct

New-IoTProductSettingsXML

Factory method to create a new object of class IoTProductSettingsXML

New-IoTProvisioningPackage (buildppkg)

Creates a .ppkg file from the customizations.xml input file. Returns a boolean indicating success or failure.

New-IoTProvisioningXML

Factory method to create a new object of class IoTProvisioningXML

New-IoTRecoveryImage (buildrecovery)

Creates recovery ffu from a regular ffu

New-IoTWindowsImage (newwinpe)

Builds a WinPE image with relevant drivers and recovery files

New-IoTWMWriter

Factory method, returing the IoTWMWriter class object used to write namespace.name.wm.xml file.

New-IoTWMXML

Factory method to create a new object of class IoTWMXML

New-IoTWorkspace (new-ws)

Creates a new IoTWorkspace xml and the directory structure at the specified input directory.

New-IoTWorkspaceXML

Creates a new IoTWorkspaceXML object

Open-IoTWorkspace (open-ws)

Opens the IoTWorkspace xml at the specified input directory and sets up the environment with those settings.

Redo-IoTCabSignature (re-signcabs)

Resigns the cab file and its contents / cat files with the certificate set in the environment.

Redo-IoTWorkspace (migrate)

Updates an old iot-adk-addonkit folder with required xml files to make it a proper workspace.

Remove-IoTProductFeature (removefid)

Removes feature id from the specified product's oeminput xml file.

Set-IoTCabVersion (setversion)

Sets the version to be used in the Cab package creation.

Set-IoTEnvironment (setenv)

Sets the environment variables as per requested architecture

Set-IoTRetailSign (retailsign)

Sets the signing certificate to the retail cert or test cert.

Set-IoTSignature (setsignature)

Sets the signing related env vars with the cert information provided.

Test-IoTCabSignature (checkcab)

Checks if the cab file and its contents are properly signed.

Test-IoTCerts (tcerts)

Checks if the certs in the workspace folder are all valid.

Test-IoTFeatures (tfids)

Validates if all features specified in the specified product/config oeminputxml are defined. This returns boolean true for success and false for failure.

Test-IoTPackages (tpkgs)

Validates if all packages required for the specified product/config image creation are available and properly signed. This returns boolean true for success and false for failure.

Test-IoTRecoveryImage (verifyrecovery)

Validates if the recovery wim files are proper in the recovery ffu

Test-IoTSignature (checksign)

Checks if the file is properly signed.

IoT Core Add-ons

IoT Core manufacturing guide