Skip to main content

24 de agosto de 2026

App Volumes PowerShell Cmdlets for Delivering Applications to Windows Endpoints

If you want to deliver the App Volumes application package in the .vhd format following your own delivery mechanism, then you can use PowerShell Cmdlets that allow you to perform operations such as install, swap, uninstall, and launch applications.

App Volumes applications can be directly delivered to Windows endpoints using device management tools.
For more information about this delivery scenario, see Deliver App Volumes Applications to Windows Endpoints.

Enhance end user experience during application uninstall and application swap

To enhance end user experience, notifications can be presented to the end user before the application gets uninstalled or swapped from the Windows endpoint. You can choose to use this capability by adding an svservice parameter EnableAppChangeNotification of type REG_DWORD at HKLM\SYSTEM\CurrentControlSet\Services\svservice\Parameters in the Windows endpoint. Prior to uninstall or swap, the value of this parameter must be configured to 1.

Note: The notifications are displayed only when the application remains launched at the time of uninstall or swap. If the application is not actively used, then no notifications are displayed even when the parameter is enabled.

To understand how the parameter helps in end user experience during uninstall or swap, see the descriptions for Uninstall-AppVolumesPackage and Swap-AppVolumesPackage in the table listing the PowerShell Cmdlets in this page.

PowerShell Cmdlets

Command line ArgumentTask
Install-AppVolumesPackage -Path VHD path -ClassicDelivery -StoreOfflineInstalls the application on the Windows endpoint, using the .vhd package from the path specified in the command. The .vhd and .json files must be at the same location and have the same file name.

The following are optional parameters:
  • -ClassicDelivery
    Use this parameter to change the package delivery mode to classic.
    Delivery type can be changed to classic at the time of installing the application on the endpoint.
    If the application package has on-demand data available during capture, then by default the delivery type is on-demand. Else, the delivery type is classic.

  • -StoreOffline
    When this parameter is used, the .vhd and .json files of the application package are locally stored on the Windows endpoint at this location C:\ProgramData\Omnissa\AppVolumes\OfflineCache\Volume ID, where Volume ID is the package volume ID. The package gets virtualized from this location and then the application is delivered.

    If this parameter is not provided, by default, the package gets virtualized and application is delivered from the path as defined by the -Path parameter.
    Note: In earlier versions of App Volumes, the .vhd and .json files are always locally stored on the Windows endpoint.

Uninstall-AppVolumesPackage -Path VHD pathUninstalls the application from the Windows endpoint.

Depending on the EnableAppChangeNotification parameter value, the uninstall behavior varies.
  • When the parameter value is 0 or the parameter is not added, then no notifications are presented to the end user and after the uninstall command runs, the application is unavailable to the user at the subsequent user login.

  • When the EnableAppChangeNotification parameter is configured to 1 and at the time of uninstall if the application remains launched, then one of the following occurs:
    • An Application Removal dialog box is displayed. The end user can either save the work and close the application or allow the application to automatically close after the timer has elapsed. In either case, the application is uninstalled from the Windows endpoint.

    • Sometimes during uninstall, a system reboot might be required. The end user is presented with A System Reboot Required dialog box. Similar to application removal, the end user can either save the work and immediately restart the system or wait for the system to automatically restart after the timer has elapsed. After the system restart, the application is uninstalled.

For more information about EnableAppChangeNotification, see the Enhance end user experience during application uninstall and application swap section earlier in this page.
Swap-AppVolumesPackage -OldPath Old VHD path -NewPath New VHD path -ClassicDelivery -StoreOfflineThis command swaps or replaces an existing application package with a new application package. An existing package can be swapped with another version of the application package or a different application package.

Depending on the EnableAppChangeNotification parameter value, the swap behavior varies.
  • When the parameter value is 0 or the parameter is not added, then after the swap command runs, the new application package is available to the user at the subsequent user login.

  • When the EnableAppChangeNotification parameter is configured to 1 and at the time of swap if the application remains launched, then one of the following occurs:
    • An Application Removal dialog box is displayed. The end user can either save the work and close the application or allow the application to automatically close after the timer has elapsed. In either case, the existing application is uninstalled from the Windows endpoint and the new application is installed.

    • Sometimes during the swap, a system reboot might be required. The end user is presented with A System Reboot Required dialog box. Similar to application removal, the end user can either save the work and immediately restart or wait for the system to automatically restart after the timer has elapsed. After the restart, the existing application is uninstalled and the new application is installed.

For more information about EnableAppChangeNotification, see the Enhance end user experience during application uninstall and application swap section earlier in this page.

-ClassicDelivery and -StoreOffline are optional parameters. When these optional parameters are used, the swap occurs immediately, the delivery mode of the swapped package is classic, and the .vhd and .json files of the new application package are locally stored on the Windows endpoint. For information about these parameters, see the other rows in this table.
Get-AppVolumesPackages -OutputFile path of the file where the json output must be storedUse this command to list application packages which are assigned to a particular session. Application details such as package name, package version, and other package identifier details are retrieved and displayed on the command line.

With this command, you can use the -OutputFile file path parameter.
File path indicates where the json output must be stored.
When this parameter is used, in addition to the output getting displayed on the command line, the output also gets stored in the json format in a file at the location as mentioned in the parameter.

Example:

In the following example, application package details such as package name, package version, volume ID, App Product ID, path from where the .vhd package is virtualized, and so on are fetched for Adobe Reader XI and Mozilla.
At the Windows PowerShell prompt, the command and output are as follows:

C:\Users\Administrator> Get-AppVolumesPackages

Package Name : Adobe Reader XI (11.0.23)
Package Version : 11.0.23
Volume ID : {b7a2615a-b5d7-4c05-ac2e-59116be2f21a}
App ID : {cc1271b6-8e79-4ae4-9648-4b0c833d93a3}
App Product ID : {000a9960-1c3e-5000-0000-00002349760e}
Package File Path : c:\users\administrator\desktop\adobevhd\adobexi.vhd
Metadata File Path : c:\users\administrator\desktop\adobevhd\adobexi.json


For more information about App Product ID (upgradecode), see Windows Command-Line Arguments for the App Volumes Application Capture Command-Line Program.
Extract-AppVolumesPackageShortcuts -Path VHD file path/json file path -IncludeIcons -IconFormat ico|png -IconSize Size -IconExtractPath folder path -OutputFile file pathUse this command to list all the shortcuts of an application package and retrieve information related to the shortcut.

To enhance user experience, Extract-AppVolumesPackageShortcuts also retrieves the Run-AppVolumesApp command line and the executable for that particular package. As a result, both the command line and executable can be saved and used later to deliver and launch the application.

Note:.vhd and .json (metadata) files must be present at the same location. The files must also have the same name.


The following parameters can be used with this command:

-OutputFile file path parameter.
File path indicates where the json output must be stored.
When this parameter is used, in addition to the output getting displayed on the command line, the output also gets stored in the json format in a file at the location as mentioned in the parameter.

-IncludeIcons
This is an optional parameter which can be used to extract the application icon. When this parameter is used, an icon is extracted to the current working directory by default. If a location is specified using the -IconExtractPath parameter, then the icon is extracted to the location specified in the parameter. If the -IncludeIcons parameter is not used, then no icon is extracted.

Other icon-related, optional parameters which can be used only with -IncludeIcons are as follows:
  • -IconFormat ico|png
    Use this parameter to extract the icon as .ico or .png. By default, the icon format is .ico.

  • -IconSize
    Use this parameter to change the icon size to any of the supported dimension values which are as follows: "16x16", "32x32", "48x48", "64x64", "128x128", and "256x256".
    By default, the icon size is 64X64.
    Note: This parameter can be used only when the icon format is .png.

  • -IconExtractPath folder path
    This optional parameter is used to indicate the location to which the icon is extracted. When this parameter is used, an application icon is extracted to the location mentioned in the folder path.

Example:

In the following example, shortcut and related information such as name, actual path of the application shortcut, description, publisher, and so on are listed for Office 2016. As -IncludeIcon and related parameters are used, icons are extracted to the C:\Users\Administrator\Desktop\temp location in the png format and are of size 256x256. For more information about these details, see the Run-AppVolumesApp description.



At the Windows PowerShell prompt, the command and output are as follows:

C:\Users\Administrator\Desktop> Extract-AppVolumesPackageShortcuts -Path "C:\Users\Administrator\Desktop\Office2016.vhd" -IncludeIcons -IconFormat png -IconSize 256x256 -IconExtractPath "C:\Users\Administrator\Desktop\temp" -OutputFile "C:\Users\Administrator\Desktop\temp\Outputfile.txt"

Name: Access 2016
Path: C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Access 2016.lnk
Description:
Publisher : Microsoft Corporation
Version : 16.0.4266.1001
Launch PS Command : Run-AppVolumesApp -Path C:\Users\Administrator\Desktop\Office2016.vhd -LaunchId 7d7c275d-979a-fe73-ff7f-d4c31ff40dbe
Launch Command : AppVolumes.exe runapp -Path C:\Users\Administrator\Desktop\Office2016.vhd -LaunchId 7d7c275d-979a-fe73-ff7f-d4c31ff40dbe
Icon Path : C:\Users\Administrator\Desktop\temp\Access 2016.png

Name: Excel 2016
Path: C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Excel 2016.lnk
Description :
Publisher : Microsoft Corporation
Version : 16.0.4266.1001
Launch PS Command : Run-AppVolumesApp -Path C:\Users\Administrator\Desktop\Office2016.vhd -LaunchId 62a238b4-ec17-94ba-8e9d-43582311b265
Launch Command : AppVolumes.exe runapp -Path C:\Users\Administrator\Desktop\Office2016.vhd -LaunchId 62a238b4-ec17-94ba-8e9d-43582311b265
Icon Path : C:\Users\Administrator\Desktop\temp\Excel 2016.png

Run-AppVolumesApp -Path VHD path -LaunchID Launch ID-LaunchID: A unique GUID identifier which represents an application shortcut in a package.

When this command is run, an application is delivered and the application shortcut is launched. When an end user clicks the shortcut, the application is launched. Each application shortcut is associated with a unique launch ID (GUID), which is captured at the time of application packaging. As the application is delivered only for that user session, this application is not available for the user after reboot.


Prerequisites:
  • Ensure that you have run the Extract-AppVolumesPackageShortcuts command which retrieves the application shortcut and associated launch ID.
  • Ensure that the .vhd package and the .json (metadata) file are present at the same location and have the same name.

¿Le resultó útil esta página?

Enviar comentarios sobre este tema

¿Le resultó útil este tema?

No incluya información personal ni confidencial.

Generando el enlace…