Skip to main content
Druva Documentation

Install the agent and register a Hyper-V host

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

Before you can backup your virtual machines, you have to register the Hyper-V host on which you create and manage virtual machines. During registration, Phoenix generates an activation token that activates Phoenix agents installed on your host. Activation ensures that Phoenix agent establishes a persistent connection with Phoenix Cloud and registers your host with Phoenix. After your host is registered, backup is enabled for the host on which the agent is installed. The Phoenix agent:

  • Scans your host and requests the VSS service for the virtual machine snapshot
  • Backs up the snapshot on the cloud
  • Restores data from the cloud when you request it

For an overview of configuration steps, see:

This article contains the following sections:

  1. Download the agent and generate activation token
  2. Install the agent
  3. Activate the agent

Step 1: Download the agent and generate 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 Protect > Hyper-V
  4. Click Register New Setup.
  5. On the Register Server page, under Install Druva Phoenix Agent, do one of the following: 
    • If you have not yet downloaded the Phoenix Agent installer, click the download link, and click Next
    • If you downloaded Phoenix Agent, skip this step, and click Next.
  6. Under Generate Activation Token, provide the following details, and click Next
    Field Description
    Token Description

    A short description of the activation token.

    Note: You cannot leave this field empty.

    This token can activate

    The number of hosts that the activation token can activate.

    The default value is 25.

    The token expires in

    The number of days after which the activation token expires.

    The default value is 7. 

  7. Under Server Activation, click Copy and save the activation token in a text file.
    Activation Token Generated
  8. Click Finish.

Step 2: Install the agent

Before you begin, ensure that:

  • You are logged in as an administrator to the host.
  • Your host matches the requirements listed in the support matrix
  • You have downloaded the Phoenix agent installer on your host. The installer is available on the Druva downloads page. You can also download the installer from the Phoenix Management Console at the time of registering hosts. 

Perform the following steps to install the agent:

  1. Copy the downloaded Phoenix agent installer to the host on which you want to install it.
  2. Double-click the Phoenix agent installer. The installation wizard appears.
  3. Accept the license agreement and click Next
  4. Use the local system account for installing the agent on the Hyper-V host. 
  5. In the Install location box, enter or select the full path to the installation home directory. 
  6. Click Install.
  7. After the installation completes, click Finish.

Command-line install

From the command prompt, run the following command:

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

Configure web-proxy (optional) 

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

Before you begin, ensure that the Phoenix agent is running before you start proxy settings.

To configure the web-proxy:

  1. Open the command line interface window.
  2. Change the directory path to the location on the system on which the Phoenix agent is installed.
    Windows default: C:\Program Files\Druva\Phoenix Agent
  3. On command prompt, run the following command:
    PhoenixHyperVControl.exe set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password
    Field Description
    Proxy_type Druva supports the following proxy types:
    • HTTP
    • socks4
    • socks5
    Proxy_IP Valid IP of the proxy server.
    Port Respective proxy port number.
    Proxy_user Valid proxy username.
    Proxy_password Valid proxy password. 

Note: Druva only supports basic authentication with web-proxy.

The web-proxy is configured successfully if you see the message Proxy details updated successfully on the terminal.

Note: Do not use quotes for proxy_IP, proxy_user or proxy_password. All the parameters must be present, if any input parameter is missing or not in prescribed order, then the utility will fail.

Additional information

  1. The Threat Management Gateway (TMG) drops IDLE connections after defined timeout duration, due to which agent retries aggressively with the server.

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

  1. The configuration file path for the Phoenix agent is C:\ProgramData\Phoenix\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.
    • PROXY_USER
    • PROXY_SERVER
    • PROXY_TYPE
    • PROXY_PASSWD2

    Note: After deleting the above listed entries, set USE_PROXY = False in 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.

Step 3: Activate the Phoenix agent

Activate the agent using the Windows command line

Open the command-line prompt with Admin privilege, and change the directory to the agent installation directory.

For example, Phoenix agent is installed on C:\Program Files\Druva\Phoenix Agent.
To change directory in CLI, you run: cd “C:\Program Files\Druva\Phoenix Agent”

After changing the directory, run the following commands to activate the agent :

For Phoenix Cloud:

PhoenixHyperVControl.exe activate <activation_token> --type <scvmm/cluster/standalone> --scvmm_fqdn <scvmm FQDN> --user <scvmm/cluster username> --password <scvmm/cluster password>

For GovCloud:

PhoenixHyperVControl.exe activate govcloud <activation_token> --type <scvmm/cluster/standalone> --scvmm_fqdn <scvmm FQDN> --user <scvmm/cluster username> --password <scvmm/cluster password>
Note
  • Replace <activation_token> with the activation token that Phoenix generated at the time of registering the host.
  • For --type, select one of <scvmm/cluster/standalone> based on your setup
  • Provide IP address or Fully Qualified Domain name for <scvmm FQDN>
  • If the Hyper-V host uses SCVMM, replace <scvmm username> and <scvmm password>
     with username and password respectively. 
    If you are registering the Hyper-V host as a cluster, replace <cluster username> and <cluster password> with domain username and password respectively. Ensure that the domain user has access permissions on all Hyper-V hosts within that cluster.
  • For example, if you are registering an SCVMM based host

    PhoenixHyperVControl.exe activate 111111AAAAAA --type scvmm --scvmm_fqdn examplehyperv.fqdn.yourorg.com --user admin --password examplepasswordforscvmm
    
  • If you are registering a clustered host:
    PhoenixHyperVControl.exe activate 111111AAAAAA --type cluster --user exampledomain\admin --password examplepasswordfordomainuser
  • If you are registering a standalone host:
    PhoenixHyperVControl.exe activate 111111AAAAAA --type standalone
  • If you are registering for Gov Cloud, add the govcloud parameter. For example, in case of a standalone host:
    PhoenixHyperVControl.exe activate govcloud 111111AAAAAA --type standalone
  • --scvmm_fqdn is applicable for System Center Virtual Machine Manager based host only. It is not applicable for a standalone host or a host in a cluster.
  • --user and --password parameters are not required for standalone hosts.
  • In place of --type, --user, --password, --scvmm_fqdn parameters, you can use -e, -u, -p, -f parameters respectively. 
  • If you move a host from one cluster to another after registration, the host appears as disconnected in the Phoenix Management Console.
  • By default, the server is registered using its Fully Qualified Domain Name (FQDN). In addition, you can use the --ServerName  or -d parameter to register your host with a name. 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". You can add the -d parameter to register the server with a different name. 
  • You can upgrade Phoenix agents to their latest available version. For more information, see Upgrade the agent.
  • If you are using SCVMM for managing virtual machines on Windows Server 2008 and Windows Server 2008 R2 hosts:
    • When you activate the Phoenix agent, select the type as standalone or cluster (based on your setup). Do not  select the type as scvmm to register your hosts through SCVMM.
    • Phoenix does not support registration of Microsoft Windows Server 2008 and Microsoft Windows Server 2008 R2 hosts through SCVMM.

If you want to update the credentials later:

PhoenixHyperVControl.exe set_credential --type <scvmm/cluster> --scvmm_fqdn <scvmm FQDN> --user <scvmm/cluster username> --password <scvmm/cluster password>

For example, 

PhoenixHyperVControl.exe set_credential --type scvmm --scvmm_fqdn=192.0.2.9 --user=exampledomain\user --password=Ex@mpleP@$$w0rd

Note: Do not use the following characters in the command:

  • Double quotes "
  • Single quotes '
  • Double back-slash \\

Next steps

After the server is registered, configure virtual machines for backup

For information on how to configure Phoenix so that it can work with third-party VSS providers, see How do I configure Phoenix to use third party VSS providers?