xref: /openbsd-src/share/man/man4/xen.4 (revision d6e4fb617d7baf1734cb8b11f3c752b48baf0cbc)
1.\"	$OpenBSD: xen.4,v 1.3 2021/10/21 15:56:17 denis Exp $
2.\"
3.\" Copyright (c) 2015 Mike Belopuhov
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: October 21 2021 $
18.Dt XEN 4
19.Os
20.Sh NAME
21.Nm xen
22.Nd Xen domU nexus device
23.Sh SYNOPSIS
24.Cd "xen0 at pvbus?"
25.Sh DESCRIPTION
26.Nm
27driver performs HVM domU guest initialization, provides abstraction for
28virtual Xen interrupts, access to the XenStore configuration storage as
29well as a device probing facility for paravirtualized devices such as
30disk and network interfaces.
31.Pp
32When running under XenServer, to let the host know that the guest has
33finished initializing and to allow graceful shutdown, set the following
34XenStore properties with
35.Xr hostctl 8
36in
37.Xr rc.local 8 :
38.Bd -literal -offset indent
39ostype=$(sysctl -n kern.ostype)
40osrelease=$(sysctl -n kern.osrelease)
41
42# XenServer Tools version
43hostctl attr/PVAddons/MajorVersion 6
44hostctl attr/PVAddons/MinorVersion 2
45hostctl attr/PVAddons/MicroVersion 0
46hostctl attr/PVAddons/BuildVersion 76888
47hostctl attr/PVAddons/Installed 1
48
49# OS version
50hostctl data/os_name "$ostype $osrelease"
51hostctl data/os_uname $osrelease
52hostctl data/os_distro $ostype
53
54# Inform Xen of IPs bound to the VM
55hostctl attr/vif/0/ipv4/0 192.0.2.1
56hostctl attr/vif/0/ipv6/0 2001:db8::1
57
58# Update XenStore
59hostctl data/updated 1
60.Ed
61.Sh SEE ALSO
62.Xr autoconf 4 ,
63.Xr intro 4 ,
64.Xr pvbus 4
65.Sh HISTORY
66The
67.Nm
68driver first appeared in
69.Ox 5.9 .
70.Sh AUTHORS
71The
72.Nm
73driver was written by
74.An Mike Belopuhov Aq Mt mikeb@openbsd.org
75from scratch, inspired by the
76.Fx
77implementation.
78