• Sales: 1-800-961-2888
  • Support: 1-800-961-4454

Rackspace Cloud Backup - Install the Agent


Getting Started with Rackspace Cloud Backup - Part 1

Note: You can use Rackspace Cloud Backup on virtually any server in the Rackspace Cloud. The exceptions are FreeBSD 9, Debian 5 and Windows 2003.

Establish network routes

If your Cloud Server was created before June 3, 2013, you might need to add network routes to the server so that it can connect to Cloud Backup through the back-end network (ServiceNet). You can find complete instructions for updating your server's network routes in the following article: Updating ServiceNet routes on Cloud Servers

Install the Agent

If you have an account with a Managed Service level, the Cloud Backup agent might already be installed on your server. If your Cloud Servers are listed under the 'Systems' tab in the 'Backup' section of the Cloud Control Panel, then the Cloud Backup agent is already installed. If it is not, Rackspace can install it for you. Check with your account manager and proceed to How to Create a Backup.

Customers who do not already have the Cloud Backup agent installed should begin with the following instructions:

 

Install the Agent on Apt-based Sytems, such as Ubuntu and Debian

SSH into your server and run the following commands consecutively as a user with sudo or superuser privileges.

Step 1. Get the agent.

sudo sh -c 'wget -q "http://agentrepo.drivesrvr.com/debian/agentrepo.key" -O- | apt-key add -'

Step 2. Add the resource.

sudo sh -c 'echo "deb [arch=amd64] http://agentrepo.drivesrvr.com/debian/ serveragent main" > /etc/apt/sources.list.d/driveclient.list'

Step 3. Install the agent.

sudo apt-get update; sudo apt-get install driveclient

Step 4. Configure the bootstrap.

You need your username and API key to complete this step. If you need assistance finding your API key, please refer to this article in our Knowledge Center.

Tip: This step asks you to confirm that you want to overwrite your config file. Answer yes.

sudo /usr/local/bin/driveclient --configure

Step 5. Start the agent.

sudo service driveclient start

Step 6. Set the agent to start on boot.

sudo update-rc.d driveclient defaults

Install the Agent on RPM-based Systems, such as CentOS, Fedora, and Red Hat

First, you must SSH into your server and run the below commands consecutively on a user with sudo or superuser privileges.

Step 1. Confirm the directory.

Go into your file directory and confirm that the path /etc/yum.repos.d path exits. If not, create it:

sudo mkdir -p /etc/yum.repos.d

Step 2. Get the RPM.

sudo wget -O /etc/yum.repos.d/drivesrvr.repo "http://agentrepo.drivesrvr.com/redhat/drivesrvr.repo"

Step 3. Install the RPM.

sudo yum -y install driveclient

Step 4. Configure the bootstrap.

You need your username and API key to complete this step. If you need assistance finding your API key, please refer to this article in our Knowledge Center.

sudo /usr/local/bin/driveclient --configure

Step 5. Start the agent.

sudo service driveclient start

Step 6. Set the agent to start on boot.

sudo chkconfig driveclient on

Install the Agent for Arch, Gentoo, and SUSE Systems

For Arch, Gentoo, and SUSE Linux systems, download the tarball. Then, SSH into your server and run the following commands consecutively as a user with sudo or superuser privileges.

Note: The tarball has the most up-to-date instructions. If the following instructions differ from the tarball instructions, use the tarball instructions.

Step 1. Get the tarball.

wget http://agentrepo.drivesrvr.com/tar/driveclient-latest.tar.bz2

Step 2. Extract the files.

tar -xvjf driveclient-latest.tar.bz2

Step 3. Change to the directory.

Enter the directory created by extracting the files, for example:

cd driveclient-1

Step 4. Create directories and copy files.

sudo cp driveclient /usr/local/bin/
sudo chown root:root /usr/local/bin/driveclient
sudo chmod 700 /usr/local/bin/driveclient
sudo mkdir -m 700 /etc/driveclient sudo cp cacert.pem /etc/driveclient

Step 5. Configure the agent.

You need your username and API key to complete this step. If you need assistance finding your API key, please see Viewing and Regenerating Your API Key.

Tip: This step asks you to confirm that you want to overwrite your config file. Answer yes.

sudo /usr/local/bin/driveclient --configure

Step 6. Start the agent.

sudo /usr/local/bin/driveclient --daemon

Example init/startup scripts are included in the tarball.

Install the Agent for Windows Systems

If you need to find out which encryption type of Windows machine you have (32- or 64-bit), navigate to your Windows Server's Control Panel and Select "System".

Step 1. Download the agent.

Note: You can right-click the following agent links and save the executable files directly to your server.

Step 2. Run the agent.

You need your API key when you install the agent. If you need assistance finding your API key, please see Viewing and Regenerating Your API Key.

There are 3 types of setups: New Install, Update Install, or GUI Install. They take the following non-quoted parameters:

  • New installation:
    driveclient-setup /S /Type=[New|Install|Update] /Username=username /ApiKey=apiKeyValue /ApiHostName=hostname [/Url=UpdateUrl]
    
  • Update installation:
    driveclient-setup /S [/Type=Install|/Type=Update]
    

Notes:

  • For non-interactive installation and automation, the /S parameter provides a silent installation.
  • If the installation type is not 'new' (/Type=New), the credentials are not overwritten.
  • For all installation types but an update /ApiHostName can be provided. If it is not provided its value defaults to api.drivesrvr.com.
  • The New and Update types of installation are provided for backward compatibility.

Step 3. Test Windows installation or update.

Test Your Windows Installation

Installation should perform the following actions:

  1. Create the "%programfiles%\driveclient" path.
  2. Place files in the Program Files\driveclient directory:
    c:\>dir "%programfiles%\driveclient" /a-d
     Volume in drive C is OS
     Volume Serial Number is EE4C-78FC
    
     Directory of C:\Program Files\driveclient
    
    10/05/2011  12:24 PM         5,749,760 driveclient.exe
    03/01/2011  05:41 PM         1,693,696 icudt42.dll
    03/01/2011  05:39 PM         1,289,216 icuuc42.dll
    10/05/2011  01:37 PM           647,630 install.log
    10/05/2011  01:37 PM            58,384 uninst.exe
                   5 File(s)      9,438,686 bytes
    
  3. Create the %programdata%\driveclient path.
  4. Place bootstrap.json in the %programdata%\driveclient path, which looks as follows:
    {
      "ApiHostName" : "api.driveclient.com",
      "Https" : true,
      "IsRegistered" : false,
      "Username" : "[yourusername]",
      "Password" : "[myownveryverylongpasswordthatnoonecouldeverpossiblycrack]"
    }
    

    The parameters provided with /type=install should be visible in the bootstrap.json file.

  5. Create a DriveClientSvc service:
    c:\>sc query DriveClientSvc
    
    SERVICE_NAME: DriveClientSvc
            TYPE               : 10  WIN32_OWN_PROCESS
            STATE              : 1  STOPPED
            WIN32_EXIT_CODE    : 0  (0x0)
            SERVICE_EXIT_CODE  : 0  (0x0)
            CHECKPOINT         : 0x0
            WAIT_HINT          : 0x0
    
  6. The entry driveclient.exe should be visible in Control Panel > Programs and Features.

Test Your Windows Update

Running driveclient-setup-latest.exe will change any updated files in “program files\driveclient”.
This is the same as running the setup with no parameters.

c:\>dir "%programfiles%\driveclient\driveclient.exe"

 Volume in drive C is OS
 Volume Serial Number is EE4C-78FC

 Directory of C:\Program Files\driveclient

10/05/2011  12:24 PM         5,749,760 driveclient.exe
               1 File(s)      5,749,760 bytes
               0 Dir(s)  449,822,932,992 bytes free

Troubleshooting

  • Connection error: If Cloud Backup indicates that the agent is not running on your server, ensure that your firewall isn't blocking outgoing connections on port 443.

What do the backup statuses Skipped, Missed, Errored, and Failed mean?

  • Skipped: The backup job was skipped because a backup job was already queued. A single backup job can be queued only once.
  • Missed: The backup job was missed because the agent did not respond. The agent was likely offline.
  • Errored: An error occurred during the backup. The backup job did run, but it needs to be investigated.
  • Failed: A serious problem occurred, and the backup job did not run.

How do I troubleshoot the Skipped, Missed, Errored, and Failed statuses?

  • Skipped: This error likely occurs because the frequency of the backup job is set too high. Consider reducing the frequency of the job, or reducing the amount of data. If this is the initial job, then the subsequent jobs might finish faster.
  • Missed: Verify that the agent is running on the server. If the agent is not already running, then start it. Next, check the logs to determine why the backup job failed. An agent should never go offline by itself. Either a software exception occurred or the agent was manually terminated.
  • Errored: Look in the logs on the server. The agent stores all the logs in one location (see the following section). Review the logs line by line. If you cannot determine the cause of the error, raise a ticket with the SME group, and they can help you identify the problem.
  • Failed: As with the Errored status, check the logs on the server. A failed status is severe.

Find Your Agent Logs

If you need to read the logs of your agent, you might find them in the following locations.

  • Linux: /var/log
  • Windows: %programdata%/driveclient

Uninstall the Agent from Linux

To uninstall the agent, stop the agent and uninstall the package.

CentOS or Red Hat

sudo service driveclient stop
sudo yum remove driveclient

Ubuntu

sudo /etc/init.d/driveclient stop
sudo apt-get remove driveclient

Uninstall the Agent from Windows

Run %programfiles%\driveclient\uninst.exe

The following changes should occur:

  • The path %programfiles%\driveclient contains a single file: install.log
c:\>dir "%programfiles%\driveclient" /a-d
 Volume in drive C is OS
 Volume Serial Number is EE4C-78FC

 Directory of C:\Program Files\driveclient

10/05/2011  01:29 PM           607,013 install.log
               1 File(s)        607,013 bytes
               2 Dir(s)  449,805,914,112 bytes free
  • The %programdata%\driveclient path does not exist.
c:\>dir "%programdata%\driveclient"
 Volume in drive C is OS
 Volume Serial Number is EE4C-78FC

 Directory of C:\ProgramData

File Not Found
  • No driveclient.exe entry exists in Control Panel > Programs and Features.
  • No DriveClientSvc service is installed.
  - There should be no scheduled tasks to "check for driveclient update".
c:\>sc query driveclientsvc
[SC] EnumQueryServicesStatus:OpenService FAILED 1060:

The specified service does not exist as an installed service.






© 2011-2013 Rackspace US, Inc.

Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License


See license specifics and DISCLAIMER