Skip to main content

How can we help you?

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 Management Console. Registering a NAS Proxy is the first step towards configuring Druva to back up a NAS share. Registering a NAS proxy involves:

  1. Installing a NAS proxy
  2. Activating the NAS proxy
  3. Configure Web proxy

Considerations for adding a NAS proxy

Druva 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 Management Console.
  2. Select the workload from the Protect menu. Note that if the All Organizations menu is enabled, you have to first select an organization where you want to add the NAS proxy, and then select the workload.
  3. 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
     
  4. In the Add NAS Proxy dialog box, click Check Prerequisites and ensure that the server meets the prerequisites for the NAS proxy installation.

    Downloadspage_NAS.png
  5. 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.
    Note: Using this Hybrid Workloads agent, you can protect MS SQL, File Servers, and Hyper-V workloads on a Windows Server or Linux Server. For more information, see Common agent installation and activation.
    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>
For example:
msiexec.exe/i C:\Users\Administrator\Downloads\Phoenix-6.0.1-154609.msi /qn/quiet/log C:\Users\Administrator\Downloads

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 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 Druva Cloud. 

Note: If your network infrastructure uses a Web proxy, you must configure it before activation. For more information, see Configure {{webproxy}}.

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, Druva 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.
      Downloadspage_NAS_cptkn.png
  2. On the Windows server, open the command prompt.
    Note: If you are using an agent older than version 6.0.1-154928,  navigate to C:\Program Files\Druva\Phoenix Agent .
  3. Paste the command and press Enter. You can also append the server name by editing the command:
    • For Druva Cloud:
      HybridWorkloadsAgent.exe nas activate -t <token> -n <ProxyName>
      
      For example: 
      HybridWorkloadsAgent.exe nas activate -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
      
      Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
      PhoenixNasControl.exe activate <activation token>

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

  • For GovCloud:
    HybridWorkloadsAgent.exe nas activate –g -t <token> -n <ProxyName>
    
    For example:
    HybridWorkloadsAgent.exe nas activate -g -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
    
Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
PhoenixNasControl.exe activate govcloud <activation token>
Field  Description
token
(-t, --token string)

Paste the copied activation.

Note: This is the token copied from the Add NAS Proxy dialog box.

ProxyName
(-n, --ServerDisplayName string)
Enter a unique proxy name in the current Organization for each workload of the same type.
GovCloud
( -g, --gov-cloud)
Enable GovCloud.

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". Druva will display the error message "Server display name already exists. Cannot register the server with same display name."

 

  1. If you’re using the Hybrid Workloads Agent shortcut to activate the agent, click Copy Token.
    1. Double-click the Hybrid Workloads Agent shortcut on the Windows server where the Hybrid Workloads Agent needs to be activated. 
      The Hybrid Workloads Agent window is displayed.
      Activation_screen.png
    2. In the Hybrid Workloads Agent window, select NAS to activate. 
      The Agent Activation page for NAS is displayed.
      NAS_activate.png
    3. Enter the following details:
Field  Description
Activation Token Paste the copied activation token.
Note: This is the token copied from the Add NAS Proxy dialog box. 
Proxy Name Enter a unique proxy name in the current Organization for each workload of the same type.
Note: The proxy name should not contain any special characters.

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

  1. Click Activate
    The NAS agent is activated successfully.
    Note: After successful activation, a green tick displays next to the workload on the mentioned common agent activation screen.

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, Druva 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.
      Downloadspage_NAS_linux.png

    6. On the Linux server, open the terminal
      Note: If you are using an agent older than version 6.0.1-155102, navigate to opt/Druva/Phoenix/bin
    7. Paste the copied command as explained below:
      • Public Cloud

        HybridWorkloadsAgent nas activate -t <token> -n <ProxyName>
        
        For example:
        HybridWorkloadsAgent nas activate -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
        
        Note: If you are using an agent older than version 6.0.1-155102, the following command can be used:
        PhoenixNasControl activate <activation token>
      • GovCloud

        HybridWorkloadsAgent nas activate –g -t <token> -n <ProxyName>
        
        For example:
        HybridWorkloadsAgent nas activate -g -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
        
        Note: If you are using an agent older than version 6.0.1-155102, the following command can be used: 
        PhoenixNasControl 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". Druva will display the error message "Server display name already exists. Cannot register the server with same display name."

Configure Web proxy

Hybrid Workloads agent connects to the Druva Cloud through the internet. If your network infrastructure uses a Web proxy, configure the Hybrid Workloads agent to use Web proxy to establish a connection with the Druva Cloud. You can configure the Web proxy either from the user interface or command line.

Configure Web proxy using the user interface

This procedure applies only to Windows servers. 

Before you begin

Ensure that Hybrid Workloads agent is running before starting proxy settings.

Procedure

  1. Double-click the Hybrid Workloads Agent application. 
  2. In the Agent Activation window, select Configure Web Proxy.
    1. Select the My network infrastructure uses a Web proxy check box to enter the details.
      The Web Proxy options are displayed.
      Webproxy.png
    2. In the Proxy Type drop-down list, select one of the supported proxy types(http, socks4, socks5). The default selection is http
    3. In the Proxy Server IP Address field, enter a valid IP address of the proxy server.
    4. In the Proxy Port field, enter the respective port number.
    5. If you want to add authentication to your proxy server, select the Proxy server requires authentication check box and add relevant username and password in their respective fields.
  3. Click Save.
    The Web proxy is configured.

Configure Web proxy servers using the command line

Before you begin
Ensure that the Hybrid Workloads agent service is running before starting proxy settings.

Procedure

  1. Open the command line interface window.
  2. In the command prompt, run the following command on Windows server to set the Web proxy:
    HybridWorkloadsAgent.exe web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password>
    For example:
    HybridWorkloadsAgent.exe web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used:
    PhoenixControl.exe set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password
  3. (Optional)You can use the following command in Windows to fetch the current proxy configuration:
    HybridWorkloadsAgent.exe web-proxy-config -g
  4. In the terminal, run the following command on Linux server to set the Web proxy:
    HybridWorkloadsAgent web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password>
    
    For example:
    HybridWorkloadsAgent web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
    Note: If you are using an agent older than version 6.0.1-154928, the following command can be used: 
    PhoenixActivate set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password
  5. (Optional)You can use the following command in Linux to fetch the current proxy configuration:
    HybridWorkloadsAgent web-proxy-config -g
    Field  Description
    Get_web-proxy
    (-g, --get)
    Fetches the current Web proxy configuration for the agent.
    Set_web_proxy
    (-s, --set)
    Sets the current Web proxy configuration for the agent.
    Proxy_type
    (-t, --proxy-type string)
    Agent supports the following proxy types:
    • http
    • socks4
    • socks5
    Note: If you do not provide the type, http is applied by default.
    Proxy_IP
    (-i, --host string)
    Valid IP or URL of proxy server.
    Port Respective proxy port number.
    Proxy_user
    (-u, --user string)
    Valid proxy user name. 
    Proxy_password
    (-p, --pass string)
    Valid proxy password.
    The Web proxy is configured successfully.
    Note: Do not use quotes for proxy_IP, proxy_user or proxy_password. 

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

    Windows 

    C:\ProgramData\Phoenix\<WorkloadName>\Phoenix.cfg

    Linux /etc/Phoenix/<WorkloadName>/Phoenix.cfg
  2. If  the proxy-details setting fails, ping the proxy-server IP from same machine and check for proxy_user and proxy_password.

Steps to delete a Web proxy once it is set up successfully

You can delete the successful set up Web proxy in the following three ways.

Using the user interface

This is applicable only to Windows Servers.

  1. Clear the My network infrastructure uses a Web proxy check box.
  2. Click Save.
Using the command line
  1. Open the command line interface window.
  2. In the command prompt, run the following command on the Windows server to remove the Web proxy: 
    HybridWorkloadsAgent.exe web-proxy-config -r
    or
    HybridWorkloadsAgent.exe web-proxy-config –remove
  3. In the terminal, run the following command in the Linux server to remove the Web proxy:
    HybridWorkloadsAgent web-proxy-config -r
    
    or
    HybridWorkloadsAgent web-proxy-config --remove
    
    Note: Enter -r or –remove command to remove the Web proxy. 
Updating the configuration file
  1. Log in to the required server.
  2. Stop the Hybrid Workloads agent Services.
    Note: If you are using an agent older than version 6.0.1-154928,  navigate to :C:\ProgramData\Phoenix\<WorkloadName> and copy the Phoenix.cfg file.
  1. Open the Phoenix.cfg with notepad and remove the below entries:
    • PROXY_USER
    • PROXY_SERVER
    • PROXY_TYPE
    • PROXY_PASSWD2
  2.  Set "USE_PROXY = False" in the same file. (Only values in a double quote)
  3. Save the Phoenix.cfg file.
  4. Start the Hybrid Workloads agent Services. 
  • Was this article helpful?