New-CMBootImage
New-CMBootImage
Adds a new operating system boot image.
Syntax
Parameter Set: New
New-CMBootImage -Index <Int32> -Name <String> -Path <String> [-Description <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-CMBootImage cmdlet adds a new Windows Preinstallation Environment (Windows PE) operating system boot image to Microsoft System Center 2012 SP1 Configuration Manager. Operating system images are .wim format files. These files contain a compressed set of reference files and folders that are required to successfully install and configure a boot image on a computer. By default, System Center 2012 Configuration Manager includes both x86 and x64 operating system images.
You must run New-CMBootImage on the computer that is running the Systems Management Server (SMS) provider. The computer account of the computer that is running the SMS provider must have Read and Write access to the package source of the boot image. For more information about the SMS provider, see Planning for the SMS Provider in Configuration Manager (https://go.microsoft.com/fwlink/?LinkID=263566) on TechNet.
Parameters
-Description<String>
Specifies a description of the boot image.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Index<Int32>
Specifies an index. An index is the number of an image in a .wim file.
Aliases |
ImageIndex |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a new boot image.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the location of the original WIM file for the boot image.
Aliases |
ImagePath |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Version<String>
Specifies the version of the boot image.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Create a new boot image object
This command creates a new boot image object and provides it with a source path for its WIM file, an index value, a name, an operating system version, and a description.
PS C:\> New-CMBootImage -Path "\\Server99.Contoso.com\SMS_CCC\osd\boot\i386\boot.wim" -Index 1 -Name "WinPE Boot Image" -Version 11 -Description "WinPE Boot Image x86 Approved 9/1/2012"