Before you can begin taking backups of your systems, you must first install the backup agent.
Agent installation can take various forms, depending on:
- the operating system you are deploying
- if you backup to an appliance
- whether you perform backups using Direct-to-Cloud (D2C)
- if you are manually installing agent software or using remote deployment (RMM)
Need details on how to deploy a D2C agent via ConnectWise Asio?
Refer to Deploy D2C agents via ConnectWise Asio
STEP 1. Windows or Linux?
For Windows operating systems, continue with the following steps.
For Linux operating systems, see Install an agent (Linux) - x360Recover
STEP 2. Download the agent installer
The x360Recover agent installation file can be downloaded from several locations.
- The appliance Login page
- The appliance Downloads page
- The vault Clients page (for client-specific Direct-to-Cloud installer image)
What's the difference between the download locations?
- When manually installing the agent in Direct-to-Cloud mode, the vault Clients page provides a download to a special version of the agent installer. This special version contains client information and a token ID in the filename. This token ID is used to identify which client the agent will register.
- When deploying in appliance mode (or for bulk distribution via RMM tools in either appliance or Direct-to-Cloud mode) you can use command-line parameters with the normal agent installer file to (a) perform silent install and/or (b) define the token ID for D2C.
Note: To obtain the token ID for RMM deployment, you must first download the client-specific installation package and then examine the file name. (See below for details.)
2.1. Download the client-specific agent installation package from that clients’ vault page:
2.2. Click on the Windows icon in the row belonging to the desired client.
- All protected systems deployed with this installer will register as belonging to this selected client.
Notes on token IDs: Client-specific agent installation packages have a custom naming format that identifies the client and contains a special registration token ID specific to the client.
A new token ID is generated whenever you download an agent installation package for a client. The generated token ID is valid for 180 days. After 180 days. the token ID will no longer be valid for agent installation and you will need to generate a new one.
If you wish to use an RMM tool to deploy the agent in Direct-to-Cloud mode to multiple systems, retrieve the token ID for that client by first downloading one instance of the agent specific to your client. (See more below on silent installation of the agent)
IMPORTANT NOTES: If you are converting an existing protected system on an appliance to Direct-to-Cloud, you must first uninstall the existing agent. (When an agent is already installed, the D2C installer cannot re-install in Direct-to-Cloud mode.) ALSO: Make sure you do not delete the agent installation folder after uninstalling the appliance agent. The configuration information left behind (after uninstalling the agent) is used to correctly identify the agent to the existing vault replica of the data.
For step-by-step instructions on how to convert an existing appliance agent to Direct-to-Cloud (D2C), refer to Convert an existing appliance agent to Direct-to-Cloud (D2C)
STEP 3. Choose an installation method and perform install
Below are instructions for two methods available for installing the agent:
3.1. Perform interactive installation (User interaction is needed)
3.1.1. Copy the agent installer to the system (or to a network file location accessible from the system.)
3.1.2. Double-click on the installer to begin the installation.
3.1.3. Click Next to begin the agent installation.
3.1.4. Accept the license agreement and click Next.
3.1.5. Specify the installation directory for the agent. (Typically, you will accept the default value.)
Note: The agent needs space for index and hash files in the installation directory. Normally, the required space is approx. 500KB for each TB of total disk size for every volume in the system (plus space for log files, etc.)
If your C: drive is tightly constrained on free space, you may wish to install the agent onto another drive with more space available.
3.1.6. (Required step) Enter the appliance IP address
Note: When you are installing using a client-specific Direct-to-Cloud agent, the appliance IP field will be greyed out. The vault address will be automatically retrieved, based on the token ID you provided in the agent installer filename.
3.1.6.a Optional step: You may choose to assign an appliance access control password to this agent.
Enter the password twice in the fields provided to confirm you typed it correctly.
IMPORTANT: If you choose to enter an optional password, the specified password will be required every time you wish to access the backup data on this protected system. This means you will need to provide the password when you perform any data recovery, when you make agent configuration changes using the application UI, and when you delete the protected system or any of its snapshots.
Note: If you later decide to add, change, or remove this optional password, you can do so using a Powershell script located in the agent installation folder. For instructions, see Change or reset an agent access control password
3.1.6.b. Optional step: You may specify a limited set of disk volumes to be backed up.
- By default, this value is left blank, indicating that all supported volumes are to be included in the backup.
Note: Volumes which are always excluded (by default) from backup include:
- Volumes using incompatible filesystems, like FAT or ReFS
- Volumes being used by the agent for Local Cache
- Nested volumes (such as a VHDX file on C: mounted as C:\VMDisk; The mount point will be excluded, because Microsoft VSS cannot snapshot both the mount point and the physical disk image file in the same dataset.)
3.1.7. When you have completed all desired fields, Click Install.
3.1.8. Click Finish to close the installer.
3.2 Perform silent agent installation (For mass deployment using scripting or RMM)
REQUIRED parameters for silent install
The x360Recover agent supports a set of command-line parameters for performing a silent install during mass agent deployment using scripting or RMM tools.
The presence of one of these parameters implies that the agent will be installed silently, with no user interaction.
- One of these two parameters is REQUIRED
- Only ONE may be specified
The agent understands the following parameters:
|One of these mandatory parameters is REQUIRED||Example|
SERVER=<appliance IP address>
Specifying the parameter SERVER=<appliance IP address> installs the agent in appliance mode and registers it with the appliance as the specified IP address
Specifying TOKENID=<Token ID> installs the agent in Direct-to-Cloud mode and registers it with the vault from which the token ID was retrieved (the client account used to create the token)
|Description of optional parameter||Example of parameter|
|Specify volumes to include in the backup
|Specify the Access Control password
|Specify the path to use for maintaining a Local Cache
|Specify the network share User Account for Local Cache
|Specify the network share User Password for Local Cache
Notes on local cache:
- Local cache should only be used when deploying in Direct-to-Cloud mode. (It serves no purpose in local appliance mode.)
- The local cache path must be specified as a local drive path when using locally-attached storage, such as a USB disk.
For example: LCPATH=Q:\LocalCache
IMPORTANT: The local cache path CANNOT BE specified as a local drive path when using network storage. You must use UNC path nomenclature, like ‘\\<Server>\<Share Name>\<Folder Name>’ etc. Network shares mounted to a drive letter in the user environment are not accessible to the agent services, so the agent needs to know where the actual shared folder exists on the network.
Perform a silent installation of the agent
Important: Always use the generic agentInstaller.msi package when performing command-line installation. Do not use the client-specific agent installer package.
Note: If you have downloaded the client-specific agent installer package, simply rename it to 'agentInstaller.msi' to remove the token and client information from the installer before deploying.
STEP 1. Launch the agent installer from the command-line, either
(a) directly inside a Windows CMD.exe shell, or
(b) via scripting run via Group Policy or via RMM management utilities.
The agent uses Microsoft Installer:
|msiexec /i <installer file name> /q SERVER=192.168.90.201 <more parameters>|
STEP 2. Deploying in Direct-to-Cloud mode looks something like this on the managed system:
|msiexec /i agentSetup.msi /q TOKENID=6484c41f970d49ac8156b9c967e7a295 <more parameters>|
STEP 3. You may also include other command-line options (such as PASSWORD) to set the agent password/ passphrase, etc.
Note: To completely hide the installation in the background, include the ‘/q’ option. Omitting ‘/q’ will display the installation progress window during installation.