Note

You are not reading the most recent version of this documentation. See the latest version available.

Setup Capture CLI (on remote VM)

Command line options of Setup Capture Remote allows to automate capturing of a batch of source installers on remote virtual machines.

Note

In order to use a remote virtual machine for capturing, first configure it. See Configuration of capturing environment.


Syntax:

"SetupCaptureRemote.exe" <command> [--parameter "value"]

Usage:

"SetupCaptureRemote.exe" capture-remotely --vm "172.16.1.100;WIN10_1809_EN" --project-location "C:\PKG" --project-name "My Project 1" --source-installation "C:\Setup\setup.exe" --args-for-unattended-install "/silent /no-restart"

The default installation path of SetupCaptureRemote.exe is:

  • x64 OS: C:\Program Files (x86)\PACE Suite\Setup Capture\App\

  • x86 OS: C:\Program Files\PACE Suite\Setup Capture\App


Commands:

Command

Description

capture-remotely

Run capturing in the Snapshotting mode on the remote virtual machine in an unattended mode.

See parameters to Capture on a remote virtual machine.

Capture on a remote virtual machine

Parameters of the capture-remotely command:

Parameter

Obligatoriness

Description

--vm

Mandatory

Defines a virtual machine on which capturing will be performed.

Supported value:

"<host_addres>;<vm_name>" - run capturing on the remote virtual machine where <host_addres> is a host or IP address of the virtualization solution (for VirtualBox <host_addres> is virtualbox); and <vm_name> is a name of a virtual machine, configured for capturing.

Example: --vm "172.16.1.100;WIN10_1809_EN"; --vm "virtualbox;WIN10_1809_EN"

--scan-registry

Optional

Defines what registry hives of the virtual machine will be scanned. If not defined, all registry will be scanned.

Supported values:

"*" - scan all registry hives
"" - do not scan registry
"HKLM; HKCU; HKU\.DEFAULT" - scan the specified hives only

Example: --scan-registry "HKLM; HKCU"

--scan-local-drives

Optional

Defines what local drives of the virtual machine will be scanned. If not defined, all local drives will be scanned.

Supported values:

"*" - scan all drives
"" - do not scan drives
"system" - scan the system local drive only (usually C:)
"non-system" – scan all local drives except the system one (usually D:, E:, etc.)

Example: --scan-local-drives "system"

--scan-permissions

Optional

Defines if the file system and registry permissions changes of the virtual machine will be scanned. If not defined, permissions will be scanned.

Supported values:

"*" - scan for permission changes
"" - do not scan for permission changes

Example: --scan-permissions "*"

--scan-services

Optional

Defines if the Windows Services of the virtual machine will be scanned for changes. If not defined, Windows Services will be scanned.

Supported values:

"*" - scan Windows Services
"" - do not scan Windows Services

Example: --scan-services "*"

--scan-devices

Optional

Defines if the system devices (printers) of the virtual machine will be scanned for changes. If not defined, system devices will be scanned.

Supported values:

"*" - scan system devices (printers)
"" - do not scan system devices (printers)

Example: --scan-devices ""

--apply-filters

Optional

Defines what exclusion filters will be applied to the captured resources. If not defined, all filters will be applied (default behavior in UI mode).

Supported values:

"*" - apply all filters (the same as not defined)
"" - do not apply filters
"filter A; Filter B" - apply only specified filters

Example: --apply-filters "standard; extended; custom filter"

--project-location

Mandatory

Defines a path to projects folder (common folder for all projects). The MGP project will be transferred from the remote virtual machine to your work station (PC) and saved to the specifed projects folder in the additional subfolder.

Example: --project-location "C:\PKG"

--project-name

Mandatory

Defines a name of the project (project folder and MGP file).

Example: --project-name "My Project 1"

--source-installation

Mandatory

Defines a path to the installer that you need to capture. This file will be transferred to the remote virtual machine.

Example: --source-installation "C:\Setup\setup.exe"

--args-for-unattended-install

Optional

Defines a command line switches that allows to run the specified installer in the silent mode.

Example: --args-for-unattended-install "/silent /no-restart"

--copy-related-files

Optional

Defines the installer-related files that should be copied to the remote virtual machine along with specified above installer. If not specified, no additional files will be copied.

Supported values:

"*" - copy all files/subfolders located in the folder with the specified installer.
"<file-path-1;file-path-2;folder-path>" - copy the specified files and folders only. The path could be absolute or relative.

Example: --copy-related-files "Folder A;File B.ext;File C.ext"

--vm-restore

Optional

Defines if the virtual machine will be restored to the previous state after the capturing completion. If not specified, the virtual machine will be restored.

Supported values:

"yes" - restore
"no" - do not restore

Example: --vm-restore "no"


Note

PACE Suite covers the whole range of application packaging tasks - learn more.

Try PACE Suite for free - 21 days no obligations unlimited trial with all functions unlocked.