Skip to main content


 

 

How can we help you?

 

 
Druva Documentation

Install the agent and register a 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

 

To enable data backup from your servers, you must first register those servers. During registration, Druva generates an activation token that you must use to activate the instances of Enterprise Workloads agent installed on your servers. Activation ensures that the Enterprise Workloads agent establishes a persistent connection with Druva Cloud, thus enabling backups from the servers on which they are installed.   

This article includes the following sections:

Download the agent and generate activation token

  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. Click Register New Server.
  4. On the Register Server page, under the Download and Install Agent on the Server section, do one of the following: 
  1. If you have not yet downloaded the Enterprise Workloads agent installer, click Check Pre-requisite to check the Enterprise Workloads agent prerequisites. In the Select OS dropdown, select the operating system of the server where you will install the Enterprise Workloads agent, and then click Download. The agent download starts on the same browser page. The agent is not downloaded on the destination server unless you click Download through the Management Console on the destination server.
    Note: Using this Enterprise Workloads agent, you can protect MS SQL, NAS, and Hyper-V workloads on a Windows Server or Linux Server. For more information, see Common agent installation and activation.
  2. If the Enterprise Workloads agent has already been downloaded, proceed to the Activate Server for Backup section.
    Register new server.png
  1. 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.  If this token has expired, click Generate New Token. In the Generate Token dialog box, enter the following details, and then click Generate.

    Field

    Description

    Token Label

    A short description of the activation token.

    Note: You cannot leave this field empty.

    This token can activate

    The number of servers that the activation token can activate. The default value is 25 servers.

    The token expires in

    The number of days after which the activation token expires. The default value is 7 days. 

  2. In the Generate Token window, you can copy the generated token by clicking the Copy Token icon. Click Done
    Token generated successfully.png
Note: Enterprise Workloads agent lists the activation token under Manage > Activation Tokens.  For more information on  managing activation tokens, see Manage activation tokens
  1. To use a pre-existing activation token, click the drop-down under the Activation Token field.

Pre-existing Activation Token.png

Install and activate Enterprise Workloads agent on a Windows server

This topic provides information about how you can install Enterprise Workloads agent on a File server with Windows operating system.

Before you begin

Before setting up Druva to back up your files and folder, review the following requirements:

  • You are logged in as an administrator to the server that you want to back up.
  • Click Download on the Register New Server page to download the Enterprise Workloads agent installer on your server. The installer is available on the Druva Downloads page.
  • Ensure that Local System Account has read and write permissions for all the files and folders you configure for backup.
  • If you plan to create a new content rule at the time of configuration, read About File server content rule to know the best practices for creating content rules. 
  • If you plan to create a new backup policy at the time of configuration, read About File server backup policies to know the best practices for creating backup policies. 

 

 
 

Install the agent

  1. Go to the location where you have downloaded the Enterprise Workloads agent installer.
  2. Double-click the Enterprise Workloads agent installer.
  3. Click Next
  4. Use local system account for installing the agent on the Windows server. 
    Note: Ensure that the available disk space is at least twice the size of the installer file.
  5. In the Install location box, type or select the full path to the installation home directory. 
  6. Click Install.
  7. After the installation completes, click Finish.

Command-line install

  • From the command prompt, run the following command:
msiexec /i <path to Phoenix msi> /qn /quiet /log <path to log file> /norestart (for agent version prior to 7.0.0)

msiexec /i <path to EnterpriseWorklaods msi> /qn /quiet /log <path to log file> /norestart (for agent version 7.0.0 and later)
For example:
msiexec.exe/i C:\Users\Administrator\Downloads\Phoenix-6.3.5-440885.msi /qn /quiet /log C:\Users\Administrator\Downloads (for agent version prior to 7.0.0)

msiexec.exe/i C:\Users\Administrator\Downloads\EnterpriseWorkloads-UnifiedAgent-7.0.0-446266.msi/qn /quiet /log C:\Users\Administrator\Downloads (for agent version 7.0.0 and later)

Activate the agent  

After you install Enterprise Workloads agent on a Windows server, you must activate that Enterprise Workloads agent using the activation token that Druva generated at the time of registering servers. The token functions as a unique identifier and performs a one-time authentication of Enterprise Workloads agents.

After authentication, Enterprise Workloads agents establish a persistent connection with Druva Cloud.

Note:
  • We recommend that you use a single token to activate servers that share something in common. For example, you might want to use a token to activate all servers that are geographically co-located. 
  • If your network infrastructure uses a Web proxy, you must configure it before activation. For more information, see Configure Web proxy.

Procedure

  1. From the Register New Server dialog box in the Management Console, click  Copy Command to copy the activation token command (CLI activation) or Copy Token (activation via  the Enterprise Workloads agent shortcut). 
    Register new server.png
     
  2. Double-click the Enterprise Workloads Agent shortcut on the server where the Enterprise Workloads agent needs to be activated.
    The Enterprise Workloads Agent window displays.
    activation1.png
     
  3. Select FS & MS-SQL under Agent Activation section,  
  4. Select the type of Cloud deployment: Public Cloud or Gov Cloud. 
  5. A set of in-built activation checks are run and the result is displayed. Click Next.
    fs_activation_chk1.png
     
  6. The Agent Activation page for FS & MS-SQL is displayed.
    fs_agent_activation_new.png
     
  7. Enter the following details: 
    Field  Description
    Activation Token Paste the copied activation token.
    Note: This is the token copied from the Register New Server dialog box. 
    Server Name Enter a unique server name in the current Organization for each workload of the same type.
    Note: The server name should not contain any special characters.
  8. Click Activate
    The backup readiness checks will run to ensure that your system is equipped for successful backup operation.
     

Command-line activation

If you choose to mass deploy Enterprise Workloads agents using third-party tools, you can use the command-line method to activate the Enterprise Workloads agent.  By default,

  • HybridWorkloadsAgent.exe is located at C:\Program Files\Druva\Phoenix Agent (for agent version prior to 7.0.0)
  • EnterpriseWorkloadsAgent.exe is located at C:\Program Files\Druva\EnterpriseWorkloads (for agent version 7.0.0 and later)

From the command prompt, run the following command:

  • For Druva Cloud:
    HybridWorkloadsAgent.exe fs-mssql activate -t <token> -n <ServerName> (for agent version prior to 7.0.0)
    For example: 
    HybridWorkloadsAgent.exe fs-mssql activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
    EnterpriseWorkloadsAgent.exe fs-mssql activate -t <token> -n <ServerName> (for agent version 7.0.0 and later)
    For example:
    EnterpriseWorkloadsAgent.exe fs-mssql activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    

 where <token> represents the activation token that Druva generated at the time of registering server.

  • For GovCloud:
    HybridWorkloadsAgent.exe  fs-mssql activate -g -t <token> -n <ServerName> (for agent version prior to 7.0.0)
    For example:
    HybridWorkloadsAgent.exe fs-mssql activate -g -t 32931-128-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-REFTY 
    
    EnterpriseWorkloadsAgent.exe fs-mssql activate -g -t <token> -n <ServerName> (for agent version 7.0.0 and later)
    For example:
    EnterpriseWorkloadsAgent.exe fs-mssql activate -g -t 32931-128-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-REFTY
Field  Description
token
(-t, --token string)

Paste the copied activation.

Note: This is the token copied from the Register New Server dialog box.

ServerName
(-n, --ServerDisplayName string)
Provide the display name for the client in Druva.
GovCloud
( -g, --gov-cloud)
Enable GovCloud.

Note:  The  server name is not case sensitive. You cannot have one server registered as "ABC and another as "abc". Druva will display the error message "Server display name already exists. Cannot register the server with same display name". 

You can upgrade Enterprise Workloads agents to their latest available version. For more information, see Agent upgrades.

The ServerName parameter is optional. The defined server name is displayed on the Registered Servers page if you provide the server name. If you do not provide a server name, then Druva picks up the hostname of the server by default and displays it in the Registered Servers page.

To back up networked storage, see Backup and restore NAS shares

Install and activate Enterprise Workloads agent on a Linux server

 

Install on CentOS or RHEL Linux, or SLES 

  1. Go to the directory that contains Enterprise Workloads agent installer.
  2. Run the following command:
rpm –ivh <package name>
For example:
rpm –ivh druva-phoenix-client-7.0.0-131748.x86_64.rpm (for agent version prior to 7.0.0)
rpm -ivh EnterpriseWorkloads-UnifiedAgent-7.0.0-447428-x86_64.rpm (for agent version 7.0.0 and later)
Note: Ensure that the available disk space is at least twice the size of the installer file.

where <package name> represents the file name (along with the extension) of the installer.

Install on Ubuntu

  1. Go to the directory that contains Enterprise Workloads agent installer.
  2. Run the following command:
dpkg -i <package_name>
For example:
dpkg -i druva-phoenix-client-6.3.5-131748.amd64.deb (for agent version prior to 7.0.0)

dpkg -i EnterpriseWorkloads-UnifiedAgent-7.0.0-447428-amd64.deb (for agent version 7.0.0 and later)
Note: Ensure that the available disk space is at least twice the size of the installer file.

where <package name> represents the file name (along with the extension) of the installer.

Activate the agent

After you install Enterprise Workloads agent, you must activate that Enterprise Workloads agent by using the activation token generated at the time of registering servers. The token functions as a unique identifier and performs a one-time authentication of Enterprise Workloads agents. After authentication, Enterprise Workloads agents establish a persistent connection with Druva Cloud. The instructions are the same for activating Enterprise Workloads agent on CentOS, Ubuntu, RHEL, and SLES Linux.

Note:

  • We recommend that you use a single token to activate servers that share something in common. For example, you might want to use a token to activate all servers that are geographically co-located. 
  • If your network infrastructure uses a Web proxy, you must configure it before activation. For more information, see Configure Web proxy.

Procedure

  1. From the Register New Server dialog box in the Management Console, click  Copy Command to copy the activation token. 
     
  2. On the Linux server, open the terminal and navigate to:
  • opt/Druva/Phoenix/bin (for agent version prior to 7.0.0)
  • /opt/Druva/EnterpriseWorkloads/ (for agent version 7.0.0 and later)
  1. Paste the copied command as explained below:
  • Public Cloud

    HybridWorkloadsAgent fs activate -t <token> -n <ServerName> (for agent version prior to 7.0.0)
    For example:
    HybridWorkloadsAgent fs activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
    EnterpriseWorkloadsAgent fs activate -t <token> -n <ServerName> (for agent version 7.0.0 and later)
    For example:
    EnterpriseWorkloadsAgent fs activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
  • GovCloud

    HybridWorkloadsAgent fs activate -g -t <token> -n <ServerName> (for agent version prior to 7.0.0)
    For example:
    HybridWorkloadsAgent fs activate -g -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
    EnterpriseWorkloadsAgent fs activate -g -t <token> -n <ServerName> (for agent version 7.0.0 and later)
    For example:
    EnterpriseWorkloadsAgent fs activate -g -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    

 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.

Note: The  Server Name is not case sensitive. You cannot have one server registered as "ABC and another as "abc". Druva will display the error message "'Server display name already exists. Cannot register the server with same display name". 

On Linux servers, Enterprise Workloads agent writes logs to /var/log/Phoenix (for agent version prior to 7.0.0) and /var/log/Druva (for agent version 7.0.0 and later). The free space at this location should be at least 1% of your source data size.

The ServerName parameter is optional. If you provide the server name, then the defined server name is displayed in the Registered Servers page. If you do not provide a server name, then Druva picks up the hostname of the server by default and displays it in the Registered Servers page.

Configure Web proxy

Enterprise Workloads agent connects to the Druva Cloud through the internet. If your network infrastructure uses a Web proxy, configure the Enterprise Workloads agent to use Web proxy to establish a connection with the Druva Cloud. You can configure the Web proxy either from the user interface or command line.

Configure Web proxy using the user interface

This procedure applies only to Windows servers. 

Before you begin

Ensure that Enterprise Workloads agent is running before starting proxy settings.

Procedure

  1. Double-click the Enterprise Workloads Agent application. 
  2. In the Agent Activation window, select Configure Web Proxy.
    1. Select the My network infrastructure uses a Web proxy check box to enter the details.
      The Web Proxy options are displayed.
      fs_web_proxy.png
       
    2. In the Proxy Type drop-down list, select one of the supported proxy types(http, socks4, socks5). The default selection is http
    3. In the Proxy Server IP Address field, enter a valid IP address of the proxy server.
    4. In the Proxy Port field, enter the respective port number.
    5. If you want to add authentication to your proxy server, select the Proxy server requires authentication check box and add relevant username and password in their respective fields.
  3. Click Save.
    The Web proxy is configured.

Configure Web proxy servers using the command line

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

Procedure

  1. Open the command line interface window.
  2. In the command prompt, run the following command on Windows server to set the Web proxy:
    HybridWorkloadsAgent.exe web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password> (for agent version prior to 7.0.0)
    
    Enterprise WorkloadsAgent.exe web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password> (for agent version 7.0.0 and later)
    
    For example:
    HybridWorkloadsAgent.exe web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    
    Enterprise WorkloadsAgent.exe web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23 
    
  3. (Optional)You can use the following command in Windows to fetch the current proxy configuration:
    HybridWorkloadsAgent.exe web-proxy-config -g (for agent version prior to 7.0.0)
    
    Enterprise WorkloadsAgent.exe web-proxy-config -g (for agent version 7.0.0 and later)
    
  4. In the terminal, run the following command on Linux server to set the Web proxy:
    HybridWorkloadsAgent web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password> (for agent version prior to 7.0.0)
    
    Enterprise WorkloadsAgent web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password> (for agent version 7.0.0 and later) 
    
    For example:
    HybridWorkloadsAgent web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    
    Enterprise WorkloadsAgent web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    
  5. (Optional)You can use the following command in Linux to fetch the current proxy configuration:
    HybridWorkloadsAgent web-proxy-config -g (for agent version prior to 7.0.0)
    
    Enterprise WorkloadsAgent web-proxy-config -g (for agent version 7.0.0 and later)
    
    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. 

Additional information

  1. The TMG drops IDLE connections after defined timeout duration, due to which agent does an aggressive retry with server.

    Note: In TMG application, it is recommended to set connection timeout value to 5 minutes.

  1. The configuration file path for Workload agent and Cache Server are as follows:
    Agent Path

    Windows 

    • C:\ProgramData\Phoenix\<WorkloadName>\Phoenix.cfg (for agent version prior to 7.0.0)
    • C:\ProgramData\Druva\EnterpriseWorkloads\Config.yaml (for agent version 7.0.0 and later)
    Linux

    /etc/Phoenix/<WorkloadName>/Phoenix.cfg (for agent version prior to 7.0.0)

    /etc/Druva/EnterpriseWorkloads/Config.yaml (for agent version 7.0.0 and later)

  2. If the proxy-details setting fails, ping the proxy-server IP from same machine and check for proxy_user and proxy_password.

Steps to delete a Web proxy once it is set up successfully

You can delete the successful set up Web proxy in the following three ways.

Using the user interface

This is applicable only to Windows Servers.

  1. Clear the My network infrastructure uses a Web proxy check box.
  2. Click Save.
Using the command line
  1. Open the command line interface window.
  2. In the command prompt, run the following command on the Windows server to remove the Web proxy: 
    HybridWorkloadsAgent.exe web-proxy-config -r (for agent version prior to 7.0.0)
    
    EnterpriseWorkloadsAgent.exe web-proxy-config -r (for agent version 7.0.0 and later)
    
    or
    HybridWorkloadsAgent.exe web-proxy-config –remove
    
    EnterpriseWorkloadsAgent.exe web-proxy-config -remove (for agent version 7.0.0 and later)
    
  3. In the terminal, run the following command in the Linux server to remove the Web proxy:
    HybridWorkloadsAgent web-proxy-config -r (for agent version prior to 7.0.0)
    
    EnterpriseWorkloadsAgent web-proxy-config -r (for agent version 7.0.0 and later)
    
    or
    HybridWorkloadsAgent web-proxy-config --remove (for agent version prior to 7.0.0)
    
    EnterpriseWorkloadsAgent web-proxy-config -remove (for agent version 7.0.0 and later)
    
    Note: Enter -r or –remove command to remove the Web proxy. 
Updating the configuration file
  1. Log in to the required server.
    Note:  For agent version 7.0.0 and later, do not perform  the below steps from 2-6. To verify if proxy is unset or not, go to C:\ProgramData\Druva\EnterpriseWorkloads\Config.yaml, and verify the following parameters:
    proxy_config: enabled: false, 
    host: ""
    password: ""
    port: ""
    proxy_type: ""
    username: "”
  2. Stop the Enterprise Workloads agent Services, navigate to C:\ProgramData\Phoenix\<WorkloadName> (for agent version prior to 7.0.0),  and copy the Phoenix.cfg file.
  1. Open the Phoenix.cfg with notepad and remove the below entries:
    • PROXY_USER
    • PROXY_SERVER
    • PROXY_TYPE
    • PROXY_PASSWD2
  2.  Set "USE_PROXY = False" in the same file. (Only values in a double quote)
  3. Save the Phoenix.cfg file.
  4. Start the Enterprise Workloads agent Services.