Skip to main content
Druva Documentation

Add and activate a NAS proxy

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

This article describes how to install and activate a NAS proxy through the Phoenix Management Console. Registering a NAS Proxy is the first step towards configuring Phoenix to back up a NAS share. Registering a NAS proxy involves:

  1. Installing a NAS proxy
  2. Activating the NAS proxy

Considerations for adding a NAS proxy

Phoenix supports backups of SMB and NFS shares.  Install the NAS proxy on:

  • A Windows server to back up SMB shares.
  • A Linux server to back up NFS shares.

Step 1: Installing a NAS proxy

  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 NAS proxy.
  3. On the menu bar, click Protect NAS
  4. The Get Started page is displayed if no NAS devices have been configured so far. On the Get Started page, under Register a NAS proxy, you will see No Proxy Registered. Click Add Proxy.

    Get Started - No Proxy.png

    If NAS proxies and NAS devices have already been configured, you can add more proxies. In the left navigation pane, click All Proxies, and click Add Proxy.

    Add Proxy.png
     
  5. In the Add NAS Proxy dialog box, click Check Prerequisites and ensure that the server meets the prerequisites for the NAS proxy installation.

    Add NAS proxy - prereq highlight.png
  6. Depending upon the type of share that you want to back up, download the agent on the Windows/Linux server that will act as the NAS proxy.
    Share Type Download and install the following agent on the server
    SMB Windows 64-bit agent on the Windows server
    NFS Linux or Ubuntu agent on the Linux/Ubuntu server

Installing the NAS proxy on a Windows server

The NAS proxy handles the backup and restore of NAS shares. Install the NAS proxy on a Windows server if you want to back up SMB shares.  

  1. Log in as an administrator on the Windows server where you want to install the NAS proxy. 
  2. Navigate to the location where you've downloaded the NAS proxy installer. 
  3. Double-click the NAS proxy installer and on the Welcome screen click Next
  4. Accept the terms in the license agreement and privacy policy, and click Next
  5. Use the local system account for installing the agent. 
  6. In the Install location box, type the install path or browse to the installation home directory. 
  7. Click Install. 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>

Installing the NAS proxy on a Linux server

The NAS proxy handles the backup and restore of NAS shares. Install the NAS proxy on a Linux server if you want to back up NFS shares.

  1. Log in as the root user on the Linux server where you want to install the NAS proxy.
  2. Navigate to the location where you've downloaded the NAS proxy installer.
  3. Run the following command depending on the OS of the server
    Operating System Command
    RHEL, CentOS, or SLES rpm –ivh <package name>
    Where <package name> is the installer name with its extension.
    Ubuntu

    dpkg –i <package name>

    Where <package name> is the installer name with its extension.
     

Step 2: Activating the NAS proxy

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, the NAS proxy establishes a persistent connection with Phoenix Cloud. 

Activating the NAS proxy on a Windows Server

  1. In the Add NAS Proxy wizard, under the Activate Proxy section, select a valid activation token. An activation token can be used to activate up to 25 NAS proxies and expires in 7 days. If all activation tokens have expired, Phoenix creates a Default Activation Token automatically when you click Add Proxy.  If you want to create a new token, perform the following tasks:

    1. Click Generate New Token to create a new token. 
    2. In the Generate Token dialog box, enter the following details, and click Generate.
      Generate token.png
       
    3. In the Generate Token dialog box, click Done.
    4. Select the newly generated token from the drop-down list under Activation Token.
    5. In the Activate Proxy section, under Windows Server, click Copy Command to copy the activation command.

      Copy command Windows.png
       
  2. On the Windows server, open the command prompt and navigate to
    C:\Program Files\Druva\Phoenix Agent
  3. Paste the command and press Enter. For example
    For Phoenix Cloud:
    C:\Program Files\Druva\Phoenix Agent> PhoenixNasControl.exe activate <activation token>
    For Phoenix GovCloud:
    C:\Program Files\Druva\Phoenix Agent> PhoenixNasControl.exe activate govcloud <activation token>
    In both the above commands, <activation token> is the activation token of the NAS proxy. 

The NAS proxy name is not case sensitive. You cannot have one NAS proxy 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."

Activating the NAS proxy on a Linux Server

  1. In the Add NAS Proxy wizard, under the Activate Proxy section, select a valid activation token. An activation token can be used to activate up to 25 NAS proxies and expires in 7 days. If all activation tokens have expired, Phoenix creates a Default Activation Token automatically when you click Add Proxy.  If you want to create a new token, perform the following tasks:

    1. Click Generate New Token to create a new token.

    2. In the Generate Token dialog box, enter the following details, and click Generate.

      Generate token.png

    3. In the Generate Token dialog box, click Done.

    4. Select the newly generated token from the drop-down list under Activation Token.

    5. In the Activate Proxy section, under Linux/Ubuntu Server, click Copy Command to copy the activation command.
      Copy command Linux.png

    6. On the Linux server, open the terminal and navigate to
      /opt/Druva/Phoenix/bin

    7. Paste the command and press Enter. For example:
      For Phoenix Cloud:
      /opt/Druva/Phoenix/bin/PhoenixNasActivate activate <activation token>
      For Phoenix GovCloud:
      /opt/Druva/Phoenix/bin/PhoenixNasActivate activate govcloud <activation token>

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

The NAS proxy name is not case sensitive. You cannot have one NAS proxy 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."

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 that the 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>.
  • 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 window or terminal in Linux.
  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
    Linux default: /opt/Druva/Phoenix
  3. Run the following command in Windows:
    PhoenixNASControl.exe set_proxy_details -t <proxy_type> -i <proxy_IP>:<port> -u <proxy_user> -p <proxy_password>
      
  4. Run the following command in Linux:
    PhoenixNasActivate set_proxy_details -t <proxy_type> -i <proxy_IP>:<port> -u <proxy_user> -p <proxy_password>

The attributes in this command are explained in the following table:

Attribute Description
<proxy_type> Druva supports the following proxy types:
  • http
  • socks4
  • socks5

Http proxy interprets and forwards HTTP or HTTPS traffic between the client and the server.

Socks4 (Socket Secure) facilitates HTTP, HTTPS, POP3, SMTP, and FTP communication between clients and servers through a firewall. Socks4 does not interpret the traffic between the client and the server. Socks4 does not support UDP proxies and authentication.

Socks5 proxy is the same as a Socks4 proxy, but it supports a variety of authentication methods and is more secure. Socks5 also supports UDP proxies.

<proxy_IP> Enter a valid IP of proxy server.
<port> Enter the respective proxy port number.
<proxy_user> The -u parameter is optional. Enter a valid proxy username. Enter * for an unauthenticated proxy. 
<proxy_password> The -p parameter is optional. Enter a valid proxy password. Enter * for an unauthenticated proxy. 

After successfully configuring the proxy settings, the following message is displayed in the Windows command prompt window.
Proxy details updated successfully. 

After successfully configuring the proxy settings, the following message is displayed in the Linux terminal.

Additional information

  1. The Threat Management Gateway(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 is as follows:
    OS Path

    Windows 

    C:\ProgramData\Phoenix\NAS\Phoenix.cfg

    Linux /etc/Phoenix/NAS/Phoenix.cfg
  2. If you want to remove the proxy setting after successfully setting it up, then you must manually remove the following proxy entries from Phoenix.cfg file.
    • 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

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

  • Was this article helpful?