Skip to content

Commit 8eb9667

Browse files
committed
AVD MSIXMGR tool reorganized some parameters
1 parent b219f73 commit 8eb9667

File tree

1 file changed

+40
-32
lines changed

1 file changed

+40
-32
lines changed

articles/virtual-desktop/msixmgr-tool-syntax-description.md

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Add the package at specified file path.
3636
msixmgr.exe -AddPackage "C:\SomeDirectory\myapp.msix"
3737
```
3838

39+
|Optional parameters|Description|Example|
40+
| -------- | -------- | -------- |
41+
|-quietUX|Installs MSIX package silently, without any user interaction|`msixmgr.exe -AddPackage C:\SomeDirectory\myapp.msix -quietUX`|
42+
3943
### -RemovePackage or -x
4044

4145
Remove the package with specified package full name.
@@ -50,6 +54,10 @@ Remove the package with specified package full name.
5054
msixmgr.exe -RemovePackage myapp_0.0.0.1_x64__8wekyb3d8bbwe
5155
```
5256

57+
|Optional parameters|Description|Example|
58+
| -------- | -------- | -------- |
59+
|-quietUX|Uninstalls MSIX package silently, without any user interaction|`msixmgr.exe -RemovePackage myapp_0.0.0.1_x64__8wekyb3d8bbwe -quietUX`|
60+
5361
### -FindPackage
5462

5563
Find a package with specific package full name.
@@ -78,80 +86,80 @@ Applies ACLs to a package folder (an unpacked package).
7886
msixmgr.exe -ApplyACLs -packagePath "C:\SomeDirectory\name_version_arch_pub"
7987
```
8088

81-
### -MountImage
89+
### -Unpack
8290

83-
Mounts the VHD, VHDX, or CIM image.
91+
Unpacks package (`.appx`, `.msix`, `.appxbundle`, `.msixbundle`) and extract its contents to a folder.
8492

8593
```
86-
-MountImage -imagePath [Path to the MSIX image] -fileType [VHD | VHDX | CIM]
94+
-Unpack -packagePath [Path to package to unpack OR path to a directory containing multiple packages to unpack] -destination [Directory to place the resulting package folder(s) in]
8795
```
8896

8997
#### Example
9098

99+
To unpack a package into a directory:
100+
91101
```
92-
msixmgr.exe -MountImage -imagePath "C:\SomeDirectory\myapp.cim" -fileType CIM
102+
msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp"
93103
```
94104

95-
|Optional parameters|Description|Example|
96-
| -------- | -------- | -------- |
97-
|-readOnly|Boolean (true of false) indicating whether the image should be mounted as read only. If not specified, the image is mounted as read-only by default. |`msixmgr.exe -MountImage -imagePath "C:\SomeDirectory\myapp.cim" -filetype CIM -readOnly false`|
105+
To unpack a package into a VHDX disk image:
98106

99-
### -quietUX
100-
101-
Quiet mode, no user interaction. Use in conjunction with other parameters.
107+
> [!NOTE]
108+
> If you're using VHD or VHDX, we recommend the size is four times the size of MSIX package.
102109
103110
```
104-
-quietUX
111+
msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -vhdSize 200 -filetype VHDX -rootDirectory apps
105112
```
106113

107-
#### Example
114+
To unpack a package into a CIM disk image:
108115

109116
```
110-
msixmgr.exe -AddPackage "C:\SomeDirectory\myapp.msix" -quietUX
117+
msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -filetype CIM -rootDirectory apps
111118
```
112119

113-
### -UnmountImage
120+
|Optional parameters|Description|Example|
121+
| -------- | -------- | -------- |
122+
|-applyacls|Applies ACLs to the resulting package folder(s) and their parent folder. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs` |
123+
|-create|Creates a new image with the specified -filetype and unpacks the packages to that image. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -fileType VHDX -vhdSize 200` |
124+
|-fileType|The type of file to unpack packages to. Valid file types include `VHD`, `VHDX`, `CIM`. This is a required parameter when unpacking to CIM files. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -fileType CIM -rootDirectory apps` |
125+
|-rootDirectory|Specifies root directory on image to unpack packages to. Required parameter for unpacking to new and existing CIM files. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -filetype CIM -rootDirectory apps` |
126+
|-validateSignature|Validates a package's signature file before unpacking package. This parameter will require that the package's certificate is installed on the machine.<br /><br />For more information, see [Certificate Stores](/windows-hardware/drivers/install/certificate-stores).|`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\Myapp" -validateSignature -applyACLs`|
114127

115-
Unmounts the VHD, VHDX, or CIM image.
128+
### -MountImage
129+
130+
Mounts the VHD, VHDX, or CIM image.
116131

117132
```
118-
-UnmountImage -imagePath [Path to the MSIX image] -fileType [VHD | VHDX | CIM]
133+
-MountImage -imagePath [Path to the MSIX image] -fileType [VHD | VHDX | CIM]
119134
```
120135

121-
#### Example:
136+
#### Example
122137

123138
```
124-
msixmgr.exe -UnmountImage -imagePath "C:\SomeDirectory\myapp.vhdx" -fileType VHDX
139+
msixmgr.exe -MountImage -imagePath "C:\SomeDirectory\myapp.cim" -fileType CIM
125140
```
126141

127142
|Optional parameters|Description|Example|
128143
| -------- | -------- | -------- |
129-
|-volumeId|Specifies GUID (specified without curly braces) associated with image to unmount. This is an optional parameter only for CIM files. |`msixmgr.exe -UnmountImage -volumeId 0ea000fe-0021-465a-887b-6dc94f15e86e -filetype CIM`|
144+
|-readOnly|Boolean (true of false) indicating whether the image should be mounted as read only. If not specified, the image is mounted as read-only by default. |`msixmgr.exe -MountImage -imagePath "C:\SomeDirectory\myapp.cim" -filetype CIM -readOnly false`|
130145

131-
### -Unpack
146+
### -UnmountImage
132147

133-
Unpacks package (`.appx`, `.msix`, `.appxbundle`, `.msixbundle`) and extract its contents to a folder.
148+
Unmounts the VHD, VHDX, or CIM image.
134149

135150
```
136-
-Unpack -packagePath [Path to package to unpack OR path to a directory containing multiple packages to unpack] -destination [Directory to place the resulting package folder(s) in]
151+
-UnmountImage -imagePath [Path to the MSIX image] -fileType [VHD | VHDX | CIM]
137152
```
138153

139-
> [!NOTE]
140-
> If you're using VHD or VHDX, we recommend the size is four times the size of MSIX package.
141-
142-
#### Example
154+
#### Example:
143155

144156
```
145-
msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp"
157+
msixmgr.exe -UnmountImage -imagePath "C:\SomeDirectory\myapp.vhdx" -fileType VHDX
146158
```
147159

148160
|Optional parameters|Description|Example|
149161
| -------- | -------- | -------- |
150-
|-applyacls|Applies ACLs to the resulting package folder(s) and their parent folder. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs` |
151-
|-create|Creates a new image with the specified -filetype and unpacks the packages to that image. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -fileType VHDX -vhdSize 200` |
152-
|-fileType|The type of file to unpack packages to. Valid file types include `VHD`, `VHDX`, `CIM`. This is a required parameter when unpacking to CIM files. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -fileType CIM -rootDirectory apps` |
153-
|-rootDirectory|Specifies root directory on image to unpack packages to. Required parameter for unpacking to new and existing CIM files. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -filetype CIM -rootDirectory apps` |
154-
|-validateSignature|Validates a package's signature file before unpacking package. This parameter will require that the package's certificate is installed on the machine.<br /><br />For more information, see [Certificate Stores](/windows-hardware/drivers/install/certificate-stores).|`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\Myapp" -validateSignature -applyACLs`|
162+
|-volumeId|Specifies GUID (specified without curly braces) associated with image to unmount. This is an optional parameter only for CIM files. |`msixmgr.exe -UnmountImage -volumeId 0ea000fe-0021-465a-887b-6dc94f15e86e -filetype CIM`|
155163

156164
### -?
157165

0 commit comments

Comments
 (0)