Install the Hyper-V Agent Host service
The Hyper-V Agent Host service is installed on one or more hosts in a protected Hyper-V environment. See Prepare for a Hyper-V Agent deployment.
Before you install a Host service, be sure that:
-
The Hyper-V Agent Management service is installed on a server with local network access to the Hyper-V environment.
-
The Hyper-V environment network address and credentials are specified in Portal for the Hyper-V Agent Management service. See Configure a new Hyper-V Agent.
You must provide Hyper-V environment information and credentials in Portal before you can install Hyper-V Agent Host services. When you install a Hyper-V Agent Host service, the Management service checks whether the host is associated with the Hyper-V environment that is specified for the Management service in Portal. If the Hyper-V host is not associated with the Hyper-V environment specified in Portal, the installation will not proceed.
-
There is local network connectivity to the Management service and the correct port is open. During the installation, the Host service must be able to establish connection with the Management service.
Do not install the Host service on the same machine as Agent for Microsoft Windows. The installer does not enforce this coexistence constraint.
To install the Host service silently, see Install the Hyper-V Agent Host 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 Host service:
-
Log in to the Hyper-V host where you want to install the Host service.
-
Double-click the Hyper-V Agent Host service installation kit.
-
In the language list, click the language for the Agent, and then click OK.
The installation wizard starts.
-
On the Welcome page, click Next.
-
On the License Agreement page, read the license agreement. Click I accept the terms in the license agreement, and then click Next.
-
On the Destination Folder page, do one of the following:
-
To install the Host service in the default location, click Next.
-
To specify another installation location, click Change. In the Change Current Destination Folder dialog box, browse to the new installation location, or enter a folder in the Folder name box. Click OK. On the Destination Folder page, click Next.
-
-
On the Connection with Hyper-V Agent Management service page, in the Network Address box, enter the fully qualified domain name (FQDN) or IP address of the Hyper-V Agent Management service that will assign work to the Host service.
Note: Specifying the FQDN of the Management service is recommended. This will allow DNS to handle IP address changes.
If an error message states that the Hyper-V Agent Management service is unreachable, check that the Hyper-V environment network address and credentials have been specified for the Management service in Portal, and that the host where you are installing the Host service is associated with the specified Hyper-V environment. See Configure a new Hyper-V Agent.
-
In the Port box, enter the port number for communicating with the Hyper-V Agent Management service.
By default, the Management service communicates with Host services using port 5444. However, a custom port might have been specified during the Management service installation.
-
Click Next.
-
Click Install.
-
On the Wizard Completed page, click Finish.
Install the Hyper-V Agent Host service in silent mode
Before you install a Host service, be sure that:
-
The Hyper-V Agent Management service is installed on a server with local network access to the Hyper-V environment.
-
The Hyper-V environment network address and credentials are specified in Portal for the Hyper-V Agent Management service. See Configure a new Hyper-V Agent.
You must provide Hyper-V environment information and credentials in Portal before you can install Hyper-V Agent Host services. When you install a Hyper-V Agent Host service, the Management service checks whether the host is associated with the Hyper-V environment that is specified for the Management service in Portal. If the Hyper-V host is not associated with the Hyper-V environment specified in Portal, the installation will not proceed.
-
There is local network connectivity to the Management service and the correct port is open. During the installation, the Host service must be able to establish connection with the Management service.
To install the Host 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\"] HOST=managementServiceAddress [PORT=portNumber] [INSTALLDIR=\"installPath\"]"
Where installKitName is the name of the Hyper-V Agent Host service installation kit: Hyper-V_Agent_Host-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:
|
|
\"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). |
|
HOST=managementServiceAddress |
Specifies the fully qualified domain name (FQDN) or IP address of the Hyper-V Agent Management service that assigns work to the Host service. Example: HOST=192.0.2.234 Specifying the FQDN is recommended. This will allow DNS to handle IP address changes. |
|
PORT=portNumber |
Optional. Specifies the port number for communicating with the Hyper-V Agent Management service. Example: UIREG_PORT=5444 If you do not specify a port number, port 5444 is used. |
|
INSTALLDIR=\"installFolder” |
Optional. Specifies the installation folder for the Host service, if you do not want to install the Host service in the default location. The installation folder must be enclosed in double quotation marks if there are spaces in the name or path. Example: INSTALLDIR=\"c:\Program Files\Host Service\" If you do not specify an installation folder, the Host service is installed in the default location. |
For example, to install the Host service in silent mode, you could run the following command:
Hyper-V_Agent_Host-x-xx-xxxx.exe /quiet /S /L1036 /V"/qn /L*v \"C:\logs\1.log\" HOST=192.0.2.234 PORT=5444"