Skip to main content

 

Druva Documentation

Download, install, and activate Phoenix CloudCache

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

To deploy Phoenix CloudCache for your setup, add Phoenix CloudCache from the Phoenix Management Console.

At the time of adding, Phoenix Cloud generates an activation key, which functions as a unique identifier and establishes a connection between Phoenix Cloud and Phoenix CloudCache. After installation, use this key to activate Phoenix CloudCache.

Notes:
  • You must install Phoenix CloudCache within the firewall limits of your remote office locations.
  • In  a production environment, we recommend that you install Phoenix CloudCache on a server on which Phoenix agent is not installed.
  • To ensure faster backups and restores, we recommend that you use a dedicated server for Phoenix CloudCache. 

Perform the following steps:

Before you begin

Ensure that the server on which you plan to install Phoenix CloudCache matches the minimum requirements listed under System requirements.

Step 1: Download the installer

You can download the Phoenix CloudCache installer from the Download Agents section Download at the top right corner of the Phoenix Management Console. 

Note: You can also download the installer at the time of adding Phoenix CloudCache.
  1. Log on to Phoenix Management Console.
  2. At the top right corner, click Downloads Agents.
  3. Scroll to the bottom of the Druva downloads page, and download Phoenix CloudCache Installer.
    For GovCloud, download Phoenix GovCloud CloudCache Installer.

Step 2: Get CloudCache activation token

  1. Log on to Phoenix Management Console.
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list.
  3. On the menu bar, click Manage > CloudCache
  4. Click Add New CloudCache.
    Add New CloudCache
  5. In the CloudCache Name box, type a name for your Phoenix CloudCache, and click Next.
    Add New CloudCache Dialog

Note: If you did not download the Phoenix CloudCache installer in step 1, click Download here.

  1. To copy the activation token, click the Copy
    Add New CloudCache
Note: You can use the activation token to activate only one instance of Phoenix CloudCache. The token remains active only for 3 days from the time of generation. If you do not use it to activate Phoenix CloudCache within 3 days, regenerate your activation token. 
  1. Copy this token to a simple text file, and save the file.

Note: Phoenix does not store activation tokens.

  1. Click Finish
    Phoenix CloudCache appears under Unconfigured CloudCache on Phoenix Management Console. The Cache status appears as "Not activated". 

Step 3: Install Phoenix CloudCache 

To install Phoenix CloudCache, administrator privileges are required on the server. 

  1. Double-click the installer, and click Next
  2. Accept the license agreement, and then click Next.
  3. In the Install Location box, type or select the full path to the installation home directory.
  4. (Optional) Select Desktop Shortcut.
  5. Click Install. 
  6. After the installation completes, click Finish.

Step 4: Configure Web proxy (Optional)

Perform this step only if you are using Web proxy in your environment

Before you begin

  • Ensure that CloudCache service is running before you start proxy settings.  

Procedure

  1. Open the command line interface window.
  2. Change the directory path to the location on your system, where phoenix agent is installed.
    Default path: C:\Program Files\Druva\Phoenix CacheServer.
  3. On command prompt, run the following command:
    PhoenixCacheControl.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 proxy IP address.
    Port Respective proxy port number.
    Proxy_user Valid proxy user name.
    Proxy_password Valid proxy password.
    After the command runs successfully, a message appears indicating that Web proxy is installed successfully.

Web Proxy

Additional information

  • The TMG drops IDLE connections after defined timeout duration, due to which Client 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 Cache Server is as follows:
    Client Path
    Cache Server     C:\ProgramData\PhoenixCloudCache\PhoenixCloudCache.cfg
  • After successfully setting up the proxy, if you want to remove proxy setting, 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 same file. 

In case of cache server, remove proxy entires from PhoenixCloudCache.cfg

Step 5: Activate Phoenix CloudCache

To establish a persistent connection between Phoenix CloudCache and Phoenix Cloud, activate Phoenix CloudCache using the activation token generated in step 2

Note: Before activating Phoenix CloudCache, ensure that the file containing the activation token is available on your server.

You can use the activation token to activate only one instance of Phoenix CloudCache. 

If you lose the activation token or if the activation token crosses expiration (3 days), you must regenerate the activation token. For instructions, see Regenerate activation token.

Procedure

  1. Wait for the Druva Phoenix CloudCache window to appear or double-click the Phoenix CloudCache desktop shortcut.
  2. Disable the govCloud option and enter the activation token. 

​​Note: If you are activating CloudCache with Gov Phoenix, enable the govCloud option.

  1. Click Activate

After activation, the status of Phoenix CloudCache listed under UnconfiguredCloudCache changes to Connected. The entry in the Action column changes to Configure.

(Optional) Command-line method for activation

  1. Open the Command Prompt and go to the following directory:
    C:\Program Files\Druva\PhoenixCacheServer
  2. Run the following command:
    PhoenixActivate <Activation Token>
    

    where <Activation Token> represents the activation token generated in step 2

    For example, your command might look like this:

    PhoenixActivate 24-33-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 

    If the activation completes successfully, the message Successfully Connected appears.

  3. If the activation does not complete successfully, the message Activation Failed appears. Perform the step 1 again.