Edit

Get-CMWinPEOptionalComponentInfo

  • Reference
Module:
ConfigurationManager

Get a Windows PE optional component.

Syntax

Get-CMWinPEOptionalComponentInfo
   -Architecture <String>
   [-LanguageId <UInt32>]
   [-Name <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMWinPEOptionalComponentInfo
   -UniqueId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to get a Windows PE (WinPE) optional component. Use this object to add it to or remove it from a boot image with the Set-CMBootImage cmdlet. For more information, see Manage boot images - Optional components.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Get optional components and add to a boot image

This example gets the .NET and PowerShell optional components, and then adds them to a boot image.

$netfxOC = Get-CMWinPEOptionalComponentInfo -Architecture 'x64' -Name 'WinPE-NetFX' -LanguageId 1033
$pwshOC = Get-CMWinPEOptionalComponentInfo -Architecture 'x64' -Name 'WinPE-PowerShell' -LanguageId 1033
$OCs = @($netfxOC, $pwshOC)

Set-CMBootImage -Id 'XYZ00556' -AddOptionalComponent $OCs

Parameters

-Architecture

Specify the architecture of a WinPE optional component.

Type:String
Accepted values:X64, X86
Position:Named
Default value:None
Required:True
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

-LanguageId

Specify the language ID for the optional component.

This ID is the decimal equivalent of the Windows language ID. For example, 1033 is 0x0409 for English (United States), and 2070 is 0x0816 for Portuguese (Portugal). For more information, see [MS-LCID]: Windows Language Code Identifier (LCID) Reference.

Configuration Manager supports 22 languages. For more information, see Client languages.

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

-Name

Specify the name of the WinPE optional component to get.

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

-UniqueId

Specify the unique ID of the WinPE optional component to get.

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

Inputs

None

Outputs

IResultObject[]

IResultObject

Notes

For more information on this return object and its properties, see SMS_WinPEOptionalComponentInfo server WMI class.