Edit

Get-CMOperatingSystemImage

  • Reference
Module:
ConfigurationManager

Gets OS images.

Syntax

Get-CMOperatingSystemImage
   [-Name <String>]
   [-Reload]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMOperatingSystemImage
   -Id <String>
   [-Reload]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

The Get-CMOperatingSystemImage cmdlet gets one or more OS images on a Configuration Manager site. OS images are .wim format files and represent a compressed collection of reference files and folders that Configuration Manager requires to successfully install and configure an OS on a computer.

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 an OS image

This command gets the OS image named OSImagePkg01 for the security scope named SecScope02.

Get-CMOperatingSystemImage -Name "OSImagePkg01" -SecuredScopeNames "SecScope02"

Parameters

-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

-Id

Specifies an array of IDs of OS images.

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

-Name

Specifies the name of an OS image.

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

-Reload

Applies to version 2006 and later. If you change the image properties using an external tool, use this option to reload the information in the site database.

Type:SwitchParameter
Aliases:ReloadImage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject[]

IResultObject