blob: 1bec8ed2fa7e24e72cde991eff3c7cd232a77c1a [file] [log] [blame]
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="hyperv-agent-install">
<title>Installing the &PRODUCT; Agent on a Hyper-V Host</title>
<para>The Hyper-V Agent helps &PRODUCT; perform operations on the Hyper-V hosts. This Agent
communicates with the Management Server and controls all the instances on the host. Each Hyper-V
host must have the Hyper-V Agent installed on it for successful interaction between the host and
&PRODUCT;. The Hyper-V Agent runs as a Windows service. Install the Agent on each host using the
following steps.</para>
<para>&PRODUCT; Management Server communicates with Hyper-V Agent by using HTTPS. For secure
communication between the Management Server and the host, install a self-signed certificate on
port 8250.</para>
<note>
<para>The Agent installer automatically perform this operation. You have not selected this
option during the Agent installation, it can also be done manually as given in step 1.</para>
</note>
<para/>
<orderedlist>
<listitem>
<para>Create and add a self-signed SSL certificate on port 8250:</para>
<orderedlist numeration="loweralpha" id="ssl-agent">
<listitem>
<para>Create A self-signed SSL certificate:</para>
<programlisting># New-SelfSignedCertificate -DnsName apachecloudstack -CertStoreLocation Cert:\LocalMachine\My</programlisting>
<para>This command creates the self-signed certificate and add that to the certificate
store <filename>LocalMachine\My</filename>.</para>
</listitem>
<listitem>
<para>Add the created certificate to port 8250 for https communication:</para>
<programlisting>netsh http add sslcert ipport=0.0.0.0:8250 certhash=&lt;thumbprint&gt; appid="{727beb1c-6e7c-49b2-8fbd-f03dbe481b08}"</programlisting>
<para>Thumbprint is the thumbprint of the certificate you created.</para>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Build the CloudStack Agent for Hyper-V as given in <ulink
url="https://cwiki.apache.org/confluence/display/CLOUDSTACK/Creating+Hyperv+Agent+Installer"
>Building CloudStack Hyper-V Agent</ulink>.</para>
</listitem>
<listitem>
<para>As an administrator, run the installer.</para>
</listitem>
<listitem>
<para>Provide the Hyper-V admin credentials when prompted.</para>
<para>When the agent installation is finished, the agent runs as a service on the host
machine.</para>
</listitem>
</orderedlist>
</section>