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
Default: The /qn display option does not restart Windows Explorer during the installation process. All other display options cause the installation process to automatically restart Windows Explorer NOTE: On Windows 7 computers with UAC enabled and set to a level other than Never notify, you must use the |
/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. By providing the
IDPSUFFIX command-line option, the Agent creates the appropriate URL without prompting for the user's email address. In addition, if your corporate environment uses Active Directory Federation Services (AD FS) and Integrated Windows Authentication (IWA), the Agent also bypasses the login page because it does not need to prompt users for credentials. See how to find your corporate IdP suffix.
To find your corporate IdP suffix:
|
(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
|
(Agent 4.10 and later) |
Specifies the Connected device from which to migrate data. If the
|
LAUNCHAGENT=value |
Specify whether to launch agent automatically after the installation. Valid input for
|
ROOTFOLDER=path
|
Sets the location of the Connected By default, the location of the folder is Example: 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 Connected |
INSTALLFOLDER=path
|
Stores the Agent's application files in Default: |
logOptions logFile
|
Writes logging information of the specified type and level to Specify standard logging options of the |
LOGINUSINGBROWSER=true/false
|
Setting the value to Default: |
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 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