Skip to main content

 

Druva Documentation

Add and activate a NAS proxy

Provides the steps to add and activate a NAS proxy on Phoenix Management Console.
Phoenix Editions: File:/tick.png Business File:/cross.png Enterprise File:/tick.png Elite

This section provides the steps to add and activate a NAS proxy through the Phoenix Management Console. This is the first step towards configuring Phoenix to back up a NAS share. 

To add and activate the NAS proxy you must:

  1. Add a NAS proxy through the Phoenix Management Console
  2. Install and activate a NAS proxy on a:
    1. Windows server
    2. Linux server

Considerations for adding a NAS proxy

Phoenix supports backups from SMB and NFS type of NAS shares.  To back up from SMB type NAS shares, you must install the NAS proxy on a Windows server. Similarly, if your NAS shares are of NFS type, you need to install the NAS proxy on a Linux server. 

Add a NAS proxy

  1. Log on to Phoenix Management Console.
  2. On the menu bar, click All Organizations and select the organization to which you can add the NAS device.
  3. On the menu bar, click NAS
  4. On the NAS page:
    1. If you are about to add the first NAS proxy, the following page appears.  click Add NAS proxy

      AddFirstNASProxy.png
       
    2. If you are about to add a NAS proxy to an existing list of NAS proxies, open the NAS proxy tab and click Add New NAS proxy

      AddNASProxy.png
       
  5. Click Next under Install Druva Phoenix Agent on the Add NAS proxy page.

    InstallPhoenixAgent.png

    The Click here link opens the web page from where you can download the NAS proxy installer. Download the Phoenix Agent installer, as it is NAS proxy is the same as the Phoenix Agent.  
  6. Under Generate Activation Token, provide the following details and click Next.

    GenActivToken.png
     
    Field Description
    Token Description
    (Mandatory field)
    A short description of the activation token. 

    This token can activate

    The number of servers that the activation token can activate.

    Default value: 25 servers

    The token expires in

    The number of days after which the activation token expires.

    Default value: 7 days

  7. Under Activation, click Copy to save the activation token to the clipboard. Use this token to activate the NAS proxy that you install on the Windows or Linux server.

    NASToken.png

    Phoenix stores these tokens and you can view and again copy them from Manage > Activation tokens on Phoenix Management Console.
  8. Click Finish

Install and activate NAS proxy on a Windows server

The NAS proxy is the Phoenix agent that handles backup and restore of NAS shares.  You must install the NAS proxy on a Windows server provided you plan to back up an SMB NAS share.

Before you begin

Ensure the following:

  • You are logged in as an administrator on the server on which you want to install the NAS proxy.
  • Your server matches the requirements listed under Support matrix for NAS proxy
  • You have downloaded the NAS proxy installer on the server. You can download the installer from the Druva downloads page. You can also download the installer from the Phoenix Management Console at the time of adding the NAS proxy. 

Install the NAS proxy

  1. Go to the location where you have downloaded the NAS proxy installer.
  2. Double-click the NAS proxy installer.
  3. Click Next
  4. In the Install location box, type or select the full path to the installation home directory. 
  5. Click Install.
  6. After the installation completes, click Finish.

Command line install:

Run the following command from the command prompt.

 msiexec /i <path to Phoenix msi> /qn /quiet /log <path to log file>

Configure web-proxy (optional) 

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

Considerations:

  • Ensure NAS proxy is running before you configure the proxy settings.
  • Druva supports only basic authentication with the web proxy.
  • Do not use quotes for <proxy_IP>, <proxy_user> or <proxy_password>.
  • The proxy configuration utility fails if any input parameter required to configure the proxy is missing. 

Procedure

  1. Open the command prompt window.
  2. Change the directory path to the location on your system, where you have installed the NAS proxy.
    Windows default: C:\Program Files\Druva\Phoenix Agent
  3. Run the following command:
    PhoenixNASControl.exe set_proxy_details -t <proxy_type> -i <proxy_IP>:<port> -u <proxy_user> -p <proxy_password>
       The attributes used in the above commend are explained below.
    Attribute 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 credentials.
    <proxy_password>
    After successfully configuring the proxy settings, the following message is displayed on the command prompt window.
    proxy details updated successfully.



     

Additional information

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

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

  1. The configuration file path for NAS proxy and Cache Server are as follows:
    OS Path

    Windows 

    C:\ProgramData\Phoenix\NAS\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 during the down time.
    • PROXY_USER
    • PROXY_SERVER
    • PROXY_TYPE
    • PROXY_PASSWD2

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

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

Activate the NAS proxy on Windows server

After you install the NAS proxy, you must activate it using the activation token generated on the Phoenix Management Console at the time of adding the proxy. The token functions as a unique identifier and performs a one-time authentication of the NAS proxy. After activation, NAS proxy establishes a persistent connection with Phoenix Cloud.                                    

Note: Druva recommends to use a single token to activate proxies that share something in common. For example, you may choose to use a token to activate proxies that back up and restore NAS shares assigned to the same department. 

To activate the NAS proxy:

  1. Obtain the activation token from Manage > Activation Token on Phoenix Management Console. 
  2. Open the command prompt window and navigate to the location where the NAS proxy .msi file is installed.
    Typically the location is C:\Program Files\Druva\Phoenix Agent.
  • For Phoenix Cloud: PhoenixNasControl.exe activate <token> 
  • For GovCloud: PhoenixNasControl.exe govcloud activate <token> 

In both the above commands, <token> is the activation token of the NAS proxy. 

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

 

Install and activate NAS proxy on a Linux server

The NAS proxy is the Phoenix Agent that handles backup and restore of NAS shares. You must install the NAS proxy on a Linux server provided you plan to back up an NFS NAS share.

Before you begin 

Ensure the following:

  • You are logged on as a root user on the server on which you want to install the Phoenix Agent.
  • Your server matches the requirements listed in  Support matrix for NAS proxy
  • You have downloaded the Phoenix agent installer on the server. You can download the installer from the Druva downloads page. You can also download the installer from the Phoenix Management Console at the time of adding the proxy. 

Install the NAS proxy on RHEL, CentOS, or SLES

  1.  Go to the directory that contains the NAS proxy installer.
  2. Run the command:
    rpm –ivh <package name>
    Where <package name> is the installer name with its extension.

 Install the NAS proxy on Ubuntu

  1. Go to the directory that contains the NAS proxy installer.
  2. Run the command:
    dpkg –i <package name>
    Where <package name> is the installer name with its extension.

Configure web-proxy (optional) 

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

Considerations

  • Ensure that the NAS proxy is running.
  • Use escape sequence for special characters if any. 
  • The web proxy configuration utility fails if any input attribute detail required to configure the proxy is missing or is not provided in the specified order.

Procedure

  1. Open the command prompt.
  2. Change the directory path to the location where you have installed the NAS proxy on your system.
    UNIX default: /opt/Druva/Phoenix
  3. Run the following command:
    PhoenixNasActivate set_proxy_details -t <proxy_type> -i <proxy_IP>:<port> -u <proxy_user> -p <proxy_password>
     The attributes used in the above commend are explained below.
    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 credentials.
    <proxy_password>
    After successfully configuring the web proxy,  the following message is displayed.
    proxy details updated successfully. 
     

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

Additional information

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

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

  • The configuration file path for NAS proxy and Cache Server is as follows:
    OS Path
    Linux     /etc/Phoenix/NAS/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
  • After deleting the proxy entries from Phoenix.cfg file, set USE_PROXY = FALSE in the same file.

Activate the NAS proxy on Linux server

After you install the NAS proxy, you must activate it using the activation token generated on the Phoenix Management Console at the time of adding the proxy. The token functions as a unique identifier and performs a one-time authentication of the NAS proxy. After activation, NAS proxy establishes a persistent connection with Phoenix Cloud.

The steps to activate the NAS proxy on CentOS, Ubuntu, RHEL, and SLES Linux are same.

Note: Druva recommends to use a single token to activate proxies that share something in common. For example, you may choose to use a token to activate proxies that back up and restore NAS shares assigned to the same department. 

To activate the NAS proxy on the Linux server:

  1. Open the command prompt.
  2. Go to opt/Druva/Phoenix/lib directory.
  3. Run the following command:
  • For Public Cloud: PhoenixNasActivate activate <token>
  • For GovCloud: PhoenixNasActivate govcloud activate <token>

 In both the above commands, <token> is the activation token for the NAS proxy.

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

  • Was this article helpful?