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 explains the following steps while setting up Phoenix to backup your MS-SQL server:

  1. Download and install the Phoenix agent 
  2. Activate the Phoenix agent
  3. (Optional) Configure web proxy on Windows

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.

Download and install the Phoenix agent

  1. Log in to the Phoenix Management Console.

  2. On the menu bar, click the drop-down next to All Organizations and select the organization in which you want to add the MS-SQL server.

  3. On the menu bar, click Protect > MS-SQL Servers.

  4. The Get Started page is displayed if no SQL servers have been configured so far.

    SQL Get started page.png
    On the Get-Started page, click Register New Server.
  5. If SQL servers have already been configured in your environment, you can register additional SQL servers, by clicking Register New Server from the All SQL Resources page.

    Register New Server.png
  6. In the Register New Server dialog box, click Check prerequisites to ensure that the MS-SQL server where you want to install the Phoenix agent meets the MS-SQL server requirements.
    Register New Server wizard.png
  7. Under the Download and install agent on the server section, click Download. Copy the installable to the MS-SQL server if you didn't download the agent from a Phoenix Management console open on the MS-SQL server.

  8. On the MS-SQL server, navigate to the location which has the Phoenix agent installer. 

  9. Double-click the Phoenix installer, and click Next.

  10. Use either the local system account or domain admin credentials while installing the agent. To use domain admin credentials, clear the Use Local System Account checkbox. Enter the domain account username in the format: domain\username
    Phoenix agent install.png
  11. In the Install location box, type or select the full path to the installation home directory. 

  12. Click Install.

  13. 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

Execute the following command from the command prompt:

 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.   

Activate the Phoenix agent

After you install the Phoenix agent on a Windows server, you must activate it 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.

  1. In the Register New Server wizard, under the Activate Server for Backup section, select a valid activation token. An activation token can be used to activate up to 25 servers and expires in 7 days. If all activation tokens have expired, Phoenix creates a Default Activation Token automatically when you click Register New Server.

    Generate a new token.png
     
  2. If you want to create a new token, perform the following tasks:

    1. Click Generate New Token.

    2. In the Generate Token dialog box, enter the following details, and click Generate.
    • Token Label: Enter a unique label for the activation token.
    • This token can activate: Enter the number of servers that can be activated using this token.
    • This token expires in: Enter the number of days after which this token will expire.
    • In the Generate Token dialog box, click Generate.
    1. Select the newly generated token from the drop-down list under Activation Token.
      Note: Phoenix lists the activation token under Manage > Activation Tokens. For more information, see  Manage activation tokens.
  3. If you’re using the CLI to activate the agent, click Copy Command.
    Copy command.png
    1. On the MS-SQL server, open a CLI and navigate to C:\Program Files\Druva\Phoenix Agent
    2. Paste the copied command and press Enter. You can also append the server name by editing the command to PhoenixActivate <activation token> --ServerName <Server Name>
      For GovCloud, the edited command is PhoenixActivate govcloud <activation token> --ServerName <Server Name>

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

  1. If you’re using the Phoenix agent shortcut to activate the agent, click Copy Token.
    Copy token.png
    1. On the MS-SQL server, double-click the Phoenix Agent shortcut. 
    2. In the Druva Phoenix dialog box, paste the copied token in the Enter Activation Token field.

      paste token.png
    3. Enter a unique server name in the Server Name field.
      Note: If you are activating the Phoenix agent for Phoenix cloud, do not select the GovCloud checkbox.
    4. Click Activate.

After activation, the registered server is visible under Protect > Windows/Linux Servers > Registered Servers page as well as the Protect > MS-SQL Servers > All SQL Resources page. The All SQL Resources page also displays the instances and availability groups hosted on the server.

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 in C:\Program Files\Druva\Phoenix Agent. For example, to change directory in CLI, you run: cd “C:\Program Files\Druva\Phoenix Agent”.
  3. In the 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

Details

Proxy_type

Druva supports the following proxy types:

  • http
  • socks4
  • socks5

Proxy_IP

Valid IP of the 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. 

The 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.

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

Next step

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