New-CMOperatingSystemInstaller
Create an OS upgrade package.
Syntax
New-CMOperatingSystemInstaller
[-Description <String>]
[-Name <String>]
[-Index <Int32>]
-Path <String>
[-Version <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Use this cmdlet to add an OS upgrade package to a Configuration Manager site. An OS upgrade package in Configuration Manager contains the Windows setup source files to upgrade an existing OS on a computer. For more information, see Manage OS upgrade packages with Configuration Manager.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Add an OS upgrade package
This command adds an OS upgrade package named Windows 10 latest and specifies the network path to the installation source files.
New-CMOperatingSystemInstaller -Name "Windows 10 latest" -Path "\\Contoso01\CM\Win10latest"Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specify an optional description to help you identify the upgrade package. The maximum length is 127 characters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Index
When you add this parameter, the site extracts a single index image from a multi-index image. It then places the new image in the same source folder as the original image in the upgrade package source files.
Using this option results in a smaller image file, and faster offline servicing. It also supports the process to Optimize image servicing, for a smaller image file after applying software updates.
| Type: | Int32 |
| Aliases: | ImageIndex |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specify the name of the OS upgrade package. The maximum length is 50 characters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Specify the network path to the OS upgrade package source files. The installation source files contain setup.exe and other files and folders to install the OS.
| Type: | String |
| Aliases: | PackageSourcePath |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
Specify an optional version of the OS image. This value is for your internal versioning, not the version of the OS. The maximum length is 32 characters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
IResultObject
Notes
For more information on this return object and its properties, see SMS_OperatingSystemInstallPackage server WMI class.