Skip to main content
Druva Documentation

Install the agent and register an MS-SQL server

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

This article provides the following steps to set up Phoenix on your server:

  1. Install the agent on your server
  2. (Optional) Configure web proxy on Windows
  3. Generate activation token
  4. Activate the agent

Before you begin

Before you can set up Phoenix in your infrastructure, ensure that you have configured organizations and administrators. For more information, see Quick steps to set up Phoenix to back up databases.

Ensure that you read through the system requirements and prerequisites.

Step 1: Install the agent on your server

  1. Download the Phoenix agent installer from the Downloads page.
  2. Go to the location where you have downloaded the Phoenix Agent installer.
  3. Double-click the Phoenix installer.
  4. Click Next
  5. Use either the local system account or domain admin credentials while installing the agent. Deselect the Use Local System Account option to use domain admin credentials.  Provide the domain account username in the format: domain\username
  6. In the Install location box, type or select the full path to the installation home directory. 
  7. Click Install.
  8. After the installation completes, click Finish.

 If you use the domain user account at the time of installing the agent, ensure that you create the domain user account credentials in the credential store and then use those credentials. Credentials stored in the Credential store persist through upgrades. For more information see Credential Store.

Command-line install

  • From the command prompt, run the following command:
 msiexec /i <path to Phoenix msi> /qn /quiet /log <path to log file>

Note: If you install the agent using the command line instruction, the agent is installed with the local system administrator account. You cannot provide the domain account credentials if you use this method.   

Step 2: (Optional) Configure Web proxy on Windows

Phoenix agent communicates with Phoenix Cloud through the internet to perform authentication, activation, and registration. If your server falls under a network configuration that uses a Web proxy, it is possible that Phoenix agent fails to communicate with Phoenix Cloud because of your network settings. Perform the following steps to configure the Phoenix agent so that it can communicate with Phoenix Cloud through the Web proxy in your network infrastructure.

Before you begin, ensure that Phoenix agent is installed and running before you start proxy settings.

Configure Web proxy 

  1. Open the command line interface window.
  2. In the command line interface, change the directory with which the CLI opens to the directory where Phoenix agent is installed.
    By default, Phoenix agent is installed on: C:\Program Files\Druva\Phoenix Agent.
    For example, to change directory in CLI, you run: cd “C:\Program Files\Druva\Phoenix Agent”
    1. 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




      Druva supports the following proxy types:

      • http
      • socks4
      • socks5


      Valid IP of the proxy server.


      Respective proxy port number.


      Valid proxy user name. Enter * for an unauthenticated proxy.


      Valid proxy password. Enter * for an unauthenticated proxy. 

  3. Web proxy is installed successfully.

Note: Druva only supports basic authentication with Web proxy.

Additional information  

  • The Threat Management Gateway (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.

  • The configuration file path for Phoenix Client and Cache Server are as follows:

    For windows agent: C:\ProgramData\Phoenix\Phoenix.cfg

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

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

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

Step 3: Generate the activation token

  1. Log on to the Phoenix Management Console,
  2. On the menu bar, click All Organizations, and select the organization in which you want to add your MS-SQL server.
  3. On the menu bar, click Protect > MS-SQL Servers.
  4. On the MS-SQL page and click Register New Server.
    Click Get Started - Register New Server if you are registering a server for the first time. 
  5. When you click Register New Server, the Register Server wizard opens. The Register Server wizard contains three sections: Install Druva Phoenix AgentGenerate Activation Token, and Server Activation.
  6. The Install Druva Phoenix Agent section lets you download the agent executable that you run on your server to install the agent.
  7.  click Next. The Generate Activation Token section lets you specify a token description, the number of servers you want to register, and set a validity of the token. By default, can use a token to register 25 servers within 7 days.
  8. The Server Activation section displays the activation token required to activate the agent. Copy the activation token, and click Finish.

Note: Phoenix lists the activation token under Manage > Activation Tokens. For more information, see  Manage activation tokens.

Step 4: 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. 


  1. Copy the activation token that Phoenix generated. 
  2. Double-click the Phoenix agent shortcut. The Druva Phoenix window is displayed:
  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, the agent 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 the 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.

On the Phoenix Management Console, the activated server is registered under the organization you selected in step 1. To see the instances or the availability group available for the server, log on to Phoenix Management Console, select the organization, and click Protect > MS-SQL Servers > All SQL Resources tab.

Next step

After your SQL server is registered, you can configure it for backup.