Skip to content

Latest commit

 

History

History
220 lines (159 loc) · 6.13 KB

New-CMWindows11EditionUpgrade.md

File metadata and controls

220 lines (159 loc) · 6.13 KB
Raw
external help file Module Name ms.date online version schema
AdminUI.PS.dll-Help.xml
ConfigurationManager
09/13/2023
2.0.0

New-CMWindows11EditionUpgrade

SYNOPSIS

Create a Windows 11 edition upgrade policy.

SYNTAX

New-CMWindows11EditionUpgrade [-Description <String>] [-EditionUpgradeWithClient <Boolean>]
 [-LicenseFile <String>] -Name <String> [-ProductKey <String>] [-WindowsEdition <WindowsEditionType>]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Create a Windows 11 edition upgrade policy. Specify a product key or license information to upgrade Windows 11 to a different edition. For more information, see Upgrade Windows devices to a new edition with Configuration Manager.

EXAMPLES

Example 1

New-CMWindows11EditionUpgrade -Name "NewEditionPolicyByKey" -WindowsEdition Windows11Enterprise -ProductKey "123ab-cd456-789ef-2j3k4-0ghi1"

PARAMETERS

-Description

Specify an optional description for the policy.

Type: String
Parameter Sets: (All)
Aliases: LocalizedDescription

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EditionUpgradeWithClient

Use this parameter to specify the type of edition upgrade to create:

  • $true: The policy is for devices managed with the Configuration Manager client. Use the ProductKey parameter to specify the license key.
  • $false: This policy is for devices running Windows 11 Mobile that you manage with on-premises MDM. Use the LicenseFile parameter to provide the XML license file.
Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseFile

When you set the EditionUpgradeWithClient parameter to $false, use this parameter to specify the path to the XML license file. Get the license file from the Microsoft Volume Licensing Service Center (VLSC). This file contains the licensing information for the new version of Windows on all devices you target with the policy. Download the ISO file for Windows 11 Mobile Enterprise, which includes the licensing XML.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specify a name for this Windows 11 edition upgrade policy.

Type: String
Parameter Sets: (All)
Aliases: LocalizedDisplayName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProductKey

When you set the EditionUpgradeWithClient parameter to $true, use this parameter to specify a valid product key for the new version of Windows. This product key can be a multiple activation key (MAK), or a generic volume licensing key (GVLK). A GVLK is also referred to as a key management service (KMS) client setup key. For more information, see Plan for volume activation. For a list of KMS client setup keys, see Appendix A of the Windows Server activation guide.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WindowsEdition

Specify the target edition of Windows 11 that corresponds with the LicenseFile or ProductKey.

Type: WindowsEditionType
Parameter Sets: (All)
Aliases:
Accepted values: Windows11Enterprise, Windows11Education, Windows11EnterpriseN, Windows11EducationN, WindowsPhone11, HolographicEnterprise

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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.

INPUTS

None

OUTPUTS

IResultObject#SMS_ConfigurationPolicy

NOTES

RELATED LINKS

Get-CMWindowsEditionUpgradeConfigurationItem

Remove-CMWindows10EditionUpgrade

Set-CMWindows10EditionUpgrade

Upgrade Windows devices to a new edition with Configuration Manager