This section lists the command-line arguments that are used with appcapture.exe to achieve tasks such as create a capture, update an existing application, end a capture session, and so on, using the command-line capture program. Some of these arguments are mandatory while few are optional.
The following table lists the command-line arguments and tasks accomplished using these arguments:
Note: The command-line arguments for an MSIX app attach format (/addmeta, /msix, and /msixvmdk) can be used only for converting an MSIX app attachment format to the Omnissa App Volumes format. These command-line arguments cannot be used for capturing packages in the App Volumes format.
| Command-line Argument | Task | Examples |
|---|---|---|
| /help | Displays the list of arguments and their description that can be used with the appcapture.exe command. | |
| /new <package_name> | Start a capture session for a new application or update an existing application.
This argument is mandatory.
Following files are created in a capture session: Note: The following arguments can be used with /new: /a, /d, /msi, /s, /novmdk, /upgradecode, and /appproductid. To see the usage of /new, see Capture an App Volumes Application. | Example: MyApp is the name of the package generated when the MyApp application is captured. |
| /d <disk_description> | Specify comments that identify the content in the output file while running a new capture session or updating an existing application. The disk description can be viewed in the App Volumes Manager admin UI as part of the package description. This argument is optional. | Example: |
| /s <source_vhd_filepath> | Update an existing (already captured) application by using the captured application's .vhd file as the source.
This argument is optional.
Note: Do not use this argument when capturing a new application.
To see the usage of /s, see Update an App Volumes Application | Example:
|
| /o output_dir | Customize the location of the output files created in a capture session by specifying the path to the directory where the files must be saved.
This argument is optional.
By default, the output files are located at C:\ProgramData\Omnissa\AppVolumes\Packages.
Note: /o can be used only with the following: /new, /meta, /vmdk, /vhd. | Example: After the capture session, MyApp_dir contains MyApp_workstation.vmdk, MyApp.vhd, and MyApp.json. |
| /novmdk | Prevents the creation of the .vmdk format of the application package.
This argument is optional and can be used when you need only the .vhd format of the application package.
By default, after a capture session, the program creates a .vmdk file for the captured application. When this argument is provided, the .vmdk file is not created. | Example:MyApp.vhd and MyApp.json are created. |
| /msi | Used with the /new appcapture.exe command to create the .msi format of the application package along with the .vmdk, .vhd, and .json output files.The .msi is required when delivering App Volumes application packages to Windows endpoints (such as physical desktops, laptops, and Windows 365 Cloud PC) using device management tools such as Omnissa Workspace ONE UEM, Microsoft Intune, or Microsoft Configuration Manager (SCCM).The .msi package is also located at the same location as the .vhd, .vmdk, and .json. For compressed packages exceeding 2GB, the output is an .msi file along with a packageid.cab file. Both files are necessary for installation, as the .msi file size limit is 2GB.If the package has on-demand data available, then by default, the delivery type of the .msi package is on-demand. Else, the delivery type of the package is classic.For more information about delivering App Volumes applications to Windows endpoints, see the Deliver App Volumes Applications Using Device Management Tools. | Example:appcapture.exe /new firefox /msifirefox.msi is created along with the firefox.vhd, firefox_workstation.vmdk, and firefox.json files. |
| /end | Completes the capture session which was started by using /new.
When /end is used, the machine reboots and the command-line capture program automatically restarts. This completes the capture process. .vhd and .vmdk package formats are generated along with the .json metadata file.
This argument is mandatory.
To see the usage of this argument, see Capture an App Volumes Application. | Example:By default, MyApp.vhd, MyApp_workstation.vmdk, and MyApp.json are created at C:\ProgramData\Omnissa\AppVolumes\Packages. |
| /noauto | Prevents the program from automatically restarting after a machine reboot. This argument is optional and can be used only with /new and /end. In some scenarios such as during capture completion and at times during application installation, the machine reboots. In either case, the command-line capture program automatically restarts on its own. At times you might want to perform some custom initialization task and prevent the automatic restart of the program. In such cases, you can use the /noauto argument. After the machine reboots, to restart the program and complete the capture session, /resume must be used. | Examples:
|
| /resume | Resumes the command-line capture program after a machine reboot. This argument is mandatory if you have used the /noauto argument while starting (/new) or ending (/end) a capture session. | Example: |
| /cancel | Cancels the capture session that was started using /new. The capture session gets cancelled and the machine reboots. It is recommended that you revert to a clean snapshot before you start a new capture session. | Example: |
| /test source_vhd_filepath | Tests and validates the captured application using the application's .vhd package format.
When this argument is used, the program attaches the package to the virtual machine and enables the application bundles in the package for testing.
To use the /test parameter, you must revert to a clean snapshot, different from the one used for application capture.
To see the usage of this argument, see Test a Captured Application. | Example:The application package, MyApp.vhd at C:\ProgramData\Omnissa\AppVolumes\Packages\test_dir is attached to the virtual machine and enabled for testing. |
| /testend | Ends the test session. If you intend to test and validate another application, then revert to the snapshot taken before you started the test session for this application. | Example: |
| /list <vhd, vmdk, or json filepath> | Prints the package information. | Example: |
| /meta <vhd or vmdk filepath> | Creates a .json metadata file for a captured application using the application's .vmdk or .vhd file as the source.
By default, the .json file is created in the same path as that of the source. | Examples:MyApp.json is created at C:\ProgramData\Omnissa\AppVolumes\Packages\. |
| /vmdk vhd_filepath | Creates a .vmdk file using the application's .vhd file as the source. | Example: Using MyApp.vhd as the source, the program creates MyApp_workstation.vmdk. By default, the .vmdk file is located at the same path as the .vhd file. In the example, MyApp_workstation.vmdk is created at C:\ProgramData\Omnissa\AppVolumes\Packages. |
| /vhd vmdk_filepath | Creates a dynamic .vhd file from a .vmdk (monolithic sparse) file as the source
Note: If you want to convert a .vmdk of an application package, captured using App Volumes Manager, the application package must be converted to a monolithic sparse .vmdk and then appcapture.exe can be used with the /vhd argument. | Example: Using MyApp_workstation.vmdk as the source, the program creates MyApp.vhd. By default, the .vhd file is located at the same path as the .vmdk file. In the example, MyApp.vhd is created at C:\ProgramData\Omnissa\AppVolumes\Packages. |
| /addmeta vhd_filepath | Creates a .json metadata file as required by App Volumes to process an MSIX app attach format.
Note: Prior to using the /addmeta argument, ensure that the VHD is not already mounted. If the VHD is mounted, you must unmount the VHD and then run the argument.
After creating the metadata for the MSIX app attach format, you can copy the .vhd and .json files to a file share and import the package to App Volumes Manager by following the Import an Application to App Volumes procedure. | |
| /msix root_path | Specifies the location of the unpacked MSIX inside the MSIX app attach format.
Note: This argument must be used with /addmeta <vhd_filepath> while creating the .json file. | Example:
A .json metadata file is created for the MyApp.vhd package, which is an MSIX app attach format. This metadata file is created at C:\VHDs.
WindowsApps\MyApp_1.0.0.0_x64__97zz0k7g87g9t specifies the location of the unpacked MSIX inside the MSIX app attach format. |
| /msixvmdk vhd_filepath | Converts the MSIX app attach format to .vmdk (monolithic sparse).
To import the .vmdk into App Volumes Manager, you must rename the file to *_workstation.vmdk and follow the procedure that is similar to importing a .vmdk package after capturing an application. For more information, see the What to do next section in Capture an App Volumes Application. | Example:Converts MyApp.vhd to .vmdk. |
| /packagefromappv | Converts an App-V application package to an App Volumes application package. Before using this argument, ensure that you are aware of certain considerations for the conversion. For more information regarding the list of considerations and about App-V conversion, see the Convert App-V Application Packages to App Volumes Application Packages. | Example:Adobe.appv is converted to an App Volumes application package. The following output files are generated: Adobe_workstation.vmdk, Adobe.vhd, and Adobe.json are generated at C:\ProgramData\Omnissa\AppVolumes\Packages. |
| convert |
Used to generate a .msi format of an already captured application package (either .vhd and .vmdk). The .msi is required when delivering App Volumes application packages to Windows endpoints (such as physical desktops, laptops, and Windows 365 Cloud PC) using device management tools such as Omnissa Workspace ONE UEM, Microsoft Intune, or Microsoft Configuration Manager (SCCM).The .msi file is generated at the same location as the .vhd or .vmdk and .json, hence the .vhd or .vmdk and .json files must be present at the same location. The files must also have the same file name.For more information about delivering App Volumes applications to Windows endpoints, see the Deliver App Volumes Applications Using Device Management Tools. |
Example:In this example, NPP.msi is generated from the existing NPP.vhd package. NPP.msi is present in the same location as NPP.vhd and NPP.json. The /format MSI argument indicates that the file generated using NPP.vhd must be in the .msi format. |
| /appproductid |
This optional parameter sets the custom GUID as the app_product_guid property for the captured .vmdk and .vhd package and as the UpgradeCode property of the captured .msi package. This property is used to identify different application package versions which belong to the same application. When importing the package to App Volumes Manager, the package gets automatically associated with an existing application. Additionally, such an identification ensures that when different application package versions of the same application are delivered to a Windows endpoint, the user receives only the later version of the application at a time. This parameter can be used with the appcapture.exe /new command to set the property for a new application package or the parameter can be used with the appcapture.exe update command to add or modify the property of an existing application package.Note:
|
Here are the different ways of using this parameter:
If you want to import this application package in App Volumes Manager and associate the package with an existing application, then custom_GUID must be the same as the application GUID in App Volumes Manager. After the command runs, app_product_guid property is set in the .json file. The value of this property is same as the application GUID. Hence, after import, the captured package is associated with the existing application in App Volumes Manager.In this command, the custom_GUID is added as the app_product_guid property of the existing .vhd package. If the package has an existing app_product_guid, then the custom_GUID replaces the existing one. |
| /upgradecode |
This optional parameter uses the UpgradeCode of the native MSI application installer and generates a GUID. This GUID is set as the app_product_guid property of the captured .vhd package and as the UpgradeCode property of the captured .msi package. This property is used to identify different application package versions which belong to the same application. Such an identification ensures that when different application package versions of the same application are delivered to a Windows endpoint, the user receives only the later version of the application at a time. This parameter can be used with the |
Here are the different ways of using this parameter:
In this command, the generated GUID is added as the app_product_guid property of the existing .vhd package. If the package has an existing app_product_guid, then the new GUID replaces the existing one. |
| update |
Used along with /appproductid and /upgradecode arguments to add or modify the app_product_guid or UpgradeCode property of the captured .vhd or .msi application package respectively. For information about these two arguments, see their description and examples in this table. Note: /appproductid cannot be used for .vmdk packages with the appcapture.exe update command. |
Examples:
7zip.msi package, which was captured earlier.NPP.vhd package. This property is present in the NPP.json file.7zip.msi App Volumes application package which was captured earlier.NPP.VHD package. This property is set in the NPP.JSON file. |
Was this page helpful?