Agent installer command-line reference (Windows)

The MSI installer for Windows-based Agents supports command-line parameters that let administrators control how the installer operates when run.

To install, upgrade, or uninstall the Agent or to preconfigure its migration options, use the following Msiexec.exe command:

msiexec displayOptions /i | /x path\ConnectedSetup[64].msi IDPSUFFIX=suffix [DEVICE_PROVISIONING_TYPE=type [MIGRATE_FROM_DEVICE=deviceID]] LAUNCHAGENT=1 ROOTFOLDER=path [INSTALLFOLDER=path] logOptions logFile

To see the complete set of options that the Msiexec.exe program supports, run the command msiexec /h. The following table describes the installer's most common command-line options.

Option Description
displayOptions

Sets the type of user interface to display during installation.

Specify one of the following standard Display options of the msiexec command:

  • /qn   None. Does not display a graphical interface or start the Agent automatically when the installation completes. Users must start the Agent manually.
  • /qb   Basic. Displays Microsoft Windows progress and error dialog boxes.
  • /qr    Reduced. Displays Agent installation progress and error dialog boxes.
  • /qf    Full. Displays all Agent installation progress, error, and completion dialog boxes.

Default: /qf

The /qn display option does not restart Windows Explorer during the installation process. As a result, upgrades sometimes cause existing badges in the Connected sync folder to temporarily disappear. For more information, see the FAQ Why are the Connected badges missing from items in the Connected folder after an Agent upgrade?

All other display options cause the installation process to automatically restart Windows Explorer to register the icons that the Agent uses like badges on files and folders to indicate sync status. When this occurs, it immediately stops any process on the computer that is currently using Windows Explorer, such as a file copy.

NOTE: On Windows 7 computers with UAC enabled and set to a level other than Never notify, you must use the /qb verbosity mode when you use the command-line installation program to install, recover, or upgrade an Agent.

/i Installs the Agent.
/x Uninstalls the Agent.
IDPSUFFIX=suffix

Identifies your company-specific identity provider (IdP) suffix for Connected.

The first time that the Agent starts after installation, the default web browser is launched and the login page is loaded for user's email address so that it can fetch the corporate IdP suffix associated with the user. It then uses the IdP suffix to create the appropriate Connected URL.

DEVICE_PROVISIONING_TYPE=type

(Agent 4.10 and later)

Specifies how the Agent provisions the device.

This value determines whether the Agent creates a new device or migrates the user's Connected data from another device when they sign in for the first time after installation.

Valid values for type:

  • new. Do not migrate the user's Connected data.

    The Agent bypasses the Device Setup Wizard and automatically provisions the computer as a secondary or additional device by assigning it a new device ID.

    If you set DEVICE_PROVISIONING_TYPE to New, the Agent ignores any specified MIGRATE_FROM_DEVICE parameter.

  • migrate. Migrate the user's Connected data.

    The Agent provisions the computer as a replacement device and migrates data to it from another Connected device (including from the same device when only reinstalling the Agent).

    The Agent determines which Connected device to migrate based on the value of the MIGRATE_FROM_DEVICE parameter.

MIGRATE_FROM_DEVICE=deviceID

(Agent 4.10 and later)

Specifies the Connected device from which to migrate data.

If the DEVICE_PROVISIONING_TYPE parameter is:

  • Set to new or not specified, the Agent installer ignores the MIGRATE_FROM_DEVICE parameter.

  • Set to migrate, migration proceeds as follows:

    • If deviceID specifies a valid device for the user, Connected automatically migrates all Connected data from that device. The Agent bypasses the Device Setup Wizard.

    • If MIGRATE_FROM_DEVICE is not specified or deviceID is missing or invalid for the user, the Agent bypasses the initial page of the Device Setup Wizard. Instead, it displays the page that lets the user select a device to migrate.

LAUNCHAGENT=value

Specify whether to launch agent automatically after the installation.

Valid input for value:

  • 1. Launch the agent automatically after the installation.

  • 0. Launch the agent manually after the installation.

ROOTFOLDER=path

Sets the location of the Connectedsync folder to path.

By default, the location of the folder is My Documents/Connected files.

Example: C:\Program Files\MyCorp\Connected Sync folder

IMPORTANT: Do not use this option to install Agents on a device shared by multiple Connected users or all users will have the same root Connectedsync folder.

INSTALLFOLDER=path

Stores the Agent's application files in path.

Default: C:\Program Files\Connected\

logOptions logFile

Writes logging information of the specified type and level to logfile.

Specify standard logging options of the msiexec command and the path of the log file that the installation process creates. You can specify either an absolute or relative path in the logfile value.

LOGINUSINGBROWSER=true/false

Setting the value to true enables the login using external default browser of the system rather than the inbuilt one.

Default: false

Examples

The following examples represent some common uses of the Msixec.exe program to install and uninstall an Agent assigned to the US-West (USW) data center.

Example 1

Install the Agent on a device running a 64-bit Windows operating system without displaying any prompts. Also, generate a log file of the process in C:\Connected_Install.log:

msiexec /qn /i ConnectedSetupUSW64.msi /l*v C:\Connected_Install.log

Example 2

Install the Agent on a device running a 64-bit Windows operating system without displaying any prompts during the installation process. Also, set the Connected sync folder to C:\Program Files\MyCorp\Connected Sync folder and generate a log file of the process in C:\Connected_Install.log:

msiexec /qn /i ConnectedSetupUSW64.msi ROOTFOLDER="C:\Program Files\MyCorp\Connected Sync folder" /l*v C:\Connected_Install.log

Example 3

Install the Agent in a custom location on a device running a 64-bit version of Windows without displaying any prompts during the installation process. Also, generate a log file of the process in C:\Connected_Install.log:

msiexec /qn /i ConnectedSetupUSW64.msi INSTALLFOLDER="C:\Program Files\Connected\" /l*v C:\Connected_Install.log

Example 4

Install the Agent on a device running a 64-bit version of Windows in a true end-to-end silent installation process, which does not require the user to provide an email address or credentials after starting the Agent (except if your site-specific SSO environment requires manual entry of credentials). Also, generate a log file of the process in C:\Connected_Install.log:

msiexec /qn /i ConnectedSetupUSW64.msi IDPSUFFIX="myCorp" INSTALLFOLDER="C:\Program Files\Connected\" /l*v C:\Connected_Install.log

Example 5

Install the Agent on a device running a 64-bit version of Windows, and configure it to migrate a user's Connected device to it the first time the Agent starts. Also, generate a log file of the installation process in C:\Connected_Install.log:

msiexec /qn /i ConnectedSetupUSW64.msi DEVICE_PROVISIONING_TYPE=migrate MIGRATE_FROM_DEVICE=123456789000000000 /l*v C:\Connected_Install.log

Example 6

Uninstall the Agent from a device running a 32-bit version of Windows without displaying any prompts. Also, generate a log file of the process in C:\Connected_Uninstall.log:

msiexec /qn /x ConnectedSetupUSW.msi /l*v C:\Connected_Uninstall.log