Sys::Virt::Error(3pm)

1Sys::Virt::Error(3pm) User Contributed Perl DocumentationSys::Virt::Error(3pm)
2
3
4

NAME

6       Sys::Virt::Error - Error object for libvirt APIs
7

DESCRIPTION

9       The "Sys::Virt::Error" class provides an encoding of the libvirt
10       errors. Instances of this object can be thrown by pretty much any of
11       the Sys::Virt APIs.
12

METHODS

14       $err->stringify
15           Convert the object into string format suitable for printing on a
16           console to inform a user of the error.
17
18       my $level = $err->level
19           Return the raw error level represented by this error. One of the
20           ERROR LEVEL CONSTANTS
21
22       my $code = $err->code
23           Return the raw error code represented by this error. One of the
24           ERROR CODE CONSTANTS
25
26       my $from = $err->domain
27           Return the error domain raising this error. One of the ERROR DOMAIN
28           CONSTANTS
29
30       my $msg = $err->message
31           Return an informative message describing the error condition.
32

CONSTANTS

34   ERROR LEVEL CONSTANTS
35       Sys::Virt::Error::LEVEL_NONE
36           Undefined error level
37
38       Sys::Virt::Error::LEVEL_WARNING
39           Warning error level
40
41       Sys::Virt::Error::LEVEL_ERROR
42           Fatal error level
43
44   ERROR DOMAIN CONSTANTS
45       The error domain indicates which internal part of libvirt the error
46       report was raised from.
47
48       Sys::Virt::Error::FROM_CONF
49           Configuration file handling
50
51       Sys::Virt::Error::FROM_DOM
52           Error while operating on a domain
53
54       Sys::Virt::Error::FROM_DOMAIN
55           Domain configuration handling
56
57       Sys::Virt::Error::FROM_LXC
58           LXC virtualization driver
59
60       Sys::Virt::Error::FROM_NET
61           Error while operating on a network
62
63       Sys::Virt::Error::FROM_NETWORK
64           Network configuration handling
65
66       Sys::Virt::Error::FROM_NODEDEV
67           Node device configuration handling
68
69       Sys::Virt::Error::FROM_NONE
70           No specific error domain.
71
72       Sys::Virt::Error::FROM_OPENVZ
73           OpenVZ virtualization driver
74
75       Sys::Virt::Error::FROM_PROXY
76           Xen proxy virtualization driver
77
78       Sys::Virt::Error::FROM_QEMU
79           QEMU virtualization driver
80
81       Sys::Virt::Error::FROM_REMOTE
82           Remote client virtualization driver
83
84       Sys::Virt::Error::FROM_RPC
85           XML-RPC handling code
86
87       Sys::Virt::Error::FROM_SECURITY
88           Security services driver
89
90       Sys::Virt::Error::FROM_SEXPR
91           SEXPR parsing code
92
93       Sys::Virt::Error::FROM_STATS_LINUX
94           Device statistics code
95
96       Sys::Virt::Error::FROM_STORAGE
97           Storage configuration handling
98
99       Sys::Virt::Error::FROM_TEST
100           Test virtualization driver
101
102       Sys::Virt::Error::FROM_UML
103           UML virtualization driver
104
105       Sys::Virt::Error::FROM_XEN
106           Xen hypervisor driver
107
108       Sys::Virt::Error::FROM_XEND
109           XenD daemon driver
110
111       Sys::Virt::Error::FROM_XENSTORE
112           XenStore driver
113
114       Sys::Virt::Error::FROM_XENXM
115           Xen XM configuration file driver
116
117       Sys::Virt::Error::FROM_XEN_INOTIFY
118           Xen Inotify events driver
119
120       Sys::Virt::Error::FROM_XML
121           Low level XML parser
122
123       Sys::Virt::Error::FROM_ESX
124           The VMWare ESX driver
125
126       Sys::Virt::Error::FROM_INTERFACE
127           The host network interface driver
128
129       Sys::Virt::Error::FROM_ONE
130           The Open Nebula driver. This constant is no longer used and
131           retained only for backwards compatibility
132
133       Sys::Virt::Error::FROM_PHYP
134           The IBM Power Hypervisor driver
135
136       Sys::Virt::Error::FROM_SECRET
137           The secret management driver
138
139       Sys::Virt::Error::FROM_VBOX
140           The VirtualBox driver
141
142       Sys::Virt::Error::FROM_AUDIT
143           The audit driver
144
145       Sys::Virt::Error::FROM_CPU
146           The CPU information driver
147
148       Sys::Virt::Error::FROM_DOMAIN_SNAPSHOT
149           The domain snapshot driver
150
151       Sys::Virt::Error::FROM_HOOK
152           The daemon hook driver
153
154       Sys::Virt::Error::FROM_NWFILTER
155           The network filter driver
156
157       Sys::Virt::Error::FROM_STREAMS
158           The data streams driver
159
160       Sys::Virt::Error::FROM_SYSINFO
161           The system information driver
162
163       Sys::Virt::Error::FROM_VMWARE
164           The VMWare driver
165
166       Sys::Virt::Error::FROM_XENAPI
167           The XenAPI driver
168
169       Sys::Virt::Error::FROM_EVENT
170           The event driver
171
172       Sys::Virt::Error::FROM_LIBXL
173           The libxl Xen driver
174
175       Sys::Virt::Error::FROM_LOCKING
176           The lock manager drivers
177
178       Sys::Virt::Error::FROM_HYPERV
179           The Hyper-V driver
180
181       Sys::Virt::Error::FROM_CAPABILITIES
182           The capabilities driver
183
184       Sys::Virt::Error::FROM_AUTH
185           The authentication handling code
186
187       Sys::Virt::Error::FROM_URI
188           The URI handling code
189
190       Sys::Virt::Error::FROM_DBUS
191           The DBus handling code
192
193       Sys::Virt::Error::FROM_DEVICE
194           The device handling code
195
196       Sys::Virt::Error::FROM_SSH
197           The libSSH2 socket client
198
199       Sys::Virt::Error::FROM_PARALLELS
200           The Parallels virtualization driver
201
202       Sys::Virt::Error::FROM_LOCKSPACE
203           The lockspace handling code
204
205       Sys::Virt::Error::FROM_INITCTL
206           The initctl client code
207
208       Sys::Virt::Error::FROM_CGROUP
209           The cgroups code
210
211       Sys::Virt::Error::FROM_IDENTITY
212           The identity management code
213
214       Sys::Virt::Error::FROM_ACCESS
215           The access control code
216
217       Sys::Virt::Error::FROM_SYSTEMD
218           The systemd init service
219
220       Sys::Virt::Error::FROM_BHYVE
221           The FreeBSD BHyve driver
222
223       Sys::Virt::Error::FROM_CRYPTO
224           The cryptographic helper APIs.
225
226       Sys::Virt::Error::FROM_FIREWALL
227           The firewall helper APIs.
228
229       Sys::Virt::Error::FROM_POLKIT
230           The polkit authentication / authorization APIs
231
232       Sys::Virt::Error::FROM_THREAD
233           The thread helper utils
234
235       Sys::Virt::Error::FROM_ADMIN
236           The administrative service
237
238       Sys::Virt::Error::FROM_LOGGING
239           The logging service
240
241       Sys::Virt::Error::FROM_XENXL
242           The Xen XL driver
243
244       Sys::Virt::Error::FROM_PERF
245           The performance events subsystem
246
247       Sys::Virt::Error::FROM_LIBSSH
248           The libSSH socket client
249
250       Sys::Virt::Error::FROM_RESCTRL
251           The resource control subsystem
252
253       Sys::Virt::Error::FROM_FIREWALLD
254           The firewalld service
255
256       Sys::Virt::Error::FROM_DOMAIN_CHECKPOINT
257           The domain checkpoint
258
259       Sys::Virt::Error::FROM_TPM
260           The TPM subsystem
261
262       Sys::Virt::Error::FROM_BPF
263           The BPF subsystem
264
265       Sys::Virt::Error::FROM_CH
266           The Cloud Hypervisor driver
267
268   ERROR CODE CONSTANTS
269       The error codes allow for specific problems to be identified and
270       handled separately from generic error handling.
271
272       Sys::Virt::Error::ERR_AUTH_FAILED
273           Authentication failure when connecting to a driver
274
275       Sys::Virt::Error::ERR_CALL_FAILED
276           Operation not supported by driver (DEPRECATED & unused)
277
278       Sys::Virt::Error::ERR_CONF_SYNTAX
279           Configuration file syntax error
280
281       Sys::Virt::Error::ERR_DOM_EXIST
282           The domain already exists
283
284       Sys::Virt::Error::ERR_DRIVER_FULL
285           Too many hypervisor drivers have been registered
286
287       Sys::Virt::Error::ERR_GET_FAILED
288           HTTP GET command failed talking to XenD
289
290       Sys::Virt::Error::ERR_GNUTLS_ERROR
291           GNUTLS encryption error in RPC driver
292
293       Sys::Virt::Error::ERR_HTTP_ERROR
294           Unexpected HTTP error code from XenD
295
296       Sys::Virt::Error::ERR_INTERNAL_ERROR
297           Generic internal error
298
299       Sys::Virt::Error::ERR_INVALID_ARG
300           Invalid argument supplied to function
301
302       Sys::Virt::Error::ERR_INVALID_CONN
303           Invalid connection object
304
305       Sys::Virt::Error::ERR_INVALID_DOMAIN
306           Invalid domain object
307
308       Sys::Virt::Error::ERR_INVALID_MAC
309           Invalid MAC address string
310
311       Sys::Virt::Error::ERR_INVALID_NETWORK
312           Invalid network object
313
314       Sys::Virt::Error::ERR_INVALID_NODE_DEVICE
315           Invalid node device object
316
317       Sys::Virt::Error::ERR_INVALID_STORAGE_POOL
318           Invalid storage pool object
319
320       Sys::Virt::Error::ERR_INVALID_STORAGE_VOL
321           Invalid storage vol object
322
323       Sys::Virt::Error::ERR_NETWORK_EXIST
324           Network with this name/uuid already exists
325
326       Sys::Virt::Error::ERR_NO_CONNECT
327           Unable to connect to requested hypervisor driver
328
329       Sys::Virt::Error::ERR_NO_DEVICE
330           Missing device information
331
332       Sys::Virt::Error::ERR_NO_DOMAIN
333           No such domain with that name/uuid/id
334
335       Sys::Virt::Error::ERR_NO_KERNEL
336           Missing kernel information in domain configuration
337
338       Sys::Virt::Error::ERR_NO_MEMORY
339           Missing memory information in domain configuration
340
341       Sys::Virt::Error::ERR_NO_NAME
342           Missing name in object configuration
343
344       Sys::Virt::Error::ERR_NO_NETWORK
345           No such network with that name/uuid
346
347       Sys::Virt::Error::ERR_NO_NODE_DEVICE
348           No such node device with that name
349
350       Sys::Virt::Error::ERR_NO_OS
351           Missing OS information in domain configuration
352
353       Sys::Virt::Error::ERR_NO_ROOT
354           Missing root device information in domain configuration
355
356       Sys::Virt::Error::ERR_NO_SECURITY_MODEL
357           Missing security model information in domain configuration
358
359       Sys::Virt::Error::ERR_NO_SOURCE
360           Missing source device information in domain configuration
361
362       Sys::Virt::Error::ERR_NO_STORAGE_POOL
363           No such storage pool with that name/uuid
364
365       Sys::Virt::Error::ERR_NO_STORAGE_VOL
366           No such storage volume with that name/path/key
367
368       Sys::Virt::Error::ERR_NO_SUPPORT
369           This operation is not supported by the active driver
370
371       Sys::Virt::Error::ERR_NO_TARGET
372           Missing target device information in domain configuration
373
374       Sys::Virt::Error::ERR_NO_XEN
375           Unable to connect to Xen hypervisor
376
377       Sys::Virt::Error::ERR_NO_XENSTORE
378           Unable to connect to XenStorage daemon
379
380       Sys::Virt::Error::ERR_OK
381           No error code. This should never be see
382
383       Sys::Virt::Error::ERR_OPEN_FAILED
384           Unable to open a configuration file
385
386       Sys::Virt::Error::ERR_OPERATIONED_DENIED
387           The operation is forbidden for the current connection
388
389       Sys::Virt::Error::ERR_OPERATION_FAILED
390           The operation failed to complete
391
392       Sys::Virt::Error::ERR_OS_TYPE
393           Missing/incorrect OS type in domain configuration
394
395       Sys::Virt::Error::ERR_PARSE_FAILED
396           Failed to parse configuration file
397
398       Sys::Virt::Error::ERR_POST_FAILED
399           HTTP POST failure talking to XenD
400
401       Sys::Virt::Error::ERR_READ_FAILED
402           Unable to read from configuration file
403
404       Sys::Virt::Error::ERR_RPC
405           Generic RPC error talking to XenD
406
407       Sys::Virt::Error::ERR_SEXPR_SERIAL
408           Failed to generic SEXPR for XenD
409
410       Sys::Virt::Error::ERR_SYSTEM_ERROR
411           Generic operating system error
412
413       Sys::Virt::Error::ERR_UNKNOWN_HOST
414           Unknown hostname
415
416       Sys::Virt::Error::ERR_WRITE_FAILED
417           Failed to write to configuration file
418
419       Sys::Virt::Error::ERR_XEN_CALL
420           Failure while talking to Xen hypervisor
421
422       Sys::Virt::Error::ERR_XML_DETAIL
423           Detailed XML parsing error
424
425       Sys::Virt::Error::ERR_XML_ERROR
426           Generic XML parsing error
427
428       Sys::Virt::Error::WAR_NO_NETWORK
429           Warning that no network driver is activated
430
431       Sys::Virt::Error::WAR_NO_NODE
432           Warning that no node device driver is activated
433
434       Sys::Virt::Error::WAR_NO_STORAGE
435           Warning that no storage driver is activated
436
437       Sys::Virt::Error::ERR_INVALID_INTERFACE
438           Invalid network interface object
439
440       Sys::Virt::Error::ERR_NO_INTERFACE
441           No interface with the matching name / mac address
442
443       Sys::Virt::Error::ERR_OPERATION_INVALID
444           The requested operation is not valid for the current object state
445
446       Sys::Virt::Error::WAR_NO_INTERFACE
447           The network interface driver is not available
448
449       Sys::Virt::Error::ERR_MULTIPLE_INTERFACES
450           There are multiple interfaces with the requested MAC address
451
452       Sys::Virt::Error::ERR_BUILD_FIREWALL
453           The firewall could not be constructed
454
455       Sys::Virt::Error::WAR_NO_NWFILTER
456           The network filter driver could not be activated
457
458       Sys::Virt::Error::ERR_NO_NWFILTER
459           There is no network filter driver available
460
461       Sys::Virt::Error::ERR_INVALID_NWFILTER
462           The network filter object was invalid
463
464       Sys::Virt::Error::WAR_NO_SECRET
465           There secret management driver is not available
466
467       Sys::Virt::Error::ERR_NO_SECRET
468           No secret with the matching uuid / usage ID
469
470       Sys::Virt::Error::ERR_INVALID_SECRET
471           Invalid secret object
472
473       Sys::Virt::Error::ERR_CONFIG_UNSUPPORTED
474           The requested XML configuration is not supported by the hypervisor
475
476       Sys::Virt::Error::ERR_OPERATION_TIMEOUT
477           The operation could not be completed in a satisfactory time
478
479       Sys::Virt::Error::ERR_MIGRATE_PERSIST_FAILED
480           Unable to persistent the domain configuration after migration
481           successfully completed
482
483       Sys::Virt::Error::ERR_HOOK_SCRIPT_FAILED
484           Execution of a daemon hook script failed
485
486       Sys::Virt::Error::ERR_INVALID_DOMAIN_SNAPSHOT
487           The domain snapshot object pointer was invalid
488
489       Sys::Virt::Error::ERR_NO_DOMAIN_SNAPSHOT
490           No matching domain snapshot was found
491
492       Sys::Virt::Error::ERR_INVALID_STREAM
493           The stream object pointer was invalid
494
495       Sys::Virt::Error::ERR_ARGUMENT_UNSUPPORTED
496           The argument value was not supported by the driver
497
498       Sys::Virt::Error::ERR_STORAGE_POOL_BUILT
499           The storage pool has already been built
500
501       Sys::Virt::Error::ERR_STORAGE_PROBE_FAILED
502           Probing the storage pool failed
503
504       Sys::Virt::Error::ERR_SNAPSHOT_REVERT_RISKY
505           Reverting the snapshot could cause data loss
506
507       Sys::Virt::Error::ERR_OPERATION_ABORTED
508           The asynchronous operation was aborted at admin request
509
510       Sys::Virt::Error::ERR_AUTH_CANCELLED
511           The user cancelled the authentication process
512
513       Sys::Virt::Error::ERR_NO_DOMAIN_METADATA
514           The requested metadata does not exist
515
516       Sys::Virt::Error::ERR_MIGRATE_UNSAFE
517           The migration operation would be unsafe to perform
518
519       Sys::Virt::Error::ERR_OVERFLOW
520           The calculation would overflow
521
522       Sys::Virt::Error::ERR_BLOCK_COPY_ACTIVE
523           Action prevented by block copy job
524
525       Sys::Virt::Error::ERR_AGENT_UNRESPONSIVE
526           The guest agent is not responding
527
528       Sys::Virt::Error::ERR_OPERATION_UNSUPPORTED
529           The operation is not supported on this host
530
531       Sys::Virt::Error::ERR_SSH
532           The SSH operation failed
533
534       Sys::Virt::Error::ERR_RESOURCE_BUSY
535           The resource requested is already in use
536
537       Sys::Virt::Error::ERR_ACCESS_DENIED
538           Not authorized to perform the operation
539
540       Sys::Virt::Error::ERR_DBUS_SERVICE
541           An error from a DBus service API
542
543       Sys::Virt::Error::ERR_STORAGE_VOL_EXIST
544           The storage volume already exists
545
546       Sys::Virt::Error::ERR_CPU_INCOMPATIBLE
547           The CPUs are not compatible
548
549       Sys::Virt::Error::ERR_INVALID_SCHEMA
550           The XML document does not comply with the XML schema
551
552       Sys::Virt::Error::ERR_MIGRATE_FINISH_OK
553           Migration finished but expected to return NULL domain.
554
555       Sys::Virt::Error::ERR_AUTH_UNAVAILABLE
556           Authentication services were not available
557
558       Sys::Virt::Error::ERR_NO_SERVER
559           Libvirt server was not found
560
561       Sys::Virt::Error::ERR_NO_CLIENT
562           Libvirt client was not found
563
564       Sys::Virt::Error::ERR_AGENT_UNSYNCED
565           Libvirt guest agent replies with wrong id to guest-sync command
566
567       Sys::Virt::Error::ERR_LIBSSH
568           The libSSH operation failed
569
570       Sys::Virt::Error::ERR_DEVICE_MISSING
571           Libvirt fail to find the desired device.
572
573       Sys::Virt::Error::ERR_INVALID_NWFILTER_BINDING
574           Invalid nwfilter binding
575
576       Sys::Virt::Error::ERR_NO_NWFILTER_BINDING
577           No nwfilter binding
578
579       Sys::Virt::Error::ERR_INVALID_DOMAIN_CHECKPOINT
580           Invalid domain checkpoint
581
582       Sys::Virt::Error::ERR_NO_DOMAIN_BACKUP
583           Domain checkpoint not found
584
585       Sys::Virt::Error::ERR_NO_DOMAIN_CHECKPOINT
586           Domain backup job id not found
587
588       Sys::Virt::Error::ERR_NO_NETWORK_PORT
589           No matching network port
590
591       Sys::Virt::Error::ERR_INVALID_NETWORK_PORT
592           Invalid network port object
593
594       Sys::Virt::Error::ERR_NETWORK_PORT_EXIST
595           Network port already exists
596
597       Sys::Virt::Error::ERR_NO_HOSTNAME
598           No domain hostname found
599
600       Sys::Virt::Error::ERR_CHECKPOINT_INCONSISTENT
601           The checkpoint is inconsistent
602
603       Sys::Virt::Error::ERR_MULTIPLE_DOMAINS
604           More than one matching domain found
605
606       Sys::Virt::Error::ERR_NO_NETWORK_METADATA
607           The requested metadata does not exist
608

AUTHORS

610       Daniel P. Berrange <berrange@redhat.com>
611

COPYRIGHT

613       Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
614

LICENSE

616       This program is free software; you can redistribute it and/or modify it
617       under the terms of either the GNU General Public License as published
618       by the Free Software Foundation (either version 2 of the License, or at
619       your option any later version), or, the Artistic License, as specified
620       in the Perl README file.
621