Install the Hyper-V Agent Management service

Install the Hyper-V Agent Management service on a VM or server that has local network access to a protected Hyper-V environment. See Prepare for a Hyper-V Agent deployment.

You cannot install the Management service directly on a Hyper-V host in a Hyper-V cluster. However, you can install the Management service on a standalone Hyper-V host. For recommended deployment methods, see Recommended deployment for protecting a Hyper-V standalone host and Recommended deployment for protecting a Hyper-V cluster.

After installing the Hyper-V Agent Management service, you must provide the Hyper-V environment network address and credentials in Portal before you can install Hyper-V Agent Host services. See Configure a new Hyper-V Agent.

By default, the Management service communicates with Host services using port 5444. However, you can specify a custom port during the Management service installation. Ensure that the correct inbound port is open.

To install the Management service silently, see Install the Hyper-V Agent Management service in silent mode.

Note: All Hyper-V Agent services run under the LocalSystem account. The account for the Hyper-V Agent cannot be changed.

Note: Beginning in Hyper-V Agent 9.00, the startup type for Hyper-V Agent services is Automatic (Delayed Start). The delayed service start allows the Agent to clean up files from VMs running using Rapid VM Restore if an Agent host restarts.

To install the Hyper-V Agent Management service:

  1. On the server or VM where you want to install the Management service, double-click the Hyper-V Agent Management service installation kit.

  2. In the language list, click the language for the Agent, and then click OK.

    The installation wizard starts.

  3. On the Welcome page, click Next.

  4. On the License Agreement page, read the license agreement. Click I accept the terms in the license agreement, and then click Next.

  5. On the Destination Folder page, do one of the following:

    • To install the Management service in the default location, click Next.

    • To install the Management service in another location, click Change. In the Change Current Destination Folder dialog box, browse to the new installation folder, or enter it in the Folder name box. Click OK. On the Destination Folder page, click Next.

  6. On the Register Hyper-V Agent Management with Portal page, specify the following information:

    • In the Network Address box, type the host name or IPV4 address of the Portal for managing the Hyper-V Agent.

      Note: We recommend specifying the Portal host name when you register an agent to Portal. If the Portal IP address changes in the future, DNS can handle the change and you will not have to manually register the agent to Portal again.

    • In the Port box, type the port number for communicating with the Portal.

    • In the Username box, type the name of the Portal user for managing the Hyper-V Agent.

      After the Hyper-V Agent is installed, the Agent appears on the Computers page of the Portal for this user and other Admin users in the user’s site.

    • In the Password box, type the password of the specified Portal user.

  7. Click Next.

  8. On the Configure Communication Port page, specify the port used to communicate with Hyper-V Agent Host services, and then click Next.

    By default, the Management service communicates with Host services using port 5444. Ensure that this inbound port, or the custom communication port specified, is open.

  9. On the Ready to Install the Program page, click Install.

  10. On the Installation Completed page, click Finish.

You must configure the Hyper-V environment network address and credentials before you can install Hyper-V Agent Host services. See Configure a new Hyper-V Agent.

Install the Hyper-V Agent Management service in silent mode

Note: Before installing the Management service in silent mode, be sure that the port for communicating with Hyper-V Agent Host services is not in use.

To install the Management service in silent mode, run the following command in the directory where the installation kit is located:

installKitName /quiet /S [/L<localeID>] /V"/qn /L*v [\"logFileName\"] UIREG_NETADDRESS=webUIAddress [UIREG_PORT=webUIportNumber] UIREG_USERNAME=webUIUser UIREG_PASSWORD=webUIUserPassword [COORDINATOR_PORT=portNumber] [INSTALLDIR=\"installPath\"]"

Where installKitName is the name of the Hyper-V Agent Management service installation kit: Hyper-V_Agent_Management-x-xx-xxxx.exe. x-xx-xxxx represents the Agent version number.

The following table lists and describes command parameters.

Parameter Description 
/L<localeID>

Optional. Specifies the language for installation log messages. Available localeID values are:

  • 1033 – English (United States). This is the default value.

  • 1036 – French (Standard)

  • 1031 – German

  • 1034 – Spanish

 
\"logFileName”

Optional. Specifies the path and name of the installation log file. If the logFileName includes spaces, enclose the value in double quotation marks.

Example: \"C:\Logs\My Log.txt\"

If you do not specify a logFileName, the installation log is saved in the Windows installer default location (usually the user’s temp directory).

 
UIREG_NETADDRESS=webUIAddress

Specifies the host name or IP address of the Portal for managing the Hyper-V Agent.

Example: UIREG_NETADDRESS=192.0.2.233

Specifying the host name is recommended. This will allow DNS to handle IP address changes.

 
UIREG_PORT=webUIportNumber

Optional. Specifies the port number used to communicate with Portal.

Example:  UIREG_PORT=8086

If you do not specify a webUIportNumber, port 8086 is used for communicating with Portal.

 
UIREG_USERNAME=webUIUser

Specifies the name of the Portal user associated with the Hyper-V Agent.

Example: UIREG_USERNAME=user@site.com 

UIREG_PASSWORD=webUIUserPassword

Specifies the password of the specified Portal user.

Example: UIREG_PASSWORD=password1234

 
COORDINATOR_PORT=portNumber

Optional. Specifies the port used to communicate with Hyper-V Agent Host services.

Example: COORDINATOR_PORT=5444

If you do not specify a port, port 5444 is used for communicating with Hyper-V Agent Host services.

 
INSTALLDIR=\"installFolder"

Optional. Specifies the installation folder for the Management service, if you do not want to install the Management service in the default location. The installation folder must be enclosed in double quotation marks if there are spaces in the path.

Example: INSTALLDIR=\"c:\Program Files\Management Service\"

If you do not specify an installation folder, the Management service is installed in the default location.

For example, to install the Management service in silent mode, you could run the following command:

Hyper-V_Agent_Management-x-xx-xxxx.exe /quiet /S /L1033 /V"/qn /L*v \"C:\logs\1.log\" UIREG_NETADDRESS=192.0.2.233 UIREG_USERNAME=user@site.com UIREG_PASSWORD=password1234 UIREG_PORT=8086 INSTALLDIR=\"C:\Program Files\Management Service\""