Skip to main content
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, Phoenix generates an activation token that you must use to activate the instances of Phoenix agent installed on your servers. Activation ensures that the Phoenix agent establishes a persistent connection with Phoenix 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 Phoenix Management Console.
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list.
  3. On the menu bar, click Protect > Windows/Linux Servers
  4. Click Register New Server.
  5. On the Register Server page, under the Download and Install Agent on the Server section, do one of the following: 
  • If you have not yet downloaded the Phoenix Agent installer, click Check Pre-requisite to check the Phoenix agent prerequisites. In the Select OS dropdown, select the operating system of the server where you will install the Phoenix 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 Phoenix Management Console on the destination server.
  • If the Phoenix agent has already been downloaded, proceed to the Activate Server for Backup section.

Download page - 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.
  2. 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.

    The token expires in

    The number of days after which the activation token expires.

    The default value is 7. 

  3. In the Generate Token window, click Copy Token to copy the token to clipboard, and then click Done.
    Token generated successfully.png
Note: Phoenix lists the activation token under Manage > Activation Tokens
  1. To use a pre-existing activation token, click the drop-down under the Activation Token field, select the activation token, and then click Copy Token.

Pre-existing Activation Token.png
 

Install and activate Phoenix agent on a Windows server

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

Before you begin

 
 
 
Page path to reuse: Phoenix/030_Configure_Phoenix_for_Backup/030_Backup_and_Restore_File_servers/020_Deploy_Phoenix_File_server_agent/005_Prerequisites
Section: Before you begin

 

 
 
 

Install the agent

  1. Go to the location where you have downloaded the Phoenix Agent installer.
  2. Double-click the Phoenix installer.
  3. Click Next
  4. Use local system account for installing the agent on the Windows server. 
  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> 

Configure web-proxy (optional)

Phoenix agent connects to the Phoenix Cloud through the internet. If your network infrastructure uses a web-proxy, configure the Phoenix agent to use web-proxy to establish a connection with the Phoenix Cloud. 

Before you begin

Before you begin, ensure that Phoenix client is running before you start proxy settings.

Procedure

  1. Open the command line interface window.
  2. Change the directory path to the location on your system, where Phoenix Agent is installed.
    Windows default: C:\Program Files\Druva\Phoenix Agent
  3. On command prompt, run the following command:
    PhoenixControl.exe set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password
     
    Field Description
    Proxy_type Druva supports the following proxy types:
    • http
    • socks4
    • socks5
    Proxy_IP Valid IP of proxy server.
    Port Respective proxy port number.
    Proxy_user Valid proxy user name. Enter * for an unauthenticated proxy. 
    Proxy_password Valid proxy password. Enter * for an unauthenticated proxy. 

Note: Druva only supports basic authentication with web proxy.

The web-proxy is configured successfully.

 

Note: Do not use quotes for proxy_IP, proxy_user or proxy_password. All the parameters must be present, if any input parameter is missing or not in prescribed order, then the utility will fail.

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

    Windows 

    C:\ProgramData\Phoenix\Phoenix.cfg

  2. If you want to remove proxy setting after successfully setting it up, then you must manually remove following proxy entries from Phoenix.cfg.
    • PROXY_USER
    • PROXY_SERVER
    • PROXY_TYPE
    • PROXY_PASSWD2

    Note: After deleting the above listed entries, set USE_PROXY = False in same file.

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

Activate the agent

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

After authentication, Phoenix agents establish a persistent connection with Phoenix 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. 

Procedure

  1. Copy the activation token that Phoenix generated. 
  2. Double-click the Phoenix agent shortcut. The Druva Phoenix window is displayed:

    <Replace the image above with the following>

    Enter Activation Token.png

     
  3. Enter the following details: 
    Field  Description

    Enter Activation Token

    Enter the activation token generated while registering server.

    Server Name

    A unique server name.

    Note: The server name should not contain any special characters.

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

  4. Click Activate

Note: Set the client to standard time zone.

  • For the client version below 4.0, if  you set  the client  to a local time zone, you will get an "Internal Error".
  • For the client version 4.0 and above, if  you set  the client to a local time zone, you will get the following error.

Command-line activation

If you choose to mass deploy Phoenix agents using third-party tools, you can use the command-line method to activate the Phoenix Agent.  By default, PhoenixControl.exe is located at the C:\Program Files\Druva\Phoenix Agent location. To activate the client, you can run PhoenixControl.exe from any location.

From the command prompt, run the following command:

  • For Phoenix Cloud:
PhoenixControl.exe activate <token> --ServerName <ServerName> 

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

  • For GovCloud:
PhoenixControl.exe activate govcloud <token> --ServerName <ServerName>

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

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

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 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 Phoenix agent on a Linux server

Before you begin

 
 
 
Page path to reuse: Phoenix/030_Configure_Phoenix_for_Backup/030_Backup_and_Restore_File_servers/020_Deploy_Phoenix_File_server_agent/005_Prerequisites
Section: Before you begin

 

 
 
 

Install on CentOS or RHEL Linux, or SLES 

  1. Go to the directory that contains Phoenix Agent installer.
  2. Run the following command:
rpm –ivh <package name>

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

Install on Ubuntu

  1. Go to the directory that contains Phoenix Agent installer.
  2. Run the following command:
dpkg -i <package_name>

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

Configure web-proxy (optional)

Phoenix agent connects to the Phoenix Cloud through the internet. If your network infrastructure uses a web-proxy, configure the Phoenix agent to use web-proxy to establish a connection with the Phoenix Cloud. 

Before you begin

Before you begin, ensure that the Phoenix agent is running.

Procedure

  1. Open the command line prompt.
  2. Change the directory path to the location where Phoenix agent is installed on your system.
    UNIX default: /opt/Druva/Phoenix/bin
  3. Run the following command:
    PhoenixActivate set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password  
    Attribute Details
    Proxy_type Druva supports the following proxy types:
    • http
    • socks4
    • socks5
    Proxy_IP Valid IP of proxy server.
    Port Respective proxy port number.
    Proxy_user Valid proxy user name.
    Proxy_password Valid proxy password.

The Phoenix agent is now configured to use the web-proxy.

Note: Use escape sequence for special characters if any. All the parameters must be present. The command will fail, if any input parameter is missing or not in the prescribed order.

Additional information

  • The TMG drops the idle connections after defined timeout duration, due to which client does an aggressive retry with server.

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

  • The configuration file path for Phoenix client and Cache Server is as follows:
    Client Path
    Linux     /etc/Phoenix/Phoenix.cfg
  • If you want to remove proxy setting after successfully setting it up, you must manually remove following proxy  entries from the Phoenix.cfg file.
    • PROXY_USER
    • PROXY_SERVER
    • PROXY_TYPE
    • PROXY_PASSWD2

    Note: After deleting the above listed entries, set USE_PROXY = False in same file.​

Activate the agent

After you install Phoenix agent, you must activate that Phoenix 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 Phoenix agents.

After authentication, Phoenix agents establish a persistent connection with Phoenix Cloud.

The instructions are same for activating Phoenix 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.

Procedure

  1. Open the command prompt.
  2. Go to the following directory.
    opt/Druva/Phoenix/bin
  3. Run the following command:
  • Public Cloud

PhoenixActivate <token> --ServerName <ServerName>
  • GovCloud

PhoenixActivate govcloud <token> --ServerName <ServerName>

 where,

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

On Linux servers, Phoenix 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 Phoenix picks up the hostname of the server by default and displays it in the Registered Servers page.