Skip to main content

 

Druva Documentation

Bulk replace devices using Integrated Mass Deployment version 4

This feature only works with inSync Client 6.0 for Cloud. inSync Client 6.0 for Cloud is currently available in the Early Access Program. If your organization wants to participate in the Early Access Program, contact Druva Support.

Device replace is a regular activity undertaken by organizations to replace old user devices with new or upgraded devices. Based on your organization's IT policy, administrators might be required to replace devices either as a one-time bulk activity or in a phased manner.  Users may also request device replace in events such as theft, damage, or hard disk crash.

A device-replace activity includes assigning a new device to a user and restoring data and system settings from the user’s old device. Using the inSync Management Console, an administrator can replace an existing device or add a new device to a user account. In addition, an administrator can also install the inSync Client on the new user device and activate it so that the existing user data and system settings are restored to the new device, and the device is available for the subsequent backups.

inSync provides administrators an easy way to manage the bulk device replace activity using the Integrated Mass Deployment version 4 (IMD v4) process. The IMD v4 process enables an administrator to replace devices for inSync users managed using both AD/LDAP and non-AD/LDAP.

Device replace using IMD v4 offers the following benefits, which are not available in IMD v2:

  • Supports device replace operation in case a user has multiple devices.
  • Supports device replace operation even if the user's hostname on the new device is different from hostname on the old device.
  • Provides device-user mapping, which allows easy identification of the device to replace in case a user has multiple devices.
  • Allows an administrator or user to define whether the new device should be replaced with the old device or added as an additional device.
  • Reduces administrator efforts to manually log on to the user device and initiate device replace.
  • Single IMD command to replace devices and deploy the inSync Client on the new or upgraded devices.

Device replace workflow using IMD v4

Device replace using the inSync IMD v4 process consists of the following steps:

  1. Create a device-map .csv file. A device-map .csv file contains the user and device mapping details, which ensures:
    • Controlled device and user activation of the inSync Client
    • Prevents the addition of rogue or unauthorized devices
    • Specifies the device to replace in case of multiple devices held by the user with the preference to restore data.
  2. Import the device-map .csv file into inSync Management Console.
  3. (Optional) Update mass deployment settings.
  4. Generate a mass deployment token.
  5. Run the IMD v4 command to replace devices.
  6. (Optional) Log on to a user device and manually activate the inSync Client.

Device Map .csv file and IMD v4 process

The IMD v4 process is driven by a device-map .csv file. A device-map .csv file contains the user and device details:

  • Each entry in the device-map .csv file is called a mapping.
  • Each mapping in the device-map .csv file is processed, and the user and device details are obtained from the inSync server.
  • A mapping is displayed on the Device Mappings page and deleted automatically after the device replace activity, and the inSync Client is activated.
  • Attributes such as email-id, device-id, and username identify the user device in inSync.
  • If inSync does not find a mapping:
    • In the case of an AD user, inSync searches for a mapping using the email address and device id.
    • In case of a non-AD user, inSync searches for a mapping using the username and device id.
  • If the device-map .csv file contains old device details that are specified in the old-device-name attribute, inSync replaces the old device with the new device and restores the data if the data-restore attribute is set.
  • If a mapping is found that does not have the value defined in the old-device-name attribute, inSync adds the device as a new device.
  • If inSync does not find a mapping when the user is present in inSync and the optional setting - Prompt user if device mapping not defined is enabled, inSync allows the administrator/user to add or replace a device.

Note:

  • The username attribute is mandatory for non-AD users. If the username is blank, IMD v4 processes requests only for AD users. If the user is not found using the username attribute, the IMD v4 process fails for the user.
  • inSync does not restore data if the OS on the new device is different than the one on the old device.
  • The IMD v4 process to replace a device works even if a user is put on Legal Hold.

Causes of IMD v4 failures

Device replace using IMD v4 fails in the following cases:

  • When a device linked to a user is marked as Disabled in inSync.
  • When a user, defined in the device-map .csv file, is not found using either the email-id or the username attribute.
  • When a mapping defined in the device-map .csv file is not found and the mass deployment setting Prompt user if device mapping not defined is not set.
  • When a user cancels the activation of the inSync Client on the device.

Step 1: Create Device Map .csv file

Before initiating a mass device replace activity, you must ensure that the user and device details are imported into a device-map file.

To know what a Device Map .csv file contains and create one, click here.

The device-map file must be in .csv format. Based on the details in the device-map file, inSync obtains user information and maps the devices to the user. The user-to-device mapping ensures controlled device and user activation of inSync Client and prevents the addition of rogue or unauthorized devices to inSync.

About Device-Map .csv file
You can download a sample device-map file from inSync Management Console and add data to it. To download the sample device-map:

  1. On the inSync Management Console menu bar, click Manage > Deployments > Device Mappings. Device Mappings page is displayed. 
  2. Click Import Device Map CSV
  3. Map Devices dialog box is displayed.
  4. Click the Download Sample CSV File link. A sample .csv file is saved to your local drive. You can update this sample with the data specified in the table below and use it as your device-map file.

The following table lists the attributes in the device-map .csv file that inSync requires to replace a device using the IMD v4 process.

Sr. No. Attribute Description Use
1

Email address

(email-id)

Email address of the inSync user whose device requires replacement. inSync validates this id with the list of user email-ids registered with inSync. Multiple devices and usernames can map to the same email-id. The .csv file may have multiple entries for the same email-id to show multiple mapped devices. Mandatory
2

Hostname of the device

(hostname)

Hostname of the new device. Mandatory
3

Device identifier

(device-id)

Device ID value of the new device. 

The commands specified below for Mac and Windows devices will display the device identifiers such as the Serial Number, UUID, or hostname of the respective device. You can use any one as a device identifier in the device-map .csv file. The device identifier must be unique and must map to a single email-id.

Mac OS

Serial Number

To display the Serial Number on a Mac device, run the following command on the terminal:

system_profiler SPHardwareDataType |grep -v tray |awk '/Serial/ {print $4}'

Another option to find the Serial Number:

  • Click the Apple (Apple_Logo.png ) icon at the top left on the menu bar and select About This Mac.

You can note the Serial Number from the About This Mac dialog box.

UUID

To display the hardware UUID of a Mac device, run the following command on the terminal:

system_profiler SPHardwareDataType | awk '/UUID/ { print $3; }'

Another option to find hardware UUID:

  1. Click the Apple (Apple_Logo.png) icon at the top left on the menu bar and select About This Mac.
  2. Click System ReportYou can note both the Serial Number (system) and Hardware UUID from the Hardware Overview page.

Hostname

To display the hostname of a Mac device, go to Setting > Sharing > Computer name.

Windows OS

Serial Number

To display the serial number of a Windows device run the following command on the command prompt:

wmic bios get serialnumber

UUID

To display the UUID of a Windows device, run the following command on the command prompt:

wmic csproduct get UUID

Hostname

To display the hostname of a Windows device, run the following command on the command prompt:

hostname

Mandatory
4

Device identifier type

(device-id-type)

The type of device identifier, such as serialnumber, uuid, or hostname specified in the device identifier column. Mandatory
5

Logged on user name

(user-name)

User name used to log on to the device.

Mandatory in case of a non-AD user.

6

inSync device name to be replaced

(old-device-name)

Name of the user's old device in inSync that is to be replaced with a new device.

Optional

Note: If  the old-device-name field is blank and user-name attribute contains a non-AD user name, IMD v3 process for deploying inSync Client on a non-AD user device is initiated.

7

Data to be restored to the new device

(data-restore)

Type of data to be restored on the new device.
Specify one of the following value in the data-restore column:

  • All - To restore both, the data and the system settings from the existing device on the new device.
  • System - To restore only the system settings from the existing device on the new device.
  • Data - To restore only the data from the existing device on the new device.
Optional

Step 2: Import Device Map .csv file into inSync

After creating the device-map .csv file, containing the user and device details, you must import it into the inSync Management Console.

To know how to import the device-map .csv file into inSync Management Console, click here.

After importing the device-map .csv file, inSync verifies the email-ids imported through the device-map .csv. If a matching email-id is not found, inSync does not import the relevant user and device details into inSync and saves a list of such users to a file. You can download the file at the end of the import. The file contains the list of user and device details and the reason for which the import failed. You need to rectify the issue for the user and again import the device-map .csv file. inSync incrementally updates the details when you import the file again.

Procedure

Make sure you have the device-map .csv file ready before you perform this procedure.
To import the device-map .csv file in inSync Management Console:

  1. On the inSync Management Console menu bar, click Manage > Deployments > Device Mappings. Device Mappings page is displayed.
  2. Click Import Device Map CSV
    Map Devices dialog box is displayed.

  3. Under Select CSV tab, click  and select the device-map .csv file that you want to import. The Upload Mappings tab displays the total number of succeeded and failed device maps. A Download failed device maps link is displayed if there are any failed device maps. Click this link to download a .csv of failed device maps and rectify the issues mentioned in its error column.
  4. Click Done. The mapped devices are displayed on the Device Mappings page. You can see the Device Name, Device ID, Device ID Type, User Email and Status.
    Download failed device maps link downloads a .csv of devices that inSync could not map to the registered users. The .csv contains errors relevant to each device and displays them against the respective device IDs. You can rectify those errors and again import the original device-map .csv. inSync increments the devices and displays them on the Device Mappings page.

Download failed device maps link downloads a .csv of devices that inSync could not map to the registered users. The .csv contains errors relevant to each device and displays them against the respective device IDs. You can rectify those errors and again import the original device-map .csv. inSync increments the devices and displays them on the Device Mappings page.

Step 3: Update Mass Deployment Settings

inSync provides a setting - Prompt user if device mapping not defined, which when set allows both the administrator as well as the user to define the device behavior if there is no user-device mapping defined within inSync, and choose to add the new device as an additional device or replace the old device with a new device.

To update this setting, click here.

Note: This setting is applicable only to inSync Client activations done using the AD/LDAP authentication.

 

To update the mass deployment settings:

1. On the inSync Management Console menu bar, click wheel.png > Settings. Settings page is displayed.

2. Click on the Mass Deployment tab.

3. In the Mass Deployment area, click Edit. Edit Settings window appears.

4. Select Prompt user if device mapping not defined checkbox.

5. Click Ok.

Mass deployment settings are updated. If an administrator does not define a device-user mapping while initiating the IMD v4 workflow, inSync will not activate the device. However, inSync will now provide an option to the administrator or the device user to manually activate the device. For more information, Step 6: (Optional) Manually activate the inSync Client on the new device.

Step 4: Generate a mass deployment token

IMD v4 command consists of a parameter - TOKENV4 (token), used as a security mechanism to ensure that the  inSync server processes activation requests only from authentic inSync Clients.

To generate a mass deployment token, click here.

 Only the inSync Cloud administrator can generate a mass deployment token and use it to run the IMD command.

Procedure

To generate the mass deployment token

  1. On the inSync Management Console menu bar, click 2.png > Settings.
  2. Click the Mass Deployment tab, and then click Get New Mass deployment Token. The Mass Deployment Token window appears.
    Create New Token.png
  3. To set an expiry date for the token, select the Enable Expiry Date check box, and then type the expiry date in the Expire on box. 
  4. Click Create New Token.
  5. Copy the token to a text file or keep it handy. You need this token when you are mass installing inSync client on user devices.
  6. Click Done.

Step 5: Run IMD v4 command

You can save the IMD v4 command as a batch file and then run it using a third-party tool to mass replace and deploy inSync Client on new user devices.

To view the complete list of parameters and see the command format, click here.
You do not need to use all parameters simultaneously. Use only the parameters that you need.

Parameters details

The following table describes the parameters used in the IMD v4 command.

Parameter Type Name Use Value
Mass deployment token TOKENV4 (for Windows)
--tokenv4 (for Mac)
Mandatory The mass deployment token generated for IMD v4.
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

WPAD_URL contains the URL of the WPAD location.

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

- 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, specify
WPAD_URL="AUTO"
inSync uses the
http://wpad/wpad.dat URL to fetch the PAC file.

PROXY_TYPE can either be 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.

inSync CloudCache Server ID

 

CACHESERVERID (forw Windows)

--cacheserver (for Mac)

Optional

 

The inSync CloudCache Server ID to which you want to map users.
To obtain the 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 the inSync Cloud when the inSync CloudCache Server runs out of disk space, set this parameter to no.

If you do not want to back up data to the 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 the 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).

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.

Scenario 1: Activate a device when you can access inSync Client executable on a shared drive

Activate a Windows Device

Command

msiexec /qn /i <path to inSync.msi> TOKENV4="<IMD-token>" SERVERLIST="<inSync Cloud Server URL>:<Port number>"

Sample command

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

Activate a Mac device

Command

/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --tokenv4 "<IMD-token>" --master "<inSync Cloud Server URL>:<Port number>"

Sample command

/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --tokenv4 "11-123this0is0a0sample0token0123" --master "cloud.druva.com:443"

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:

Command

msiexec /qn /i "<path to inSync msi>" TOKENV4='<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>"

Sample Command

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

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.

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.

Command 

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

Sample Command

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

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

Sample command

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

Scenario 4: You want to replace a device and install the inSync Client in a specific language on the new device

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

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

Replace a Windows Device

Command

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

Sample Command

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

Replace a Mac Device

Command

/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --tokenv4 "<IMDToken>" 
--master "<server-fqdn>:<port>" --proxy-server "<IP address of proxy server>:<port number>" --language="<fr, en, de, ja>"

Sample Command

/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --tokenv4 "11-123this0is0a0sample0token0123" --master "cloud.druva.com:443" --language="en"

Step 6: (Optional) Manually activate the inSync Client on the new device

An administrator or inSync Client user may to have to manually activate the inSync Client on the new device based on the setting defined in Step 3: Update Mass Deployment Settings. This is an optional step.

To know more, click here.

Manual activation of the inSync Client step is required only if the following criteria are satisfied:

  • If inSync does not find a user-device mapping, but the user exists within inSync.
  • Prompt user if device mapping not defined setting is enabled in the inSync Management Console. For more information, see Step 3: Update Mass Deployment Settings.

Manual activation of the inSync Client involves the following steps:

  1. Provide inSync administrator or inSync user credentials, depending on the individual logging in, on the activation screen.
  2. If there are multiple devices held by the user in inSync, the following options are displayed for the new device:
    • Replace the new device with one of the other associated devices.
    • Add the new device as an additional device.

Procedure

  1. Log on to the user device.
    • IT or System administrator with administrator credentials.
    • End user with their credentials.
  2. Launch inSync Client on the user device. The following screen is displayed.
    IMDv4_1.png
  3. Choose one of the following actions:
    • Click Cancel to manually activate inSync Client at a later stage. Clicking Cancel at this stage, by an administrator or an end user, fails the IMDv4 process.
    • Click Configure to continue with the activation process.
  4. If you click Configure, perform the following steps to activate the inSync Client:
    1. On the inSync Client login page, select inSync Cloud as the edition.
    2. Type the email address of your inSync account.
    3. Click Next. A window appears:
      • If you are using single sign-on credentials for your inSync account, type your single sign-on password in that window.
        OR 
      • Type the password for your inSync account.
    4. On successful verification, a Configure <hostname> for Backup page appears.
      IMDv4_2.png
    5. Select one of the following actions:
      • Add as new device - Select this option to add or associate this device as a new device to the user account.
      • Replace an existing device  - Select this option to replace another device that has the inSync Client installed on it with this new device.
    6. Click Configure. Depending upon your selection the following happens:
      • If you have selected Add as new device, the new device is added to the user account.
      • If you have selected Replace an existing device,  you will see a Select device to replace box that displays the list of devices which have inSync Client on it.
        • In the Select device to replace box, click the device you want to replace.
        • If you want to restore all backed up data, select the All backup data check box.
        • If you want to restore system and application settings, select the System and application settings check box. This check box appears only if an inSync administrator has enabled system and application settings. You must restart your device after your system and application settings are restored.
        • Click Continue.
        • After the restore operation completes, inSync displays amount of data restored and the count of files whose restoration failed, in the Restore Summary window.
    7. The new device is ready for the user.