libvirtd.conf 15.8 KB
Newer Older
1 2
# Master libvirt daemon configuration file
#
3
# For further information consult https://libvirt.org/format.html
4 5 6 7
#
# NOTE: the tests/daemon-conf regression test script requires
# that each "PARAMETER = VALUE" line in this file have the parameter
# name just after a leading "#".
8

9 10
#################################################################
#
11
# Network connectivity controls
12 13
#

14 15 16 17
# Flag listening for secure TLS connections on the public TCP/IP port.
# NB, must pass the --listen flag to the libvirtd process for this to
# have any effect.
#
18
# It is necessary to setup a CA and issue server certificates before
19 20 21
# using this capability.
#
# This is enabled by default, uncomment this to disable it
22
#listen_tls = 0
23 24 25 26 27

# Listen for unencrypted TCP connections on the public TCP/IP port.
# NB, must pass the --listen flag to the libvirtd process for this to
# have any effect.
#
28 29 30
# Using the TCP socket requires SASL authentication by default. Only
# SASL mechanisms which support data encryption are allowed. This is
# DIGEST_MD5 and GSSAPI (Kerberos5)
31 32
#
# This is disabled by default, uncomment this to enable it.
33
#listen_tcp = 1
34 35 36 37 38 39



# Override the port for accepting secure TLS connections
# This can be a port number, or service name
#
40
#tls_port = "16514"
41 42 43

# Override the port for accepting insecure TCP connections
# This can be a port number, or service name
44 45
#
#tcp_port = "16509"
46 47


48 49 50
# Override the default configuration which binds to all network
# interfaces. This can be a numeric IPv4/6 address, or hostname
#
51 52 53 54
# If the libvirtd service is started in parallel with network
# startup (e.g. with systemd), binding to addresses other than
# the wildcards (0.0.0.0/::) might not be available yet.
#
55
#listen_addr = "192.168.0.1"
56

57 58 59 60 61 62

# Flag toggling mDNS advertizement of the libvirt service.
#
# Alternatively can disable for all services on a host by
# stopping the Avahi daemon
#
63 64
# This is disabled by default, uncomment this to enable it
#mdns_adv = 1
65 66 67

# Override the default mDNS advertizement name. This must be
# unique on the immediate broadcast network.
68
#
69
# The default is "Virtualization Host HOSTNAME", where HOSTNAME
E
Eric Blake 已提交
70
# is substituted for the short hostname of the machine (without domain)
71
#
72
#mdns_name = "Virtualization Host Joe Demo"
73 74


75 76 77 78
#################################################################
#
# UNIX socket access controls
#
79 80 81 82

# Set the UNIX domain socket group ownership. This can be used to
# allow a 'trusted' set of users access to management capabilities
# without becoming root.
83 84 85
#
# This is restricted to 'root' by default.
#unix_sock_group = "libvirt"
86 87 88 89

# Set the UNIX socket permissions for the R/O socket. This is used
# for monitoring VM status only
#
E
Eric Blake 已提交
90 91
# Default allows any user. If setting group ownership, you may want to
# restrict this too.
92
#unix_sock_ro_perms = "0777"
93 94 95 96

# Set the UNIX socket permissions for the R/W socket. This is used
# for full management of VMs
#
97 98 99 100
# Default allows only root. If PolicyKit is enabled on the socket,
# the default will change to allow everyone (eg, 0777)
#
# If not using PolicyKit and setting group ownership for access
E
Eric Blake 已提交
101
# control, then you may want to relax this too.
102
#unix_sock_rw_perms = "0770"
103

104 105 106 107 108 109
# Set the UNIX socket permissions for the admin interface socket.
#
# Default allows only owner (root), do not change it unless you are
# sure to whom you are exposing the access to.
#unix_sock_admin_perms = "0700"

110 111
# Set the name of the directory in which sockets will be found/created.
#unix_sock_dir = "/var/run/libvirt"
112

113 114


115
#################################################################
116
#
117
# Authentication.
118
#
119 120 121 122 123 124 125 126 127
#  - none: do not perform auth checks. If you can connect to the
#          socket you are allowed. This is suitable if there are
#          restrictions on connecting to the socket (eg, UNIX
#          socket permissions), or if there is a lower layer in
#          the network providing auth (eg, TLS/x509 certificates)
#
#  - sasl: use SASL infrastructure. The actual auth scheme is then
#          controlled from /etc/sasl2/libvirt.conf. For the TCP
#          socket only GSSAPI & DIGEST-MD5 mechanisms will be used.
E
Eric Blake 已提交
128
#          For non-TCP or TLS sockets, any scheme is allowed.
129
#
130 131 132 133 134 135
#  - polkit: use PolicyKit to authenticate. This is only suitable
#            for use on the UNIX sockets. The default policy will
#            require a user to supply their own password to gain
#            full read/write access (aka sudo like), while anyone
#            is allowed read/only access.
#
136 137 138 139 140 141 142 143
# Set an authentication scheme for UNIX read-only sockets
# By default socket permissions allow anyone to connect
#
# To restrict monitoring of domains you may wish to enable
# an authentication mechanism here
#auth_unix_ro = "none"

# Set an authentication scheme for UNIX read-write sockets
144 145 146
# By default socket permissions only allow root. If PolicyKit
# support was compiled into libvirt, the default will be to
# use 'polkit' auth.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
#
# If the unix_sock_rw_perms are changed you may wish to enable
# an authentication mechanism here
#auth_unix_rw = "none"

# Change the authentication scheme for TCP sockets.
#
# If you don't enable SASL, then all TCP traffic is cleartext.
# Don't do this outside of a dev/test scenario. For real world
# use, always enable SASL and use the GSSAPI or DIGEST-MD5
# mechanism in /etc/sasl2/libvirt.conf
#auth_tcp = "sasl"

# Change the authentication scheme for TLS sockets.
#
# TLS sockets already have encryption provided by the TLS
# layer, and limited authentication is done by certificates
#
# It is possible to make use of any SASL authentication
# mechanism as well, by using 'sasl' for this option
#auth_tls = "none"


170 171 172 173 174 175 176 177
# Change the API access control scheme
#
# By default an authenticated user is allowed access
# to all APIs. Access drivers can place restrictions
# on this. By default the 'nop' driver is enabled,
# meaning no access control checks are done once a
# client has authenticated with libvirtd
#
178
#access_drivers = [ "polkit" ]
179

180
#################################################################
181
#
182
# TLS x509 certificate configuration
183
#
184

185 186 187 188 189 190 191 192 193 194 195 196 197 198
# Use of TLS requires that x509 certificates be issued. The default locations
# for the certificate files is as follows:
#
#   /etc/pki/CA/cacert.pem                 - The CA master certificate
#   /etc/pki/libvirt/servercert.pem        - The server certificate signed with
#                                            the cacert.pem
#   /etc/pki/libvirt/private/serverkey.pem - The server private key
#
# It is possible to override the default locations by altering the 'key_file',
# 'cert_file', and 'ca_file' values and uncommenting them below.
#
# NB, overriding the default of one location requires uncommenting and
# possibly additionally overriding the other settings.
#
199 200 201

# Override the default server key file path
#
202
#key_file = "/etc/pki/libvirt/private/serverkey.pem"
203 204 205

# Override the default server certificate file path
#
206
#cert_file = "/etc/pki/libvirt/servercert.pem"
207 208 209

# Override the default CA certificate path
#
210
#ca_file = "/etc/pki/CA/cacert.pem"
211 212

# Specify a certificate revocation list.
213
#
214
# Defaults to not using a CRL, uncomment to enable it
215 216 217 218 219 220 221 222 223 224
#crl_file = "/etc/pki/CA/crl.pem"



#################################################################
#
# Authorization controls
#


225 226 227 228 229
# Flag to disable verification of our own server certificates
#
# When libvirtd starts it performs some sanity checks against
# its own certificates.
#
230 231
# Default is to always run sanity checks. Uncommenting this
# will disable sanity checks which is not a good idea
232 233
#tls_no_sanity_certificate = 1

234 235 236 237 238 239 240 241 242 243
# Flag to disable verification of client certificates
#
# Client certificate verification is the primary authentication mechanism.
# Any client which does not present a certificate signed by the CA
# will be rejected.
#
# Default is to always verify. Uncommenting this will disable
# verification - make sure an IP whitelist is set
#tls_no_verify_certificate = 1

244

E
Eric Blake 已提交
245
# A whitelist of allowed x509 Distinguished Names
246
# This list may contain wildcards such as
247 248 249 250 251 252 253 254 255
#
#    "C=GB,ST=London,L=London,O=Red Hat,CN=*"
#
# See the POSIX fnmatch function for the format of the wildcards.
#
# NB If this is an empty list, no client can connect, so comment out
# entirely rather than using empty list to disable these checks
#
# By default, no DN's are checked
256
#tls_allowed_dn_list = ["DN1", "DN2"]
257 258


259
# A whitelist of allowed SASL usernames. The format for username
260 261
# depends on the SASL authentication mechanism. Kerberos usernames
# look like username@REALM
262
#
263 264 265 266 267
# This list may contain wildcards such as
#
#    "*@EXAMPLE.COM"
#
# See the POSIX fnmatch function for the format of the wildcards.
268 269 270 271
#
# NB If this is an empty list, no client can connect, so comment out
# entirely rather than using empty list to disable these checks
#
272 273
# By default, no Username's are checked
#sasl_allowed_username_list = ["joe@EXAMPLE.COM", "fred@EXAMPLE.COM" ]
274 275


276 277 278 279 280 281 282
# Override the compile time default TLS priority string. The
# default is usually "NORMAL" unless overridden at build time.
# Only set this is it is desired for libvirt to deviate from
# the global default settings.
#
#tls_priority="NORMAL"

283 284 285 286 287 288 289 290

#################################################################
#
# Processing controls
#

# The maximum number of concurrent client connections to allow
# over all sockets combined.
291
#max_clients = 5000
292

M
Michal Privoznik 已提交
293 294 295 296 297 298
# The maximum length of queue of connections waiting to be
# accepted by the daemon. Note, that some protocols supporting
# retransmission may obey this so that a later reattempt at
# connection succeeds.
#max_queued_clients = 1000

299
# The maximum length of queue of accepted but not yet
300 301
# authenticated clients. The default value is 20. Set this to
# zero to turn this feature off.
302
#max_anonymous_clients = 20
303 304 305

# The minimum limit sets the number of workers to start up
# initially. If the number of active clients exceeds this,
J
Ján Tomko 已提交
306
# then more threads are spawned, up to max_workers limit.
307 308 309 310 311
# Typically you'd want max_workers to equal maximum number
# of clients allowed
#min_workers = 5
#max_workers = 20

312 313

# The number of priority workers. If all workers from above
E
Eric Blake 已提交
314
# pool are stuck, some calls marked as high priority
315 316 317
# (notably domainDestroy) can be executed in this pool.
#prio_workers = 5

318 319
# Limit on concurrent requests from a single client
# connection. To avoid one client monopolizing the server
320 321
# this should be a small fraction of the global max_workers
# parameter.
322 323
#max_client_requests = 5

324 325 326 327 328 329 330 331 332 333
# Same processing controls, but this time for the admin interface.
# For description of each option, be so kind to scroll few lines
# upwards.

#admin_min_workers = 1
#admin_max_workers = 5
#admin_max_clients = 5
#admin_max_queued_clients = 5
#admin_max_client_requests = 5

D
Daniel Veillard 已提交
334 335 336 337 338
#################################################################
#
# Logging controls
#

E
Eric Blake 已提交
339
# Logging level: 4 errors, 3 warnings, 2 information, 1 debug
D
Daniel Veillard 已提交
340
# basically 1 will log everything possible
341 342 343 344
# Note: Journald may employ rate limiting of the messages logged
# and thus lock up the libvirt daemon. To use the debug level with
# journald you have to specify it explicitly in 'log_outputs', otherwise
# only information level messages will be logged.
D
Daniel Veillard 已提交
345 346 347 348 349
#log_level = 3

# Logging filters:
# A filter allows to select a different logging level for a given category
# of logs
350
# The format for a filter is one of:
D
Daniel Veillard 已提交
351
#    x:name
352
#    x:+name
353 354 355 356 357 358 359 360 361 362

#      where name is a string which is matched against the category
#      given in the VIR_LOG_INIT() at the top of each libvirt source
#      file, e.g., "remote", "qemu", or "util.json" (the name in the
#      filter can be a substring of the full category name, in order
#      to match multiple similar categories), the optional "+" prefix
#      tells libvirt to log stack trace for each message matching
#      name, and x is the minimal level where matching messages should
#      be logged:

D
Daniel Veillard 已提交
363 364 365 366 367
#    1: DEBUG
#    2: INFO
#    3: WARNING
#    4: ERROR
#
E
Eric Blake 已提交
368
# Multiple filters can be defined in a single @filters, they just need to be
369 370
# separated by spaces. Note that libvirt performs "first" match, i.e. if
# there are concurrent filters, the first one that matches will be applied,
371 372 373
# given the order in log_filters with the exception of a wildcard filter, since
# that's only taken into account if no other filter has matched, so
# "4:* 1:util.pci" and "1:util.pci 4:*" are equivalent definitions.
D
Daniel Veillard 已提交
374
#
375 376 377
# e.g. to only get warning or errors from the remote layer and only errors
# from the event layer:
#log_filters="3:remote 4:event"
D
Daniel Veillard 已提交
378 379

# Logging outputs:
E
Eric Blake 已提交
380
# An output is one of the places to save logging information
D
Daniel Veillard 已提交
381 382 383 384 385 386 387
# The format for an output can be:
#    x:stderr
#      output goes to stderr
#    x:syslog:name
#      use syslog for the output and use the given name as the ident
#    x:file:file_path
#      output to a file, with the given filepath
388 389
#    x:journald
#      output to journald logging system
D
Daniel Veillard 已提交
390 391 392 393 394 395
# In all case the x prefix is the minimal level, acting as a filter
#    1: DEBUG
#    2: INFO
#    3: WARNING
#    4: ERROR
#
E
Eric Blake 已提交
396
# Multiple outputs can be defined, they just need to be separated by spaces.
397 398 399
# e.g. to log all warnings and errors to syslog under the libvirtd ident:
#log_outputs="3:syslog:libvirtd"
#
400

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

##################################################################
#
# Auditing
#
# This setting allows usage of the auditing subsystem to be altered:
#
#   audit_level == 0  -> disable all auditing
#   audit_level == 1  -> enable auditing, only if enabled on host (default)
#   audit_level == 2  -> enable auditing, and exit if disabled on host
#
#audit_level = 2
#
# If set to 1, then audit messages will also be sent
# via libvirt logging infrastructure. Defaults to 0
#
#audit_logging = 1

###################################################################
420
# UUID of the host:
421 422 423 424 425 426 427 428 429 430
# Host UUID is read from one of the sources specified in host_uuid_source.
#
# - 'smbios': fetch the UUID from 'dmidecode -s system-uuid'
# - 'machine-id': fetch the UUID from /etc/machine-id
#
# The host_uuid_source default is 'smbios'. If 'dmidecode' does not provide
# a valid UUID a temporary UUID will be generated.
#
# Another option is to specify host UUID in host_uuid.
#
431 432 433 434 435 436 437
# Keep the format of the example UUID below. UUID must not have all digits
# be the same.

# NB This default all-zeros UUID will not work. Replace
# it with the output of the 'uuidgen' command and then
# uncomment this entry
#host_uuid = "00000000-0000-0000-0000-000000000000"
438
#host_uuid_source = "smbios"
439 440 441 442

###################################################################
# Keepalive protocol:
# This allows libvirtd to detect broken client connections or even
E
Eric Blake 已提交
443
# dead clients.  A keepalive message is sent to a client after
444 445 446 447 448 449 450 451
# keepalive_interval seconds of inactivity to check if the client is
# still responding; keepalive_count is a maximum number of keepalive
# messages that are allowed to be sent to the client without getting
# any response before the connection is considered broken.  In other
# words, the connection is automatically closed approximately after
# keepalive_interval * (keepalive_count + 1) seconds since the last
# message received from the client.  If keepalive_interval is set to
# -1, libvirtd will never send keepalive requests; however clients
E
Eric Blake 已提交
452
# can still send them and the daemon will send responses.  When
453 454 455 456 457 458
# keepalive_count is set to 0, connections will be automatically
# closed after keepalive_interval seconds of inactivity without
# sending any keepalive messages.
#
#keepalive_interval = 5
#keepalive_count = 5
459

460
#
461 462 463
# These configuration options are no longer used.  There is no way to
# restrict such clients from connecting since they first need to
# connect in order to ask for keepalive.
464 465
#
#keepalive_required = 1
466
#admin_keepalive_required = 1
467 468 469 470

# Keepalive settings for the admin interface
#admin_keepalive_interval = 5
#admin_keepalive_count = 5
471 472 473 474 475 476 477 478 479

###################################################################
# Open vSwitch:
# This allows to specify a timeout for openvswitch calls made by
# libvirt. The ovs-vsctl utility is used for the configuration and
# its timeout option is set by default to 5 seconds to avoid
# potential infinite waits blocking libvirt.
#
#ovs_timeout = 5