This section lists the command-line arguments that are used with appcapture.exe to achieve tasks such as starting a capture session, updating an existing application, ending a capture session, and so on, using the command-line capture program.
The table in this page lists the commands and parameters which can be used with the capture command-line program.
Note:
-
To use the commands and parameters in the earlier format, see App Volumes Administration guide, versions 2503 or earlier, at Omnissa Product Documentation.
-
The command-line arguments for MSIX app attach format cannot be used in the current version of App Volumes. For information about these arguments, see Omnissa App Volumes Administration Guide version 2503 and earlier.
Description of Commands and Parameters
| Command-line Argument | Task | Examples |
|---|---|---|
| Actions | ||
| help | This command displays the list of appcapture.exe commands, options, and their descriptions. | |
| start | This command starts a capture session for a new application or updates an existing application.appcapture.exe start /name name_of_the_packageIf additional parameters are not provided, then by default, the Note: The following parameters can be used with this command: | Example: In this example, Notepad++, is the name of the package, captured in the VHD format. Author and description are added as capture details. As /output is not provided, the output files - Notepad++.vhd and Notepad++.json - are generated at this location: C:\ProgramData\Omnissa\AppVolumes\Packages by default. |
| metadata | This command extracts the .json metadata file for the captured application, which can either be a VMDK or VHD application package.appcapture.exe metadata /file "path_of_the_captured_application_package"/file can be either .vmdk or .vhd.By default, the .json file is extracted to the same location as the captured application. If the /output parameter is provided, then the .json file is extracted to the location as specified in the parameter. | Example:In this example, Notepad++.json for the Notepad++.vhd application package is extracted to the path as specified in the /output parameter, which is C:\Users\TestUser\Desktop\Test. |
| convert |
This command converts the format of a captured application to another application package format. The converted package can be in VHD, VMDK, or MSI format.appcapture.exe convert /file "path_of_the_source_application_package" /format [VHD | VMDK | MSI]The application package located in the path specified in the /file parameter is converted to the application package format as mentioned in the /format parameter.By default, the new format of the converted application package is located at the same path as the source application package and has the same file name as the source package. This command can also be used to convert an App-V application package to an App Volumes package. For more information about converting an App-V application package, see Convert App-V Application Packages to App Volumes Application Packages. Note: To generate a .vhd application package from a .vmdk application package, which is captured using App Volumes Manager, the .vmdk package must be converted to a monolithic sparse .vmdk and then the convert command can be used.
|
Example:
|
| cancel | This command cancels an ongoing capture session.appcapture.exe cancelThe capture session gets canceled and the machine reboots. It is recommended that you revert to a clean snapshot before you start a new capture session. | Example:In this example, the capture session for Notepad++ gets canceled. |
| finalize | This command ends a capture session.appcapture.exe finalizeWhen finalize is used, the machine reboots and the command-line capture program automatically restarts. After the restart, the capture process is complete. If no additional parameters are provided, then the .vhd and .json files are generated by default. .vhd is the application package format and .json is the metadata file. By default, these files are located at: C:\ProgramData\Omnissa\AppVolumes\Packages.
| Example:In this example, Notepad++.vhd and Notepad++.json are generated at C:\ProgramData\Omnissa\AppVolumes\Packages after the capture session completes. |
| resume | This command resumes the command-line capture program after a machine reboot. If you have used the /manualresume parameter at application capture, then you must use this command to resume the program.appcapture.exe resume | Example:In this example, the machine reboots after application capture, but the program does not automatically restart after the reboot as the /manualresume is provided. When the resume command is provided, the program restarts. |
| update | This command is used as follows:
For information about these two arguments, see their description and examples in this table. Note: /appproductid cannot be used for .vmdk packages with this 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. |
| test | This command tests and validates the captured .vhd application package. When this command is used, the program attaches the package to the virtual machine and enables the application bundles in the package for testing.appcapture.exe test /package path_of_the_VHD_packageNote: Before using the test command, you must revert to a clean snapshot, which is different from the one used for application capture.
| Example:In this example, Notepad++.vhd is attached to the virtual machine and enabled for testing. |
| testend | This command 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: |
| securityscan | This optional command performs a security scan on a VHD application package using Microsoft Defender. When the command runs, a securityscan.bat script is triggered which runs Microsoft Defender and the VHD package is scanned. After the scan finishes, a .json file is generated which contains information such as the time stamp of the scan, scan command, scan result, scan output, path of the VHD package for which the scan is run, volume ID, app ID, and so on. Some of this information is also added to the metadata file (.json) of the captured VHD package in a section called securityscan. appcapture.exe securityscan /path VHD_file_path /output scan_output_json_path/path - indicates path of the captured VHD packageNote: Ensure that the captured .json file is at the same path as the captured VHD package./output - indicates the location at which the scan result (.json) must be generatedThis location can be different from /pathFor the securityscan command to run successfully, it is mandatory to provide the /output parameter.When the same VHD package is scanned subsequently, scan results are overwritten in the .json file. To retain the earlier scan results for the package, a different .json file name can be provided in the /output parameter. However, the metadata file (.json) of the package contains only the latest scan results.Here are some considerations when using this command: Note: Currently, this command can be used only for the Microsoft Defender solution. Note: For information about a failed scan, see the output field in the .json file generated as an output of the securityscan command. Before importing the package to App Volumes Manager, ensure that the scan is successful.A scan summary can be generated on the console for a single file or multiple files (in the same folder) using the /summary parameter. For more information about this parameter, see one of the rows in the Options section of this table.
| Example:In this example, the securityscan command scans Notepad++.vhd and scan results (scannotepad++.json) are generated at the path as specified in the /output parameter. The scan results are also added to the securityscan section of Notepad++.json. |
| Options | ||
| /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 start /name 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. |
| /description | This parameter can be used to add a description for a captured application either during a new capture session or when updating an existing application. When the package is imported to App Volumes Manager, this description can be viewed in the admin UI as part of package description. This parameter is optional. | Example: |
| /format | This parameter can be used to choose the output format of an application package during a new capture session or when converting an already-captured application to a different format. Hence, this parameter can be used with start and convert commands. The output formats can be VHD, VMDK, or MSI.
Note: If this parameter is not provided, then by default, the generated output is in the VHD format. You can use this parameter with the startcommand in the following ways :
| Example: In this example, the generated Notepad++.vhd format is converted to Notepad++.vmdk and Notepad++.msi formats. Later, the Notepad++.vhd format is deleted. |
| /manualresume | This parameter prevents the command-line capture program from an automatic restart after a machine reboot. The program must be manually restarted after the reboot using the resume command.This parameter is optional and can be used only with the start command.Sometimes during capture completion or application installation, the machine reboots. In either case, the command-line capture program automatically restarts on its own. Sometimes, you might want to perform some custom initialization task and prevent the automatic restart of the program. In such cases, this parameter can be used. After the machine reboots, the resume command must be used to restart the program and complete the capture session. | Examples:
If the machine reboots after application capture, then the program does not automatically restart after the reboot. The resume command must be provided for the program to restart. |
| /output | This parameter can be used to specify the location of output files. For example, this parameter can be used when starting a capture session Using this parameter is optional. If this parameter is not provided, then by default, the output files are located at C:\ProgramData\Omnissa\AppVolumes\Packages.Note: This parameter can be used only with the following commands: start,metadata, and convert. | Example: In this example, the Test folder contains Notepad++.vhd and Notepad++.json after the capture session. |
| /source | This parameter can be used to update an existing VHD application package using the .vhd file as the source.This argument is optional. Note: Using this parameter is optional; however, this parameter must not be used when capturing a new application. | Example: In this example, Notepad++_update is the name of the updated package. This name must be different from the name given to the application package captured at first, which is Notepad++.vhd. The command-line capture program uses Notepad++.vhd as the source file to capture the updated package.
|
| /summary | This optional parameter generates a summary of the scan result of a single VHD file or multiple VHD files in the same folder on the console. Scan summary contains the name of the file and scan status (success, failure, and not scanned). For files that are not scanned, the securityscan command must be run again.appcapture.exe securityscan /summary folder path | filepathfolder path - indicates the folder which contains multiple .vhd files Scan summary is displayed for all the files in this folder. file path - file for which the scan summary is generated and displayed | Example: In this example, ScanVHD is the folder that contains multiple VHD files. When this parameter is used, scan results of all the files in the ScanVHD folder are displayed.In this example, the scan result of Notepad++.vhd is displayed as follows: Security scan summary for file.
|
| /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. |
Using MSI format
The .msi format 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).
For compressed packages exceeding 2 GB, 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 2 GB. 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. This delivery type can be changed from on-demand to classic using a parameter at the time of delivering the package to the endpoints.
For more information about delivering App Volumes applications to Windows endpoints, see the Deliver App Volumes Applications Using Device Management Tools section in the App Volumes Install Guide, version 2412 and later, at Omnissa Product Documentation.
이 페이지가 도움이 되었나요?