Skip to main content

How can we help you?

Druva Documentation

Install the agent and register a server

Phoenix 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 Phoenix generates an activation token that you must use to activate the instances of Hybrid Workloads agent installed on your servers. Activation ensures that the Hybrid 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 Hybrid Workloads agent installer, click Check Pre-requisite to check the Hybrid Workloads agent prerequisites. In the Select OS dropdown, select the operating system of the server where you will install the Hybrid 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 Hybrid 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 Hybrid Workloads agent has already been downloaded, proceed to the Activate Server for Backup section.

Downloadspage.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: Druva Phoenix 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 Hybrid Workloads agent on a Windows server

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

Before you begin

Before setting up Druva Phoenix 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 Hybrid 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. 

 

 
 

Watch video

 

Install the agent

  1. Go to the location where you have downloaded the Hybrid Workloads agent installer.
  2. Double-click the Hybrid 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> 
For example:
msiexec.exe/i C:\Users\Administrator\Downloads\Phoenix-6.0.1-154609.msi/qn/quiet/log C:\Users\Administrator\Downloads

Activate the agent

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

After authentication, Hybrid 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 Hybrid Workloads agent shortcut). 
    Downloadspage_cktkn.png
  2. Double-click the Hybrid Workloads Agent shortcut on the server where the Hybrid Workloads agent needs to be activated.
    The Hybrid Workloads Agent window displays.
    Activateagent.png
  3.  In the Hybrid Workloads Agent window, select FS & MS-SQL to activate. 
    The Agent Activation page for FS & MS-SQL is displayed.
    Fs_activatescreen.png
  4. 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.

    ​​Note: If you are activating the Hybrid Workloads agent for Druva Cloud, do not select the GovCloud check box.

  5. Click Activate

Command-line activation

If you choose to mass deploy Hybrid Workloads agents using third-party tools, you can use the command-line method to activate the Hybrid Workloads agent.  By default, HybridWorkloadsAgent.exe is located at the C:\Program Files\Druva\Phoenix Agent location. 

From the command prompt, run the following command:

  • For Druva Cloud:
    HybridWorkloadsAgent.exe fs-mssql activate -t <token> -n <ServerName>
    
    For example: 
    HybridWorkloadsAgent.exe fs-mssql activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
    PhoenixControl.exe activate <token> --ServerName <ServerName>

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

  • For GovCloud:
    HybridWorkloadsAgent.exe  fs-mssql activate -g -t <token> -n <ServerName>
    
    For example:
    HybridWorkloadsAgent.exe fs-mssql activate -g -t 32931-128-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-REFTY
Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
PhoenixControl.exe activate govcloud <token> --ServerName <ServerName>
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 Phoenix.
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 Phoenix will display the error message "Server display name already exists. Cannot register the server with same display name". 

You can upgrade Hybrid 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 Phoenix 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 Hybrid Workloads agent on a Linux server

 

Install on CentOS or RHEL Linux, or SLES 

  1. Go to the directory that contains Hybrid Workloads agent installer.
  2. Run the following command:
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.

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

Install on Ubuntu

  1. Go to the directory that contains 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
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 Hybrid Workloads agent, you must activate that Hybrid 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 Hybrid Workloads agents. After authentication, Hybrid Workloads agents establish a persistent connection with Druva Cloud. The instructions are the same for activating Hybrid 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. 
    Downloadspage_linux.png
  2. On the Linux server, open the terminal
    Note: If you are using an agent older than version 6.0.1-154928, navigate to opt/Druva/Phoenix/bin
  3. Paste the copied command as explained below:
  • Public Cloud

    HybridWorkloadsAgent fs activate -t <token> -n <ServerName>
    
    For example:
    HybridWorkloadsAgent fs activate -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
    PhoenixActivate <token> --ServerName <ServerName>
  • GovCloud

    HybridWorkloadsAgent fs activate -g -t <token> -n <ServerName>
    
    For example:
    HybridWorkloadsAgent fs activate -g -t 32931-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RFE3
    
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used: 
    PhoenixActivate govcloud <token> --ServerName <ServerName>

 where,

  • <token> represents the activation token that Druva Phoenix 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 Phoenix 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 Phoenix will display the error message "'Server display name already exists. Cannot register the server with same display name". 

On Linux servers, Hybrid Workloads agent writes logs to /var/log/Phoenix. 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 Phoenix picks up the hostname of the server by default and displays it in the Registered Servers page.

Configure Web proxy

Hybrid Workloads agent connects to the Druva Cloud through the internet. If your network infrastructure uses a Web proxy, configure the Hybrid 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 Hybrid Workloads agent is running before starting proxy settings.

Procedure

  1. Double-click the Hybrid 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.
      Webproxy.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 Hybrid 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 example:
    HybridWorkloadsAgent.exe web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
    PhoenixControl.exe set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password
  3. (Optional)You can use the following command in Windows to fetch the current proxy configuration:
    HybridWorkloadsAgent.exe web-proxy-config -g
  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 example:
    HybridWorkloadsAgent web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used: 
    PhoenixActivate set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password
  5. (Optional)You can use the following command in Linux 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. 

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 Hybrid Workloads agent and Cache Server are as follows:
    Agent Path

    Windows 

    C:\ProgramData\Phoenix\<WorkloadName>\Phoenix.cfg

    Linux /etc/Phoenix/<WorkloadName>/Phoenix.cfg
  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
    or
    HybridWorkloadsAgent.exe web-proxy-config –remove
  3. 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
    
    Note: Enter -r or –remove command to remove the Web proxy. 
Updating the configuration file
  1. Log in to the required server.
  2. Stop the Hybrid Workloads agent Services.
    Note: If you are using an agent older than version 6.0.1-154928,  navigate to :C:\ProgramData\Phoenix\<WorkloadName> 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 Hybrid Workloads agent Services.