PowerShell Commands

Add-WindowsCapability

Add-WindowsCapability [-LimitAccess] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>][-ScratchDirectory <String>] [-Source <String[]>] [-SystemDrive <String>] [-WindowsDirectory <String>] -Name*<String> -Online* [<CommonParameters>]
Add-WindowsCapability [-LimitAccess] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>][-ScratchDirectory <String>] [-Source <String[]>] [-SystemDrive <String>] [-WindowsDirectory <String>] -Name*<String> -Path* <String> [<CommonParameters>]

The Add-WindowsCapability cmdlet acquires a Windows capability package from a priority-ordered list of source locations, and then installs the package on the specified operating system image.

Parameters

-LimitAccess [<SwitchParameter>]

  • Accepts pipeline input ByPropertyName

Indicates that this cmdlet does not access Windows�Update for the source package.

-LogLevel [<LogLevel>]

  • Accepts pipeline input ByPropertyName

Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows:1 = Errors only2 = Errors and warnings3 = Errors, warnings, and information4 = All of the information listed previously, plus debug output

-LogPath [<String>]

  • Accepts pipeline input ByPropertyName

Specifies 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.

-Name <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the identity of the capability to add to an operating system image.

-Online <SwitchParameter>

  • This value is required
  • Accepts pipeline input ByPropertyName

Indicates that the cmdlet operates on a running operating system on the local host.

-Path <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies 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>]

  • Accepts pipeline input ByPropertyName

Specifies 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.

-Source [<String[]>]

  • Accepts pipeline input ByPropertyName

Specifies the location of the files that are required to add a Windows capability package to an image. You can specify the Windows directory of a mounted image or a running Windows installation that is shared on the network.

If you specify multiple Source arguments, the files are gathered from the first location where they are found and the rest of the locations are ignored. Separate source locations with a comma.

If you do not specify a Source, the default location set by Group Policy is used. WindowsUpdate is also used for online images.

Source can only be used when servicing images that are running at least Windowsr 8 or Windows Serverr 2012.

-SystemDrive [<String>]

  • Accepts pipeline input ByPropertyName

Specifies 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>]

  • Accepts pipeline input ByPropertyName

Specifies 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.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Outputs
Microsoft.Dism.Commands.ImageObject
Examples
  1. Add a Windows capability package to an image:
    PS C:\> Add-WindowsCapability -Name "Language.TextToSpeech~~~fr-FR~0.0.1.0" -Path "C:\offline" -Source "C:\Windows\winsxs"
    

    This command adds a Windows capability package to the operating system image specified by the Name parameter at the path C:\offline. The Source parameter specifies the location of required files.

  2. Add a Windows capability package to the local host:
    PS C:\> Add-WindowsCapability -Name "Language.TextToSpeech~~~fr-FR~0.0.1.0" -Online -LimitAccess -Source "C:\Windows\winsxs"
    

    This command adds a windows capabilities package the local host while the operating system continues to run.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands