2007-06-19 13:43:28 +00:00
<?xml version="1.0" encoding="ISO-8859-1"?>
2008-04-25 16:23:51 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2008-04-23 17:08:31 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
<!--
This file is autogenerated from uri.html.in
Do not edit this file. Changes will be lost.
-->
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" / >
< link rel = "stylesheet" type = "text/css" href = "main.css" / >
< link rel = "SHORTCUT ICON" href = "32favicon.png" / >
< title > libvirt: Connection URIs< / title >
< meta name = "description" content = "libvirt, virtualization, virtualization API" / >
< / head >
< body >
< div id = "header" >
< div id = "headerLogo" > < / div >
< div id = "headerSearch" >
2008-07-22 09:52:31 +00:00
< form action = "search.php" enctype = "application/x-www-form-urlencoded" method = "get" > < div >
2008-04-25 16:23:51 +00:00
< input id = "query" name = "query" type = "text" size = "12" value = "" / >
< input id = "submit" name = "submit" type = "submit" value = "Search" / >
2008-07-22 09:52:31 +00:00
< / div > < / form >
2008-04-23 17:08:31 +00:00
< / div >
< / div >
< div id = "body" >
2008-04-25 16:23:51 +00:00
< div id = "menu" >
2008-07-22 09:52:31 +00:00
< ul class = "l0" > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Front page of the libvirt website" class = "inactive" href = "index.html" > Home< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Details of new features and bugs fixed in each release" class = "inactive" href = "news.html" > News< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Get the latest source releases, binary builds and get access to the source repository" class = "inactive" href = "downloads.html" > Downloads< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Information for users, administrators and developers" class = "active" href = "docs.html" > Documentation< / a >
2008-07-22 09:52:31 +00:00
< ul class = "l1" > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Information about deploying and using libvirt" class = "active" href = "deployment.html" > Deployment< / a >
2008-07-22 09:52:31 +00:00
< ul class = "l2" > < li >
2008-04-25 16:23:51 +00:00
< div >
< span class = "active" > URI format< / span >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Enable remote access over TCP" class = "inactive" href = "remote.html" > Remote access< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Configure authentication for the libvirt daemon" class = "inactive" href = "auth.html" > Authentication< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Access the libvirt daemon from a native Windows client" class = "inactive" href = "windows.html" > Windows port< / a >
< / div >
2008-12-23 13:47:10 +00:00
< / li > < li >
< div >
< a title = "The library and the daemon logging support" class = "inactive" href = "logging.html" > Logging< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < / ul >
2008-04-25 16:23:51 +00:00
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Overview of the logical subsystems in the libvirt API" class = "inactive" href = "intro.html" > Architecture< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Description of the XML formats used in libvirt" class = "inactive" href = "format.html" > XML format< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Hypervisor specific driver information" class = "inactive" href = "drivers.html" > Drivers< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Reference manual for the C public API" class = "inactive" href = "html/index.html" > API reference< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Bindings of the libvirt API for other languages" class = "inactive" href = "bindings.html" > Language bindings< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < / ul >
2008-04-25 16:23:51 +00:00
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "User contributed content" class = "inactive" href = "http://wiki.libvirt.org" > Wiki< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Frequently asked questions" class = "inactive" href = "FAQ.html" > FAQ< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "How and where to report bugs and request features" class = "inactive" href = "bugs.html" > Bug reports< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "How to contact the developers via email and IRC" class = "inactive" href = "contact.html" > Contact< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Miscellaneous links of interest related to libvirt" class = "inactive" href = "relatedlinks.html" > Related Links< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < li >
2008-04-25 16:23:51 +00:00
< div >
< a title = "Overview of all content on the website" class = "inactive" href = "sitemap.html" > Sitemap< / a >
< / div >
2008-07-22 09:52:31 +00:00
< / li > < / ul >
2008-04-25 16:23:51 +00:00
< / div >
2008-04-23 17:08:31 +00:00
< div id = "content" >
< h1 > Connection URIs< / h1 >
< p >
2007-06-19 16:07:58 +00:00
Since libvirt supports many different kinds of virtualization
(often referred to as "drivers" or "hypervisors"), we need a
way to be able to specify which driver a connection refers to.
Additionally we may want to refer to a driver on a remote
machine over the network.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
To this end, libvirt uses URIs as used on the Web and as defined in < a href = "http://www.ietf.org/rfc/rfc2396.txt" > RFC 2396< / a > . This page
documents libvirt URIs.
2008-04-23 17:08:31 +00:00
< / p >
2008-07-22 09:52:31 +00:00
< ul > < li >
< a href = "#URI_libvirt" > Specifying URIs to libvirt< / a >
< / li > < li >
< a href = "#URI_virsh" > Specifying URIs to virsh, virt-manager and virt-install< / a >
< / li > < li >
< a href = "#URI_xen" > xen:/// URI< / a >
< / li > < li >
< a href = "#URI_qemu" > qemu:///... QEMU and KVM URIs< / a >
< / li > < li >
< a href = "#URI_remote" > Remote URIs< / a >
< / li > < li >
< a href = "#URI_test" > test:///... Test URIs< / a >
< / li > < li >
< a href = "#URI_legacy" > Other & legacy URI formats< / a >
< / li > < / ul >
2008-04-23 17:08:31 +00:00
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_libvirt" id = "URI_libvirt" > Specifying URIs to libvirt< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
The URI is passed as the < code > name< / code > parameter to < a href = "html/libvirt-libvirt.html#virConnectOpen" > < code > virConnectOpen< / code > < / a > or < a href = "html/libvirt-libvirt.html#virConnectOpenReadOnly" > < code > virConnectOpenReadOnly< / code > < / a > . For example:
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
virConnectPtr conn = virConnectOpenReadOnly (< b > "test:///default"< / b > );
2008-04-23 17:08:31 +00:00
< / pre >
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_virsh" id = "URI_virsh" > Specifying URIs to virsh, virt-manager and virt-install< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
In virsh use the < code > -c< / code > or < code > --connect< / code > option:
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
virsh < b > -c test:///default< / b > list
2008-04-23 17:08:31 +00:00
< / pre >
< p >
2007-06-19 16:07:58 +00:00
If virsh finds the environment variable
< code > VIRSH_DEFAULT_CONNECT_URI< / code > set, it will try this URI by
default.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
When using the interactive virsh shell, you can also use the
< code > connect< / code > < i > URI< / i > command to reconnect to another
hypervisor.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
In virt-manager use the < code > -c< / code > or < code > --connect=< / code > < i > URI< / i > option:
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
virt-manager < b > -c test:///default< / b >
2008-04-23 17:08:31 +00:00
< / pre >
< p >
2007-06-19 16:07:58 +00:00
In virt-install use the < code > --connect=< / code > < i > URI< / i > option:
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
virt-install < b > --connect=test:///default< / b > < i > [other options]< / i >
2008-04-23 17:08:31 +00:00
< / pre >
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_xen" id = "URI_xen" > xen:/// URI< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< p >
2008-07-22 09:52:31 +00:00
< i > This section describes a feature which is new in libvirt >
2007-06-19 16:07:58 +00:00
0.2.3. For libvirt ≤ 0.2.3 use < a href = "#URI_legacy_xen" > < code > "xen"< / code > < / a > .< / i >
2008-07-22 09:52:31 +00:00
< / p >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
To access a Xen hypervisor running on the local machine
use the URI < code > xen:///< / code > .
2008-04-23 17:08:31 +00:00
< / p >
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_qemu" id = "URI_qemu" > qemu:///... QEMU and KVM URIs< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
To use QEMU support in libvirt you must be running the
2007-09-05 14:32:13 +00:00
< code > libvirtd< / code > daemon (named < code > libvirt_qemud< / code >
in releases prior to 0.3.0). The purpose of this
2007-06-19 16:07:58 +00:00
daemon is to manage qemu instances.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2008-02-05 19:27:37 +00:00
The < code > libvirtd< / code > daemon should be started by the
2007-11-15 17:07:28 +00:00
init scripts when the machine boots. It should appear as
a process < code > libvirtd --daemon< / code > running as root
in the background and will handle qemu instances on behalf
2008-04-23 17:08:31 +00:00
of all users of the machine (among other things). < / p >
< p >
2007-06-19 16:07:58 +00:00
So to connect to the daemon, one of two different URIs is used:
2008-04-23 17:08:31 +00:00
< / p >
2008-07-22 09:52:31 +00:00
< ul > < li > < code > qemu:///system< / code > connects to a system mode daemon. < / li > < li > < code > qemu:///session< / code > connects to a session mode daemon. < / li > < / ul >
2008-04-23 17:08:31 +00:00
< p >
2007-09-05 14:32:13 +00:00
(If you do < code > libvirtd --help< / code > , the daemon will print
2007-06-19 16:07:58 +00:00
out the paths of the Unix domain socket(s) that it listens on in
the various different modes).
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
KVM URIs are identical. You select between qemu, qemu accelerated and
KVM guests in the < a href = "format.html#KVM1" > guest XML as described
here< / a > .
2008-04-23 17:08:31 +00:00
< / p >
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_remote" id = "URI_remote" > Remote URIs< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
Remote URIs are formed by taking ordinary local URIs and adding a
2008-11-28 12:03:20 +00:00
hostname and/or transport name. As a special case, using a URI
scheme of 'remote', will tell the remote libvirtd server to probe
for the optimal hypervisor driver. This is equivalent to passing
a NULL URI for a local connection. For example:
2008-04-23 17:08:31 +00:00
< / p >
2008-07-22 09:52:31 +00:00
< table class = "top_table" > < tr > < th > Local URI < / th > < th > Remote URI < / th > < th > Meaning < / th > < / tr > < tr > < td >
< code > xen:///< / code >
< / td > < td >
< code > xen://oirase/< / code >
< / td > < td > Connect to the Xen hypervisor running on host < code > oirase< / code >
2008-11-28 12:03:20 +00:00
using TLS. < / td > < / tr > < tr > < td >
< code > NULL< / code >
< / td > < td >
< code > remote://oirase/< / code >
< / td > < td > Connect to the "default" hypervisor running on host < code > oirase< / code >
2008-07-22 09:52:31 +00:00
using TLS. < / td > < / tr > < tr > < td >
< code > xen:///< / code >
< / td > < td >
< code > xen+ssh://oirase/< / code >
< / td > < td > Connect to the Xen hypervisor running on host < code > oirase< / code >
by going over an < code > ssh< / code > connection. < / td > < / tr > < tr > < td >
< code > test:///default< / code >
< / td > < td >
< code > test+tcp://oirase/default< / code >
< / td > < td > Connect to the test driver on host < code > oirase< / code >
using an unsecured TCP connection. < / td > < / tr > < / table >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
Remote URIs in libvirt offer a rich syntax and many features.
We refer you to < a href = "remote.html#Remote_URI_reference" > the libvirt
remote URI reference< / a > and < a href = "remote.html" > full documentation
for libvirt remote support< / a > .
2008-04-23 17:08:31 +00:00
< / p >
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_test" id = "URI_test" > test:///... Test URIs< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
The test driver is a dummy hypervisor for test purposes.
The URIs supported are:
2008-04-23 17:08:31 +00:00
< / p >
2008-07-22 09:52:31 +00:00
< ul > < li > < code > test:///default< / code > connects to a default set of
host definitions built into the driver. < / li > < li > < code > test:///path/to/host/definitions< / code > connects to
2007-06-19 16:07:58 +00:00
a set of host definitions held in the named file.
2008-07-22 09:52:31 +00:00
< / li > < / ul >
2008-04-23 17:08:31 +00:00
< h3 >
2008-07-22 09:52:31 +00:00
< a name = "URI_legacy" id = "URI_legacy" > Other & legacy URI formats< / a >
< / h3 >
2008-04-23 17:08:31 +00:00
< h4 >
2008-07-22 09:52:31 +00:00
< a name = "URI_NULL" id = "URI_NULL" > NULL and empty string URIs< / a >
< / h4 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
Libvirt allows you to pass a < code > NULL< / code > pointer to
< code > virConnectOpen*< / code > . Empty string (< code > ""< / code > ) acts in
the same way. Traditionally this has meant
< q > connect to the local Xen hypervisor< / q > . However in future this
may change to mean < q > connect to the best available hypervisor< / q > .
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
The theory is that if, for example, Xen is unavailable but the
machine is running an OpenVZ kernel, then we should not try to
connect to the Xen hypervisor since that is obviously the wrong
thing to do.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
In any case applications linked to libvirt can continue to pass
< code > NULL< / code > as a default choice, but should always allow the
user to override the URI, either by constructing one or by allowing
the user to type a URI in directly (if that is appropriate). If your
application wishes to connect specifically to a Xen hypervisor, then
for future proofing it should choose a full < a href = "#URI_xen" > < code > xen:///< / code > URI< / a > .
2008-04-23 17:08:31 +00:00
< / p >
< h4 >
2008-07-22 09:52:31 +00:00
< a name = "URI_file" id = "URI_file" > File paths (xend-unix-server)< / a >
< / h4 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
If XenD is running and configured in < code > /etc/xen/xend-config.sxp< / code > :
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
(xend-unix-server yes)
2008-04-23 17:08:31 +00:00
< / pre >
< p >
2007-06-19 16:07:58 +00:00
then it listens on a Unix domain socket, usually at
< code > /var/lib/xend/xend-socket< / code > . You may pass a different path
using a file URI such as:
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
virsh -c ///var/run/xend/xend-socket
2008-04-23 17:08:31 +00:00
< / pre >
< h4 >
2008-07-22 09:52:31 +00:00
< a name = "URI_http" id = "URI_http" > Legacy: < code > http://...< / code > (xend-http-server)< / a >
< / h4 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
If XenD is running and configured in < code > /etc/xen/xend-config.sxp< / code > :
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
(xend-http-server yes)
2008-04-23 17:08:31 +00:00
< / pre >
< p >
2007-06-19 16:07:58 +00:00
then it listens on TCP port 8000. libvirt allows you to
try to connect to xend running on remote machines by passing
< code > http://< i > hostname< / i > [:< i > port< / i > ]/< / code > , for example:
2008-04-23 17:08:31 +00:00
< / p >
< pre >
2007-06-19 16:07:58 +00:00
virsh -c http://oirase/ list
2008-04-23 17:08:31 +00:00
< / pre >
< p >
2007-06-19 16:07:58 +00:00
This method is unencrypted and insecure and is definitely not
recommended for production use. Instead use < a href = "remote.html" > libvirt's remote support< / a > .
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
Notes:
2008-04-23 17:08:31 +00:00
< / p >
2008-07-22 09:52:31 +00:00
< ol > < li > The HTTP client does not fully support IPv6. < / li > < li > Many features do not work as expected across HTTP connections, in
2007-06-19 16:07:58 +00:00
particular, < a href = "html/libvirt-libvirt.html#virConnectGetCapabilities" > virConnectGetCapabilities< / a > .
The < a href = "remote.html" > remote support< / a > however does work
2008-07-22 09:52:31 +00:00
correctly. < / li > < li > XenD's new-style XMLRPC interface is not supported by
2007-06-19 16:07:58 +00:00
libvirt, only the old-style sexpr interface known in the Xen
2008-07-22 09:52:31 +00:00
documentation as "unix server" or "http server".< / li > < / ol >
2008-04-23 17:08:31 +00:00
< h4 >
2008-07-22 09:52:31 +00:00
< a name = "URI_legacy_xen" id = "URI_legacy_xen" > Legacy: < code > "xen"< / code > < / a >
< / h4 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
Another legacy URI is to specify name as the string
< code > "xen"< / code > . This will continue to refer to the Xen
hypervisor. However you should prefer a full < a href = "#URI_xen" > < code > xen:///< / code > URI< / a > in all future code.
2008-04-23 17:08:31 +00:00
< / p >
< h4 >
2008-07-22 09:52:31 +00:00
< a name = "URI_legacy_proxy" id = "URI_legacy_proxy" > Legacy: Xen proxy< / a >
< / h4 >
2008-04-23 17:08:31 +00:00
< p >
2007-06-19 16:07:58 +00:00
Libvirt continues to support connections to a separately running Xen
proxy daemon. This provides a way to allow non-root users to make a
safe (read-only) subset of queries to the hypervisor.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
There is no specific "Xen proxy" URI. However if a Xen URI of any of
the ordinary or legacy forms is used (eg. < code > NULL< / code > ,
< code > ""< / code > , < code > "xen"< / code > , ...) which fails, < i > and< / i > the
user is not root, < i > and< / i > the Xen proxy socket can be connected to
(< code > /tmp/libvirt_proxy_conn< / code > ), then libvirt will use a proxy
connection.
2008-04-23 17:08:31 +00:00
< / p >
< p >
2007-06-19 16:07:58 +00:00
You should consider using < a href = "remote.html" > libvirt remote support< / a >
in future.
2008-04-23 17:08:31 +00:00
< / p >
< / div >
< / div >
< div id = "footer" >
2008-04-28 08:29:35 +00:00
< p id = "sponsor" >
Sponsored by:< br / > < a href = "http://et.redhat.com/" > < img src = "et.png" alt = "Project sponsored by Red Hat Emerging Technology" / > < / a > < / p >
2008-04-23 17:08:31 +00:00
< / div >
< / body >
< / html >
