Install a Cloud Backup client before backing up an on-premises NAS file system - Cloud Backup

Before you use Cloud Backup to back up or restore files from an on-premises NAS file system, you must install a Cloud Backup client.

Usage notes

To achieve the optimal backup performance, we recommend that you run a Cloud Backup client on a host with the following configurations: 64-bit CPU with two or more cores and more than 8 GB available memory.
The volume of data that can be backed up depends on the available memory. For a host with 4 GB available memory, a maximum of one million files, up to 8 TB in total, can be backed up. If you want to back up tens of millions of files, we recommend that you configure 16 GB available memory.
Before you install and uninstall a Cloud Backup client, check the client installation path:
- If a NAS file system is mounted to the installation path, run the umount command to unmount the NAS file system. This prevents the file system from being accidentally deleted.
- If other important directories and files exist in the installation path, move them to another path. This prevents these directories and files from being accidentally deleted.
Before you use Cloud Backup, we recommend that you read the topics about the limits on Cloud Backup, the default backup speed, and the features available in each region. For more information, see Limits, Backup speed and recovery speed, Features, and Features available in each region.

Download and activate a Cloud Backup client for Windows

Log on to the Cloud Backup console.
In the left-side navigation pane, choose Backup > NAS Backup.
In the top navigation bar, select the region where the on-premises NAS file system is deployed.
Note
Alibaba Cloud continuously updates Cloud Backup to support more regions. You can log on to the Cloud Backup console to view the regions in which Cloud Backup is supported.
On the NAS Backup page, click Local NAS.
Click Add Client.
Download the Cloud Backup client for Windows.
You can download the installation package of the Cloud Backup client for Windows (64-bit) or Windows (32-bit). Record the activation code. The activation code is used to install and activate the Cloud Backup client.
Install and activate the Cloud Backup client for Windows.
1. Double-click the installation package of the Cloud Backup client and select the language that you want to use.
2. Select the path in which you want to install the Cloud Backup client, and click Next.
3. Select Local client connecting to Alibaba Cloud and click Next.
  For more information, see How do I select a component and account when I install a Cloud Backup client?
4. Configure the logon identity.
  Files in an on-premises NAS file system are shared over a network. To back up or archive files in an on-premises NAS file system, select This user. The user must meet the following requirements:
  - The user has the permissions of the local administrator.
  - The user has the permissions to log on as a service.
    To configure the logon user, perform the following steps:
    Open Control Panel. In the window that appears, click Administrative Tools.
    Open Local Security Policy and choose Local Policies > User Rights Assignment.
    Turn on Log on as a service. In the dialog box that appears, add a user.
  - The user has the permissions to access files that are shared over a network.
  For more information, see How do I select a component and account when I install a Cloud Backup client?
5. If you want to use a proxy server, enter the IP address of the proxy server. Click Next.
6. Enter the activation code that you recorded in the Activation token field. Then, click Next.
7. Click Install.
  After the client is installed, you can view the NAS file system on the NAS File System tab of the Local NAS page.
Optional. Configure the configclustertaskfetchernum parameter of the Cloud Backup client to accelerate the execution of backup tasks. Perform the following steps:
1. Log on to the ECS instance.
2. Change the maximum number of concurrent tasks on the Cloud Backup client to 2. We recommend that you set the value to 8 or smaller. The larger the value, the more resources are consumed. We recommend that you set a reasonable value.
  A backup job may be divided into multiple tasks. You can use the configclustertaskfetchernum parameter to specify the maximum number of tasks that are concurrently executed on the Cloud Backup client.
  The default value of the configclustertaskfetchernum parameter is 1.
  Set the value of the configclustertaskfetchernum parameter in the hbrclient.yaml file to 2. We recommend that you do not set the parameter to a value greater than 8.
```
configclustertaskfetchernum: 2
```
  Note
  On Windows, the hbrclient.yaml file is located at the following path: C:\Program Files\Aliyun Hybrid Backup Service Client\conf..
3. Restart the Cloud Backup service. Note that running tasks are affected if you restart the Cloud Backup service. We recommend that you restart the Cloud Backup service during off-peak hours.
  Open the Command Prompt, enter services.msc, and then press Enter. In the Services dialog box, find and restart the Cloud Backup service.

Download and activate a Cloud Backup client for Linux

Log on to the Cloud Backup console.
In the left-side navigation pane, choose Backup > NAS Backup.
In the top navigation bar, select the region where the on-premises NAS file system is deployed.
Note
Alibaba Cloud continuously updates Cloud Backup to support more regions. You can log on to the Cloud Backup console to view the regions in which Cloud Backup is supported.
Click Add Client.
Automatically activate the Cloud Backup client for Linux.
Copy one of the commands based on your network. Then, paste and run the command on the Cloud Backup client for Linux to activate the client.
Run one of the following commands to install the tool that is required to back up and restore on-premises NAS file systems.
The Network File System (NFS) and Server Message Block (SMB) protocols are supported. You can select a tool based on the protocol of your NAS file system.
- NFS tool
  - CentOS
```
sudo yum install nfs-utils
```
  - Ubuntu
```
sudo apt-get install nfs-common
```
- SMB tool
  - CentOS
```
sudo yum install cifs-utils
```
  - Ubuntu
```
sudo apt-get install cifs-utils
```
  - openSUSE
```
sudo zypper install cifs-utils
```
Optional. Configure the configclustertaskfetchernum parameter of the Cloud Backup client to accelerate the execution of backup tasks. Perform the following steps:
1. Log on to the ECS instance.
2. Change the maximum number of concurrent tasks on the Cloud Backup client to 2. We recommend that you set the value to 8 or smaller. The larger the value, the more resources are consumed. We recommend that you set a reasonable value.
  A backup job may be divided into multiple tasks. You can use the configclustertaskfetchernum parameter to specify the maximum number of tasks that are concurrently executed on the Cloud Backup client.
  The default value of the configclustertaskfetchernum parameter is 1.
  Set the value of the configclustertaskfetchernum parameter in the hbrclient.yaml file to 2. We recommend that you do not set the parameter to a value greater than 8.
```
configclustertaskfetchernum: 2
```
  Note
  On Linux, the hbrclient.yaml file is located at the following path: /opt/alibabacloud/hbrclient/conf.
3. Restart the Cloud Backup service. Note that running tasks are affected if you restart the Cloud Backup service.
  Run the systemctl restart hbrclient command to restart the Cloud Backup service.

What to do next

Back up files from an on-premises NAS file system