Get-WindowsOptionalFeature

Get information about optional features in a Windows image.
This relates to the features shown in the Control Panel ➞ “Turn Windows features on or off”. e.g. Hyper-V, IIS.

Syntax
      Get-WindowsOptionalFeature [-FeatureName String] [-LogLevel {Errors | Warnings | WarningsInfo}]
         [-LogPath String] [-PackageName String] [-PackagePath String] [-ScratchDirectory String]
            [-SystemDrive String] [-WindowsDirectory String] -Online [CommonParameters]

      Get-WindowsOptionalFeature [-FeatureName String] [-LogLevel {Errors | Warnings | WarningsInfo}]
         [-LogPath String] [-PackageName String] [-PackagePath String] [-ScratchDirectory String]
            [-SystemDrive String] [-WindowsDirectory String] -Path String [CommonParameters]

Key
   -FeatureName [String]
      The name of a feature to get detailed information about. Feature names are case sensitive if you are 
      servicing a Windows image other than Windows 8.

   -LogLevel [LogLevel]
      The maximum output level shown in the logs. The default log level is 3.
      LogLevels:
       1 = Errors only
       2 = Errors and warnings
       3 = Errors, warnings, and information
       4 = All of the information listed previously, plus debug output

   -LogPath [String]
      The full path and file name to log to. If not set, the default is %WINDIR%\Logs\Dism\dism.log.
      In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file 
      will automatically be archived. The archived log file will be saved with .bak appended to the file name and a 
      new log file will be generated. Each time the log file is archived the .bak file will be overwritten. 
      When using a network share that is not joined to a domain, use the net use command together with domain 
      credentials to set access permissions before you set the log path for the DISM log.

   -Online
      Apply the action on the Operating System that is currently running on the local computer.

   -PackageName [String]
      The name of a package as it is listed in the Windows image. Use the -PackageName parameter to get all 
      of the features in the package. Use the -FeatureName and -PackageName parameters to get more detailed 
      information about a specific feature in the package.

   -PackagePath [String]
      The location of a .cab file in the Windows image. Use the -PackagePath parameter to get all of the 
      features in the package. Use the -FeatureName and -PackagePath parameters to get more detailed information about 
      a specific feature in the package.

   -Path String
      The full path to the root directory of the offline Windows image that you will service.
      If the  directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified.

   -ScratchDirectory [String]
      A temporary directory that will be used when extracting files for use during servicing.
      The  directory must exist locally. If not specified, the \Windows\%Temp% directory will be used, with a 
      subdirectory name of a randomly generated hexadecimal value for each run of DISM.
      Items in the scratch directory are deleted after each operation. 
      You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for 
      installation. The directory used for extracting files for temporary usage during servicing should be a local 
      directory.

   -SystemDrive [String]
      The path to the location of the BootMgr files. This is necessary only when the BootMgr files are 
      located on a partition other than the one that you are running the command from. Use -SystemDrive to service 
      an installed Windows image from a Windows PE environment.

   -WindowsDirectory [String]
      The path to the Windows directory relative to the image path. This cannot be the full path to the 
      Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the 
      root of the offline image directory.

Get-WindowsOptionalFeature gets information about all features (Operating System features that include optional Windows foundation features) in the Windows Foundation Package or a specified package in the Windows image.

This is equivalent to Get-CIMinstance -classname 'win32_optionalfeature' | Select-Object name
(or the older and slower Get-WmiObject -class win32_optionalfeature.
Get-CIMinstance adds the ability to retrieve this information from a remote machine.

Get-WindowsOptionalFeature requires elevation.

Examples

List the optional features in the running Operating System:

PS C:\> Get-WindowsOptionalFeature –Online

Check if either of the two "Windows PowerShell 2.0" optional features are still enabled in the running OS. If present they should be disabled:

PS C:\> Get-WindowsOptionalFeature -Online -FeatureName MicrosoftWindowsPowerShellV2
PS C:\> Get-WindowsOptionalFeature -Online -FeatureName MicrosoftWindowsPowerShellV2root

or

PS C:\> Get-WindowsOptionalFeature -Online | Where {$_.FeatureName -like '*PowerShellV2*'}

List only the enabled optional features in the running Operating System:

PS C:\> Get-WindowsOptionalFeature –Online | Where {$_.state -eq 'Enabled'} | Select-Object FeatureName

List only the disabled optional features in the running Operating System:

PS C:\> Get-WindowsOptionalFeature –Online | Where {$_.state -eq 'Disabled'} | Select-Object FeatureName | Sort-Object FeatureName

List the optional features in a package in a mounted image:

PS C:\> Get-WindowsOptionalFeature –Path "c:\offline" –PackageName "Microsoft-Windows-Backup-Package~31bf3856ad364e35~x86~~6.1.7601.16525"

Get details about a feature in a mounted image:

PS C:\> Get-WindowsOptionalFeature –Path "c:\offline" –FeatureName Hearts

Get details about a feature in a specified package in a mounted image:

PS C:\> Get-WindowsOptionalFeature –Path "c:\offline" –FeatureName "MyFeature" –PackagePath "c:\packages\package.cab"

“Wealth is not about having a lot of money; it’s about having a lot of options” ~ Chris Rock

Related PowerShell Cmdlets

Enable-ADOptionalFeature - Enable an Active Directory optional feature.
Disable-WindowsOptionalFeature - Disable a feature in a Windows image.
Get-CimInstance -ClassName 'win32_optionalfeature'
Get-WindowsCapability - Get capabilities for an image or a running OS.
Get-WindowsFeature - Retrieve roles, role services, and features.
Add-WindowsPackage - Add a single .cab or .msu file to a Windows image.


 
Copyright © 1999-2024 SS64.com
Some rights reserved