Skip to content

Commit 19b021c

Browse files
authored
Merge pull request MicrosoftDocs#2591 from PatAltimore/patricka-dism
Dism module update for WS2022
2 parents 98f148d + 717f79e commit 19b021c

17 files changed

+1443
-166
lines changed

docset/winserver2022-ps/dism/Add-AppxProvisionedPackage.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.Dism.PowerShell.dll-Help.xml
44
Module Name: System.Object[]
5-
ms.date: 12/21/2016
5+
ms.date: 10/07/2021
66
online version: https://docs.microsoft.com/powershell/module/dism/add-appxprovisionedpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Add-AppxProvisionedPackage
@@ -18,16 +18,18 @@ Adds an app package (.appx) that will install for each new user to a Windows ima
1818
### Offline
1919
```
2020
Add-AppxProvisionedPackage [-FolderPath <String>] [-PackagePath <String>] [-DependencyPackagePath <String[]>]
21-
[-LicensePath <String>] [-SkipLicense] [-CustomDataPath <String>] -Path <String> [-WindowsDirectory <String>]
22-
[-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>] [-StubPackageOption <StubPackageOption>] [-LogLevel <LogLevel>] [-Regions <String>]
21+
[-OptionalPackagePath <String[]>] [-LicensePath <String[]>] [-SkipLicense] [-CustomDataPath <String>]
22+
[-Regions <String>] [-StubPackageOption <StubPackageOption>] -Path <String> [-WindowsDirectory <String>]
23+
[-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>] [-LogLevel <LogLevel>]
2324
[<CommonParameters>]
2425
```
2526

2627
### Online
2728
```
2829
Add-AppxProvisionedPackage [-FolderPath <String>] [-PackagePath <String>] [-DependencyPackagePath <String[]>]
29-
[-LicensePath <String>] [-SkipLicense] [-CustomDataPath <String>] [-Online] [-WindowsDirectory <String>]
30-
[-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>] [-StubPackageOption <StubPackageOption>] [-LogLevel <LogLevel>] [-Regions <String>]
30+
[-OptionalPackagePath <String[]>] [-LicensePath <String[]>] [-SkipLicense] [-CustomDataPath <String>]
31+
[-Regions <String>] [-StubPackageOption <StubPackageOption>] [-Online] [-WindowsDirectory <String>]
32+
[-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>] [-LogLevel <LogLevel>]
3133
[<CommonParameters>]
3234
```
3335

@@ -122,7 +124,7 @@ Accept wildcard characters: False
122124
Specifies the location of the .xml file containing your application license.
123125
124126
```yaml
125-
Type: String
127+
Type: String[]
126128
Parameter Sets: (All)
127129
Aliases:
128130

@@ -185,6 +187,23 @@ Accept pipeline input: True (ByPropertyName)
185187
Accept wildcard characters: False
186188
```
187189

190+
### -OptionalPackagePath
191+
Specifies the path to an optional package that will also be provisioned. For more information on
192+
optional packages, see
193+
[Optional packages and related set authoring](/windows/msix/package/optional-packages).
194+
195+
```yaml
196+
Type: String[]
197+
Parameter Sets: (All)
198+
Aliases:
199+
200+
Required: False
201+
Position: Named
202+
Default value: None
203+
Accept pipeline input: True (ByPropertyName)
204+
Accept wildcard characters: False
205+
```
206+
188207
### -PackagePath
189208
Specifies the location of the app package (.appx) to add to the Windows image.
190209
This package will be added for every new user account.
@@ -221,7 +240,7 @@ Accept wildcard characters: False
221240
```
222241

223242
### -Regions
224-
Specifies what regions an app package (.appx or .appxbundle) must be provisioned in. The region argument can either be all, indicating that the app should be provisioned for all regions, or it can be a semi-colon delimited list of regions. The regions will be in the form of [ISO 3166-1 Alpha-2 or ISO 3166-1 Alpha-3 codes](https://en.wikipedia.org/wiki/ISO_3166-1). For example, the United States can be specified as either "US" or "USA" (case-insensitive). When a list of regions is not specified, the package will be provisioned only if it is pinned to start layout.
243+
Specifies what regions an app package (.appx or .appxbundle) must be provisioned in. The region argument can either be "all", indicating that the app should be provisioned for all regions, or it can be a semi-colon delimited list of regions. The regions will be in the form of [ISO 3166-1 Alpha-2 or ISO 3166-1 Alpha-3 codes](https://en.wikipedia.org/wiki/ISO_3166-1). For example, the United States can be specified as either "US" or "USA" (case-insensitive). When a list of regions is not specified, the package will be provisioned only if it is pinned to start layout.
225244

226245
Note: Option is available on client OS.
227246

@@ -285,7 +304,7 @@ Aliases:
285304
Required: False
286305
Position: Named
287306
Default value: None
288-
Accept pipeline input: InstallFull, InstallStub
307+
Accept pipeline input: True (ByPropertyName)
289308
Accept wildcard characters: False
290309
```
291310

docset/winserver2022-ps/dism/Add-WindowsCapability.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.Dism.PowerShell.dll-Help.xml
44
Module Name: System.Object[]
5-
ms.date: 12/21/2016
5+
ms.date: 08/24/2021
66
online version: https://docs.microsoft.com/powershell/module/dism/add-windowscapability?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Add-WindowsCapability
@@ -17,14 +17,15 @@ Installs a Windows capability package on the specified operating system image.
1717

1818
### Online
1919
```powershell
20-
Add-WindowsCapability -Online -Name <String> [-LimitAccess] [-Source <String[]>] [-WindowsDirectory <String>]
21-
[-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>] [-LogLevel <LogLevel>]
22-
[<CommonParameters>]
20+
Add-WindowsCapability [-Name <String>] [-LimitAccess] [-Source <String[]>] [-Online]
21+
[-WindowsDirectory <String>] [-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>]
22+
[-LogLevel <LogLevel>] [<CommonParameters>]
2323
```
2424

2525
### Offline
2626
```powershell
27-
Add-WindowsCapability -Path <String> -Name <String> [-Source <String[]>] [-WindowsDirectory <String>] [-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>]
27+
Add-WindowsCapability [-Name <String>] [-LimitAccess] [-Source <String[]>] -Path <String>
28+
[-WindowsDirectory <String>] [-SystemDrive <String>] [-LogPath <String>] [-ScratchDirectory <String>]
2829
[-LogLevel <LogLevel>] [<CommonParameters>]
2930
```
3031

@@ -63,7 +64,7 @@ Indicates that this cmdlet does not query Windows Update for source packages whe
6364
```yaml
6465
Type: SwitchParameter
6566
Parameter Sets: (All)
66-
Aliases:
67+
Aliases:
6768

6869
Required: False
6970
Position: Named
@@ -94,7 +95,7 @@ If not set, the default is `"$env:WINDIR\Logs\Dism\dism.log"`.
9495
In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB.
9596
The log file will automatically be archived.
9697
The archived log file will be saved with .bak appended to the file name and a new log file will be generated.
97-
Each time the log file is archived the .bak file will be overwritten.
98+
Each time the log file is archived the .bak file will be overwritten.
9899
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.
99100
100101
```yaml
@@ -115,7 +116,7 @@ Specifies the identity of the capability to add to an operating system image.
115116
```yaml
116117
Type: String
117118
Parameter Sets: (All)
118-
Aliases:
119+
Aliases:
119120

120121
Required: True
121122
Position: Named
@@ -130,7 +131,7 @@ Indicates that the cmdlet operates on a running operating system on the local ho
130131
```yaml
131132
Type: SwitchParameter
132133
Parameter Sets: Online
133-
Aliases:
134+
Aliases:
134135

135136
Required: True
136137
Position: Named
@@ -146,7 +147,7 @@ If the directory named Windows is not a subdirectory of the root directory, *Win
146147
```yaml
147148
Type: String
148149
Parameter Sets: Offline
149-
Aliases:
150+
Aliases:
150151

151152
Required: True
152153
Position: Named
@@ -159,14 +160,14 @@ Accept wildcard characters: False
159160
Specifies a temporary directory that will be used when extracting files for use during servicing.
160161
The directory must exist locally.
161162
If not specified, the `"$env:Temp"` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM.
162-
Items in the scratch directory are deleted after each operation.
163+
Items in the scratch directory are deleted after each operation.
163164
You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation.
164165
The directory used for extracting files for temporary usage during servicing should be a local directory.
165166
166167
```yaml
167168
Type: String
168169
Parameter Sets: (All)
169-
Aliases:
170+
Aliases:
170171

171172
Required: False
172173
Position: Named
@@ -180,12 +181,12 @@ Specifies the location of the files that are required to add a Windows capabilit
180181
181182
If you do not specify a *Source*, the default location set by Group Policy is used. If that fails, Windows Update is also used for online images, unless *LimitAccess* is specified. When all fail, the cmdlet fails silently; no exceptions are thrown.
182183
183-
*Source* can only be used when servicing images that are running at least Windows® 8 or Windows Server® 2012.
184+
*Source* can only be used when servicing images that are running at least Windows 8 or Windows Server 2012.
184185
185186
```yaml
186187
Type: String[]
187188
Parameter Sets: (All)
188-
Aliases:
189+
Aliases:
189190

190191
Required: False
191192
Position: Named
@@ -202,7 +203,7 @@ Use -SystemDrive to service an installed Windows image from a Windows PE environ
202203
```yaml
203204
Type: String
204205
Parameter Sets: (All)
205-
Aliases:
206+
Aliases:
206207

207208
Required: False
208209
Position: Named
@@ -219,7 +220,7 @@ If not specified, the default is the Windows directory in the root of the offlin
219220
```yaml
220221
Type: String
221222
Parameter Sets: (All)
222-
Aliases:
223+
Aliases:
223224

224225
Required: False
225226
Position: Named

docset/winserver2022-ps/dism/Add-WindowsImage.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.Dism.PowerShell.dll-Help.xml
44
Module Name: System.Object[]
5-
ms.date: 12/21/2016
5+
ms.date: 08/25/2021
66
online version: https://docs.microsoft.com/powershell/module/dism/add-windowsimage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Add-WindowsImage
@@ -17,17 +17,17 @@ Adds an additional image to an existing image (.wim) file.
1717

1818
```
1919
Add-WindowsImage -ImagePath <String> -CapturePath <String> [-ConfigFilePath <String>] [-Description <String>]
20-
-Name <String> [-CheckIntegrity] [-NoRpFix] [-Setbootable] [-Verify] [-WIMBoot] [-LogPath <String>]
21-
[-ScratchDirectory <String>] [-LogLevel <LogLevel>] [<CommonParameters>]
20+
-Name <String> [-CheckIntegrity] [-NoRpFix] [-Setbootable] [-Verify] [-WIMBoot] [-SupportEa]
21+
[-LogPath <String>] [-ScratchDirectory <String>] [-LogLevel <LogLevel>] [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
2525
The **Add-WindowsImage** cmdlet adds an additional image to an existing image (.wim) file.
2626
**Add-WindowsImage** compares new files to the resources in the existing .wim file, specified by the *Name* parameter and the *ImagePath* parameter, and stores only a single copy of each unique file so that each file is only captured once.
2727
The .wim file can have only one assigned compression type.
28-
Therefore, you can only append files with the same compression type.
28+
Therefore, you can only append files with the same compression type.
2929

30-
The **Add-WindowsImage** cmdlet does not apply to virtual hard disk (VHD) files.
30+
The **Add-WindowsImage** cmdlet does not apply to virtual hard disk (VHD) files.
3131

3232
It's important to note that you'll need to ensure you have enough disk space before you run **Add-WindowsImage**.
3333
If you run out of disk space while the image is being appended, you might corrupt the .wim file.
@@ -49,7 +49,7 @@ Specifies the path to the location of the new files that will be compared to the
4949
```yaml
5050
Type: String
5151
Parameter Sets: (All)
52-
Aliases:
52+
Aliases:
5353

5454
Required: True
5555
Position: Named
@@ -65,7 +65,7 @@ CheckIntegrity stops the operation if DISM detects that the .wim file is corrupt
6565
```yaml
6666
Type: SwitchParameter
6767
Parameter Sets: (All)
68-
Aliases:
68+
Aliases:
6969

7070
Required: False
7171
Position: Named
@@ -81,7 +81,7 @@ For more information, see [DISM Configuration List and WimScript.ini Files](http
8181
```yaml
8282
Type: String
8383
Parameter Sets: (All)
84-
Aliases:
84+
Aliases:
8585

8686
Required: False
8787
Position: Named
@@ -96,7 +96,7 @@ Specifies the description of the image to be captured.
9696
```yaml
9797
Type: String
9898
Parameter Sets: (All)
99-
Aliases:
99+
Aliases:
100100

101101
Required: False
102102
Position: Named
@@ -111,7 +111,7 @@ Specifies the location of the WIM file containing the Windows image you want to
111111
```yaml
112112
Type: String
113113
Parameter Sets: (All)
114-
Aliases:
114+
Aliases:
115115

116116
Required: True
117117
Position: Named
@@ -148,7 +148,7 @@ If not set, the default is `%WINDIR%\Logs\Dism\dism.log`.
148148
In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB.
149149
The log file will automatically be archived.
150150
The archived log file will be saved with .bak appended to the file name and a new log file will be generated.
151-
Each time the log file is archived the .bak file will be overwritten.
151+
Each time the log file is archived the .bak file will be overwritten.
152152
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.
153153

154154
```yaml
@@ -169,7 +169,7 @@ Specifies the name of an image in a WIM file.
169169
```yaml
170170
Type: String
171171
Parameter Sets: (All)
172-
Aliases:
172+
Aliases:
173173
174174
Required: True
175175
Position: Named
@@ -186,7 +186,7 @@ If the parameter is not specified, reparse points that resolve to paths outside
186186
```yaml
187187
Type: SwitchParameter
188188
Parameter Sets: (All)
189-
Aliases:
189+
Aliases:
190190
191191
Required: False
192192
Position: Named
@@ -199,14 +199,14 @@ Accept wildcard characters: False
199199
Specifies a temporary directory that will be used when extracting files for use during servicing.
200200
The directory must exist locally.
201201
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.
202-
Items in the scratch directory are deleted after each operation.
202+
Items in the scratch directory are deleted after each operation.
203203
You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation.
204204
The directory used for extracting files for temporary usage during servicing should be a local directory.
205205

206206
```yaml
207207
Type: String
208208
Parameter Sets: (All)
209-
Aliases:
209+
Aliases:
210210
211211
Required: False
212212
Position: Named
@@ -223,7 +223,22 @@ Only one volume image can be marked as bootable in a .wim file.
223223
```yaml
224224
Type: SwitchParameter
225225
Parameter Sets: (All)
226-
Aliases:
226+
Aliases:
227+
228+
Required: False
229+
Position: Named
230+
Default value: None
231+
Accept pipeline input: True (ByPropertyName)
232+
Accept wildcard characters: False
233+
```
234+
235+
### -SupportEa
236+
Appends an image with extended attributes.
237+
238+
```yaml
239+
Type: SwitchParameter
240+
Parameter Sets: (All)
241+
Aliases:
227242
228243
Required: False
229244
Position: Named
@@ -233,14 +248,14 @@ Accept wildcard characters: False
233248
```
234249

235250
### -Verify
236-
Checks for errors and file duplication.
237-
During an apply operation, for example, using the **Add-WindowsImage** cmdlet, the size and the hash of the file being applied are checked against the image file to verify they are both equal.
251+
Checks for errors and file duplication.
252+
During an apply operation, for example, using the **Add-WindowsImage** cmdlet, the size and the hash of the file being applied are checked against the image file to verify they are both equal.
238253
During a capture operation, for example, when using the **New-WindowsImage** cmdlet, after the files is captured into a Windows image, the file is written to a temporary file and compared on a bit-by-bit basis with the original file.
239254

240255
```yaml
241256
Type: SwitchParameter
242257
Parameter Sets: (All)
243-
Aliases:
258+
Aliases:
244259
245260
Required: False
246261
Position: Named
@@ -255,7 +270,7 @@ Specifies that the offline image to be added will be formatted to install on a W
255270
```yaml
256271
Type: SwitchParameter
257272
Parameter Sets: (All)
258-
Aliases:
273+
Aliases:
259274
260275
Required: False
261276
Position: Named

0 commit comments

Comments
 (0)