Skip to main content


 

 

How can we help you?

 

Druva Documentation

Deploy the backup agent or proxy using the common agent on a Linux server

Heads up!

We've transitioned to a new documentation portal to serve you better. Access the latest content by clicking here.

Enterprise Workloads Editions: File:/tick.png Business File:/cross.png Enterprise File:/tick.png Elite

 

Using the common Hybrid Workloads agent, you can install the agent and activate it for your File Servers and NAS workloads on a Linux server based on your requirement, thereby saving time for installing and activating the agent individually for each workload. 
The steps include the following:

Step 1: Download and generate activation token

You can protect different types of workloads using the common agent. For example, if you download the agent for File Servers, the same can be used to protect NAS and vice-versa. The agent is also available for download on the Druva Downloads page. The steps to download an agent and generate an activation token are as follows:

  1. Log in to the Management Console.
  2. Select the workload from the Protect menu. Note that if the All Organizations menu is enabled, you have to first select an organization and then select the workload.
  3. For each workload, select the following option:
    1. Click Register New Server for File Servers.
    2. Click Add Proxy for NAS.
      The respective registration screens appear. 
  4. Under the Download and Install Agent on the Server section, select Linux in the Select OS drop-down. 
    Note: 
    • You can click Check Pre-requisite to check the Hybrid Workloads agent prerequisites.
    • For NAS, directly select the Linux Download option.
  5. Click Download.
    The agent download starts on the same browser page.
  6. Under the Activation Token section, if there aren't any existing tokens, a Default Activation Token is generated. This token is valid for 25 servers and for 7 days. 
    Note: If this token has expired, click Generate New Token. In the Generate Token dialog box, enter the required details, and click Generate
  7. Select the Copy Token icon. 
    The activation token is copied successfully.

Step 2: Install and activate agent 

Once the agent is installed, a set of checks is run to ensure that the system is ready for activation of the agent and all the required conditions are met. If not, it will provide a curated set of errors that might have occurred and will also provide the solution to tackle and fix the same.

Perform the following steps to install the agent: 

  1. Go to the directory that contains the Hybrid Workloads agent installer.
  2. Run the following command:
    dpkg -i <package_name>
    
    For example:
    dpkg -i druva-phoenix-client-6.0.1-131748.amd64.deb
    
    or
    rpm –ivh <package name>
    
    For example:
    rpm –ivh druva-phoenix-client-6.0.1-131748.x86_64.rpm
    Note: Ensure that the available disk space is at least twice the size of the installer file.

Perform the following steps to activate the agent:

Note: If your network infrastructure uses a Web proxy, you must configure it before activation. For more information, see Configure Web proxy.
  1. On the Linux server, open the terminal.
  2. Paste the copied command for File Servers as explained below:
    1. Public Cloud
      HybridWorkloadsAgent fs activate -t <token> -n <ServerName> 
      
      For example:
      HybridWorkloadsAgent fs activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    2. GovCloud
      HybridWorkloadsAgent fs activate -g -t <token> -n <ServerName>
      
      For example:
      HybridWorkloadsAgent fs activate -g -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
  3. Paste the copied command for NAS as explained below:
    1. Public Cloud
      HybridWorkloadsAgent nas activate -t <token> -n <ProxyName>
      
      For example:
      HybridWorkloadsAgent nas activate -t 52931-221-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f8221343eb233c44a -n WIN-RTG3
    2. GovCloud
      HybridWorkloadsAgent nas activate -g -t <token> -n <ProxyName>
      
      For example:
      HybridWorkloadsAgent nas activate -g -t 52931-221-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f8221343eb233c44a -n WIN-RTG3Paste the copied command for Oracle DTC as explained below:
  4. Paste the copied command for Oracle DTC as explained below:

    1. Public Cloud:
      /opt/Druva/PhoenixOracle/bin/HybridWorkloadsAgent oracledtc activate --token <valid_token> -n “<ServerName>”
      For Example:
      /opt/Druva/PhoenixOracle/bin/HybridWorkloadsAgent oracledtc activate --token 52931-221-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f8221343eb233c44a -n "WIN-RTG3"

    2. Gov Cloud:
      /opt/Druva/PhoenixOracle/bin/HybridWorkloadsAgent oracledtc activate -g --token <token> -n ”<ServerName>”
      For example:
      /opt/Druva/PhoenixOracle/bin/HybridWorkloadsAgent oracledtc activate -g --token 52931-221-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f8221343eb233c44a -n “WIN-RTG3”

    3. The agent is activated successfully.

Note: The ServerName should be within double quotes.

 where,

  • <token> represents the activation token that Druva generated at the time of registering server.
  • <ServerName> represents the tag to the server that you want to activate. You can tag a server during activation or after activation. For example, if you add the 'druva_file_server' tag to your server, you can search for the server on the Druva portal using the 'druva_file_server' name. This is an optional argument. If you do not provide any value for this argument, the FQDN of the server is assigned as the default value for this attribute.
  • <ProxyName> represents the tag to the proxy that you want to activate.

Once the agent is successfully activated, a set of backup readiness checks for the common agent are executed to reduce instances of failure during the first backup. These checks enable you to make sure that your system is ready and equipped to perform a backup operation.
 

Step 3: Configure Web proxy

Before you begin
Ensure that the Hybrid Workloads agent service is running before starting proxy settings.

Procedure

  1. Open the command line interface window.
  2. In the terminal, run the following command set the Web proxy:
    HybridWorkloadsAgent web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password>
  3. (Optional)You can use the following command to fetch the current proxy configuration:
    HybridWorkloadsAgent web-proxy-config -g
    Field  Description
    Get_web-proxy
    (-g, --get)
    Fetches the current Web proxy configuration for the agent.
    Set_web_proxy
    (-s, --set)
    Sets the current Web proxy configuration for the agent.
    Proxy_type
    (-t, --proxy-type string)
    Agent supports the following proxy types:
    • http
    • socks4
    • socks5
    Note: If you do not provide the type, http is applied by default.
    Proxy_IP
    (-i, --host string)
    Valid IP or URL of proxy server.
    Port Respective proxy port number.
    Proxy_user
    (-u, --user string)
    Valid proxy user name. 
    Proxy_password
    (-p, --pass string)
    Valid proxy password.
    The Web proxy is configured successfully.
    Note: 
    • Do not use quotes for proxy_IP, proxy_user or proxy_password. 
    • In the terminal, run the following command in the Linux server to remove the Web proxy:
      HybridWorkloadsAgent web-proxy-config -r
      or
      HybridWorkloadsAgent web-proxy-config --remove
      or
      /opt/Druva/PhoenixOracle/bin/HybridWorkloadsAgent web-proxy-config -r
      or
      /opt/Druva/PhoenixOracle/bin/HybridWorkloadsAgent web-proxy-config --remove