1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
=============
Documentation
=============
Deployment / operation
----------------------
`Applications <apps.html>`__
Applications known to use libvirt
`Manual pages <manpages/index.html>`__
Manual pages for libvirt tools / daemons
`Windows <windows.html>`__
Downloads for Windows
`macOS <macos.html>`__
Working with libvirt on macOS
`Migration <migration.html>`__
Migrating guests between machines
`Daemons <daemons.html>`__
Overview of the daemons provided by libvirt
`Remote access <remote.html>`__
Enable remote access over TCP
`TLS certs <kbase/tlscerts.html>`__
Generate and deploy x509 certificates for TLS
`Authentication <auth.html>`__
Configure authentication for the libvirt daemon
`Access control <acl.html>`__
Configure access control libvirt APIs with `polkit <aclpolkit.html>`__
`Logging <logging.html>`__
The library and the daemon logging support
`Audit log <auditlog.html>`__
Audit trail logs for host operations
`Firewall <firewall.html>`__
Firewall and network filter configuration
`Hooks <hooks.html>`__
Hooks for system specific management
`SSH Proxy <ssh-proxy.html>`__
Enable SSH into guests over a VSOCK
`NSS module <nss.html>`__
Enable domain host name translation to IP addresses
`FAQ <https://wiki.libvirt.org/page/FAQ>`__
Frequently asked questions
Application development
-----------------------
`API reference <html/index.html>`__
Reference manual for the C public API, split in:
* `common <html/libvirt-libvirt-common.html>`__
* `domain <html/libvirt-libvirt-domain.html>`__
* `domain checkpoint <html/libvirt-libvirt-domain-checkpoint.html>`__
* `domain snapshot <html/libvirt-libvirt-domain-snapshot.html>`__
* `error <html/libvirt-virterror.html>`__
* `event <html/libvirt-libvirt-event.html>`__
* `host <html/libvirt-libvirt-host.html>`__
* `interface <html/libvirt-libvirt-interface.html>`__
* `network <html/libvirt-libvirt-network.html>`__
* `node device <html/libvirt-libvirt-nodedev.html>`__
* `network filter <html/libvirt-libvirt-nwfilter.html>`__
* `secret <html/libvirt-libvirt-secret.html>`__
* `storage <html/libvirt-libvirt-storage.html>`__
* `stream <html/libvirt-libvirt-stream.html>`__
and the documentation for the API of the additional libs:
* `admin <html/libvirt-libvirt-admin.html>`__
* `QEMU <html/libvirt-libvirt-qemu.html>`__
* `LXC <html/libvirt-libvirt-lxc.html>`__
`XML schemas <format.html>`__
Description of the XML schemas for
* `domains <formatdomain.html>`__
* `networks <formatnetwork.html>`__
* `network ports <formatnetworkport.html>`__
* `network filtering <formatnwfilter.html>`__
* `storage <formatstorage.html>`__
* `storage encryption <formatstorageencryption.html>`__
* `capabilities <formatcaps.html>`__
* `domain capabilities <formatdomaincaps.html>`__
* `storage pool capabilities <formatstoragecaps.html>`__
* `node devices <formatnode.html>`__
* `secrets <formatsecret.html>`__
* `snapshots <formatsnapshot.html>`__
* `checkpoints <formatcheckpoint.html>`__
* `backup jobs <formatbackup.html>`__
`Language bindings and API modules <bindings.html>`__
Bindings of the libvirt API for
`c# <csharp.html>`__,
`go <https://pkg.go.dev/libvirt.org/go/libvirt>`__ (`all go modules <golang.html>`__),
`java <https://java.libvirt.org/>`__,
`ocaml <https://ocaml.libvirt.org/>`__,
`perl <https://search.cpan.org/dist/Sys-Virt/>`__,
`python <python.html>`__,
`php <https://php.libvirt.org>`__,
`ruby <https://ruby.libvirt.org/>`__
and integration API modules for
`D-Bus <dbus.html>`__
`URI format <uri.html>`__
The URI formats used for connecting to libvirt
`CGroups <cgroups.html>`__
Control groups integration
`Drivers <drivers.html>`__
Hypervisor specific driver information
`Support guarantees <support.html>`__
Details of support status for various interfaces
`Driver support <hvsupport.html>`__
matrix of API support per hypervisor per release
`Knowledge Base <kbase/index.html>`__
Task oriented guides to key features
Project development
-------------------
`Contributor guidelines <hacking.html>`__
General hacking guidelines for contributors
`Docs style guide <styleguide.html>`__
Style guidelines for reStructuredText docs
`Project strategy <strategy.html>`__
Sets a vision for future direction & technical choices
`CI <ci.html>`__
Details on our Continuous Integration
`Upstream issue handling <issue-handling.html>`__
Outlines the process of handling issues as well as describes the supported
issue types along with their life cycle.
`Bug reports <bugs.html>`__
How and where to report bugs and request features
`Compiling <compiling.html>`__
How to compile libvirt
`Goals <goals.html>`__
Terminology and goals of libvirt API
`API concepts <api.html>`__
The libvirt API concepts
`API extensions <api_extension.html>`__
Adding new public libvirt APIs
`Testing <testing.html>`__
Details various types of testing available for libvirt
`New repo setup <newreposetup.html>`__
Procedure for configuring new git repositories for libvirt
`Libvirt logos <logos/index.html>`__
Libvirt logo files and guideline how to use them
|
