Install nuCDP Client on Linux

From nuCDP Wiki
Jump to: navigation, search


The following guide will show you how to install nuCDP Client on a Linux OS. It takes 5-10 minutes to get the nuCDP Client up and running.


  • A server with either of the following Linux Distros :
    • Redhat Style distro (CentOS, RHEL, Scientific Linux)
    • Debian Style distro (Ubuntu, Debian)
  • If you have a firewall, then please allow access to download all packages from *

Installing nuCDP Client

Open a Shell Terminal (e.g. PuTTY) and SSH to your device. Run the following commands:

wget -N
chmod +x

The installation will begin immediately. Once the installation has finished you will see something like this :


Thats it the installation of nuCDP Client is completed ! But you still need to do some initial configuration.

Create the Module

The Linux nuCDP Client needs to insert a Kernel Module for keeping track of the blocks which are changing. When the installer runs, the module would have been created. The module will be created if its missing from your system even at a later time. The kernel-headers will be required for compiling the module. This is generally taken care by the installer itself.

You can force the creation of the module with the following command :

/usr/local/nucdp/client/cli -m

The Module is inserted if its not already loaded.
You can check if the module is already inserted or not :

lsmod | grep nucdp

If the module is loaded, something like the following should be displayed :

nucdpvXXX             112192  2

Configure the Client

You will now need to configure the Client with a nuCDP Server where the backups will be stored. Please execute the following command :

root> /usr/local/nucdp/client/cli -a hostname=HOSTNAME username=USERNAME

You will now be prompted for your account password.

Following is an explanation of the parameters :

  • hostname : The IP Address or the HostName of the server where nuCDP server is installed e.g.
  • username : The username / email address of the user account on the nuCDP Server e.g. john
  • password : The password of the user account on the nuCDP Server e.g. SECRET

Note : The password will not be saved anywhere and is being used only for verification with the server. You should also clear the shell history.

The following is a screenshot of how to configure the client :


Add Block Devices to Backup

Now that the client has connected to the nuCDP server, we will need to configure the client to backup certain block devices.

Adding Block Devices via Command Line

You can see a list of existing partitions with the following command :

root# /usr/local/nucdp/client/cli -p

To add a partition execute the following command :

root# /usr/local/nucdp/client/cli -p add=/dev/sda1

The following is a screenshot :


Adding Block Devices via nuCDP Admin Panel GUI

If you have access to the nuCDP Admin Panel, then you can Manage Partitions using the nuCDP Admin Panel. Go to nuCDP Server Admin Panel -> Devices -> Click on the device you want to manage the partitions of. There click on the Manage Partitions button. A small window similar to the one below will open up :


You can Add or Remove the partitions listed there.

Start the nuCDP Client Service

After the above steps are done, its time to start the nuCDP Client. Execute the following command :

root# service nucdpclient restart

The backups will start in 15 minutes because the default backup interval is 15 minutes. If you would like to change the backup interval, you can add/edit the interval time in the Configuration file :

root# vi /usr/local/nucdp/client/conf/nucdp.ini

Add / Edit something like the following line :

interval=*/5 * * * *

The above changes the backup interval to every 5 minutes.


You can check the Raw Logs of the nuCDP Client at /var/log/nucdp/nucdpclient.log

tail -f /var/log/nucdp/nucdpclient.log

You can also set the log display level by editing nucdp.ini
Please add the following line :



If you need any help please email us at