Skip to main content
Redstor.com

1027 - ESE for Linux

Jacques van Rensburg
  • Updated
    Tags:
  • Technical
  • ESE
  • Linux
  • v18

The Enterprise Server Edition (ESE) Data Management Agent is available on Linux platforms. 

Note: Please refer to the System Requirements and Compatibility Matrix for supported operating systems and requirements.

 First-time Installation of the Agent

Ubuntu

1. Install the Backup Pro ESE package. 

sudo dpkg -i <installer file path>

"Installer file path" refers to the location to which the ESE installer file was downloaded, e.g. /Home/User/Downloads/LinuxInstaller.deb

2. Add the relevant user to the newly created "backuppro" group:

sudo usermod -G backuppro -a <your user>

3. Log out if necessary and log in as the user you have added.

4. For the backupprogui or backupprocli to communicate with the backuppro.service successfully, the service needs to be (a) running and (b) using a localhost port that the GUI or CLI can access.

(a) Check if the service has been started and start it if necessary:

  • For Ubuntu 16.04 and later: systemctl status backuppro.service
  • For Ubuntu pre 16.04: service backuppro status

Note: See Controlling the Backup Pro service below for more command options.

(b) To find the service port, view the file /etc/opt/backuppro/webserver.json

The port itself can be tested using curl as follows:

curl http://localhost:<serviceportnumber>/api/v1/status

Example:

curl http://localhost:37681/api/v1/status

The response returned from this should print out "OK".

If the OK response is not returned, all listening TCP ports on the host and their associated applications can be found with the following command:

sudo netstat -tulpn | grep LISTEN

Third-party software such as malware, antivirus, or even firewalls can potentially impair access to TCP ports. The ESE application and service port should be added to the exclusions for these if applicable. Read more in Article 008.

5. Start the Agent UI by launching Redstor Pro ESE from the desktop, or running backupprogui from a terminal.

Note: If you're running a headless environment, see Command-line options below. 

 

Red Hat Enterprise Linux / CentOS

Note: If you're running a headless environment, see Command-line options below. 

 

If you are deploying the agent from the RedApp:

1. Run:

sudo chmod +x <installer file name>

Note:

  • The installer file name should have no file extension.
  • For the installer file name, type linuxInstaller and press tab to autocomplete.

2. Run:

sudo ./<installer file name> 

3. Add the relevant users to the newly created "backuppro" group:

usermod -G backuppro -a <user>

3. Log in as the <user> user.

4. Check that the service has been started and start it if necessary:

  • For RHEL 7.x: systemctl status backuppro.service
  • For RHEL 6.x:  service backuppro status

Note: See Controlling the Backup Pro service below for more command options.

5. Start the Agent UI: Launch "Redstor Pro ESE" from the desktop, or run backupproguifrom a terminal.

 

If you have downloaded an installer from our Downloads page:

1. Switch to the root user:

su -

2. Install the ESE agent installer package that you have downloaded:

rpm -i <installer rpm file>

3. Add the relevant users to the newly created "backuppro" group:

usermod -G backuppro -a <user>

4. Log in as the <user> user.

5. Check that the service has been started and start it if necessary:

  • For RHEL 7.x: systemctl status backuppro.service
  • For RHEL 6.x:  service backuppro status

5. Start the Agent UI: Launch "Redstor Pro ESE" from the desktop, or run backupproguifrom a terminal.

 

 

Controlling the Backup Pro service

On Linux distros that use systemd, control the Backup Pro service with the following command:

systemctl [start/stop/status] backuppro.service

Example:

systemctl start backuppro.service

 

On other Linux distros, control the Backup Pro service with the following command:

service backuppro [start/stop/status]

Example:

service backuppro start

 

 Performing upgrades manually

Ubuntu

1. Check the current version:

dpkg -l redstorbackuppro

2. Upgrade the software:

dpkg -i <new installer file path>

"New installer file path" refers to the location to which the newer ESE installer file was downloaded, e.g.  Home/User/Downloads/LinuxInstaller.deb

3. Check that the service has been started and start it if necessary:

systemctl status backuppro.service

Note: See Controlling the Backup Pro service for other command options.

 

Red Hat Enterprise Linux / CentOS

1. Check the current version:

rpm -q redstorbackuppro

2. Upgrade the software:

rpm -U <new client rpm file>

3. Check that the service has been started and start it if necessary:

systemctl status backuppro.service

Note: See Controlling the Backup Pro service for other command options.

On both RHEL and Ubuntu, the UI will be closed. During the upgrade process, the Backup Pro service will be stopped and restarted automatically.

 

Performing updates automatically

When Agent updates are downloaded from the Downloads page and installed on the relevant Storage Platform, these updates are automatically downloaded to the Agent machine and installed at the next backup (or on next restarting the backup service). 

 

Relevant directories and paths

Backup Pro service

/etc/systemd/system/backuppro.service

or 

/etc/init.d/backuppro

 

Desktop icon info

/usr/share/applications/backuppro.desktop

 

GUI and command line tools

/usr/bin/backupprogui

/usr/bin/backupprocli

 

Config files  (*.properties)

/etc/opt/backuppro/a5backup.properties  

/etc/opt/backuppro/backupset.xml  

/etc/opt/backuppro/defaults.properties  

/etc/opt/backuppro/log.properties  

/etc/opt/backuppro/service.properties  

/etc/opt/backuppro/sp.properties  

/etc/opt/backuppro/ui-log.properties

 

Other files in /etc/opt/backuppro/

a5profile.properties 

backupgui.properties (will be created on first opening the Agent UI)

connection.properties 

 

Agent library files

/opt/backuppro/lib

 

Agent JRE

/opt/backuppro/a5jre

 

Backup and restore logs

/var/log/backuppro/Backup{date}.log

/var/log/backuppro/Backup{date}.log

Example: /var/log/backuppro/fsaccessBackup20170421190003.log

 

Service and UI log - -

/var/log/backuppro/fsaccess.log  

/var/log/backuppro/service.log  

/var/log/backuppro/service_errors.log  

/var/log/backuppro/ui.log

 

Backup cache and history

/var/opt/backuppro/data/history/<Account GUID folder>

/var/opt/backuppro/data/temp

 

Agent active tasks

/var/opt/backuppro/tasks

 

Uninstalling the Agent

Ubuntu: Partial removal for subsequent reinstallation

This option allows a user to reinstall the Agent later so that it will use the same defaults.properties.

dpkg -r redstorbackuppro

Note:

  • Leaves only files in /etc/opt/backuppro  
  • Leaves backuppro group

 

Ubuntu: Complete removal

This will remove all files previously installed for the Agent.

dpkg -P redstorbackuppro

Note:

  • Removes /etc/opt/backuppro and contents  
  • Removes the backuppro group

 

Red Hat Enterprise Linux / CentOS

This will leave copies of configuration files with a .rpmsave extension.

rpm -e redstorbackuppro

Note:

  • Leaves *.rpmsave files in /etc/opt/backuppro  
  • Removes the backuppro group

 

Command-line options

For useful commands for the Agent, see this article.

Related articles

Comments

0 comments

Article is closed for comments.