Import-StartLayout
Imports the layout of the Start into a mounted Windows image.
Syntax
Path
Import-StartLayout
[-LayoutPath] <String>
[-MountPath] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Import-StartLayout
-LayoutLiteralPath <String>
-MountLiteralPath <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Import-StartLayout cmdlet imports the specified layout of Start into a mounted Windows image. When you import a layout, it replaces the existing layout of Start for the default user profile. When the Windows image is booted, new users will receive the imported layout at sign-in. New users will be able to customize their default layout, but not the layout for the default user profile.
Before you use this cmdlet, mount the Windows image file to import the layout into.
You must have administrator rights to import a layout.
In Windows 10, the Export-StartLayout cmdlet exports layouts as .xml files, and the Import-StartLayout cmdlet imports only .xml files.
Caution
The Import-StartLayout cmdlet is deprecated in Windows 11. It has no effect on either Start or Taskbar layout. To configure the Start layout in Windows 11, see Customize the Windows 11 Start layout. To configure Taskbar layout in Windows 11, see Customize the Taskbar.
Examples
Example 1: Import a layout into a Windows image
PS C:\> Import-StartLayout -LayoutPath "Layout.xml" -MountPath "C:\"
This command imports a layout of the Start screen into a Windows image.
Example 2: Validate the layout file and Windows image
PS C:\> Import-StartLayout -LayoutPath "Layout.xml" -MountPath " C:\" -WhatIf
This command validates the layout file and the Windows image by using the WhatIf parameter. Besides that parameter, the command is the same as the previous example, but this command makes no changes.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: | SwitchParameter |
Default value: | False |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-LayoutLiteralPath
Specifies a literal path to a layout file. This parameter does not accept the wildcard character (*). If the path includes an escape character (\), enclose the string in single quotes (').
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
LiteralPath
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-LayoutPath
Specifies a path to a layout file.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Path
Position: | 1 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-MountLiteralPath
Specifies the literal path where you mounted the .wim file. This parameter does not accept the wildcard character (*). If the path includes an escape character (\), enclose the string in single quotes (').
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
LiteralPath
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-MountPath
Specifies the path where you mounted the .wim file and specifies the local appdata folder for the default user.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Path
Position: | 2 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: | SwitchParameter |
Default value: | False |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.