Add hyperv manual pages provided by Microsoft, formatted
for FreeBSD standards. Very little, if any, content was modified. These are not yet linked to the build. Submitted by: Abhishek Gupta (abgupta!microsoft dot com) Sponsored by: The FreeBSD Foundation
This commit is contained in:
gjb
parent
b38edcd355
commit
06fdbb11ae
90
share/man/man4/hv_ata_pci_disengage.4
Normal file
90
share/man/man4/hv_ata_pci_disengage.4
Normal file
@ -0,0 +1,90 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_ata_pci_disengage
|
||||||
|
.Nd Hyper-V ATA PCI Disengage driver
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver prevents the native
|
||||||
|
.Fx
|
||||||
|
ATA driver from
|
||||||
|
loading in the presence of Hyper-V.
|
||||||
|
.Fx
|
||||||
|
guests running on Hyper-V can take advantage of the Hyper-V Storage
|
||||||
|
Virtual Consumer
|
||||||
|
.Pq Xr hv_storvsc 4
|
||||||
|
for using their IDE devices.
|
||||||
|
Since the ATA
|
||||||
|
driver serves IDE devices as well, there is a chance that the ATA driver may
|
||||||
|
interfere with the operations of
|
||||||
|
.Xr hv_storvsc 4 .
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver avoids
|
||||||
|
conflicts between the ATA driver and
|
||||||
|
.Xr hv_storvsc 4
|
||||||
|
by disabling the ATA driver
|
||||||
|
when the
|
||||||
|
.Fx
|
||||||
|
guest is booting.
|
||||||
|
.Pp
|
||||||
|
A side effect of disabling the ATA driver is that CDROM may become
|
||||||
|
inoperational on
|
||||||
|
.Fx
|
||||||
|
guest partitions.
|
||||||
|
If CDROM access is a must then users may use
|
||||||
|
"set hw.ata.disk_enable=1" at boot time to prevent the ATA driver from being
|
||||||
|
disabled.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_vmbus 4 ,
|
||||||
|
.Xr hv_utils 4 ,
|
||||||
|
.Xr hv_netvsc 4 ,
|
||||||
|
.Xr hv_storvsc 4
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The driver was developed through a joint effort between Citrix Incorporated,
|
||||||
|
Microsoft Corporation, and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
96
share/man/man4/hv_kvp.4
Normal file
96
share/man/man4/hv_kvp.4
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_kvp
|
||||||
|
.Nd Hyper-V Key Value Pair Driver
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver provides the ability to store, retrieve, modify and delete
|
||||||
|
key value pairs for
|
||||||
|
.Fx
|
||||||
|
guest partitions running on Hyper-V.
|
||||||
|
Hyper-V allows administrators to store custom metadata in the form
|
||||||
|
of key value pairs inside the
|
||||||
|
.Fx
|
||||||
|
guest partition.
|
||||||
|
Administrators can use Windows Powershell scripts to add, read,
|
||||||
|
modify and delete such key value pairs.
|
||||||
|
.Pp
|
||||||
|
The driver is bare bones and merely forwards requests to its counterpart
|
||||||
|
user mode daemon,
|
||||||
|
.Xr hv_kvp_daemon 8 .
|
||||||
|
The daemon maintains pools of key value
|
||||||
|
pairs and does the actual metadata management.
|
||||||
|
.Pp
|
||||||
|
The same driver and daemon combination are also used to set and get
|
||||||
|
IP addresses from a
|
||||||
|
.Fx
|
||||||
|
guest.
|
||||||
|
.Pp
|
||||||
|
The set functionality is particularly
|
||||||
|
useful when the
|
||||||
|
.Fx
|
||||||
|
guest is assigned a static IP address and is failed over from one
|
||||||
|
Hyper-V host to another.
|
||||||
|
After failover, Hyper-V uses the set IP functionality to automatically
|
||||||
|
update the
|
||||||
|
.Fx
|
||||||
|
guest's IP address to its original static value.
|
||||||
|
.Pp
|
||||||
|
On the other hand, the get IP functionality is used to update the guest IP
|
||||||
|
address in the Hyper-V management console window.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_vmbus 4 ,
|
||||||
|
.Xr hv_utils 4 ,
|
||||||
|
.Xr hv_netvsc 4 ,
|
||||||
|
.Xr hv_storvsc 4 ,
|
||||||
|
.Xr hv_ata_pci_disengage 4 ,
|
||||||
|
.Xr hv_kvp_daemon 8
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The driver was developed through a joint effort between Citrix
|
||||||
|
Incorporated, Microsoft Corporation and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
83
share/man/man4/hv_netvsc.4
Normal file
83
share/man/man4/hv_netvsc.4
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_netvsc
|
||||||
|
.Nd Hyper-V Network Virtual Service Consumer
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver implements the virtual network device for
|
||||||
|
.Fx
|
||||||
|
guest
|
||||||
|
partitions running on Hyper-V.
|
||||||
|
.Fx
|
||||||
|
guest partitions running on Hyper-V do not have direct access to
|
||||||
|
network devices attached to the Hyper-V server.
|
||||||
|
Although a
|
||||||
|
.Fx
|
||||||
|
guest can access network devices using Hyper-V's
|
||||||
|
full emulation mode, the performance in this mode tends to be unsatisfactory.
|
||||||
|
.Pp
|
||||||
|
To counter the above issues, the
|
||||||
|
.Nm
|
||||||
|
driver implements a network
|
||||||
|
Virtual
|
||||||
|
Service Consumer (VSC) that relays network requests from the guest partition
|
||||||
|
to the network Virtual Service Provider (VSP) hosted in the root partition
|
||||||
|
using the high performance data exchange infrastructure provided by
|
||||||
|
.Xr hv_vmbus 4
|
||||||
|
driver.
|
||||||
|
The VSP in the root partition then forwards the network related requests to
|
||||||
|
the physical network card.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_vmbus 4 ,
|
||||||
|
.Xr hv_utils 4 ,
|
||||||
|
.Xr hv_storvsc 4 ,
|
||||||
|
.Xr hv_ata_pci_disengage 4
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The driver was developed through a joint effort between Citrix Incorporated,
|
||||||
|
Microsoft Corporation, and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
89
share/man/man4/hv_storvsc.4
Normal file
89
share/man/man4/hv_storvsc.4
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_storvsc
|
||||||
|
.Nd Hyper-V Storage Virtual Service Consumer
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver implements the virtual store device for
|
||||||
|
.Fx
|
||||||
|
guest
|
||||||
|
partitions running on Hyper-V.
|
||||||
|
.Fx
|
||||||
|
guest partitions running on Hyper-V do not have direct access to
|
||||||
|
storage devices attached to the Hyper-V server.
|
||||||
|
Although a
|
||||||
|
.Fx
|
||||||
|
guest can access storage devices using Hyper-V's
|
||||||
|
full emulation mode, the performance in this mode tends to be unsatisfactory.
|
||||||
|
.Pp
|
||||||
|
To counter the above issues, the
|
||||||
|
.Nm
|
||||||
|
driver implements a storage
|
||||||
|
Virtual
|
||||||
|
Service Consumer (VSC) that relays storage requests from the guest partition
|
||||||
|
to the storage Virtual Service Provider (VSP) hosted in the root partition
|
||||||
|
using the high performance data exchange infrastructure provided by
|
||||||
|
.Xr hv_vmbus 4
|
||||||
|
driver.
|
||||||
|
The VSP in the root partition then forwards the storage related requests to
|
||||||
|
the physical storage device.
|
||||||
|
.Pp
|
||||||
|
This driver functions by presenting a SCSI HBA interface to the Comman Access
|
||||||
|
Method (CAM) layer.
|
||||||
|
CAM control blocks (CCBs) are
|
||||||
|
converted into VSCSI protocol messages which are delivered to the root
|
||||||
|
partition VSP over the Hyper-V VMBus.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_vmbus 4 ,
|
||||||
|
.Xr hv_utils 4 ,
|
||||||
|
.Xr hv_netvsc 4 ,
|
||||||
|
.Xr hv_ata_pci_disengage 4
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The driver was developed through a joint effort between Citrix Incorporated,
|
||||||
|
Microsoft Corporation, and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
85
share/man/man4/hv_utils.4
Normal file
85
share/man/man4/hv_utils.4
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_utils
|
||||||
|
.Nd Hyper-V Utilities Driver
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver provides time keeping, shutdown and heartbeat
|
||||||
|
functionality for
|
||||||
|
.Fx
|
||||||
|
guest partitions running on Hyper-V.
|
||||||
|
Hyper-V is a hypervisor-based virtualization technology from Microsoft.
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
driver is one of the core drivers required to be present in guest
|
||||||
|
partitions running on Hyper-V.
|
||||||
|
This driver provides the following
|
||||||
|
functionalities to guest partitions:
|
||||||
|
.Pp
|
||||||
|
(a) Time Keeping: The clock inside the guest partition will remain accurate by
|
||||||
|
synchronizing to the clock on the virtualization server via Timesync service,
|
||||||
|
and with the help of the pluggable time source device.
|
||||||
|
.Pp
|
||||||
|
(b) Integrated shutdown: Guest partitions running
|
||||||
|
.Fx
|
||||||
|
can be shut down from
|
||||||
|
Hyper-V Manager console by using the
|
||||||
|
.Qq Shut down
|
||||||
|
command.
|
||||||
|
.Pp
|
||||||
|
(c) Heartbeat: This feature allows the virtualization server to detect whether
|
||||||
|
the guest partition is running and responsive.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_vmbus 4 ,
|
||||||
|
.Xr hv_netvsc 4 ,
|
||||||
|
.Xr hv_storvsc 4 ,
|
||||||
|
.Xr hv_ata_pci_disengage 4
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The driver was developed through a joint effort between Citrix Incorporated,
|
||||||
|
Microsoft Corporation, and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
93
share/man/man4/hv_vmbus.4
Normal file
93
share/man/man4/hv_vmbus.4
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_vmbus
|
||||||
|
.Nd Hyper-V Virtual Machine Bus (VMBus) Driver
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
provides a high performance communication interface between
|
||||||
|
guest and root partitions in Hyper-V.
|
||||||
|
Hyper-V is a hypervisor-based virtualization technology from Microsoft.
|
||||||
|
Hyper-V supports isolation in terms of a partition.
|
||||||
|
A partition is a
|
||||||
|
logical unit of isolation, supported by the hypervisor, in which
|
||||||
|
operating systems execute.
|
||||||
|
.Pp
|
||||||
|
The Microsoft hypervisor must have at least one parent, or root,
|
||||||
|
partition, running Windows Server operating system.
|
||||||
|
The virtualization stack runs in the parent partition and has
|
||||||
|
direct access to the hardware devices.
|
||||||
|
The root partition then creates the child partitions which host
|
||||||
|
the guest operating systems.
|
||||||
|
.Pp
|
||||||
|
Child partitions do not have direct access to other hardware resources
|
||||||
|
and are presented
|
||||||
|
a virtual view of the resources, as virtual devices (VDevs).
|
||||||
|
Requests to the virtual devices are
|
||||||
|
redirected either via the VMBus or the hypervisor to the devices in
|
||||||
|
the parent partition, which handles the requests.
|
||||||
|
.Pp
|
||||||
|
The VMBus is a logical inter-partition communication channel.
|
||||||
|
The parent partition hosts Virtualization Service Providers (VSPs)
|
||||||
|
which communicate over the VMBus to handle device access requests from
|
||||||
|
child partitions.
|
||||||
|
Child partitions host Virtualization Service
|
||||||
|
Consumers (VSCs) which redirect device requests to VSPs in the parent
|
||||||
|
partition via the VMBus.
|
||||||
|
The Hyper-V VMBus driver defines and implements
|
||||||
|
the interface that facilitate high performance bi-directional communication
|
||||||
|
between the VSCs and VSPs.
|
||||||
|
All VSCs utilize the VMBus driver.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_utils 4 ,
|
||||||
|
.Xr hv_netvsc 4 ,
|
||||||
|
.Xr hv_storvsc 4 ,
|
||||||
|
.Xr hv_ata_pci_disengage 4
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The driver was developed through a joint effort between Citrix Incorporated,
|
||||||
|
Microsoft Corporation, and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
96
share/man/man8/hv_kvp_daemon.8
Normal file
96
share/man/man8/hv_kvp_daemon.8
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
.\" $FreeBSD$
|
||||||
|
.\"
|
||||||
|
.\" Copyright (c) 2012 Microsoft Corp.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.Dd September 10, 2013
|
||||||
|
.Dt HYPER-V 4
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm hv_kvp_daemon
|
||||||
|
.Nd Hyper-V Key Value Pair Daemon
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
To compile this driver into the kernel, place the following lines in
|
||||||
|
the system kernel configuration file:
|
||||||
|
.Bd -ragged -offset indent
|
||||||
|
.Cd "device hyperv"
|
||||||
|
.Ed
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
daemon provides the ability to store, retrieve, modify and delete
|
||||||
|
Key Value pairs for
|
||||||
|
.Fx
|
||||||
|
guest partitions running on Hyper-V.
|
||||||
|
Hyper-V allows administrators to store custom metadata in the form
|
||||||
|
of Key Value pairs inside the
|
||||||
|
.Fx
|
||||||
|
guest partition.
|
||||||
|
Administrators can use Windows Powershell scripts to add, read, modify
|
||||||
|
and delete such Key Value pairs.
|
||||||
|
.Pp
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
accepts Key Value pair management requests from the
|
||||||
|
.Xr hv_kvp 4
|
||||||
|
driver and performs the actual metadata management on the file-system.
|
||||||
|
.Pp
|
||||||
|
The same daemon and driver combination is also used to set and get
|
||||||
|
IP addresses from a
|
||||||
|
.Fx
|
||||||
|
guest.
|
||||||
|
.Pp
|
||||||
|
The set functionality is particularly
|
||||||
|
useful when the
|
||||||
|
.Fx
|
||||||
|
guest is assigned a static IP address and is failed
|
||||||
|
over from one Hyper-V host to another.
|
||||||
|
After failover, Hyper-V uses the set IP functionality to automatically
|
||||||
|
update the
|
||||||
|
.Fx
|
||||||
|
guest's IP address to its original static value.
|
||||||
|
.Pp
|
||||||
|
On the other hand, the get IP functionality is used to update the guest IP
|
||||||
|
address in the Hyper-V management console window.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr hv_vmbus 4 ,
|
||||||
|
.Xr hv_utils 4 ,
|
||||||
|
.Xr hv_netvsc 4 ,
|
||||||
|
.Xr hv_storvsc 4 ,
|
||||||
|
.Xr hv_ata_pci_disengage 4 ,
|
||||||
|
.Xr hv_kvp 4
|
||||||
|
.Sh HISTORY
|
||||||
|
Support for
|
||||||
|
.Nm
|
||||||
|
first appeared in
|
||||||
|
.Fx 10.0 .
|
||||||
|
The daemon was developed through a joint effort between Citrix Incorporated,
|
||||||
|
Microsoft Corporation, and Network Appliance Incorporated.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
|
.Fx
|
||||||
|
support for
|
||||||
|
.Nm
|
||||||
|
was first added by
|
||||||
|
.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
|
||||||
Loading…
x
Reference in New Issue
Block a user