Skip to main content
druva_logo.pngDruva
|
Documentation

How can we help you?

 

Trending articles:
Druva Documentation

IMD Command Parameter details

  1. Last updated
  2. Save as PDF
inSync Cloud Editions: File:/tick.png Elite Plus File:/tick.png Elite File:/cross.png Enterprise File:/cross.png Business

Overview

The following table describes the parameters used during IMD followed by examples.

Parameter type Name Use Value

Mass deployment token

TOKENV2 (for Windows)
--token (for Mac)

Mandatory

The mass deployment token generated for IMD.

inSync server IP address and port number

SERVERLIST (for Windows)
--master (for Mac)

Mandatory

The IP address and the backup/sync port of the inSync Server.
For example:
cloud.druva.com:443
govcloud.druva.com:443

Use of system proxy settings

 

SYSTEM_PROXY (for Windows)

--system-proxy (for Mac)

 

Optional

1, if system proxy settings must be used.

Static proxy server details

PROXY_SERVER (for Windows)
PROXY_TYPE (for Windows)

--proxy-server (for Mac)

--proxy-type(for Mac)

Optional

PROXY_SERVER contains the IP address and port number of the static proxy server. Example: 192.168.54.100:1080
PROXY_TYPE can either be http, socks4, or socks5.

WPAD URL details

WPAD_URL (for Windows)
PROXY_TYPE (for Windows)

--wpad-url (for Mac)

--proxy-type (for Mac)

 Optional

Based on the value provided for the WPAD_URL parameter, inSync fetches the proxy PAC file.

Based on your requirement, specify one of the following values for WPAD_URL parameter:

- If you want inSync Client to use a specific, company internal URL to fetch the PAC file, specify WPAD_URL= http://<internalserver-company>.com/wpad.dat, 
This URL is accessible only internally in the company's LAN.

- If you want inSync Client to automatically detect URL of the WPAD location using the DNS, specify WPAD_URL="WPAD_DNS"
inSync uses the http://wpad/wpad.dat URL to fetch the PAC file.

- If you want inSync Client to automatically detect the URL of the WPAD location using DHCP (252 option), specify WPAD_URL="WPAD_DHCP"
With this value, inSync first detects the URL of WPAD location using the DHCP (252 option). If the URL is not detected, it then attempts to detect the URL using the DNS method. 

PROXY_TYPE parameter is mandatory when using WPAD_URL parameter and must be set to either http, socks4, or socks5.

Forces inSync Client to use system's certificates

FORCE_SYSTEM_CERTS (for Windows)

--force-system-certs (for Mac)

Optional

FORCE_SYSTEM_CERTS is a parameter that will direct inSync Client to use the system's certificates for validation of inSync server's validation.

Default value of the parameter is NO.

Set this parameter to YES if you have MITM proxy configured in your environment. 

inSync Share folder location

USERSHAREHOME (for Windows)

--syncshare-path (for Mac)

Optional

The path to the folder where the inSync Share folder will be created. For Windows OS, if the path contains a space, you must use three double quotes around the path.
Example: """E:\parent folder"""
 

Note:

  • You cannot use system variables in the path.
  • The destination folder must exist in the user devices.
  • The destination folder must not contain a folder named inSync Share.
  • The user must have write access to the destination folder.

    If these conditions are not met, the inSync Share folder is created in the default location.

Replace the existing device of the user

REPLACE_DEVICE (for Windows)

--replace-device (for Mac)

Optional

If this parameter is set to Yes, the device will replace the existing device of the user. 

Restore System, App settings

RESTORE_SYSTEM_
SETTINGS (for Windows)

--restore-system-settings (for Mac)

Optional

 

If this parameter is set to Yes, the system settings from the existing device will be restored on the new device.

If this parameter is set to No, the system settings from the existing device will not be restored on the new device.

Note:

  • You cannot restore system settings to a different OS platform. For example, you cannot restore from a Mac device to a Windows device. However, you can restore system settings from one version of an OS to a higher version of an OS. For example, you can restore system settings from a Windows 7 device to a Windows 8 device.
  • This parameter is applicable only to IMD version 2 and works if the user has only one device or laptop.

Restore data from an existing device of the user

 

RESTORE_DATA (for Windows)

--restore-data (for Mac)

Optional

If this parameter is set to Yes, the data backed up from the existing device will be restored on the new device. This works only if the user has one device and the new device has the same OS as the existing one.
If this parameter is set to No, the data backed up from the existing device will not be restored on the new device.

 

inSync CloudCache Server ID

 

CACHESERVERID (for Windows)

--cacheserver (for Mac)

Optional

 

The inSync CloudCache Server ID to which you want to map users.
To obtain the inSync CloudCache Server ID:

  1. On the inSync Management Console menu bar, click Manage > CloudCache Servers.
  2. Click the link of the CloudCache Server for which you want to obtain the ID. The CloudCache Server Information area displays the CloudCache Server ID.

Note: If a CloudCache mapping is configured to automatically assign new users to a CloudCache Server, it is given higher preference than this parameter.

inSync CloudCache Backup Settings

 

CACHEFULLBLOCK (for Windows)

--cache-full-block (for Mac)

Optional

If you want to back up data to inSync Cloud when inSync CloudCache Server runs out of disk space, set this parameter to no.

If you do not want to back up data to inSync Cloud when the inSync CloudCache Server runs out of disk space, set this parameter to yes. If you set this parameter to yes and inSync CloudCache Server runs out of disk space, backup operations fail.

Hide the inSync Client shortcut from appearing on the Desktop and in the notification area

HEADLESS (for Windows)

Optional

If you want to hide the inSync Client shortcut from appearing on the Desktop and in the notification area, set this parameter to 1.

Install the inSync Client in a specific language

LANGUAGE (for Windows)

Optional

You can install the inSync Client in one of the following languages:
French (fr), German (de), English (en), Japanese (ja), and Spanish (ES).

Check inSync Client activation on user device

ACTIVATION_CHECK (for Windows)

Optional

If this parameter is set to YES, a check is performed for successful activation of the inSync Client on the user device.
If the inSync Client activation

  • Is successful - The installation is successful. You get an installation success message for that particular user.
  • Fails - The installation fails. You get an installation failed message for that particular user. You must run the inSync Client installation process again for such users. By default, the parameter is set to NO.
Note:
  • This parameter is applicable only for the devices running on the Windows operating system.
  • If multiple users are logged on their devices, and if inSync Client activation on any of the user device is successful, the installation process is successful.

 Timeout interval for inSync Client activation

ACTIVATION_TIMEOUT (for Windows)

Optional

This parameter specifies the timeout period, value in seconds, before which the inSync Client must be activated after its installation on a device.
If the inSync Client is not activated before the time specified, the installation fails.
Default timeout value is 300 seconds.

Note: This parameter is applicable only for the devices running on the Windows operating system.

Remove inSync Client configuration on user devices

CLEAR_CLIENT_CONFIGURATION (for Windows)

Optional

This parameter specifies whether the inSync Client configuration should be removed from the user devices during the inSync Client uninstallation process.
Set the parameter value to YES to remove the inSync Client configuration, while uninstalling the inSync Client.
By default, the parameter is set to NO.
Restrict users from uninstalling inSync Client from their devices

HIDE_ARP
HIDE_UNINSTALL (for Windows)

Optional

You can restrict the users from uninstalling or removing the inSync Client from their Windows devices while installing it on the user devices. This feature utilizes the Windows OS property ARPNOREMOVE. 

If you want to restrict the users from uninstalling and removing the inSync Client from there devices, set both of these parameters to 1.

Note: For more information on the RESTORE_DEVICE, RESTORE_SYSTEM_SETTINGS, and RESTORE_DATA options, see Persona backup and OS migration.

Examples

Install inSync on Windows devices

inSync Cloud Editions: File:/tick.png Elite Plus File:/tick.png Elite File:/cross.png Enterprise File:/cross.png Business

You can save the sample script as a .bat file. You can deploy these scripts by using a third-party tool.

You do not need to use all parameters simultaneously. Use only the parameters that you need.

Scenario 1: You can access inSync Client executable on a shared network

The inSync Client executable is located on a shared network. You can run the following command by using an automated installation tool:

msiexec /qn /i "<path to inSync msi>" TOKENV2='<mass deployment token>' SERVERLIST="<IP address of inSync Server>:<Backup/sync port>"

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443"

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

You can define a secondary port in the command. If the inSync Client is unable to use the primary port, the inSync Client uses the secondary port to connect to the inSync Master.

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443,cloud.druva.com:6061,cloud.druva.com:80"

Note: You must follow the exact usage of single (') and double quotation marks (") as provided in the example.

Scenario 2: You can access the inSync Master through a fixed proxy server

The inSync Client executable is located on a shared network. You can run the following command by using an automated installation tool:

msiexec /qn /i "<path to inSync msi>" TOKENV2='<mass deployment token>' CACHESERVERID=<ID> CACHEFULLBLOCK=<yes or no> SERVERLIST="<IP address of inSync Server>:<Backup/sync port>" PROXY_TYPE="<type of proxy used>" PROXY_SERVER="<IP address of proxy server>:<port number>" SYSTEM_PROXY="1" USERSHAREHOME="<new_location>"

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' CACHESERVERID=16 CACHEFULLBLOCK=no SERVERLIST="cloud.druva.com:443" PROXY_SERVER="192.168.54.100:1080" PROXY_TYPE="socks5" USERSHAREHOME="E:\"

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

You can define a secondary port in the command. If the inSync Client is unable to use the primary port, the inSync Client uses the secondary port to connect to the inSync Master.

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' CACHESERVERID=16 CACHEFULLBLOCK=no SERVERLIST="cloud.druva.com:443,cloud.druva.com:6061,cloud.druva.com:80" PROXY_SERVER="192.168.54.100:1080" PROXY_TYPE="socks5" USERSHAREHOME="E:\"

Note: You must follow the exact usage of single (') and double quotation marks (") as provided in the example.

Scenario 3: You want to hide the inSync Client shortcut from appearing on the Desktop and in the notification area

You can use the HEADLESS parameter. You can run the following command by using an automated installation tool:

Note: If you have disabled Show inSync icon in the notification area for the selected profile, ensure that you use HEADLESS parameter in the script. If you do not use this parameter, inSync Client icon continues to appear in the notification area for the user devices until the inSync Client installation completes. For more information, see Enable inSync notifications.

 

 

The most recent data from the old device is not restored onto the non-AD bound device if you are using the HEADLESS parameter while adding a new device for a remote non-AD user. Refer Restore Delta Data to learn more.

msiexec /qn /i "<path to inSync msi>" TOKENV2='<mass deployment token>' SERVERLIST="<IP address of inSync Server>:<Backup/sync port>" HEADLESS="1"

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443" HEADLESS="1"

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

You can define a secondary port in the command. If the inSync Client is unable to use the primary port, the inSync Client uses the secondary port to connect to the inSync Master.

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443,cloud.druva.com:6061,cloud.druva.com:80" HEADLESS="1"

Note: You must follow the exact usage of single (') and double quotation marks (") as provided in the example.

Scenario 4: You want to install the inSync Client in a specific language

You can install the inSync Client in one of the following languages:

French (fr), German (de), English (en), Japanese (ja).

Note: inSync Client 5.5 or later supports the Japanese language. If you want to install the inSync Client in the Japanese language, you must upgrade to inSync Client 5.5. For more information on how you can upgrade the inSync Client, see Upgrade inSync on a user laptop.

You can run the following command by using an automated installation tool:

msiexec /qn /i "<path to inSync msi>" TOKENV2='<mass deployment token>' SERVERLIST="<IP address of inSync Server>:<Backup/sync port>" LANGUAGE="<fr, en, de, ja>"

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443" LANGUAGE="en"

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

You can define a secondary port in the command. If the inSync Client is unable to use the primary port, the inSync Client uses the secondary port to connect to the inSync Master.

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443,cloud.druva.com:6061,cloud.druva.com:80" LANGUAGE="en"

Note: You must follow the exact usage of single (') and double quotation marks (") as provided in the example.

Scenario 5: You want to install the inSync Client in the user locale of the user device

The inSync Client installer supports the following languages:

  • English (en)
  • French (fr)
  • German (de)
  • Japanese (ja)
  • Spanish (es)

If you do not specify a language parameter (scenario 4), the user locale of the user device determines the language in which the inSync Client is installed. However, if the user locale is in a language other than the languages that the inSync Client supports, the inSync Client is installed in English. 

You can run the following command by using an automated installation tool:

msiexec /qn /i "<path to inSync msi>" TOKENV2='<mass deployment token>' SERVERLIST="<IP address of inSync Server>:<Backup/sync port>"

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443"

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

You can define a secondary port in the command. If the inSync Client is unable to use the primary port, the inSync Client uses the secondary port to connect to the inSync Master.

For example

msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443,cloud.druva.com:6061,cloud.druva.com:80"

Note: You must follow the exact usage of single (') and double quotation marks (") as provided in the example.

Scenario 6: You want to restrict the users from uninstalling the inSync Client from their devices

This feature is available with inSync Client 6.2.0 and above.

You can run the following command using an automated installation tool in addition to the desired parameters mentioned earlier, to restrict the users from uninstalling the inSync Client from their devices.

Using this command will not list inSync Client in Control Panel > Programs > Programs and Features.

msiexec /qn /i "<path to inSync msi>" TOKENV2='<mass deployment token>' SERVERLIST="<IP address of inSync Server>:<Backup/sync port> HIDE_ARP="1" HIDE_UNINSTALL="1"

 For example

 msiexec /qn /i "\\sharelocation\inSync.msi" TOKENV2='11-123this0is0a0sample0token0123' SERVERLIST="cloud.druva.com:443" HIDE_ARP="1" HIDE_UNINSTALL="1"

 Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

 

Install inSync on Mac devices

inSync Cloud Editions: File:/tick.png Elite Plus File:/tick.png Elite File:/cross.png Enterprise File:/cross.png Business

IMD parameters need to be passed in the mass deployment command. The parameters are saved to Keychain so that the mass deployment token is saved securely. For more information on parameters, see Parameter details.

inSync Client 6.2.0 and earlier

Procedure

To mass deploy inSync Client on Mac devices:

  1. Install inSync Client on Mac devices in your environment using any automated installation tool.
  2. After installing the inSync Client on user devices, use the following command to pass the IMD configuration parameters to the inSync Client. These parameters are securely saved in the system Keychain of the Mac devices. You need root privileges to execute this command.

Basic command format:  <AppExecutable> [<--parameter1> <value1>] [<--parameter2> <value2>] ...

/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --token "<IMDToken>" 
--master "<server-fqdn>:<port>" --proxy-server "<IP address of proxy server>:<port number>"

Example:

/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --token "11-123this0is0a0sample0token0123"
 --master "cloud.druva.com:443" --proxy-server "192.168.54.100:1080"

The command passes the IMD parameters to the client system and saves them in Keychain of the Mac device.

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

In case the IMD command fails, refer to the troubleshooting section. 

inSync Client 6.5.0 and later

Procedure

To mass deploy inSync Client on Mac devices:

  1. Install inSync Client on Mac devices in your environment using any automated installation tool.
  2. After installing the inSync Client on user devices, use the following command to pass the IMD configuration parameters to the inSync Client. These parameters are securely saved in the system Keychain of the Mac devices. You need root privileges to execute this command.

Basic command format:  <AppExecutable> [<--parameter1> <value1>] [<--parameter2> <value2>] ...

/Applications/Druva\ inSync.app/Contents/MacOS/inSync --token "<IMDToken>" 
--master "<server-fqdn>:<port>" --proxy-server "<IP address of proxy server>:<port number>"

Example:

/Applications/Druva\ inSync.app/Contents/MacOS/inSync --token "11-123this0is0a0sample0token0123"
 --master "cloud.druva.com:443" --proxy-server "192.168.54.100:1080"

The command passes the IMD parameters to the client system and saves them in Keychain of the Mac device.

Note: The token value used in the example is for presentation purpose only. A token is unique and you must generate your own before the installation.

In case the IMD command fails, refer to the troubleshooting section.