Overview
The device-user mapping process allows easy identification of the device to replace.
Device mapping supports device replacement operation even if the user's hostname on the new device is different from the hostname on the old device.
Procedure
Device replacement using the CSV file process consists of the following steps:
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.
Device Map CSV file process
The 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 the 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 processes requests only for AD users. If the user is not found using the username attribute, the IMD 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 process to replace a device works even if a user is put on Legal Hold.
Causes of failures
Device replacement 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 Prompts the user if device mapping is not defined, it 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 replacement activity, you must ensure that the user and device details are imported into a device map file.
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 Endpoints and add data to it. To download the sample device map:
On the Endpoints page, click Device Mappings from the left navigation menu.
Click the Import Device Map CSV button located on the top left of the page. The Import Device Map CSV dialog box appears.
📝 Note
If the CSV file that you import includes users who have enabled data privacy, we will notify those users and server administrators about the new device mapping. Sending email notifications would mitigate a potential threat when a rogue administrator attempts to gain access to user data. To disable email notifications, contact Support.
Click the Download Sample CSV File link. A sample .csv file will be 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.
SN | Attribute | Description | Use |
1 | Email address
| 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 of the new device. | Mandatory |
3 | Device identifier
| Device ID value of the new device. The commands specified below for Mac and Windows devices will display the respective device identifiers, such as the Serial Number, UUID, or hostname. You can use any one as a device identifier in the device-map .csv file. The device identifier must be unique and 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:
Another option to find the Serial Number:
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:
Another option to find hardware UUID:
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:
UUID To display the UUID of a Windows device, run the following command on the command prompt:
Hostname To display the hostname of a Windows device, run the following command on the command prompt:
| Mandatory |
4 | Device identifier type
| The type of device identifier, such as serial number, UUID, or hostname specified in the device identifier column. | Mandatory |
5 | Logged in 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
| Name of the user's old device in inSync that is to be replaced with a new device. | Optional 📝 Note |
7 | Data to be restored to the new device
| Type of data to be restored 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 environment.
To learn how to import the device-map .csv file into Druva 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
To import the device map .csv file into Endpoints, perform the following steps:
1. On the Endpoints page, select the Device Mappings from the left navigation menu.
2. Click the Import Device Map CSV button located on the top left of the page. The Import Device Map CSV dialog box appears.
📝 Note
If the .csv file that you import includes users who have enabled data privacy, we will notify those users and server administrators about the new device mapping. Sending email notifications would mitigate a potential threat when a rogue administrator attempts to gain access to user data. To disable email notifications, contact Support.
3. Click Browse to select the device map .csv file that you want to import. Click Import.
The Upload Device Mappings dialog box appears, which displays the total number of succeeded and failed device maps. Click Done.
💡 Tip
If a matching email ID is not found, the relevant user and device details will not be imported. Click the Download List link on the Upload Device Mappings dialog box to download a .csv file of failed device maps that includes the reasons for the import failure. You need to rectify the issues mentioned in the error column and import the device map .csv file again. The details are incrementally updated when you import the file again.
You can view the device map details on the Device Mappings page in New Device Name (hostname), New Device ID, Device ID Type, User Email, User Name, Old Device Name, and Restore Data columns. You can also view the following information on the Device Mappings page.
Source: From which the device mapping is created, for example, API, CSV.
Created by: Client Credential, who created the device mapping.
Step 3: Update Mass Deployment Settings
inSync provides a setting - Prompt user if device mapping is 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.
📝 Note
This setting is applicable only to inSync Client activations done using the AD/LDAP authentication.
To update the mass deployment settings:
Go to Endpoint -> Mass Deployment tab from the left navigation bar.
Select Edit in the Mass Deployment Settings section. The Mass Deployment settings window appears.
Select Activate only the first device for every user; if you want to activate inSync Client on the first device, the user only logs on. If you uncheck this field, the inSync Client will be activated on all the devices the user logs on.
Select the Prompt user if device mapping not defined checkbox to enable the following when the user-to-device mapping is not defined on the Console:
An Administrator and the inSync Client user can define the device behavior.
inSync Client users can either replace an old device or add a new one as an additional one.
Select the Deploy without device mapping checkbox when you want to perform mass deployment of inSync Client on user devices that are not mapped in the inSync Management Console.
Mass deployment settings are updated. If an administrator does not define a device-user mapping while initiating the IMD 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 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.
❗ Important
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:
On the Endpoint workload page, select Mass Deployment.
Select Generate token. The Mass Deployment Token Window appears.
Select the Enable Expiry Date check box to set the expiry date.
Set the expiry period in the Expire date box.
Click Create New Token. Your token is generated.
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. Click Done.
Step 5: Run the IMD command
You can save the IMD 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.
💡 Tip
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 command.
Parameter Type | Name | Use | Value |
Mass deployment token | TOKENV4 (for Windows) | Mandatory | The mass deployment token is generated for the IMD command. |
inSync server IP address and port number | SERVERLIST (for Windows) | Mandatory | The IP address and the backup/sync port of the inSync Server. |
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-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 |
WPAD URL details | WPAD_URL (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
- If you want inSync Client to automatically detect URL of the WPAD location, specify
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 CloudCache Server ID | CACHESERVERID (forw Windows)
--cacheserver (for Mac) | Optional | The inSync CloudCache Server ID to which you want to map users.
📝 Note |
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: |
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.
📝 Note
|
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. 📝 Note |
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. |
Scenario 1: Activate a device when you can access the 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.app/Contents/MacOS/inSync --tokenv4 "IMDToken" --master "cloud.druva.com:443"
Sample command
/Applications/Druva\ inSync/inSync.app/Contents/MacOS/inSync --tokenv4 "11-123this0is0a0sample0token0123" --master "cloud.druva.com:443"
Command for inSync Client v6.5 and later versions
/Applications/Druva\ inSync.app/Contents/MacOS/inSync --token "<IMDToken>"--master "<server-fqdn>:<port>" --proxy-server "<IP address of proxy server>:<port number>"
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 the HEADLESS parameter in the script. If you do not use this parameter, the inSync Client icon continues appearing in the user devices' notification area 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), and 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 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.)
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:
Provide inSync administrator or inSync user credentials, depending on the individual logging in, on the activation screen.
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
Log on to the user's device.
IT or System administrator with administrator credentials.
End-users with their credentials.
Launch inSync Client on the user device.
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 Imass deployment process.
Click Configure to continue with the activation process.
If you click Configure, perform the following steps to activate the inSync Client:
On the inSync Client login page, select inSync Cloud as the edition.
Type the email address of your inSync account.
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.
ORType the password for your inSync account.
On successful verification, a Configure <hostname> for Backup page appears.
Select one of the following actions:
Add as new device—Select this option to add or associate this device with the user account as a new device.
Replace an existing device - Select this option to replace another device that has the inSync Client installed on it with this new device.
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 with inSync Client on them.
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. The device must be restarted after you restore the system and application settings.
Click Continue.
After the restore operation completes, inSync displays the amount of data restored and the count of files whose restoration failed, in the Restore Summary window.
The new device is ready for the user.