Skip to main content
All CollectionsEnterprise WorkloadsProtect NAS SharesSet up Phoenix to back up NAS Shares
Add and activate a NAS proxy
Add and activate a NAS proxy
Updated over 2 months ago

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 Deploy a NAS proxy, you will see No Proxy Registered message is displayed. Click Add NAS Proxy.
    ​


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

    ​

  4. In the Add NAS Proxy dialog box, click Check Prerequisite and ensure that the server meets the prerequisites for the NAS proxy installation.
    ​

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

    • 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. Specify the Installation location and select the appropriate checkboxes:

    1. (Optional) Desktop Shortcut: You can create a desktop shortcut for the Druva Enterprise Workloads Agent installation wizard.

    2. (Optional) Enable Signature Verification: Selecting this option ensures the integrity and authenticity of binaries. It also prevents the execution of any altered binaries, thereby safeguarding against malicious modifications or tampering with packages.
      ​

  7. Click Install. After the installation completes, click Finish.

Command-line install:

  1. Run the following command from the command prompt
    ​msiexec /i <path to Phoenix msi> /qn /quiet /log <path to log file> (for agent version prior to 7.0.0)
    ​For example,
    ​msiexec.exe/i C:\Users\Administrator\Downloads\Phoenix-6.0.1-154609.msi /qn/quiet/log C:\Users\Administrator\Downloads
    ​
    ​msiexec /i <path to EnterpriseWorklaods msi> /qn /quiet /log <path to log file> (for agent version 7.0.0 and later)
    ​For example,
    ​msiexec.exe/i C:\Users\Administrator\Downloads\EnterpriseWorkloads-UnifiedAgent-7.0.0-447428.msi /qn/quiet/log C:\Users\Administrator\Downloads
    ​

  2. Enter input as [yes/no] to enable signature verification.
    ​


    📝 Notes

    • By default, the input option for enabling signature verification is [no].

    • The Enable Signature Verification option ensures the integrity and authenticity of binaries. It also prevents the execution of any altered binaries, thereby safeguarding against malicious modifications or tampering with the package.
      ​

  3. (Optional) You can also verify the integrity and authenticity of the package. See Package Signature Verification for more details.

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

    • 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.
      ​

  4. Enter input as [yes/no] to enable signature verification.
    ​


    📝 Notes

    • By default, the input option for enabling signature verification is [no].

    • The Enable Signature Verification option ensures the integrity and authenticity of binaries. It also prevents the execution of any altered binaries, thereby safeguarding against malicious modifications or tampering with the package.
      ​

  5. (Optional) You can also verify the integrity and authenticity of the package. See Package Signature Verification for more details.
    ​

Step 2: Activating the NAS proxy​

Watch video

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

​You cannot activate a NAS proxy with a version prior to 7.0.0. A proxy will always be a part of the pool.

📝 Note

​Whenever you add and activate a proxy, the newly added proxy goes to the Default Proxy Pool. The Default Proxy Pool cannot be deleted. However, you can move a proxy from the Default Proxy Pool to a different pool. For more information, see Change Backup Proxy Pool.

📝 Note

​If your network infrastructure uses a Web proxy, you must configure it before activation. For more information, see Configure Web proxy.

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

  2. On the Windows server, open the command prompt and navigate to:

    • C:\Program Files\Druva\Phoenix Agent (for agent version prior to 7.0.0)

    • C:\Program Files\Druva\EnterpriseWorkloads (for agent version 7.0.0 and later)
      ​

  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 agent version prior to 7.0.0)

        For example:

      • HybridWorkloadsAgent.exe nas activate -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3

      • EnterpriseWorkloadsAgent.exe nas activate -t <token> -n <ProxyName> (for agent version 7.0.0 and later)

        For example:

      • EnterpriseWorkloadsAgent.exe nas activate -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
        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 agent version prior to 7.0.0)

        For example:

        HybridWorkloadsAgent.exe nas activate -g -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3

      • EnterpriseWorkloadsAgent nas activate -t <token> -n <ProxyName> (for agent version 7.0.0 and later)

        For example:

        EnterpriseWorkloadsAgent.exe nas activate -g -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
        ​

        • token (-t, --token string): Paste the copied activation. 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.
          ​

          💡 Tip
          ​

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

  4. If you’re using the Enterprise Workloads Agent shortcut to activate the agent, click Copy Token.

    1. Double-click the Enterprise Workloads Agent shortcut on the Windows server where the Enterprise Workloads Agent needs to be activated.
      The Enterprise Workloads Agent window is displayed.
      ​

    2. In the Enterprise Workloads Agent window, select NAS to activate.

    3. Select the type of Cloud deployment: Public Cloud or Gov Cloud.

    4. A set of in-built activation checks are run and the result is displayed. Click Next.
      ​

    5. The Agent Activation page for NAS is displayed.
      ​

    6. Enter the following details:

      • Activation Token: Paste the copied activation token. 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. The proxy name should not contain any special characters.
        ​

    7. Click Activate.
      The backup readiness checks will run to ensure that your system is equipped for successful backup operation.
      ​
      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.
      ​

    6. On the Linux server, open the terminal and navigate to:

      • opt/Druva/Phoenix/bin (for agent version prior to 7.0.0)

      • cd /opt/Druva/EnterpriseWorkloads/bin (for agent version 7.0.0 and later)

    7. Paste the copied command as explained below:

      • Public Cloud

        • HybridWorkloadsAgent nas activate -t <token> -n <ProxyName> (for agent version prior to 7.0.0)

          For example:

          HybridWorkloadsAgent nas activate -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3

        • EnterpriseWorkloadsAgent nas activate -t <token> -n <ProxyName> (for agent version 7.0.0 and later)

          For example:

          EnterpriseWorkloadsAgent nas activate -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
          ​
          ​

      • GovCloud

        • ​HybridWorkloadsAgent nas activate –g -t <token> -n <ProxyName> (for agent version prior to 7.0.0)

          For example:

          HybridWorkloadsAgent nas activate -g -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3

        • EnterpriseWorkloadsAgent nas activate -g -t <token> -n <ProxyName> (for agent version 7.0.0 and later)

          For example:

          EnterpriseWorkloadsAgent nas activate -g -t 67831-228-1762-591132241ce4fb2e14fca792cbf532f4a2359eb0bf1b96f82211373ebea7c23b -n WIN-RTG3
          ​
          ​
          In both the above commands, <activation token> is the activation token of the NAS proxy.
          ​

          💡 Tip

          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

Enterprise Workloads agent connects to the Druva Cloud through the internet. If your network infrastructure uses a Web proxy, configure the Enterprise 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 Enterprise Workloads agent is running before starting proxy settings.

Procedure

  1. Double-click the Enterprise 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.
      ​

      ​

    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 Enterprise 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 agent version prior to 7.0.0)

      For example:

      HybridWorkloadsAgent.exe web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23

    • Enterprise WorkloadsAgent.exe web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password> (for agent version 7.0.0 and later)
      For example:

      Enterprise WorkloadsAgent.exe web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23
      ​

  3. (Optional)You can use the following command in Windows to fetch the current proxy configuration:

    HybridWorkloadsAgent.exe web-proxy-config -g (for agent version prior to 7.0.0)Enterprise WorkloadsAgent.exe web-proxy-config -g (for agent version 7.0.0 and later)

  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

    • Enterprise WorkloadsAgent web-proxy-config -s -t <proxy_type> -i <ProxyHost_IP>:port -u <Proxy_user> -p <Proxy_password> (for agent version 7.0.0 and later)

      For example:

      Enterprise WorkloadsAgent web-proxy-config -s -t http -i 172.34.23.218:80 -u johndoe -p pass23

  5. (Optional)You can use the following command in Linux to fetch the current proxy configuration:

    HybridWorkloadsAgent web-proxy-config -g (for agent version prior to 7.0.0)Enterprise WorkloadsAgent web-proxy-config -g (for agent version 7.0.0 and later)

    • 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.
    ​

  2. The configuration file path for Workloads agent and Cache Server are as follows:

    • Windows:

      • C:\ProgramData\Phoenix\<WorkloadName>\Phoenix.cfg (for agent version prior to 7.0.0)

      • C:\ProgramData\Druva\EnterpriseWorkloads\Config.yaml (for agent version 7.0.0 and later)

    • Linux:

      • /etc/Phoenix/<WorkloadName>/Phoenix.cfg (for agent version prior to 7.0.0)

      • /etc/Druva/EnterpriseWorkloads/Config.yaml (for agent version 7.0.0 and later)
        ​

  3. 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 (for agent version prior to 7.0.0)

    • EnterpriseWorkloadsAgent.exe web-proxy-config -r (for agent version 7.0.0 and later)

      or

    • HybridWorkloadsAgent.exe web-proxy-config –remove (for agent version prior to 7.0.0)

    • EnterpriseWorkloadsAgent.exe web-proxy-config –remove (for agent version 7.0.0 and later)

  3. In the terminal, run the following command in the Linux server to remove the Web proxy:

    • HybridWorkloadsAgent web-proxy-config -r (for agent version prior to 7.0.0)

    • EnterpriseWorkloadsAgent web-proxy-config -r for agent version 7.0.0 and later)

      or

    • HybridWorkloadsAgent web-proxy-config --remove (for agent version prior to 7.0.0)

    • EnterpriseWorkloadsAgent web-proxy-config --remove for agent version 7.0.0 and later)

      📝 Note


      ​Enter -r or –remove command to remove the Web proxy.

Updating the configuration file

  1. Log in to the required server.
    ​

    📝 Note
    ​
    ​​For agent version 7.0.0 and later, do not perform steps from 2-6. To verify if the proxy is unset or not, go to C:\ProgramData\Druva\EnterpriseWorkloads\Config.yaml, and verify the below parameters:

    proxy_config: enabled: false,

    host: ""

    password: ""

    port: ""

    proxy_type: ""

    username: "”

  2. Stop the Hybrid Workloads agent Services, navigate to C:\ProgramData\Phoenix\<WorkloadName> (for agent version prior to 7.0.0), and copy the Phoenix.cfg file.

  3. Open the Phoenix.cfg with notepad and remove the below entries:

    • PROXY_USER

    • PROXY_SERVER

    • PROXY_TYPE

    • PROXY_PASSWD2

  4. Set "USE_PROXY = False" in the same file. (Only values in a double quote)

  5. Save the Phoenix.cfg file.

  6. Start the Hybrid Workloads agent Services.

Next steps

Related Articles
Install the agent and register a Hyper-V host
Install the agent and register a server
FAQs for NAS shares
Install the agent and register an MS SQL server
Deploy the backup agent or proxy using the common agent on a Linux server
Did this answer your question?