1Sys::Virt::Domain(3) User Contributed Perl Documentation Sys::Virt::Domain(3)
2
6 Sys::Virt::Domain - Represent & manage a libvirt guest domain
7
9 The "Sys::Virt::Domain" module represents a guest domain managed by the
10 virtual machine monitor.
11
13 my $id = $dom->get_id()
14 Returns an integer with a locally unique identifier for the domain.
15 my $uuid = $dom->get_uuid()
17 Returns a 16 byte long string containing the raw globally unique
18 identifier (UUID) for the domain.
19 my $uuid = $dom->get_uuid_string()
21 Returns a printable string representation of the raw UUID, in the
22 format 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'.
23 my $name = $dom->get_name()
25 Returns a string with a locally unique name of the domain
26 my $hostname = $dom->get_hostname()
28 Returns a string representing the hostname of the guest
29 my $str = $dom->get_metadata($type, $uri, $flags =0)
31 Returns the metadata element of type $type associated with the
32 domain. If $type is "Sys::Virt::Domain::METADATA_ELEMENT" then the
33 $uri parameter specifies the XML namespace to retrieve, otherwise
34 $uri should be "undef". The optional $flags parameter defaults to
35 zero.
36 $dom->set_metadata($type, $val, $key, $uri, $flags=0)
38 Sets the metadata element of type $type to hold the value $val. If
39 $type is "Sys::Virt::Domain::METADATA_ELEMENT" then the $key and
40 $uri elements specify an XML namespace to use, otherwise they
41 should both be "undef". The optional $flags parameter defaults to
42 zero.
43 $dom->is_active()
45 Returns a true value if the domain is currently running
46 $dom->is_persistent()
48 Returns a true value if the domain has a persistent configuration
49 file defined
50 $dom->is_updated()
52 Returns a true value if the domain is running and has a persistent
53 configuration file defined that is out of date compared to the
54 current live config.
55 my $xml = $dom->get_xml_description($flags=0)
57 Returns an XML document containing a complete description of the
58 domain's configuration. The optional $flags parameter controls
59 generation of the XML document, defaulting to 0 if omitted. It can
60 be one or more of the XML DUMP constants listed later in this
61 document.
62 my $type = $dom->get_os_type()
64 Returns a string containing the name of the OS type running within
65 the domain.
66 $dom->create($flags)
68 Start a domain whose configuration was previously defined using the
69 "define_domain" method in Sys::Virt. The $flags parameter accepts
70 one of the DOMAIN CREATION constants documented later, and defaults
71 to 0 if omitted.
72 $dom->create_with_files($fds, $flags)
74 Start a domain whose configuration was previously defined using the
75 "define_domain" method in Sys::Virt. The $fds parameter is an array
76 of UNIX file descriptors which will be passed to the init process
77 of the container. This is only supported with container based
78 virtualization.The $flags parameter accepts one of the DOMAIN
79 CREATION constants documented later, and defaults to 0 if omitted.
80 $dom->undefine()
82 Remove the configuration associated with a domain previously
83 defined with the "define_domain" method in Sys::Virt. If the domain
84 is running, you probably want to use the "shutdown" or "destroy"
85 methods instead.
86 $dom->suspend()
88 Temporarily stop execution of the domain, allowing later
89 continuation by calling the "resume" method.
90 $dom->resume()
92 Resume execution of a domain previously halted with the "suspend"
93 method.
94 $dom->pm_wakeup()
96 Wakeup the guest from power management suspend state
97 $dom->pm_suspend_for_duration($target, $duration, $flags=0)
99 Tells the guest OS to enter the power management suspend state
100 identified by $target. The $target parameter should be one of the
101 NODE SUSPEND CONTANTS listed in "Sys::Virt". The $duration
102 specifies when the guest should automatically wakeup. The $flags
103 parameter is optional and defaults to zero.
104 $dom->save($filename)
106 Take a snapshot of the domain's state and save the information to
107 the file named in the $filename parameter. The domain can later be
108 restored from this file with the "restore_domain" method on the
109 Sys::Virt object.
110 $dom->managed_save($flags=0)
112 Take a snapshot of the domain's state and save the information to a
113 managed save location. The domain will be automatically restored
114 with this state when it is next started. The $flags parameter is
115 unused and defaults to zero.
116 $bool = $dom->has_managed_save_image($flags=0)
118 Return a non-zero value if the domain has a managed save image that
119 will be used at next start. The $flags parameter is unused and
120 defaults to zero.
121 $dom->managed_save_remove($flags=0)
123 Remove the current managed save image, causing the guest to perform
124 a full boot next time it is started. The $flags parameter is unused
125 and defaults to zero.
126 $dom->managed_save_define_xml($xml, $flags=0)
128 Update the XML of the managed save image to $xml. The $flags
129 parameter is unused and defaults to zero.
130 $xml = $dom->managed_save_get_xml_description($flags=0)
132 Get the XML in the managed save image. The $flags parameter accepts
133 the following constants
134 Sys::Virt::Domain::SAVE_IMAGE_XML_SECURE
136 Include security sensitive information in the XML dump, such as
137 passwords.
138 $dom->core_dump($filename[, $flags])
140 Trigger a core dump of the guest virtual machine, saving its memory
141 image to $filename so it can be analysed by tools such as "crash".
142 The optional $flags flags parameter is currently unused and if
143 omitted will default to 0.
144 $dom->core_dump_format($filename, $format, [, $flags])
146 Trigger a core dump of the guest virtual machine, saving its memory
147 image to $filename so it can be analysed by tools such as "crash".
148 The $format parameter is one of the core dump format constants.
149 The optional $flags flags parameter is currently unused and if
150 omitted will default to 0.
151 Sys::Virt::Domain::CORE_DUMP_FORMAT_RAW
153 The raw ELF format
154 Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_ZLIB
156 The zlib compressed ELF format
157 Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_SNAPPY
159 The snappy compressed ELF format
160 Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_LZO
162 The lzo compressed ELF format
163 $dom->destroy()
165 Immediately poweroff the machine. This is equivalent to removing
166 the power plug. The guest OS is given no time to cleanup / save
167 state. For a clean poweroff sequence, use the "shutdown" method
168 instead.
169 my $info = $dom->get_info()
171 Returns a hash reference summarising the execution state of the
172 domain. The elements of the hash are as follows:
173 maxMem
175 The maximum memory allowed for this domain, in kilobytes
176 memory
178 The current memory allocated to the domain in kilobytes
179 cpuTime
181 The amount of CPU time used by the domain
182 nrVirtCpu
184 The current number of virtual CPUs enabled in the domain
185 state
187 The execution state of the machine, which will be one of the
188 constants &Sys::Virt::Domain::STATE_*.
189 my ($state, $reason) = $dom->get_state()
191 Returns an array whose values specify the current state of the
192 guest, and the reason for it being in that state. The $state
193 values are the same as for the "get_info" API, and the $reason
194 values come from:
195 Sys::Virt::Domain::STATE_CRASHED_UNKNOWN
197 It is not known why the domain has crashed
198 Sys::Virt::Domain::STATE_CRASHED_PANICKED
200 The domain has crashed due to a kernel panic
201 Sys::Virt::Domain::STATE_NOSTATE_UNKNOWN
203 It is not known why the domain has no state
204 Sys::Virt::Domain::STATE_PAUSED_DUMP
206 The guest is paused due to a core dump operation
207 Sys::Virt::Domain::STATE_PAUSED_FROM_SNAPSHOT
209 The guest is paused due to a snapshot
210 Sys::Virt::Domain::STATE_PAUSED_IOERROR
212 The guest is paused due to an I/O error
213 Sys::Virt::Domain::STATE_PAUSED_MIGRATION
215 The guest is paused due to migration
216 Sys::Virt::Domain::STATE_PAUSED_SAVE
218 The guest is paused due to a save operation
219 Sys::Virt::Domain::STATE_PAUSED_UNKNOWN
221 It is not known why the domain has paused
222 Sys::Virt::Domain::STATE_PAUSED_USER
224 The guest is paused at admin request
225 Sys::Virt::Domain::STATE_PAUSED_WATCHDOG
227 The guest is paused due to the watchdog
228 Sys::Virt::Domain::STATE_PAUSED_SHUTTING_DOWN
230 The guest is paused while domain shutdown takes place
231 Sys::Virt::Domain::STATE_PAUSED_SNAPSHOT
233 The guest is paused while a snapshot takes place
234 Sys::Virt::Domain::STATE_PAUSED_CRASHED
236 The guest is paused due to a kernel panic
237 Sys::Virt::Domain::STATE_PAUSED_STARTING_UP
239 The guest is paused as it is being started up.
240 Sys::Virt::Domain::STATE_PAUSED_POSTCOPY
242 The guest is paused as post-copy migration is taking place
243 Sys::Virt::Domain::STATE_PAUSED_POSTCOPY_FAILED
245 The guest is paused as post-copy migration failed
246 Sys::Virt::Domain::STATE_RUNNING_BOOTED
248 The guest is running after being booted
249 Sys::Virt::Domain::STATE_RUNNING_FROM_SNAPSHOT
251 The guest is running after restore from snapshot
252 Sys::Virt::Domain::STATE_RUNNING_MIGRATED
254 The guest is running after migration
255 Sys::Virt::Domain::STATE_RUNNING_MIGRATION_CANCELED
257 The guest is running after migration abort
258 Sys::Virt::Domain::STATE_RUNNING_RESTORED
260 The guest is running after restore from file
261 Sys::Virt::Domain::STATE_RUNNING_SAVE_CANCELED
263 The guest is running after save cancel
264 Sys::Virt::Domain::STATE_RUNNING_UNKNOWN
266 It is not known why the domain has started
267 Sys::Virt::Domain::STATE_RUNNING_UNPAUSED
269 The guest is running after a resume
270 Sys::Virt::Domain::STATE_RUNNING_WAKEUP
272 The guest is running after wakeup from power management suspend
273 Sys::Virt::Domain::STATE_RUNNING_CRASHED
275 The guest was restarted after crashing
276 Sys::Virt::Domain::STATE_RUNNING_POSTCOPY
278 The guest is running but post-copy is taking place
279 Sys::Virt::Domain::STATE_BLOCKED_UNKNOWN
281 The guest is blocked for an unknown reason
282 Sys::Virt::Domain::STATE_SHUTDOWN_UNKNOWN
284 It is not known why the domain has shutdown
285 Sys::Virt::Domain::STATE_SHUTDOWN_USER
287 The guest is shutdown due to admin request
288 Sys::Virt::Domain::STATE_SHUTOFF_CRASHED
290 The guest is shutoff after a crash
291 Sys::Virt::Domain::STATE_SHUTOFF_DESTROYED
293 The guest is shutoff after being destroyed
294 Sys::Virt::Domain::STATE_SHUTOFF_FAILED
296 The guest is shutoff due to a virtualization failure
297 Sys::Virt::Domain::STATE_SHUTOFF_FROM_SNAPSHOT
299 The guest is shutoff after a snapshot
300 Sys::Virt::Domain::STATE_SHUTOFF_MIGRATED
302 The guest is shutoff after migration
303 Sys::Virt::Domain::STATE_SHUTOFF_SAVED
305 The guest is shutoff after a save
306 Sys::Virt::Domain::STATE_SHUTOFF_SHUTDOWN
308 The guest is shutoff due to controlled shutdown
309 Sys::Virt::Domain::STATE_SHUTOFF_UNKNOWN
311 It is not known why the domain has shutoff
312 Sys::Virt::Domain::STATE_SHUTOFF_DAEMON
314 The daemon stopped the guest due to a failure
315 Sys::Virt::Domain::STATE_PMSUSPENDED_UNKNOWN
317 It is not known why the domain was suspended to RAM
318 Sys::Virt::Domain::STATE_PMSUSPENDED_DISK_UNKNOWN
320 It is not known why the domain was suspended to disk
321 my $info = $dom->get_control_info($flags=0)
323 Returns a hash reference providing information about the control
324 channel. The returned keys in the hash are
325 "state"
327 One of the CONTROL INFO constants listed later
328 "details"
330 Currently unused, always 0.
331 "stateTime"
333 The elapsed time since the control channel entered the current
334 state.
335 my $time = $dom->get_time($flags=0);
337 Get the current time of the guest, in seconds and nanoseconds. The
338 $flags parameter is currently unused and defaults to zero. The
339 return value is an array ref with two elements, the first contains
340 the time in seconds, the second contains the remaining nanoseconds.
341 $dom->set_time($secs, $nsecs, $flags=0);
343 Set the current time of the guest, in seconds and nanoseconds. The
344 $flags parameter accepts one of
345 "Sys::Virt::Domain::TIME_SYNC"
347 Re-sync domain time from domain's RTC.
348 $dom->set_user_password($username, $password, $flags=0);
350 Update the password for account $username to be $password.
351 $password is the clear-text password string unless the
352 PASSWORD_ENCRYPTED flag is set.
353 "Sys::Virt::Domain::PASSWORD_ENCRYPTED"
355 The $password is encrypted with the password scheme required by
356 the guest OS.
357 $dom->rename($newname, $flags=0)
359 Change the name of an inactive guest to be $newname. The $flags
360 parameter is currently unused and defaults to zero.
361 my @errs = $dom->get_disk_errors($flags=0)
363 Returns a list of all disk errors that have occurred on the backing
364 store for the guest's virtual disks. The returned array elements
365 are hash references, containing two keys
366 "path"
368 The path of the disk with an error
369 "error"
371 The error type
372 $dom->send_key($keycodeset, $holdtime, \@keycodes, $flags=0)
374 Sends a sequence of keycodes to the guest domain. The $keycodeset
375 should be one of the constants listed later in the KEYCODE SET
376 section. $holdtiem is the duration, in milliseconds, to keep the
377 key pressed before releasing it and sending the next keycode.
378 @keycodes is an array reference containing the list of keycodes to
379 send to the guest. The elements in the array should be keycode
380 values from the specified keycode set. $flags is currently unused.
381 my $info = $dom->get_block_info($dev, $flags=0)
383 Returns a hash reference summarising the disk usage of the host
384 backing store for a guest block device. The $dev parameter should
385 be the path to the backing store on the host. $flags is currently
386 unused and defaults to 0 if omitted. The returned hash contains the
387 following elements
388 capacity
390 Logical size in bytes of the block device backing image *
391 allocation
393 Highest allocated extent in bytes of the block device backing
394 image
395 physical
397 Physical size in bytes of the container of the backing image
398 $dom->set_max_memory($mem)
400 Set the maximum memory for the domain to the value $mem. The value
401 of the $mem parameter is specified in kilobytes.
402 $mem = $dom->get_max_memory()
404 Returns the current maximum memory allowed for this domain in
405 kilobytes.
406 $dom->set_memory($mem, $flags)
408 Set the current memory for the domain to the value $mem. The value
409 of the $mem parameter is specified in kilobytes. This must be less
410 than, or equal to the domain's max memory limit. The $flags
411 parameter can control whether the update affects the live guest, or
412 inactive config, defaulting to modifying the current state.
413 $dom->set_memory_stats_period($period, $flags)
415 Set the period on which guests memory stats are refreshed, with
416 $period being a value in seconds. The $flags parameter is currently
417 unused.
418 $dom->shutdown()
420 Request that the guest OS perform a graceful shutdown and poweroff.
421 This usually requires some form of cooperation from the guest
422 operating system, such as responding to an ACPI signal, or a guest
423 agent process. For an immediate, forceful poweroff, use the
424 "destroy" method instead.
425 $dom->reboot([$flags])
427 Request that the guest OS perform a graceful shutdown and
428 optionally restart. The optional $flags parameter is currently
429 unused and if omitted defaults to zero.
430 $dom->reset([$flags])
432 Perform a hardware reset of the virtual machine. The guest OS is
433 given no opportunity to shutdown gracefully. The optional $flags
434 parameter is currently unused and if omitted defaults to zero.
435 $dom->get_max_vcpus()
437 Return the maximum number of vcpus that are configured for the
438 domain
439 $dom->attach_device($xml[, $flags])
441 Hotplug a new device whose configuration is given by $xml, to the
442 running guest. The optional <$flags> parameter defaults to 0, but
443 can accept one of the device hotplug flags described later.
444 $dom->detach_device($xml[, $flags])
446 Hotunplug an existing device whose configuration is given by $xml,
447 from the running guest. The optional <$flags> parameter defaults to
448 0, but can accept one of the device hotplug flags described later.
449 $dom->detach_device_alias($alias[, $flags])
451 Hotunplug an existing device which is identified by $alias. The
452 optional <$flags> parameter defaults to 0, but can accept one of
453 the device hotplug flags described later.
454 $dom->update_device($xml[, $flags])
456 Update the configuration of an existing device. The new
457 configuration is given by $xml. The optional <$flags> parameter
458 defaults to 0 but can accept one of the device hotplug flags
459 described later.
460 $data = $dom->block_peek($path, $offset, $size[, $flags])
462 Peek into the guest disk $path, at byte $offset capturing $size
463 bytes of data. The returned scalar may contain embedded NULLs. The
464 optional $flags parameter is currently unused and if omitted
465 defaults to zero.
466 $data = $dom->memory_peek($offset, $size[, $flags])
468 Peek into the guest memory at byte $offset virtual address,
469 capturing $size bytes of memory. The return scalar may contain
470 embedded NULLs. The optional $flags parameter is currently unused
471 and if omitted defaults to zero.
472 $flag = $dom->get_autostart();
474 Return a true value if the guest domain is configured to
475 automatically start upon boot. Return false, otherwise
476 $dom->set_autostart($flag)
478 Set the state of the autostart flag, which determines whether the
479 guest will automatically start upon boot of the host OS
480 $dom->set_vcpus($count, [$flags])
482 Set the number of virtual CPUs in the guest VM to $count. The
483 optional $flags parameter can be used to control whether the
484 setting changes the live config or inactive config.
485 $dom->set_vcpu($cpumap, $state, [$flags])
487 Set the state of the CPUs in $cpumap to $state. The $flags
488 parameter defaults to zero if not present.
489 $count = $dom->get_vcpus([$flags])
491 Get the number of virtual CPUs in the guest VM. The optional
492 $flags parameter can be used to control whether to query the
493 setting of the live config or inactive config.
494 $dom->set_guest_vcpus($cpumap, $state, [$flags=0])
496 Set the online status of the guest OS CPUs. The $cpumap parameter
497 describes the set of CPUs to modify (eg "0-3,^1"). $state is
498 either 1 to set the CPUs online, or 0 to set them offline. The
499 $flags parameter is currently unused and defaults to 0.
500 $info $dom->get_guest_vcpus([$flags=0])
502 Query information about the guest OS CPUs. The returned data is a
503 hash reference with the following keys.
504 vcpus
506 String containing bitmap representing CPU ids reported
507 currently known to the guest.
508 online
510 String containing bitmap representing CPU ids that are
511 currently online in the guest.
512 offlinable
514 String containing bitmap representing CPU ids that can be
515 offlined in the guest.
516 The $flags parameter is currently unused and defaults to 0.
518 $type = $dom->get_scheduler_type()
520 Return the scheduler type for the guest domain
521 $stats = $dom->block_stats($path)
523 Fetch the current I/O statistics for the block device given by
524 $path. The returned hash reference contains keys for
525 "rd_req"
527 Number of read requests
528 "rd_bytes"
530 Number of bytes read
531 "wr_req"
533 Number of write requests
534 "wr_bytes"
536 Number of bytes written
537 "errs"
539 Some kind of error count
540 my $params = $dom->get_scheduler_parameters($flags=0)
542 Return the set of scheduler tunable parameters for the guest, as a
543 hash reference. The precise set of keys in the hash are specific to
544 the hypervisor.
545 $dom->set_scheduler_parameters($params, $flags=0)
547 Update the set of scheduler tunable parameters. The value names for
548 tunables vary, and can be discovered using the
549 "get_scheduler_params" call
550 my $params = $dom->get_memory_parameters($flags=0)
552 Return a hash reference containing the set of memory tunable
553 parameters for the guest. The keys in the hash are one of the
554 constants MEMORY PARAMETERS described later. The $flags parameter
555 accepts one or more the CONFIG OPTION constants documented later,
556 and defaults to 0 if omitted.
557 $dom->set_memory_parameters($params, $flags=0)
559 Update the memory tunable parameters for the guest. The $params
560 should be a hash reference whose keys are one of the MEMORY
561 PARAMETERS constants. The $flags parameter accepts one or more the
562 CONFIG OPTION constants documented later, and defaults to 0 if
563 omitted.
564 my $params = $dom->get_blkio_parameters($flags=0)
566 Return a hash reference containing the set of blkio tunable
567 parameters for the guest. The keys in the hash are one of the
568 constants BLKIO PARAMETERS described later. The $flags parameter
569 accepts one or more the CONFIG OPTION constants documented later,
570 and defaults to 0 if omitted.
571 $dom->set_blkio_parameters($params, $flags=0)
573 Update the blkio tunable parameters for the guest. The $params
574 should be a hash reference whose keys are one of the BLKIO
575 PARAMETERS constants. The $flags parameter accepts one or more the
576 CONFIG OPTION constants documented later, and defaults to 0 if
577 omitted.
578 $stats = $dom->get_block_iotune($disk, $flags=0)
580 Return a hash reference containing the set of blkio tunable
581 parameters for the guest disk $disk. The keys in the hash are one
582 of the constants BLOCK IOTUNE PARAMETERS described later.
583 $dom->set_block_iotune($disk, $params, $flags=0);
585 Update the blkio tunable parameters for the guest disk $disk. The
586 $params should be a hash reference whose keys are one of the BLOCK
587 IOTUNE PARAMETERS constants.
588 my $params = $dom->get_interface_parameters($intf, $flags=0)
590 Return a hash reference containing the set of interface tunable
591 parameters for the guest. The keys in the hash are one of the
592 constants INTERFACE PARAMETERS described later.
593 $dom->set_interface_parameters($intf, $params, $flags=0)
595 Update the interface tunable parameters for the guest. The $params
596 should be a hash reference whose keys are one of the INTERFACE
597 PARAMETERS constants.
598 my $params = $dom->get_numa_parameters($flags=0)
600 Return a hash reference containing the set of numa tunable
601 parameters for the guest. The keys in the hash are one of the
602 constants NUMA PARAMETERS described later. The $flags parameter
603 accepts one or more the CONFIG OPTION constants documented later,
604 and defaults to 0 if omitted.
605 $dom->set_numa_parameters($params, $flags=0)
607 Update the numa tunable parameters for the guest. The $params
608 should be a hash reference whose keys are one of the NUMA
609 PARAMETERS constants. The $flags parameter accepts one or more the
610 CONFIG OPTION constants documented later, and defaults to 0 if
611 omitted.
612 my $params = $dom->get_perf_events($flags=0)
614 Return a hash reference containing the set of performance events
615 that are available for the guest. The keys in the hash are one of
616 the constants PERF EVENTS described later. The $flags parameter
617 accepts one or more the CONFIG OPTION constants documented later,
618 and defaults to 0 if omitted.
619 $dom->set_perf_events($params, $flags=0)
621 Update the enabled state for performance events for the guest. The
622 $params should be a hash reference whose keys are one of the PERF
623 EVENTS constants. The $flags parameter accepts one or more the
624 CONFIG OPTION constants documented later, and defaults to 0 if
625 omitted.
626 $dom->block_resize($disk, $newsize, $flags=0)
628 Resize the disk $disk to have new size $newsize KB. If the disk is
629 backed by a special image format, the actual resize is done by the
630 hypervisor. If the disk is backed by a raw file, or block device,
631 the resize must be done prior to invoking this API call, and it
632 merely updates the hypervisor's view of the disk size. The
633 following flags may be used
634 Sys::Virt::Domain::BLOCK_RESIZE_BYTES
636 Treat $newsize as if it were in bytes, rather than KB.
637 $dom->interface_stats($path)
639 Fetch the current I/O statistics for the block device given by
640 $path. The returned hash containins keys for
641 "rx_bytes"
643 Total bytes received
644 "rx_packets"
646 Total packets received
647 "rx_errs"
649 Total packets received with errors
650 "rx_drop"
652 Total packets drop at reception
653 "tx_bytes"
655 Total bytes transmitted
656 "tx_packets"
658 Total packets transmitted
659 "tx_errs"
661 Total packets transmitted with errors
662 "tx_drop"
664 Total packets dropped at transmission.
665 $dom->memory_stats($flags=0)
667 Fetch the current memory statistics for the guest domain. The
668 $flags parameter is currently unused and can be omitted. The
669 returned hash containins keys for
670 "swap_in"
672 Data read from swap space
673 "swap_out"
675 Data written to swap space
676 "major_fault"
678 Page fault involving disk I/O
679 "minor_fault"
681 Page fault not involving disk I/O
682 "unused"
684 Memory not used by the system
685 "available"
687 Total memory seen by guest
688 "rss"
690 Resident set size. Size of memory resident in host RAM.
691 $info = $dom->get_security_label()
693 Fetch information about the security label assigned to the guest
694 domain. The returned hash reference has two keys, "model" gives the
695 name of the security model in effect (eg "selinux"), while "label"
696 provides the name of the security label applied to the domain. This
697 method only returns information about the first security label. To
698 retrieve all labels, use "get_security_label_list".
699 @info = $dom->get_security_label_list()
701 Fetches information about all security labels assigned to the guest
702 domain. The elements in the returned array are all hash references,
703 whose keys are as described for "get_security_label".
704 $ddom = $dom->migrate(destcon, \%params, flags=0)
706 Migrate a domain to an alternative host. The "destcon" parameter
707 should be a "Sys::Virt" connection to the remote target host. The
708 "flags" parameter takes one or more of the
709 "Sys::Virt::Domain::MIGRATE_XXX" constants described later in this
710 document. The %params parameter is a hash reference used to set
711 various parameters for the migration operation, with the following
712 valid keys.
713 "Sys::Virt::Domain::MIGRATE_PARAM_URI"
715 The URI to use for initializing the domain migration. It takes
716 a hypervisor specific format. The uri_transports element of the
717 hypervisor capabilities XML includes details of the supported
718 URI schemes. When omitted libvirt will auto-generate suitable
719 default URI. It is typically only necessary to specify this URI
720 if the destination host has multiple interfaces and a specific
721 interface is required to transmit migration data.
722 "Sys::Virt::Domain::MIGRATE_PARAM_DEST_NAME"
724 The name to be used for the domain on the destination host.
725 Omitting this parameter keeps the domain name the same. This
726 field is only allowed to be used with hypervisors that support
727 domain renaming during migration.
728 "Sys::Virt::Domain::MIGRATE_PARAM_DEST_XML"
730 The new configuration to be used for the domain on the
731 destination host. The configuration must include an identical
732 set of virtual devices, to ensure a stable guest ABI across
733 migration. Only parameters related to host side configuration
734 can be changed in the XML. Hypervisors which support this field
735 will forbid migration if the provided XML would cause a change
736 in the guest ABI. This field cannot be used to rename the
737 domain during migration (use VIR_MIGRATE_PARAM_DEST_NAME field
738 for that purpose). Domain name in the destination XML must
739 match the original domain name.
740 Omitting this parameter keeps the original domain
742 configuration. Using this field with hypervisors that do not
743 support changing domain configuration during migration will
744 result in a failure.
745 "Sys::Virt::Domain::MIGRATE_PARAM_GRAPHICS_URI"
747 URI to use for migrating client's connection to domain's
748 graphical console as VIR_TYPED_PARAM_STRING. If specified, the
749 client will be asked to automatically reconnect using these
750 parameters instead of the automatically computed ones. This can
751 be useful if, e.g., the client does not have a direct access to
752 the network virtualization hosts are connected to and needs to
753 connect through a proxy. The URI is formed as follows:
754 protocol://hostname[:port]/[?parameters]
756 where protocol is either "spice" or "vnc" and parameters is a
758 list of protocol specific parameters separated by '&'.
759 Currently recognized parameters are "tlsPort" and "tlsSubject".
760 For example,
761 spice://target.host.com:1234/?tlsPort=4567
763 "Sys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH"
765 The maximum bandwidth (in MiB/s) that will be used for
766 migration. If set to 0 or omitted, libvirt will choose a
767 suitable default. Some hypervisors do not support this feature
768 and will return an error if this field is used and is not 0.
769 "Sys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH_POSTCOPY"
771 The maximum bandwidth (in MiB/s) that will be used for
772 migration during post-copy phase. If set to 0 or omitted,
773 libvirt will choose a suitable default. Some hypervisors do not
774 support this feature and return an error if this field is used
775 and is not 0.
776 "Sys::Virt::Domain::MIGRATE_PARAM_LISTEN_ADDRESS"
778 The address on which to listen for incoming migration
779 connections. If omitted, libvirt will listen on the wildcard
780 address (0.0.0.0 or ::). This default may be a security risk if
781 guests, or other untrusted users have the ability to connect to
782 the virtualization host, thus use of an explicit restricted
783 listen address is recommended.
784 "Sys::Virt::Domain::MIGRATE_PARAM_DISK_PORT"
786 Port that destination server should use for incoming disks
787 migration. Type is VIR_TYPED_PARAM_INT. If set to 0 or omitted,
788 libvirt will choose a suitable default. At the moment this is
789 only supported by the QEMU driver.
790 "Sys::Virt::Domain::MIGRATE_PARAM_MIGRATE_DISKS"
792 The list of disks to migrate when doing block storage
793 migration. In contrast to other parameters whose values are
794 plain strings, the parameter value should be an array
795 reference, whose elements are in turn strings representing the
796 disk target names.
797 "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION"
799 The type of compression method use use, either "xbzrle" or
800 "mt".
801 "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_THREADS"
803 The number of compression threads to use
804 "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_DTHREADS"
806 The number of decompression threads
807 "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_LEVEL"
809 The compression level from 0 (no compression) to 9 (maximum
810 compression)
811 "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE"
813 The size of the cache for xbzrle compression
814 "Sys::Virt::Domain::MIGRATE_PARAM_PERSIST_XML"
816 The alternative persistent XML config to copy
817 "Sys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INITIAL"
819 The initial percentage to throttle guest vCPUs
820 "Sys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT"
822 The additional percentage step size to throttle guest vCPUs if
823 progress is not made
824 $ddom = $dom->migrate(destcon, flags=0, dname=undef, uri=undef,
826 bandwidth=0)
827 Migrate a domain to an alternative host. Use of positional
828 parameters with "migrate" is deprecated in favour of passing a hash
829 reference as described above.
830 $ddom = $dom->migrate2(destcon, dxml, flags, dname, uri, bandwidth)
832 Migrate a domain to an alternative host. This method is deprecated
833 in favour of passing a hash ref to "migrate".
834 $ddom = $dom->migrate_to_uri(desturi, \%params, flags=0)
836 Migrate a domain to an alternative host. The "desturi" parameter
837 should be a valid libvirt connection URI for the remote target
838 host. The "flags" parameter takes one or more of the
839 "Sys::Virt::Domain::MIGRATE_XXX" constants described later in this
840 document. The %params parameter is a hash reference used to set
841 various parameters for the migration operation, with the same keys
842 described for the "migrate" API.
843 $dom->migrate_to_uri(desturi, flags, dname, bandwidth)
845 Migrate a domain to an alternative host. Use of positional
846 parameters with "migrate_to_uri" is deprecated in favour of passing
847 a hash reference as described above.
848 $dom->migrate_to_uri2(dconnuri, miguri, dxml, flags, dname, bandwidth)
850 Migrate a domain to an alternative host. This method is deprecated
851 in favour of passing a hash ref to "migrate_to_uri".
852 $dom->migrate_set_max_downtime($downtime, $flags=0)
854 Set the maximum allowed downtime during migration of the guest. A
855 longer downtime makes it more likely that migration will complete,
856 at the cost of longer time blackout for the guest OS at the switch
857 over point. The "downtime" parameter is measured in milliseconds.
858 The $flags parameter is currently unused and defaults to zero.
859 $downtime = $dom->migrate_get_max_downtime($flags=0) Get the current
861 value of the maximum downtime allowed during a migration of a guest.
862 The returned <downtime> value is measured in milliseconds. The $flags
863 parameter is currently unused and defaults to zero.
864 $dom->migrate_set_max_speed($bandwidth, $flags=0)
865 Set the maximum allowed bandwidth during migration of the guest.
866 The "bandwidth" parameter is measured in MB/second. The $flags
867 parameter takes zero or more of the constants:
868 $Sys::Virt::Domain::MIGRATE_MAX_SPEED_POSTCOPY
870 Set the post-copy speed instead of the pre-copy speed.
871 $bandwidth = $dom->migrate_get_max_speed($flags=0)
873 Get the maximum allowed bandwidth during migration fo the guest.
874 The returned <bandwidth> value is measured in MB/second. The
875 $flags parameter is accepts the same constants as
876 "migrate_set_max_speed".
877 $dom->migrate_set_compression_cache($cacheSize, $flags=0)
879 Set the maximum allowed compression cache size during migration of
880 the guest. The "cacheSize" parameter is measured in bytes. The
881 $flags parameter is currently unused and defaults to zero.
882 $cacheSize = $dom->migrate_get_compression_cache($flags=0)
884 Get the maximum allowed compression cache size during migration of
885 the guest. The returned <bandwidth> value is measured in bytes.
886 The $flags parameter is currently unused and defaults to zero.
887 $dom->migrate_start_post_copy($flags=0)
889 Switch the domain from pre-copy to post-copy mode. This requires
890 that the original migrate command had the
891 "Sys::Virt::Domain::MIGRATE_POST_COPY" flag specified.
892 $dom->inject_nmi($flags)
894 Trigger an NMI in the guest virtual machine. The $flags parameter
895 is currently unused and defaults to 0.
896 $dom->open_console($st, $devname, $flags)
898 Open the text console for a serial, parallel or paravirt console
899 device identified by $devname, connecting it to the stream $st. If
900 $devname is undefined, the default console will be opened. $st must
901 be a "Sys::Virt::Stream" object used for bi-directional
902 communication with the console. $flags is currently unused,
903 defaulting to 0.
904 $dom->open_channel($st, $devname, $flags)
906 Open the text console for a data channel device identified by
907 $devname, connecting it to the stream $st. $st must be a
908 "Sys::Virt::Stream" object used for bi-directional communication
909 with the channel. $flags is currently unused, defaulting to 0.
910 $dom->open_graphics($idx, $fd, $flags)
912 Open the graphics console for a guest, identified by $idx, counting
913 from 0. The $fd should be a file descriptor for an anoymous socket
914 pair. The $flags argument should be one of the constants listed at
915 the end of this document, and defaults to 0.
916 $fd = $dom->open_graphics_fd($idx, $flags)
918 Open the graphics console for a guest, identified by $idx, counting
919 from 0. The $flags argument should be one of the constants listed
920 at the end of this document, and defaults to 0. The return value
921 will be a file descriptor connected to the console which must be
922 closed when no longer needed. This method is preferred over
923 "open_graphics" since it will work correctly under sVirt mandatory
924 access control policies.
925 my $mimetype = $dom->screenshot($st, $screen, $flags)
927 Capture a screenshot of the virtual machine's monitor. The $screen
928 parameter controls which monitor is captured when using a multi-
929 head or multi-card configuration. $st must be a "Sys::Virt::Stream"
930 object from which the data can be read. $flags is currently unused
931 and defaults to 0. The mimetype of the screenshot is returned
932 @vcpuinfo = $dom->get_vcpu_info($flags=0)
934 Obtain information about the state of all virtual CPUs in a running
935 guest domain. The returned list will have one element for each
936 vCPU, where each elements contains a hash reference. The keys in
937 the hash are, "number" the vCPU number, "cpu" the physical CPU on
938 which the vCPU is currently scheduled, "cpuTime" the cumulative
939 execution time of the vCPU, "state" the running state and
940 "affinity" giving the allowed shedular placement. The value for
941 "affinity" is a string representing a bitmask against physical
942 CPUs, 8 cpus per character. To extract the bits use the "unpack"
943 function with the "b*" template. NB The "state", "cpuTime", "cpu"
944 values are only available if using $flags value of 0, and the
945 domain is currently running; otherwise they will all be set to
946 zero.
947 $dom->pin_vcpu($vcpu, $mask)
949 Pin the virtual CPU given by index $vcpu to physical CPUs given by
950 $mask. The $mask is a string representing a bitmask against
951 physical CPUs, 8 cpus per character.
952 $mask = $dom->get_emulator_pin_info()
954 Obtain information about the CPU affinity of the emulator process.
955 The returned $mask is a bitstring against physical CPUs, 8 cpus per
956 character. To extract the bits use the "unpack" function with the
957 "b*" template.
958 $dom->pin_emulator($newmask, $flags=0)
960 Pin the emulator threads to the physical CPUs identified by the
961 affinity in $newmask. The $newmask is a bitstring against the
962 physical CPUa, 8 cpus per character. To create a suitable
963 bitstring, use the "vec" function with a value of 1 for the "BITS"
964 parameter.
965 @iothreadinfo = $dom->get_iothread_info($flags=0)
967 Obtain information about the state of all IOThreads in a running
968 guest domain. The returned list will have one element for each
969 IOThread, where each elements contains a hash reference. The keys
970 in the hash are, "number" the IOThread number and "affinity" giving
971 the allowed schedular placement. The value for "affinity" is a
972 string representing a bitmask against physical CPUs, 8 cpus per
973 character. To extract the bits use the "unpack" function with the
974 "b*" template.
975 $dom->pin_iothread($iothread, $mask)
977 Pin the IOThread given by index $iothread to physical CPUs given by
978 $mask. The $mask is a string representing a bitmask against
979 physical CPUs, 8 cpus per character.
980 $dom->add_iothread($iothread, $flags=0)
982 Add a new IOThread by the $iothread value to the guest domain. The
983 $flags parameter accepts one or more the CONFIG OPTION constants
984 documented later, and defaults to 0 if omitted.
985 $dom->del_iothread($iothread, $flags=0)
987 Delete an existing IOThread by the $iothread value from the guest
988 domain. The $flags parameter accepts one or more the CONFIG OPTION
989 constants documented later, and defaults to 0 if omitted.
990 $dom->set_iothread($iothread, $params, $flags=0)
992 Set parameters for the IOThread by the $iothread value on the guest
993 domain. The $params parameter is a hash reference whose keys are
994 the "IOTHREAD STATS" constants documented later. The $flags
995 parameter accepts one or more the CONFIG OPTION constants
996 documented later, and defaults to 0 if omitted.
997 my @stats = $dom->get_cpu_stats($startCpu, $numCpus, $flags=0)
999 Requests the guests host physical CPU usage statistics, starting
1000 from host CPU <$startCpu> counting up to $numCpus. If $startCpu is
1001 -1 and $numCpus is 1, then the utilization across all CPUs is
1002 returned. Returns an array of hash references, each element
1003 containing stats for one CPU.
1004 my $info = $dom->get_job_info()
1006 Returns a hash reference summarising the execution state of the
1007 background job. The elements of the hash are as follows:
1008 type
1010 The type of job, one of the JOB TYPE constants listed later in
1011 this document.
1012 timeElapsed
1014 The elapsed time in milliseconds
1015 timeRemaining
1017 The expected remaining time in milliseconds. Only set if the
1018 "type" is JOB_UNBOUNDED.
1019 dataTotal
1021 The total amount of data expected to be processed by the job,
1022 in bytes.
1023 dataProcessed
1025 The current amount of data processed by the job, in bytes.
1026 dataRemaining
1028 The expected amount of data remaining to be processed by the
1029 job, in bytes.
1030 memTotal
1032 The total amount of mem expected to be processed by the job, in
1033 bytes.
1034 memProcessed
1036 The current amount of mem processed by the job, in bytes.
1037 memRemaining
1039 The expected amount of mem remaining to be processed by the
1040 job, in bytes.
1041 fileTotal
1043 The total amount of file expected to be processed by the job,
1044 in bytes.
1045 fileProcessed
1047 The current amount of file processed by the job, in bytes.
1048 fileRemaining
1050 The expected amount of file remaining to be processed by the
1051 job, in bytes.
1052 my ($type, $stats) = $dom->get_job_stats($flags=0)
1054 Returns an array summarising the execution state of the background
1055 job. The $type value is one of the JOB TYPE constants listed later
1056 in this document. The $stats value is a hash reference, whose
1057 elements are one of the following constants.
1058 type
1060 The type of job, one of the JOB TYPE constants listed later in
1061 this document.
1062 The $flags parameter defaults to zero and can take one of the
1064 following constants.
1065 Sys::Virt::Domain::JOB_STATS_COMPLETED
1067 Return the stats of the most recently completed job.
1068 Sys::Virt::Domain::JOB_TIME_ELAPSED
1070 The elapsed time in milliseconds
1071 Sys::Virt::Domain::JOB_TIME_ELAPSED_NET
1073 Time in milliseconds since the beginning of the migration job
1074 NOT including the time required to transfer control flow from
1075 the source host to the destination host.
1076 Sys::Virt::Domain::JOB_TIME_REMAINING
1078 The expected remaining time in milliseconds. Only set if the
1079 "type" is JOB_UNBOUNDED.
1080 Sys::Virt::Domain::JOB_DATA_TOTAL
1082 The total amount of data expected to be processed by the job,
1083 in bytes.
1084 Sys::Virt::Domain::JOB_DATA_PROCESSED
1086 The current amount of data processed by the job, in bytes.
1087 Sys::Virt::Domain::JOB_DATA_REMAINING
1089 The expected amount of data remaining to be processed by the
1090 job, in bytes.
1091 Sys::Virt::Domain::JOB_MEMORY_TOTAL
1093 The total amount of mem expected to be processed by the job, in
1094 bytes.
1095 Sys::Virt::Domain::JOB_MEMORY_PROCESSED
1097 The current amount of mem processed by the job, in bytes.
1098 Sys::Virt::Domain::JOB_MEMORY_REMAINING
1100 The expected amount of mem remaining to be processed by the
1101 job, in bytes.
1102 Sys::Virt::Domain::JOB_MEMORY_CONSTANT
1104 The number of pages filled with a constant byte which have been
1105 transferred
1106 Sys::Virt::Domain::JOB_MEMORY_NORMAL
1108 The number of pages transferred without any compression
1109 Sys::Virt::Domain::JOB_MEMORY_NORMAL_BYTES
1111 The number of bytes transferred without any compression
1112 Sys::Virt::Domain::JOB_MEMORY_BPS
1114 The bytes per second transferred
1115 Sys::Virt::Domain::JOB_MEMORY_DIRTY_RATE
1117 The number of memory pages dirtied per second
1118 Sys::Virt::Domain::JOB_MEMORY_PAGE_SIZE
1120 The memory page size in bytes
1121 Sys::Virt::Domain::JOB_MEMORY_ITERATION
1123 The total number of iterations over guest memory
1124 Sys::Virt::Domain::JOB_MEMORY_POSTCOPY_REQS
1126 The number of page requests received from the destination host
1127 during post-copy migration.
1128 Sys::Virt::Domain::JOB_DISK_TOTAL
1130 The total amount of file expected to be processed by the job,
1131 in bytes.
1132 Sys::Virt::Domain::JOB_DISK_PROCESSED
1134 The current amount of file processed by the job, in bytes.
1135 Sys::Virt::Domain::JOB_DISK_REMAINING
1137 The expected amount of file remaining to be processed by the
1138 job, in bytes.
1139 Sys::Virt::Domain::JOB_DISK_BPS
1141 The bytes per second transferred
1142 Sys::Virt::Domain::JOB_AUTO_CONVERGE_THROTTLE
1144 The percentage by which vCPUs are currently throttled
1145 Sys::Virt::Domain::JOB_COMPRESSION_CACHE
1147 The size of the compression cache in bytes
1148 Sys::Virt::Domain::JOB_COMPRESSION_BYTES
1150 The number of compressed bytes transferred
1151 Sys::Virt::Domain::JOB_COMPRESSION_PAGES
1153 The number of compressed pages transferred
1154 Sys::Virt::Domain::JOB_COMPRESSION_CACHE_MISSES
1156 The number of changing pages not in compression cache
1157 Sys::Virt::Domain::JOB_COMPRESSION_OVERFLOW
1159 The number of changing pages in the compression cache but sent
1160 uncompressed since the compressed page was larger than the non-
1161 compressed page.
1162 Sys::Virt::Domain::JOB_DOWNTIME
1164 The number of milliseconds of downtime expected during
1165 migration switchover.
1166 Sys::Virt::Domain::JOB_DOWNTIME_NET
1168 Real measured downtime (ms) NOT including the time required to
1169 transfer control flow from the source host to the destination
1170 host.
1171 Sys::Virt::Domain::JOB_SETUP_TIME
1173 The number of milliseconds of time doing setup of the job
1174 Sys::Virt::Domain::JOB_OPERATION
1176 The type of operation associated with the job
1177 The values for the Sys::Virt::Domain::JOB_OPERATION field are
1179 Sys::Virt::Domain::JOB_OPERATION_UNKNOWN
1181 No known job type
1182 Sys::Virt::Domain::JOB_OPERATION_START
1184 The guest is starting
1185 Sys::Virt::Domain::JOB_OPERATION_SAVE
1187 The guest is saving to disk
1188 Sys::Virt::Domain::JOB_OPERATION_RESTORE
1190 The guest is restoring from disk
1191 Sys::Virt::Domain::JOB_OPERATION_MIGRATION_IN
1193 The guest is migrating in from another host
1194 Sys::Virt::Domain::JOB_OPERATION_MIGRATION_OUT
1196 The guest is migrating out to another host
1197 Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT
1199 The guest is saving a snapshot
1200 Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT_REVERT
1202 The guest is reverting to a snapshot
1203 Sys::Virt::Domain::JOB_OPERATION_DUMP
1205 The guest is saving a crash dump
1206 $dom->abort_job()
1208 Aborts the currently executing job
1209 my $info = $dom->get_block_job_info($path, $flags=0)
1211 Returns a hash reference summarising the execution state of the
1212 block job. The $path parameter should be the fully qualified path
1213 of the block device being changed. Valid $flags include:
1214 Sys::Virt::Domain::BLOCK_JOB_INFO_BANDWIDTH_BYTES
1216 Treat bandwidth value as bytes instead of MiB.
1217 $dom->set_block_job_speed($path, $bandwidth, $flags=0)
1219 Change the maximum I/O bandwidth used by the block job that is
1220 currently executing for $path. The $bandwidth argument is specified
1221 in MB/s. The $flags parameter can take the bitwise union of the
1222 values:
1223 Sys::Virt::Domain::BLOCK_JOB_SPEED_BANDWIDTH_BYTES
1225 The $bandwidth parameter value is measured in bytes/s instead
1226 of MB/s.
1227 $dom->abort_block_job($path, $flags=0)
1229 Abort the current job that is executing for the block device
1230 associated with $path
1231 $dom->block_pull($path, $bandwidth, $flags=0)
1233 Merge the backing files associated with $path into the top level
1234 file. The $bandwidth parameter specifies the maximum I/O rate to
1235 allow in MB/s. The $flags parameter can take the bitwise union of
1236 the values:
1237 Sys::Virt::Domain::BLOCK_PULL_BANDWIDTH_BYTES
1239 The $bandwidth parameter value is measured in bytes/s instead
1240 of MB/s.
1241 $dom->block_rebase($path, $base, $bandwidth, $flags=0)
1243 Switch the backing path associated with $path to instead use $base.
1244 The $bandwidth parameter specifies the maximum I/O rate to allow in
1245 MB/s. The $flags parameter can take the bitwise union of the
1246 values:
1247 Sys::Virt::Domain::BLOCK_REBASE_BANDWIDTH_BYTES
1249 The $bandwidth parameter value is measured in bytes/s instead
1250 of MB/s.
1251 $dom->block_copy($path, $destxml, $params, $flags=0)
1253 Copy contents of a disk image <$path> into the target volume
1254 described by $destxml which follows the schema of the <disk>
1255 element in the domain XML. The $params parameter is a hash of
1256 optional parameters to control the process
1257 Sys::Virt::Domain::BLOCK_COPY_BANDWIDTH
1259 The maximum bandwidth in bytes per second.
1260 Sys::Virt::Domain::BLOCK_COPY_GRANULARITY
1262 The granularity in bytes of the copy process
1263 Sys::Virt::Domain::BLOCK_COPY_BUF_SIZE
1265 The maximum amount of data in flight in bytes.
1266 $dom->block_commit($path, $base, $top, $bandwidth, $flags=0)
1268 Commit changes there were made to the temporary top level file
1269 $top. Takes all the differences between $top and $base and merge
1270 them into $base. The $bandwidth parameter specifies the maximum I/O
1271 rate to allow in MB/s. The $flags parameter can take the bitwise
1272 union of the values:
1273 Sys::Virt::Domain::BLOCK_COMMIT_BANDWIDTH_BYTES
1275 The $bandwidth parameter value is measured in bytes instead of
1276 MB/s.
1277 $count = $dom->num_of_snapshots()
1279 Return the number of saved snapshots of the domain
1280 @names = $dom->list_snapshot_names()
1282 List the names of all saved snapshots. The names can be used with
1283 the "lookup_snapshot_by_name"
1284 @snapshots = $dom->list_snapshots()
1286 Return a list of all snapshots currently known to the domain. The
1287 elements in the returned list are instances of the
1288 Sys::Virt::DomainSnapshot class. This method requires O(n) RPC
1289 calls, so the "list_all_snapshots" method is recommended as a more
1290 efficient alternative.
1291 my @snapshots = $dom->list_all_snapshots($flags)
1293 Return a list of all domain snapshots associated with this domain.
1294 The elements in the returned list are instances of the
1295 Sys::Virt::DomainSnapshot class. The $flags parameter can be used
1296 to filter the list of return domain snapshots.
1297 my $snapshot = $dom->get_snapshot_by_name($name)
1299 Return the domain snapshot with a name of $name. The returned
1300 object is an instance of the Sys::Virt::DomainSnapshot class.
1301 $dom->has_current_snapshot()
1303 Returns a true value if the domain has a currently active snapshot
1304 $snapshot = $dom->current_snapshot()
1306 Returns the currently active snapshot for the domain.
1307 $snapshot = $dom->create_snapshot($xml[, $flags])
1309 Create a new snapshot from the $xml. The $flags parameter accepts
1310 the SNAPSHOT CREATION constants listed in
1311 "Sys::Virt::DomainSnapshots".
1312 $dom->fs_trim($mountPoint, $minimum, $flags=0);
1314 Issue an FS_TRIM command to the device at $mountPoint to remove
1315 chunks of unused space that are at least $minimum bytes in length.
1316 $flags is currently unused and defaults to zero.
1317 $dom->fs_freeze(\@mountPoints, $flags=0);
1319 Freeze all the filesystems associated with the @mountPoints array
1320 reference. If <@mountPoints> is an empty list, then all filesystems
1321 will be frozen. $flags is currently unused and defaults to zero.
1322 $dom->fs_thaw(\@mountPoints, $flags=0);
1324 Thaw all the filesystems associated with the @mountPoints array
1325 reference. If <@mountPoints> is an empty list, then all filesystems
1326 will be thawed. $flags is currently unused and defaults to zero.
1327 @fslist = $dom->get_fs_info($flags=0);
1329 Obtain a list of all guest filesystems. The returned list will
1330 contain one element for each filesystem, whose value will be a hash
1331 reference with the following keys
1332 name
1334 The name of the guest device that is mounted
1335 fstype
1337 The filesystem type (eg 'ext4', 'fat', 'ntfs', etc)
1338 mountpoint
1340 The location in the filesystem tree of the mount
1341 devalias
1343 An array reference containing list of device aliases associated
1344 with the guest device. The device aliases correspond to disk
1345 target names in the guest XML configuration
1346 @nics = $dom->get_interface_addresses($src, $flags=0);
1348 Obtain a list of all guest network interfaces. The $src parameter
1349 is one of the constants
1350 Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_LEASE
1352 Extract the DHCP server lease information
1353 Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_AGENT
1355 Query the guest OS via an agent
1356 Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_ARP
1358 Extract from the local ARP tables
1359 The returned list will contain one element for each interface. The
1361 values in the list will be a hash reference with the following keys
1362 name
1364 The name of the guest interface that is mounted
1365 hwaddr
1367 The hardware address, aka MAC, if available.
1368 addrs
1370 An array reference containing list of IP addresses associated
1371 with the guest NIC. Each element in the array is a further hash
1372 containing
1373 addr
1375 The IP address string
1376 prefix
1378 The IP address network prefix
1379 type
1381 The IP address type (IPv4 vs IPv6)
1382 $dom->send_process_signal($pid, $signum, $flags=0);
1384 Send the process $pid the signal $signum. The $signum value must be
1385 one of the constants listed later, not a POSIX or Linux signal
1386 value. $flags is currently unused and defaults to zero.
1387 $dom->set_block_threshold($dev, $threshold, $flags=0);
1389 Set the threshold level for delivering the EVENT_ID_BLOCK_THRESHOLD
1390 if the device or backing chain element described by $dev is written
1391 beyond the set $threshold level. The threshold level is unset once
1392 the event fires. The event might not be delivered at all if
1393 libvirtd was not running at the moment when the threshold was
1394 reached.
1395 $dom->set_lifecycle_action($type, $action, $flags=0)
1397 Changes the actions of lifecycle events for domain represented as
1398 <on_$type>$action</on_$type> in the domain XML.
1399 $info = $dom->get_launch_security_info($flags=0)
1401 Get information about the domaim launch security policy. $flags is
1402 currently unused and defaults to zero. The returned hash may
1403 contain the following keys
1404 Sys::Virt::Domain::LAUNCH_SECURITY_SEV_MEASUREMENT
1406 The AMD SEV launch measurement
1407
1409 A number of the APIs take a "flags" parameter. In most cases passing a
1410 value of zero will be satisfactory. Some APIs, however, accept named
1411 constants to alter their behaviour. This section documents the current
1412 known constants.
1413 DOMAIN STATE
1415 The domain state constants are useful in interpreting the "state" key
1416 in the hash returned by the "get_info" method.
1417 Sys::Virt::Domain::STATE_NOSTATE
1419 The domain is active, but is not running / blocked (eg idle)
1420 Sys::Virt::Domain::STATE_RUNNING
1422 The domain is active and running
1423 Sys::Virt::Domain::STATE_BLOCKED
1425 The domain is active, but execution is blocked
1426 Sys::Virt::Domain::STATE_PAUSED
1428 The domain is active, but execution has been paused
1429 Sys::Virt::Domain::STATE_SHUTDOWN
1431 The domain is active, but in the shutdown phase
1432 Sys::Virt::Domain::STATE_SHUTOFF
1434 The domain is inactive, and shut down.
1435 Sys::Virt::Domain::STATE_CRASHED
1437 The domain is inactive, and crashed.
1438 Sys::Virt::Domain::STATE_PMSUSPENDED
1440 The domain is active, but in power management suspend state
1441 CONTROL INFO
1443 The following constants can be used to determine what the guest domain
1444 control channel status is
1445 Sys::Virt::Domain::CONTROL_ERROR
1447 The control channel has a fatal error
1448 Sys::Virt::Domain::CONTROL_OK
1450 The control channel is ready for jobs
1451 Sys::Virt::Domain::CONTROL_OCCUPIED
1453 The control channel is busy
1454 Sys::Virt::Domain::CONTROL_JOB
1456 The control channel is busy with a job
1457 If the status is "Sys::Virt::Domain::CONTROL_ERROR", then one of the
1459 following constants describes the reason
1460 Sys::Virt::Domain::CONTROL_ERROR_REASON_NONE
1462 There is no reason for the error available
1463 Sys::Virt::Domain::CONTROL_ERROR_REASON_UNKNOWN
1465 The reason for the error is unknown
1466 Sys::Virt::Domain::CONTROL_ERROR_REASON_INTERNAL
1468 There was an internal error in libvirt
1469 Sys::Virt::Domain::CONTROL_ERROR_REASON_MONITOR
1471 There was an error speaking to the monitor
1472 DOMAIN CREATION
1474 The following constants can be used to control the behaviour of domain
1475 creation
1476 Sys::Virt::Domain::START_PAUSED
1478 Keep the guest vCPUs paused after starting the guest
1479 Sys::Virt::Domain::START_AUTODESTROY
1481 Automatically destroy the guest when the connection is closed (or
1482 fails)
1483 Sys::Virt::Domain::START_BYPASS_CACHE
1485 Do not use OS I/O cache if starting a domain with a saved state
1486 image
1487 Sys::Virt::Domain::START_FORCE_BOOT
1489 Boot the guest, even if there was a saved snapshot
1490 Sys::Virt::Domain::START_VALIDATE
1492 Validate the XML document against the XML schema
1493 DOMAIN DEFINE
1495 The following constants can be used to control the behaviour of domain
1496 define operations
1497 Sys::Virt::Domain::DEFINE_VALIDATE
1499 Validate the XML document against the XML schema
1500 KEYCODE SETS
1502 The following constants define the set of supported keycode sets
1503 Sys::Virt::Domain::KEYCODE_SET_LINUX
1505 The Linux event subsystem keycodes
1506 Sys::Virt::Domain::KEYCODE_SET_XT
1508 The original XT keycodes
1509 Sys::Virt::Domain::KEYCODE_SET_ATSET1
1511 The AT Set1 keycodes (aka XT)
1512 Sys::Virt::Domain::KEYCODE_SET_ATSET2
1514 The AT Set2 keycodes (aka AT)
1515 Sys::Virt::Domain::KEYCODE_SET_ATSET3
1517 The AT Set3 keycodes (aka PS2)
1518 Sys::Virt::Domain::KEYCODE_SET_OSX
1520 The OS-X keycodes
1521 Sys::Virt::Domain::KEYCODE_SET_XT_KBD
1523 The XT keycodes from the Linux Keyboard driver
1524 Sys::Virt::Domain::KEYCODE_SET_USB
1526 The USB HID keycode set
1527 Sys::Virt::Domain::KEYCODE_SET_WIN32
1529 The Windows keycode set
1530 Sys::Virt::Domain::KEYCODE_SET_QNUM
1532 The XT keycode set, with the extended scancodes using the high bit
1533 of the first byte, instead of the low bit of the second byte.
1534 Sys::Virt::Domain::KEYCODE_SET_RFB
1536 A deprecated alias for "Sys::Virt::Domain::KEYCODE_SET_QNUM"
1537 MEMORY PEEK
1539 The following constants can be used with the "memory_peek" method's
1540 flags parameter
1541 Sys::Virt::Domain::MEMORY_VIRTUAL
1543 Indicates that the offset is using virtual memory addressing.
1544 Sys::Virt::Domain::MEMORY_PHYSICAL
1546 Indicates that the offset is using physical memory addressing.
1547 VCPU STATE
1549 The following constants are useful when interpreting the virtual CPU
1550 run state
1551 Sys::Virt::Domain::VCPU_OFFLINE
1553 The virtual CPU is not online
1554 Sys::Virt::Domain::VCPU_RUNNING
1556 The virtual CPU is executing code
1557 Sys::Virt::Domain::VCPU_BLOCKED
1559 The virtual CPU is waiting to be scheduled
1560 OPEN GRAPHICS CONSTANTS
1562 The following constants are used when opening a connection to the guest
1563 graphics server
1564 Sys::Virt::Domain::OPEN_GRAPHICS_SKIPAUTH
1566 Skip authentication of the client
1567 OPEN CONSOLE CONSTANTS
1569 The following constants are used when opening a connection to the guest
1570 console
1571 Sys::Virt::Domain::OPEN_CONSOLE_FORCE
1573 Force opening of the console, disconnecting any other open session
1574 Sys::Virt::Domain::OPEN_CONSOLE_SAFE
1576 Check if the console driver supports safe operations
1577 OPEN CHANNEL CONSTANTS
1579 The following constants are used when opening a connection to the guest
1580 channel
1581 Sys::Virt::Domain::OPEN_CHANNEL_FORCE
1583 Force opening of the channel, disconnecting any other open session
1584 XML DUMP OPTIONS
1586 The following constants are used to control the information included in
1587 the XML configuration dump
1588 Sys::Virt::Domain::XML_INACTIVE
1590 Report the persistent inactive configuration for the guest, even if
1591 it is currently running.
1592 Sys::Virt::Domain::XML_SECURE
1594 Include security sensitive information in the XML dump, such as
1595 passwords.
1596 Sys::Virt::Domain::XML_UPDATE_CPU
1598 Update the CPU model definition to match the current executing
1599 state.
1600 Sys::Virt::Domain::XML_MIGRATABLE
1602 Update the XML to allow migration to older versions of libvirt
1603 DEVICE HOTPLUG OPTIONS
1605 The following constants are used to control device hotplug operations
1606 Sys::Virt::Domain::DEVICE_MODIFY_CURRENT
1608 Modify the domain in its current state
1609 Sys::Virt::Domain::DEVICE_MODIFY_LIVE
1611 Modify only the live state of the domain
1612 Sys::Virt::Domain::DEVICE_MODIFY_CONFIG
1614 Modify only the persistent config of the domain
1615 Sys::Virt::Domain::DEVICE_MODIFY_FORCE
1617 Force the device to be modified
1618 MEMORY OPTIONS
1620 The following constants are used to control memory change operations
1621 Sys::Virt::Domain::MEM_CURRENT
1623 Modify the current state
1624 Sys::Virt::Domain::MEM_LIVE
1626 Modify only the live state of the domain
1627 Sys::Virt::Domain::MEM_CONFIG
1629 Modify only the persistent config of the domain
1630 Sys::Virt::Domain::MEM_MAXIMUM
1632 Modify the maximum memory value
1633 CONFIG OPTIONS
1635 The following constants are used to control what configuration a domain
1636 update changes
1637 Sys::Virt::Domain::AFFECT_CURRENT
1639 Modify the current state
1640 Sys::Virt::Domain::AFFECT_LIVE
1642 Modify only the live state of the domain
1643 Sys::Virt::Domain::AFFECT_CONFIG
1645 Modify only the persistent config of the domain
1646 MIGRATE OPTIONS
1648 The following constants are used to control how migration is performed
1649 Sys::Virt::Domain::MIGRATE_LIVE
1651 Migrate the guest without interrupting its execution on the source
1652 host.
1653 Sys::Virt::Domain::MIGRATE_PEER2PEER
1655 Manage the migration process over a direct peer-2-peer connection
1656 between the source and destination host libvirtd daemons.
1657 Sys::Virt::Domain::MIGRATE_TUNNELLED
1659 Tunnel the migration data over the libvirt daemon connection,
1660 rather than the native hypervisor data transport. Requires
1661 PEER2PEER flag to be set.
1662 Sys::Virt::Domain::MIGRATE_PERSIST_DEST
1664 Make the domain persistent on the destination host, defining its
1665 configuration file upon completion of migration.
1666 Sys::Virt::Domain::MIGRATE_UNDEFINE_SOURCE
1668 Remove the domain's persistent configuration after migration
1669 completes successfully.
1670 Sys::Virt::Domain::MIGRATE_PAUSED
1672 Do not re-start execution of the guest CPUs on the destination host
1673 after migration completes.
1674 Sys::Virt::Domain::MIGRATE_NON_SHARED_DISK
1676 Copy the complete contents of the disk images during migration
1677 Sys::Virt::Domain::MIGRATE_NON_SHARED_INC
1679 Copy the incrementally changed contents of the disk images during
1680 migration
1681 Sys::Virt::Domain::MIGRATE_CHANGE_PROTECTION
1683 Do not allow changes to the virtual domain configuration while
1684 migration is taking place. This option is automatically implied if
1685 doing a peer-2-peer migration.
1686 Sys::Virt::Domain::MIGRATE_UNSAFE
1688 Migrate even if the compatibility check indicates the migration
1689 will be unsafe to the guest.
1690 Sys::Virt::Domain::MIGRATE_OFFLINE
1692 Migrate the guest config if the guest is not currently running
1693 Sys::Virt::Domain::MIGRATE_COMPRESSED
1695 Enable compression of the migration data stream
1696 Sys::Virt::Domain::MIGRATE_ABORT_ON_ERROR
1698 Abort if an I/O error occurrs on the disk
1699 Sys::Virt::Domain::MIGRATE_AUTO_CONVERGE
1701 Force convergance of the migration operation by throttling guest
1702 runtime
1703 Sys::Virt::Domain::MIGRATE_RDMA_PIN_ALL
1705 Pin memory for RDMA transfer
1706 Sys::Virt::Domain::MIGRATE_POSTCOPY
1708 Enable support for post-copy migration
1709 Sys::Virt::Domain::MIGRATE_TLS
1711 Setting this flag will cause the migration to attempt to use the
1712 TLS environment configured by the hypervisor in order to perform
1713 the migration. If incorrectly configured on either source or
1714 destination, the migration will fail.
1715 UNDEFINE CONSTANTS
1717 The following constants can be used when undefining virtual domain
1718 configurations
1719 Sys::Virt::Domain::UNDEFINE_MANAGED_SAVE
1721 Also remove any managed save image when undefining the virtual
1722 domain
1723 Sys::Virt::Domain::UNDEFINE_SNAPSHOTS_METADATA
1725 Also remove any snapshot metadata when undefining the virtual
1726 domain.
1727 Sys::Virt::Domain::UNDEFINE_NVRAM
1729 Also remove any NVRAM state file when undefining the virtual
1730 domain.
1731 Sys::Virt::Domain::UNDEFINE_KEEP_NVRAM
1733 keep NVRAM state file when undefining the virtual domain.
1734 JOB TYPES
1736 The following constants describe the different background job types.
1737 Sys::Virt::Domain::JOB_NONE
1739 No job is active
1740 Sys::Virt::Domain::JOB_BOUNDED
1742 A job with a finite completion time is active
1743 Sys::Virt::Domain::JOB_UNBOUNDED
1745 A job with an unbounded completion time is active
1746 Sys::Virt::Domain::JOB_COMPLETED
1748 The job has finished, but isn't cleaned up
1749 Sys::Virt::Domain::JOB_FAILED
1751 The job has hit an error, but isn't cleaned up
1752 Sys::Virt::Domain::JOB_CANCELLED
1754 The job was aborted at user request, but isn't cleaned up
1755 MEMORY PARAMETERS
1757 The following constants are useful when getting/setting memory
1758 parameters for guests
1759 Sys::Virt::Domain::MEMORY_HARD_LIMIT
1761 The maximum memory the guest can use.
1762 Sys::Virt::Domain::MEMORY_SOFT_LIMIT
1764 The memory upper limit enforced during memory contention.
1765 Sys::Virt::Domain::MEMORY_MIN_GUARANTEE
1767 The minimum memory guaranteed to be reserved for the guest.
1768 Sys::Virt::Domain::MEMORY_SWAP_HARD_LIMIT
1770 The maximum swap the guest can use.
1771 Sys::Virt::Domain::MEMORY_PARAM_UNLIMITED
1773 The value of an unlimited memory parameter
1774 BLKIO PARAMETERS
1776 The following parameters control I/O tuning for the domain as a whole
1777 Sys::Virt::Domain::BLKIO_WEIGHT
1779 The I/O weight parameter
1780 Sys::Virt::Domain::BLKIO_DEVICE_WEIGHT
1782 The per-device I/O weight parameter
1783 Sys::Virt::Domain::BLKIO_DEVICE_READ_BPS
1785 The per-device I/O bytes read per second
1786 Sys::Virt::Domain::BLKIO_DEVICE_READ_IOPS
1788 The per-device I/O operations read per second
1789 Sys::Virt::Domain::BLKIO_DEVICE_WRITE_BPS
1791 The per-device I/O bytes write per second
1792 Sys::Virt::Domain::BLKIO_DEVICE_WRITE_IOPS
1794 The per-device I/O operations write per second
1795 BLKIO TUNING PARAMETERS
1797 The following parameters control I/O tuning for an individual guest
1798 disk.
1799 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC
1801 The total bytes processed per second.
1802 Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC
1804 The bytes read per second.
1805 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC
1807 The bytes written per second.
1808 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC
1810 The total I/O operations processed per second.
1811 Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC
1813 The I/O operations read per second.
1814 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC
1816 The I/O operations written per second.
1817 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX
1819 The maximum total bytes processed per second.
1820 Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX
1822 The maximum bytes read per second.
1823 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX
1825 The maximum bytes written per second.
1826 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX
1828 The maximum total I/O operations processed per second.
1829 Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX
1831 The maximum I/O operations read per second.
1832 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX
1834 The maximum I/O operations written per second.
1835 Sys::Virt::Domain::BLOCK_IOTUNE_SIZE_IOPS_SEC
1837 The maximum I/O operations per second
1838 Sys::Virt::Domain::BLOCK_IOTUNE_GROUP_NAME
1840 A string representing a group name to allow sharing of I/O
1841 throttling quota between multiple drives
1842 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH
1844 The duration in seconds allowed for maximum total bytes processed
1845 per second.
1846 Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH
1848 The duration in seconds allowed for maximum bytes read per second.
1849 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH
1851 The duration in seconds allowed for maximum bytes written per
1852 second.
1853 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH
1855 The duration in seconds allowed for maximum total I/O operations
1856 processed per second.
1857 Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH
1859 The duration in seconds allowed for maximum I/O operations read per
1860 second.
1861 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH
1863 The duration in seconds allowed for maximum I/O operations written
1864 per second.
1865 SCHEDULER CONSTANTS
1867 Sys::Virt::Domain::SCHEDULER_CAP
1868 The VM cap tunable
1869 Sys::Virt::Domain::SCHEDULER_CPU_SHARES
1871 The CPU shares tunable
1872 Sys::Virt::Domain::SCHEDULER_LIMIT
1874 The VM limit tunable
1875 Sys::Virt::Domain::SCHEDULER_RESERVATION
1877 The VM reservation tunable
1878 Sys::Virt::Domain::SCHEDULER_SHARES
1880 The VM shares tunable
1881 Sys::Virt::Domain::SCHEDULER_VCPU_PERIOD
1883 The VCPU period tunable
1884 Sys::Virt::Domain::SCHEDULER_VCPU_QUOTA
1886 The VCPU quota tunable
1887 Sys::Virt::Domain::SCHEDULER_GLOBAL_PERIOD
1889 The VM global period tunable
1890 Sys::Virt::Domain::SCHEDULER_GLOBAL_QUOTA
1892 The VM global quota tunable
1893 Sys::Virt::Domain::SCHEDULER_WEIGHT
1895 The VM weight tunable
1896 NUMA PARAMETERS
1898 The following constants are useful when getting/setting the guest NUMA
1899 memory policy
1900 Sys::Virt::Domain::NUMA_MODE
1902 The NUMA policy mode
1903 Sys::Virt::Domain::NUMA_NODESET
1905 The NUMA nodeset mask
1906 The following constants are useful when interpreting the
1908 "Sys::Virt::Domain::NUMA_MODE" parameter value
1909 Sys::Virt::Domain::NUMATUNE_MEM_STRICT
1911 Allocation is mandatory from the mask nodes
1912 Sys::Virt::Domain::NUMATUNE_MEM_PREFERRED
1914 Allocation is preferred from the masked nodes
1915 Sys::Virt::Domain::NUMATUNE_MEM_INTERLEAVE
1917 Allocation is interleaved across all masked nods
1918 INTERFACE PARAMETERS
1920 The following constants are useful when getting/setting the per network
1921 interface tunable parameters
1922 Sys::Virt::Domain::BANDWIDTH_IN_AVERAGE
1924 The average inbound bandwidth
1925 Sys::Virt::Domain::BANDWIDTH_IN_PEAK
1927 The peak inbound bandwidth
1928 Sys::Virt::Domain::BANDWIDTH_IN_BURST
1930 The burstable inbound bandwidth
1931 Sys::Virt::Domain::BANDWIDTH_IN_FLOOR
1933 The minimum inbound bandwidth
1934 Sys::Virt::Domain::BANDWIDTH_OUT_AVERAGE
1936 The average outbound bandwidth
1937 Sys::Virt::Domain::BANDWIDTH_OUT_PEAK
1939 The peak outbound bandwidth
1940 Sys::Virt::Domain::BANDWIDTH_OUT_BURST
1942 The burstable outbound bandwidth
1943 PERF EVENTS
1945 The following constants defined performance events which can be
1946 monitored for a guest
1947 Sys::Virt::Domain::PERF_PARAM_CMT
1949 The CMT event counter which can be used to measure the usage of
1950 cache (bytes) by applications running on the platform. It
1951 corresponds to the "perf.cmt" field in the *Stats APIs.
1952 Sys::Virt::Domain::PERF_PARAM_MBML
1954 The MBML event counter which can be used to monitor the amount of
1955 data (bytes/s) sent through the memory controller on the socket.
1956 It corresponds to the "perf.mbml" field in the *Stats APIs.
1957 Sys::Virt::Domain::PERF_PARAM_MBMT
1959 The MBMT event counter which can be used to monitor total system
1960 bandwidth (bytes/s) from one level of cache to another. It
1961 corresponds to the "perf.mbmt" field in the *Stats APIs.
1962 Sys::Virt::Domain::PERF_PARAM_CACHE_MISSES
1964 The cache_misses perf event counter which can be used to measure
1965 the count of cache misses by applications running on the platform.
1966 It corresponds to the "perf.cache_misses" field in the *Stats APIs.
1967 Sys::Virt::Domain::PERF_PARAM_CACHE_REFERENCES
1969 The cache_references perf event counter which can be used to
1970 measure the count of cache hits by applications running on the
1971 platform. It corresponds to the "perf.cache_references" field in
1972 the *Stats APIs.
1973 Sys::Virt::Domain::PERF_PARAM_CPU_CYCLES
1975 The cpu_cycles perf event counter which can be used to measure how
1976 many cpu cycles one instruction needs. It corresponds to the
1977 "perf.cpu_cycles" field in the *Stats APIs.
1978 Sys::Virt::Domain::PERF_PARAM_INSTRUCTIONS
1980 The instructions perf event counter which can be used to measure
1981 the count of instructions by applications running on the platform.
1982 It corresponds to the "perf.instructions" field in the *Stats APIs.
1983 Sys::Virt::Domain::PERF_PARAM_BRANCH_INSTRUCTIONS
1985 The branch_instructions perf event counter which can be used to
1986 measure the count of instructions by applications running on the
1987 platform. It corresponds to the "perf.branch_instructions" field in
1988 the *Stats APIs.
1989 Sys::Virt::Domain::PERF_PARAM_BRANCH_MISSES
1991 The branch_misses perf event which can be used to measure the count
1992 of branch misses by applications running on the platform. It
1993 corresponds to the "perf.branch_misses" field in the *Stats APIs.
1994 Sys::Virt::Domain::PERF_PARAM_BUS_CYCLES The bus_cycles perf event
1996 counter which can be used to measure the count of bus cycles by
1997 applications running on the platform. It corresponds to the
1998 "perf.bus_cycles" field in the *Stats APIs.
1999 Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_FRONTEND The
2000 stalled_cycles_frontend perf event counter which can be used to measure
2001 the count of stalled cpu cycles in the frontend of the instruction
2002 processor pipeline by applications running on the platform. It
2003 corresponds to the "perf.stalled_cycles_frontend" field in the *Stats
2004 APIs.
2005 Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_BACKEND The
2006 stalled_cycles_backend perf event counter which can be used to measure
2007 the count of stalled cpu cycles in the backend of the instruction
2008 processor pipeline by application running on the platform. It
2009 corresponds to the "perf.stalled_cycles_backend" field in the *Stats
2010 APIs.
2011 Sys::Virt::Domain::PERF_PARAM_REF_CPU_CYCLES The ref_cpu_cycles perf
2012 event counter which can be used to measure the count of total cpu
2013 cycles not affected by CPU frequency scaling by applications running on
2014 the platform. It corresponds to the "perf.ref_cpu_cycles" field in the
2015 *Stats APIs.
2016 Sys::Virt::Domain::PERF_PARAM_CPU_CLOCK The cpu_clock perf event
2017 counter which can be used to measure the count of cpu clock time by
2018 applications running on the platform. It corresponds to the
2019 "perf.cpu_clock" field in the *Stats APIs.
2020 Sys::Virt::Domain::PERF_PARAM_TASK_CLOCK The task_clock perf event
2021 counter which can be used to measure the count of task clock time by
2022 applications running on the platform. It corresponds to the
2023 "perf.task_clock" field in the *Stats APIs.
2024 Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS The page_faults perf event
2025 counter which can be used to measure the count of page faults by
2026 applications running on the platform. It corresponds to the
2027 "perf.page_faults" field in the *Stats APIs.
2028 Sys::Virt::Domain::PERF_PARAM_CONTEXT_SWITCHES The context_switches
2029 perf event counter which can be used to measure the count of context
2030 switches by applications running on the platform. It corresponds to the
2031 "perf.context_switches" field in the *Stats APIs.
2032 Sys::Virt::Domain::PERF_PARAM_CPU_MIGRATIONS The cpu_migrations perf
2033 event counter which can be used to measure the count of cpu migrations
2034 by applications running on the platform. It corresponds to the
2035 "perf.cpu_migrations" field in the *Stats APIs.
2036 Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MIN The page_faults_min perf
2037 event counter which can be used to measure the count of minor page
2038 faults by applications running on the platform. It corresponds to the
2039 "perf.page_faults_min" field in the *Stats APIs.
2040 Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MAJ The page_faults_maj perf
2041 event counter which can be used to measure the count of major page
2042 faults by applications running on the platform. It corresponds to the
2043 "perf.page_faults_maj" field in the *Stats APIs.
2044 Sys::Virt::Domain::PERF_PARAM_ALIGNMENT_FAULTS The alignment_faults
2045 perf event counter which can be used to measure the count of alignment
2046 faults by applications running on the platform. It corresponds to the
2047 "perf.alignment_faults" field in the *Stats APIs.
2048 Sys::Virt::Domain::PERF_PARAM_EMULATION_FAULTS The emulation_faults
2049 perf event counter which can be used to measure the count of emulation
2050 faults by applications running on the platform. It corresponds to the
2051 "perf.emulation_faults" field in the *Stats APIs.
2052 IOTHREAD STATS
2054 The following constants defined IOThread statistics which can be
2055 monitored for a guest
2056 Sys::Virt::Domain::IOTHREAD_PARAM_POLL_MAX_NS
2058 The maximum polling time that can be used by polling algorithm in
2059 ns. The polling time starts at 0 (zero) and is the time spent by
2060 the guest to process IOThread data before returning the CPU to the
2061 host. The polling time will be dynamically modified over time based
2062 on the poll_grow and poll_shrink parameters provided.
2063 Sys::Virt::Domain::IOTHREAD_PARAM_POLL_GROW
2065 This provides a value for the dynamic polling adjustment algorithm
2066 to use to grow its polling interval up to the poll_max_ns value.
2067 Sys::Virt::Domain::IOTHREAD_PARAM_POLL_SHRINK
2069 This provides a value for the dynamic polling adjustment algorithm
2070 to use to shrink its polling interval when the polling interval
2071 exceeds the poll_max_ns value.
2072 VCPU FLAGS
2074 The following constants are useful when getting/setting the VCPU count
2075 for a guest
2076 Sys::Virt::Domain::VCPU_LIVE
2078 Flag to request the live value
2079 Sys::Virt::Domain::VCPU_CONFIG
2081 Flag to request the persistent config value
2082 Sys::Virt::Domain::VCPU_CURRENT
2084 Flag to request the current config value
2085 Sys::Virt::Domain::VCPU_MAXIMUM
2087 Flag to request adjustment of the maximum vCPU value
2088 Sys::Virt::Domain::VCPU_GUEST
2090 Flag to request the guest VCPU mask
2091 Sys::Virt::Domain::VCPU_HOTPLUGGABLE
2093 Flag to make vcpus added hot(un)pluggable
2094 STATE CHANGE EVENTS
2096 The following constants allow domain state change events to be
2097 interpreted. The events contain both a state change, and a reason.
2098 Sys::Virt::Domain::EVENT_DEFINED
2100 Indicates that a persistent configuration has been defined for the
2101 domain.
2102 Sys::Virt::Domain::EVENT_DEFINED_ADDED
2104 The defined configuration is newly added
2105 Sys::Virt::Domain::EVENT_DEFINED_UPDATED
2107 The defined configuration is an update to an existing
2108 configuration
2109 Sys::Virt::Domain::EVENT_DEFINED_RENAMED
2111 The defined configuration is a rename of an existing
2112 configuration
2113 Sys::Virt::Domain::EVENT_DEFINED_FROM_SNAPSHOT
2115 The defined configuration was restored from a snapshot
2116 Sys::Virt::Domain::EVENT_RESUMED
2118 The domain has resumed execution
2119 Sys::Virt::Domain::EVENT_RESUMED_MIGRATED
2121 The domain resumed because migration has completed. This is
2122 emitted on the destination host.
2123 Sys::Virt::Domain::EVENT_RESUMED_UNPAUSED
2125 The domain resumed because the admin unpaused it.
2126 Sys::Virt::Domain::EVENT_RESUMED_FROM_SNAPSHOT
2128 The domain resumed because it was restored from a snapshot
2129 Sys::Virt::Domain::EVENT_RESUMED_POSTCOPY
2131 The domain resumed but post-copy is running in background
2132 Sys::Virt::Domain::EVENT_STARTED
2134 The domain has started running
2135 Sys::Virt::Domain::EVENT_STARTED_BOOTED
2137 The domain was booted from shutoff state
2138 Sys::Virt::Domain::EVENT_STARTED_MIGRATED
2140 The domain started due to an incoming migration
2141 Sys::Virt::Domain::EVENT_STARTED_RESTORED
2143 The domain was restored from saved state file
2144 Sys::Virt::Domain::EVENT_STARTED_FROM_SNAPSHOT
2146 The domain was restored from a snapshot
2147 Sys::Virt::Domain::EVENT_STARTED_WAKEUP
2149 The domain was woken up from suspend
2150 Sys::Virt::Domain::EVENT_STOPPED
2152 The domain has stopped running
2153 Sys::Virt::Domain::EVENT_STOPPED_CRASHED
2155 The domain stopped because guest operating system has crashed
2156 Sys::Virt::Domain::EVENT_STOPPED_DESTROYED
2158 The domain stopped because administrator issued a destroy
2159 command.
2160 Sys::Virt::Domain::EVENT_STOPPED_FAILED
2162 The domain stopped because of a fault in the host
2163 virtualization environment.
2164 Sys::Virt::Domain::EVENT_STOPPED_MIGRATED
2166 The domain stopped because it was migrated to another machine.
2167 Sys::Virt::Domain::EVENT_STOPPED_SAVED
2169 The domain was saved to a state file
2170 Sys::Virt::Domain::EVENT_STOPPED_SHUTDOWN
2172 The domain stopped due to graceful shutdown of the guest.
2173 Sys::Virt::Domain::EVENT_STOPPED_FROM_SNAPSHOT
2175 The domain was stopped due to a snapshot
2176 Sys::Virt::Domain::EVENT_SHUTDOWN
2178 The domain has shutdown but is not yet stopped
2179 Sys::Virt::Domain::EVENT_SHUTDOWN_FINISHED
2181 The domain finished shutting down
2182 Sys::Virt::Domain::EVENT_SHUTDOWN_HOST
2184 The domain shutdown due to host trigger
2185 Sys::Virt::Domain::EVENT_SHUTDOWN_GUEST
2187 The domain shutdown due to guest trigger
2188 Sys::Virt::Domain::EVENT_SUSPENDED
2190 The domain has stopped executing, but still exists
2191 Sys::Virt::Domain::EVENT_SUSPENDED_MIGRATED
2193 The domain has been suspended due to offline migration
2194 Sys::Virt::Domain::EVENT_SUSPENDED_PAUSED
2196 The domain has been suspended due to administrator pause
2197 request.
2198 Sys::Virt::Domain::EVENT_SUSPENDED_IOERROR
2200 The domain has been suspended due to a block device I/O error.
2201 Sys::Virt::Domain::EVENT_SUSPENDED_FROM_SNAPSHOT
2203 The domain has been suspended due to resume from snapshot
2204 Sys::Virt::Domain::EVENT_SUSPENDED_WATCHDOG
2206 The domain has been suspended due to the watchdog triggering
2207 Sys::Virt::Domain::EVENT_SUSPENDED_RESTORED
2209 The domain has been suspended due to restore from saved state
2210 Sys::Virt::Domain::EVENT_SUSPENDED_API_ERROR
2212 The domain has been suspended due to an API error
2213 Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY
2215 The domain has been suspended for post-copy migration
2216 Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY_FAILED
2218 The domain has been suspended due post-copy migration failing
2219 Sys::Virt::Domain::EVENT_UNDEFINED
2221 The persistent configuration has gone away
2222 Sys::Virt::Domain::EVENT_UNDEFINED_REMOVED
2224 The domain configuration has gone away due to it being removed
2225 by administrator.
2226 Sys::Virt::Domain::EVENT_UNDEFINED_RENAMED
2228 The undefined configuration is a rename of an existing
2229 configuration
2230 Sys::Virt::Domain::EVENT_PMSUSPENDED
2232 The domain has stopped running
2233 Sys::Virt::Domain::EVENT_PMSUSPENDED_MEMORY
2235 The domain has suspend to RAM.
2236 Sys::Virt::Domain::EVENT_PMSUSPENDED_DISK
2238 The domain has suspend to Disk.
2239 Sys::Virt::Domain::EVENT_CRASHED
2241 The domain has crashed
2242 Sys::Virt::Domain::EVENT_CRASHED_PANICKED
2244 The domain has crashed due to a kernel panic
2245 EVENT ID CONSTANTS
2247 Sys::Virt::Domain::EVENT_ID_LIFECYCLE
2248 Domain lifecycle events
2249 Sys::Virt::Domain::EVENT_ID_REBOOT
2251 Soft / warm reboot events
2252 Sys::Virt::Domain::EVENT_ID_RTC_CHANGE
2254 RTC clock adjustments
2255 Sys::Virt::Domain::EVENT_ID_IO_ERROR
2257 File IO errors, typically from disks
2258 Sys::Virt::Domain::EVENT_ID_WATCHDOG
2260 Watchdog device triggering
2261 Sys::Virt::Domain::EVENT_ID_GRAPHICS
2263 Graphics client connections.
2264 Sys::Virt::Domain::EVENT_ID_IO_ERROR_REASON
2266 File IO errors, typically from disks, with a root cause
2267 Sys::Virt::Domain::EVENT_ID_CONTROL_ERROR
2269 Errors from the virtualization control channel
2270 Sys::Virt::Domain::EVENT_ID_BLOCK_JOB
2272 Completion status of asynchronous block jobs, identified by source
2273 file name.
2274 Sys::Virt::Domain::EVENT_ID_BLOCK_JOB_2
2276 Completion status of asynchronous block jobs, identified by target
2277 device name.
2278 Sys::Virt::Domain::EVENT_ID_DISK_CHANGE
2280 Changes in disk media
2281 Sys::Virt::Domain::EVENT_ID_TRAY_CHANGE
2283 CDROM media tray state
2284 Sys::Virt::Domain::EVENT_ID_PMSUSPEND
2286 Power management initiated suspend to RAM
2287 Sys::Virt::Domain::EVENT_ID_PMSUSPEND_DISK
2289 Power management initiated suspend to Disk
2290 Sys::Virt::Domain::EVENT_ID_PMWAKEUP
2292 Power management initiated wakeup
2293 Sys::Virt::Domain::EVENT_ID_BALLOON_CHANGE
2295 Balloon target changes
2296 Sys::Virt::Domain::EVENT_ID_DEVICE_ADDED
2298 Asynchronous guest device addition
2299 Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVED
2301 Asynchronous guest device removal
2302 Sys::Virt::Domain::EVENT_ID_TUNABLE
2304 Changes of any domain tuning parameters. The callback will be
2305 provided with a hash listing all changed parameters. The later
2306 DOMAIN TUNABLE constants can be useful when accessing the hash keys
2307 Sys::Virt::Domain::EVENT_ID_AGENT_LIFECYCLE
2309 Domain guest agent lifecycle events. The "state" parameter to the
2310 callback will match one of the constants
2311 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_CONNECTED
2313 The agent is now connected
2314 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED
2316 The agent is now disconnected
2317 The second parameter, "reason", matches one of the following
2319 constants
2320 Sys::Virt::Domain::EVENT_ID_MIGRATION_ITERATION
2322 Domain migration progress iteration. The "iteration" parameter to
2323 the callback will specify the number of iterations migration has
2324 made over guest RAM.
2325 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN
2327 The reason is unknown
2328 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED
2330 The domain was initially booted
2331 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_CHANNEL
2333 The channel on a running guest changed state
2334 Sys::Virt::Domain::EVENT_ID_JOB_COMPLETED
2336 Domain background job completion notification. The callback
2337 provides a hash containing the job stats. The keyus in the hash are
2338 the same as those used with the
2339 "Sys::Virt::Domain::get_job_stats()" method.
2340 Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVAL_FAILED
2342 Guest device removal has failed.
2343 Sys::Virt::Domain::EVENT_ID_METADATA_CHANGE
2345 The domain metadata has changed
2346 Sys::Virt::Domain::EVENT_ID_BLOCK_THRESHOLD
2348 The event occurs when the hypervisor detects that the given storage
2349 element was written beyond the point specified by threshold. The
2350 event is useful for thin-provisioned storage.
2351 IO ERROR EVENT CONSTANTS
2353 These constants describe what action was taken due to the IO error.
2354 Sys::Virt::Domain::EVENT_IO_ERROR_NONE
2356 No action was taken, the error was ignored & reported as success to
2357 guest
2358 Sys::Virt::Domain::EVENT_IO_ERROR_PAUSE
2360 The guest is paused since the error occurred
2361 Sys::Virt::Domain::EVENT_IO_ERROR_REPORT
2363 The error has been reported to the guest OS
2364 WATCHDOG EVENT CONSTANTS
2366 These constants describe what action was taken due to the watchdog
2367 firing
2368 Sys::Virt::Domain::EVENT_WATCHDOG_NONE
2370 No action was taken, the watchdog was ignored
2371 Sys::Virt::Domain::EVENT_WATCHDOG_PAUSE
2373 The guest is paused since the watchdog fired
2374 Sys::Virt::Domain::EVENT_WATCHDOG_POWEROFF
2376 The guest is powered off after the watchdog fired
2377 Sys::Virt::Domain::EVENT_WATCHDOG_RESET
2379 The guest is reset after the watchdog fired
2380 Sys::Virt::Domain::EVENT_WATCHDOG_SHUTDOWN
2382 The guest attempted to gracefully shutdown after the watchdog fired
2383 Sys::Virt::Domain::EVENT_WATCHDOG_DEBUG
2385 No action was taken, the watchdog was logged
2386 Sys::Virt::Domain::EVENT_WATCHDOG_INJECTNMI
2388 An NMI was injected into the guest after the watchdog fired
2389 GRAPHICS EVENT PHASE CONSTANTS
2391 These constants describe the phase of the graphics connection
2392 Sys::Virt::Domain::EVENT_GRAPHICS_CONNECT
2394 The initial client connection
2395 Sys::Virt::Domain::EVENT_GRAPHICS_INITIALIZE
2397 The client has been authenticated & the connection is running
2398 Sys::Virt::Domain::EVENT_GRAPHICS_DISCONNECT
2400 The client has disconnected
2401 GRAPHICS EVENT ADDRESS CONSTANTS
2403 These constants describe the format of the address
2404 Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV4
2406 An IPv4 address
2407 Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV6
2409 An IPv6 address
2410 Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_UNIX
2412 An UNIX socket path address
2413 DISK CHANGE EVENT CONSTANTS
2415 These constants describe the reason for a disk change event
2416 Sys::Virt::Domain::EVENT_DISK_CHANGE_MISSING_ON_START
2418 The disk media was cleared, as its source was missing when
2419 attempting to start the guest
2420 Sys::Virt::Domain::EVENT_DISK_DROP_MISSING_ON_START
2422 The disk device was dropped, as its source was missing when
2423 attempting to start the guest
2424 TRAY CHANGE CONSTANTS
2426 These constants describe the reason for a tray change event
2427 Sys::Virt::Domain::EVENT_TRAY_CHANGE_CLOSE
2429 The tray was closed
2430 Sys::Virt::Domain::EVENT_TRAY_CHANGE_OPEN
2432 The tray was opened
2433 DOMAIN BLOCK JOB TYPE CONSTANTS
2435 The following constants identify the different types of domain block
2436 jobs
2437 Sys::Virt::Domain::BLOCK_JOB_TYPE_UNKNOWN
2439 An unknown block job type
2440 Sys::Virt::Domain::BLOCK_JOB_TYPE_PULL
2442 The block pull job type
2443 Sys::Virt::Domain::BLOCK_JOB_TYPE_COPY
2445 The block copy job type
2446 Sys::Virt::Domain::BLOCK_JOB_TYPE_COMMIT
2448 The block commit job type
2449 Sys::Virt::Domain::BLOCK_JOB_TYPE_ACTIVE_COMMIT
2451 The block active commit job type
2452 DOMAIN BLOCK JOB COMPLETION CONSTANTS
2454 The following constants can be used to determine the completion status
2455 of a block job
2456 Sys::Virt::Domain::BLOCK_JOB_COMPLETED
2458 A successfully completed block job
2459 Sys::Virt::Domain::BLOCK_JOB_FAILED
2461 An unsuccessful block job
2462 Sys::Virt::Domain::BLOCK_JOB_CANCELED
2464 A block job canceled byy the user
2465 Sys::Virt::Domain::BLOCK_JOB_READY
2467 A block job is running
2468 DOMAIN BLOCK REBASE CONSTANTS
2470 The following constants are useful when rebasing block devices
2471 Sys::Virt::Domain::BLOCK_REBASE_SHALLOW
2473 Limit copy to top of source backing chain
2474 Sys::Virt::Domain::BLOCK_REBASE_REUSE_EXT
2476 Reuse existing external file for copy
2477 Sys::Virt::Domain::BLOCK_REBASE_COPY_RAW
2479 Make destination file raw
2480 Sys::Virt::Domain::BLOCK_REBASE_COPY
2482 Start a copy job
2483 Sys::Virt::Domain::BLOCK_REBASE_COPY_DEV
2485 Treat destination as a block device instead of file
2486 Sys::Virt::Domain::BLOCK_REBASE_RELATIVE
2488 Keep backing chain referenced using relative names
2489 DOMAIN BLOCK COPY CONSTANTS
2491 The following constants are useful when copying block devices
2492 Sys::Virt::Domain::BLOCK_COPY_SHALLOW
2494 Limit copy to top of source backing chain
2495 Sys::Virt::Domain::BLOCK_COPY_REUSE_EXT
2497 Reuse existing external file for copy
2498 Sys::Virt::Domain::BLOCK_COPY_TRANSIENT_JOB
2500 Don't force usage of recoverable job for the copy operation
2501 DOMAIN BLOCK JOB ABORT CONSTANTS
2503 The following constants are useful when aborting job copy jobs
2504 Sys::Virt::Domain::BLOCK_JOB_ABORT_ASYNC
2506 Request only, do not wait for completion
2507 Sys::Virt::Domain::BLOCK_JOB_ABORT_PIVOT
2509 Pivot to mirror when ending a copy job
2510 DOMAIN BLOCK COMMIT JOB CONSTANTS
2512 The following constants are useful with block commit job types
2513 Sys::Virt::Domain::BLOCK_COMMIT_DELETE
2515 Delete any files that are invalid after commit
2516 Sys::Virt::Domain::BLOCK_COMMIT_SHALLOW
2518 NULL base means next backing file, not whole chain
2519 Sys::Virt::Domain::BLOCK_COMMIT_ACTIVE
2521 Allow two phase commit when top is active layer
2522 Sys::Virt::Domain::BLOCK_COMMIT_RELATIVE
2524 Keep backing chain referenced using relative names
2525 DOMAIN SAVE / RESTORE CONSTANTS
2527 The following constants can be used when saving or restoring virtual
2528 machines
2529 Sys::Virt::Domain::SAVE_BYPASS_CACHE
2531 Do not use OS I/O cache when saving state.
2532 Sys::Virt::Domain::SAVE_PAUSED
2534 Mark the saved state as paused to prevent the guest CPUs starting
2535 upon restore.
2536 Sys::Virt::Domain::SAVE_RUNNING
2538 Mark the saved state as running to allow the guest CPUs to start
2539 upon restore.
2540 DOMAIN CORE DUMP CONSTANTS
2542 The following constants can be used when triggering domain core dumps
2543 Sys::Virt::Domain::DUMP_LIVE
2545 Do not pause execution while dumping the guest
2546 Sys::Virt::Domain::DUMP_CRASH
2548 Crash the guest after completing the core dump
2549 Sys::Virt::Domain::DUMP_BYPASS_CACHE
2551 Do not use OS I/O cache when writing core dump
2552 Sys::Virt::Domain::DUMP_RESET
2554 Reset the virtual machine after finishing the dump
2555 Sys::Virt::Domain::DUMP_MEMORY_ONLY
2557 Only include guest RAM in the dump, not the device state
2558 DESTROY CONSTANTS
2560 The following constants are useful when terminating guests using the
2561 "destroy" API.
2562 Sys::Virt::Domain::DESTROY_DEFAULT
2564 Destroy the guest using the default approach
2565 Sys::Virt::Domain::DESTROY_GRACEFUL
2567 Destroy the guest in a graceful manner
2568 SHUTDOWN CONSTANTS
2570 The following constants are useful when requesting that a guest
2571 terminate using the "shutdown" API
2572 Sys::Virt::Domain::SHUTDOWN_DEFAULT
2574 Shutdown using the hypervisor's default mechanism
2575 Sys::Virt::Domain::SHUTDOWN_GUEST_AGENT
2577 Shutdown by issuing a command to a guest agent
2578 Sys::Virt::Domain::SHUTDOWN_ACPI_POWER_BTN
2580 Shutdown by injecting an ACPI power button press
2581 Sys::Virt::Domain::SHUTDOWN_INITCTL
2583 Shutdown by talking to initctl (containers only)
2584 Sys::Virt::Domain::SHUTDOWN_SIGNAL
2586 Shutdown by sending SIGTERM to the init process
2587 Sys::Virt::Domain::SHUTDOWN_PARAVIRT
2589 Shutdown by issuing a paravirt power control command
2590 REBOOT CONSTANTS
2592 The following constants are useful when requesting that a guest
2593 terminate using the "reboot" API
2594 Sys::Virt::Domain::REBOOT_DEFAULT
2596 Reboot using the hypervisor's default mechanism
2597 Sys::Virt::Domain::REBOOT_GUEST_AGENT
2599 Reboot by issuing a command to a guest agent
2600 Sys::Virt::Domain::REBOOT_ACPI_POWER_BTN
2602 Reboot by injecting an ACPI power button press
2603 Sys::Virt::Domain::REBOOT_INITCTL
2605 Reboot by talking to initctl (containers only)
2606 Sys::Virt::Domain::REBOOT_SIGNAL
2608 Reboot by sending SIGHUP to the init process
2609 Sys::Virt::Domain::REBOOT_PARAVIRT
2611 Reboot by issuing a paravirt power control command
2612 METADATA CONSTANTS
2614 The following constants are useful when reading/writing metadata about
2615 a guest
2616 Sys::Virt::Domain::METADATA_TITLE
2618 The short human friendly title of the guest
2619 Sys::Virt::Domain::METADATA_DESCRIPTION
2621 The long free text description of the guest
2622 Sys::Virt::Domain::METADATA_ELEMENT
2624 The structured metadata elements for the guest
2625 DISK ERROR CONSTANTS
2627 The following constants are useful when interpreting disk error codes
2628 Sys::Virt::Domain::DISK_ERROR_NONE
2630 No error
2631 Sys::Virt::Domain::DISK_ERROR_NO_SPACE
2633 The host storage has run out of free space
2634 Sys::Virt::Domain::DISK_ERROR_UNSPEC
2636 An unspecified error has occurred.
2637 MEMORY STATISTIC CONSTANTS
2639 Sys::Virt::Domain::MEMORY_STAT_SWAP_IN
2640 Swap in
2641 Sys::Virt::Domain::MEMORY_STAT_SWAP_OUT
2643 Swap out
2644 Sys::Virt::Domain::MEMORY_STAT_MINOR_FAULT
2646 Minor faults
2647 Sys::Virt::Domain::MEMORY_STAT_MAJOR_FAULT
2649 Major faults
2650 Sys::Virt::Domain::MEMORY_STAT_RSS
2652 Resident memory
2653 Sys::Virt::Domain::MEMORY_STAT_UNUSED
2655 Unused memory
2656 Sys::Virt::Domain::MEMORY_STAT_AVAILABLE
2658 Available memory
2659 Sys::Virt::Domain::MEMORY_STAT_ACTUAL_BALLOON
2661 Actual balloon limit
2662 Sys::Virt::Domain::MEMORY_STAT_USABLE
2664 Amount of usable memory
2665 Sys::Virt::Domain::MEMORY_STAT_LAST_UPDATE
2667 Time of last stats refresh from guest
2668 Sys::Virt::Domain::MEMORY_STAT_DISK_CACHES
2670 Disk cache size
2671 DOMAIN LIST CONSTANTS
2673 The following constants can be used when listing domains
2674 Sys::Virt::Domain::LIST_ACTIVE
2676 Only list domains that are currently active (running, or paused)
2677 Sys::Virt::Domain::LIST_AUTOSTART
2679 Only list domains that are set to automatically start on boot
2680 Sys::Virt::Domain::LIST_HAS_SNAPSHOT
2682 Only list domains that have a stored snapshot
2683 Sys::Virt::Domain::LIST_INACTIVE
2685 Only list domains that are currently inactive (shutoff, saved)
2686 Sys::Virt::Domain::LIST_MANAGEDSAVE
2688 Only list domains that have current managed save state
2689 Sys::Virt::Domain::LIST_NO_AUTOSTART
2691 Only list domains that are not set to automatically start on boto
2692 Sys::Virt::Domain::LIST_NO_MANAGEDSAVE
2694 Only list domains that do not have any managed save state
2695 Sys::Virt::Domain::LIST_NO_SNAPSHOT
2697 Only list domains that do not have a stored snapshot
2698 Sys::Virt::Domain::LIST_OTHER
2700 Only list domains that are not running, paused or shutoff
2701 Sys::Virt::Domain::LIST_PAUSED
2703 Only list domains that are paused
2704 Sys::Virt::Domain::LIST_PERSISTENT
2706 Only list domains which have a persistent config
2707 Sys::Virt::Domain::LIST_RUNNING
2709 Only list domains that are currently running
2710 Sys::Virt::Domain::LIST_SHUTOFF
2712 Only list domains that are currently shutoff
2713 Sys::Virt::Domain::LIST_TRANSIENT
2715 Only list domains that do not have a persistent config
2716 SEND KEY CONSTANTS
2718 The following constants are to be used with the "send_key" API
2719 Sys::Virt::Domain::SEND_KEY_MAX_KEYS
2721 The maximum number of keys that can be sent in a single call to
2722 "send_key"
2723 BLOCK STATS CONSTANTS
2725 The following constants provide the names of well known block stats
2726 fields
2727 Sys::Virt::Domain::BLOCK_STATS_ERRS
2729 The number of I/O errors
2730 Sys::Virt::Domain::BLOCK_STATS_FLUSH_REQ
2732 The number of flush requests
2733 Sys::Virt::Domain::BLOCK_STATS_FLUSH_TOTAL_TIMES
2735 The time spent processing flush requests
2736 Sys::Virt::Domain::BLOCK_STATS_READ_BYTES
2738 The amount of data read
2739 Sys::Virt::Domain::BLOCK_STATS_READ_REQ
2741 The number of read requests
2742 Sys::Virt::Domain::BLOCK_STATS_READ_TOTAL_TIMES
2744 The time spent processing read requests
2745 Sys::Virt::Domain::BLOCK_STATS_WRITE_BYTES
2747 The amount of data written
2748 Sys::Virt::Domain::BLOCK_STATS_WRITE_REQ
2750 The number of write requests
2751 Sys::Virt::Domain::BLOCK_STATS_WRITE_TOTAL_TIMES
2753 The time spent processing write requests
2754 CPU STATS CONSTANTS
2756 The following constants provide the names of well known cpu stats
2757 fields
2758 Sys::Virt::Domain::CPU_STATS_CPUTIME
2760 The total CPU time, including both hypervisor and vCPU time.
2761 Sys::Virt::Domain::CPU_STATS_USERTIME
2763 THe total time in kernel
2764 Sys::Virt::Domain::CPU_STATS_SYSTEMTIME
2766 The total time in userspace
2767 Sys::Virt::Domain::CPU_STATS_VCPUTIME
2769 The total vCPU time.
2770 CPU STATS CONSTANTS
2772 The following constants provide the names of well known schedular
2773 parameters
2774 Sys::Virt::SCHEDULER_EMULATOR_PERIOD
2776 The duration of the time period for scheduling the emulator
2777 Sys::Virt::SCHEDULER_EMULATOR_QUOTA
2779 The quota for the emulator in one schedular time period
2780 Sys::Virt::SCHEDULER_IOTHREAD_PERIOD
2782 The duration of the time period for scheduling the iothread
2783 Sys::Virt::SCHEDULER_IOTHREAD_QUOTA
2785 The quota for the iothread in one schedular time period
2786 DOMAIN STATS FLAG CONSTANTS
2788 The following constants are used as flags when requesting bulk domain
2789 stats from "Sys::Virt::get_all_domain_stats".
2790 Sys::Virt::Domain::GET_ALL_STATS_ACTIVE
2792 Include stats for active domains
2793 Sys::Virt::Domain::GET_ALL_STATS_INACTIVE
2795 Include stats for inactive domains
2796 Sys::Virt::Domain::GET_ALL_STATS_OTHER
2798 Include stats for other domains
2799 Sys::Virt::Domain::GET_ALL_STATS_PAUSED
2801 Include stats for paused domains
2802 Sys::Virt::Domain::GET_ALL_STATS_PERSISTENT
2804 Include stats for persistent domains
2805 Sys::Virt::Domain::GET_ALL_STATS_RUNNING
2807 Include stats for running domains
2808 Sys::Virt::Domain::GET_ALL_STATS_SHUTOFF
2810 Include stats for shutoff domains
2811 Sys::Virt::Domain::GET_ALL_STATS_TRANSIENT
2813 Include stats for transient domains
2814 Sys::Virt::Domain::GET_ALL_STATS_ENFORCE_STATS
2816 Require that all requested stats fields are returned
2817 Sys::Virt::Domain::GET_ALL_STATS_BACKING
2819 Get stats for image backing files too
2820 Sys::Virt::Domain::GET_ALL_STATS_NOWAIT
2822 Skip stats if they can't be acquired without waiting
2823 DOMAIN STATS FIELD CONSTANTS
2825 The following constants are used to control which fields are returned
2826 for stats queries.
2827 Sys::Virt::Domain::STATS_BALLOON
2829 Balloon statistics
2830 Sys::Virt::Domain::STATS_BLOCK
2832 Block device info
2833 Sys::Virt::Domain::STATS_CPU_TOTAL
2835 CPU usage info
2836 Sys::Virt::Domain::STATS_INTERFACE
2838 Network interface info
2839 Sys::Virt::Domain::STATS_STATE
2841 General lifecycle state
2842 Sys::Virt::Domain::STATS_VCPU
2844 Virtual CPU info
2845 Sys::Virt::Domain::STATS_PERF
2847 Performance event counter values
2848 Sys::Virt::Domain::STATS_IOTHREAD
2850 IOThread performance statistics values
2851 PROCESS SIGNALS
2853 The following constants provide the names of signals which can be sent
2854 to guest processes. They mostly correspond to POSIX signal names.
2855 Sys::Virt::Domain::PROCESS_SIGNAL_NOP
2857 SIGNOP
2858 Sys::Virt::Domain::PROCESS_SIGNAL_HUP
2860 SIGHUP
2861 Sys::Virt::Domain::PROCESS_SIGNAL_INT
2863 SIGINT
2864 Sys::Virt::Domain::PROCESS_SIGNAL_QUIT
2866 SIGQUIT
2867 Sys::Virt::Domain::PROCESS_SIGNAL_ILL
2869 SIGILL
2870 Sys::Virt::Domain::PROCESS_SIGNAL_TRAP
2872 SIGTRAP
2873 Sys::Virt::Domain::PROCESS_SIGNAL_ABRT
2875 SIGABRT
2876 Sys::Virt::Domain::PROCESS_SIGNAL_BUS
2878 SIGBUS
2879 Sys::Virt::Domain::PROCESS_SIGNAL_FPE
2881 SIGFPE
2882 Sys::Virt::Domain::PROCESS_SIGNAL_KILL
2884 SIGKILL
2885 Sys::Virt::Domain::PROCESS_SIGNAL_USR1
2887 SIGUSR1
2888 Sys::Virt::Domain::PROCESS_SIGNAL_SEGV
2890 SIGSEGV
2891 Sys::Virt::Domain::PROCESS_SIGNAL_USR2
2893 SIGUSR2
2894 Sys::Virt::Domain::PROCESS_SIGNAL_PIPE
2896 SIGPIPE
2897 Sys::Virt::Domain::PROCESS_SIGNAL_ALRM
2899 SIGALRM
2900 Sys::Virt::Domain::PROCESS_SIGNAL_TERM
2902 SIGTERM
2903 Sys::Virt::Domain::PROCESS_SIGNAL_STKFLT
2905 SIGSTKFLT
2906 Sys::Virt::Domain::PROCESS_SIGNAL_CHLD
2908 SIGCHLD
2909 Sys::Virt::Domain::PROCESS_SIGNAL_CONT
2911 SIGCONT
2912 Sys::Virt::Domain::PROCESS_SIGNAL_STOP
2914 SIGSTOP
2915 Sys::Virt::Domain::PROCESS_SIGNAL_TSTP
2917 SIGTSTP
2918 Sys::Virt::Domain::PROCESS_SIGNAL_TTIN
2920 SIGTTIN
2921 Sys::Virt::Domain::PROCESS_SIGNAL_TTOU
2923 SIGTTOU
2924 Sys::Virt::Domain::PROCESS_SIGNAL_URG
2926 SIGURG
2927 Sys::Virt::Domain::PROCESS_SIGNAL_XCPU
2929 SIGXCPU
2930 Sys::Virt::Domain::PROCESS_SIGNAL_XFSZ
2932 SIGXFSZ
2933 Sys::Virt::Domain::PROCESS_SIGNAL_VTALRM
2935 SIGVTALRM
2936 Sys::Virt::Domain::PROCESS_SIGNAL_PROF
2938 SIGPROF
2939 Sys::Virt::Domain::PROCESS_SIGNAL_WINCH
2941 SIGWINCH
2942 Sys::Virt::Domain::PROCESS_SIGNAL_POLL
2944 SIGPOLL
2945 Sys::Virt::Domain::PROCESS_SIGNAL_PWR
2947 SIGPWR
2948 Sys::Virt::Domain::PROCESS_SIGNAL_SYS
2950 SIGSYS
2951 Sys::Virt::Domain::PROCESS_SIGNAL_RT0
2953 SIGRT0
2954 Sys::Virt::Domain::PROCESS_SIGNAL_RT1
2956 SIGRT1
2957 Sys::Virt::Domain::PROCESS_SIGNAL_RT2
2959 SIGRT2
2960 Sys::Virt::Domain::PROCESS_SIGNAL_RT3
2962 SIGRT3
2963 Sys::Virt::Domain::PROCESS_SIGNAL_RT4
2965 SIGRT4
2966 Sys::Virt::Domain::PROCESS_SIGNAL_RT5
2968 SIGRT5
2969 Sys::Virt::Domain::PROCESS_SIGNAL_RT6
2971 SIGRT6
2972 Sys::Virt::Domain::PROCESS_SIGNAL_RT7
2974 SIGRT7
2975 Sys::Virt::Domain::PROCESS_SIGNAL_RT8
2977 SIGRT8
2978 Sys::Virt::Domain::PROCESS_SIGNAL_RT9
2980 SIGRT9
2981 Sys::Virt::Domain::PROCESS_SIGNAL_RT10
2983 SIGRT10
2984 Sys::Virt::Domain::PROCESS_SIGNAL_RT11
2986 SIGRT11
2987 Sys::Virt::Domain::PROCESS_SIGNAL_RT12
2989 SIGRT12
2990 Sys::Virt::Domain::PROCESS_SIGNAL_RT13
2992 SIGRT13
2993 Sys::Virt::Domain::PROCESS_SIGNAL_RT14
2995 SIGRT14
2996 Sys::Virt::Domain::PROCESS_SIGNAL_RT15
2998 SIGRT15
2999 Sys::Virt::Domain::PROCESS_SIGNAL_RT16
3001 SIGRT16
3002 Sys::Virt::Domain::PROCESS_SIGNAL_RT17
3004 SIGRT17
3005 Sys::Virt::Domain::PROCESS_SIGNAL_RT18
3007 SIGRT18
3008 Sys::Virt::Domain::PROCESS_SIGNAL_RT19
3010 SIGRT19
3011 Sys::Virt::Domain::PROCESS_SIGNAL_RT20
3013 SIGRT20
3014 Sys::Virt::Domain::PROCESS_SIGNAL_RT21
3016 SIGRT21
3017 Sys::Virt::Domain::PROCESS_SIGNAL_RT22
3019 SIGRT22
3020 Sys::Virt::Domain::PROCESS_SIGNAL_RT23
3022 SIGRT23
3023 Sys::Virt::Domain::PROCESS_SIGNAL_RT24
3025 SIGRT24
3026 Sys::Virt::Domain::PROCESS_SIGNAL_RT25
3028 SIGRT25
3029 Sys::Virt::Domain::PROCESS_SIGNAL_RT26
3031 SIGRT26
3032 Sys::Virt::Domain::PROCESS_SIGNAL_RT27
3034 SIGRT27
3035 Sys::Virt::Domain::PROCESS_SIGNAL_RT28
3037 SIGRT28
3038 Sys::Virt::Domain::PROCESS_SIGNAL_RT29
3040 SIGRT29
3041 Sys::Virt::Domain::PROCESS_SIGNAL_RT30
3043 SIGRT30
3044 Sys::Virt::Domain::PROCESS_SIGNAL_RT31
3046 SIGRT31
3047 Sys::Virt::Domain::PROCESS_SIGNAL_RT32
3049 SIGRT32
3050 DOMAIN TUNABLE CONSTANTS
3052 The following constants are useful when accessing domain tuning
3053 parameters in APIs and events
3054 Sys::Virt::Domain::TUNABLE_CPU_CPU_SHARES
3056 Proportional CPU weight
3057 Sys::Virt::Domain::TUNABLE_CPU_EMULATORPIN
3059 Emulator thread CPU pinning mask
3060 Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_PERIOD
3062 Emulator thread CPU period
3063 Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_QUOTA
3065 Emulator thread CPU quota
3066 Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_PERIOD
3068 Iothread thread CPU period
3069 Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_QUOTA
3071 Iothread thread CPU quota
3072 Sys::Virt::Domain::TUNABLE_CPU_VCPUPIN
3074 VCPU thread pinning mask
3075 Sys::Virt::Domain::TUNABLE_CPU_VCPU_PERIOD
3077 VCPU thread period
3078 Sys::Virt::Domain::TUNABLE_CPU_VCPU_QUOTA
3080 VCPU thread quota
3081 Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_PERIOD
3083 VM global period
3084 Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_QUOTA
3086 VM global quota
3087 Sys::Virt::Domain::TUNABLE_BLKDEV_DISK
3089 The name of guest disks
3090 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC
3092 Read throughput in bytes per sec
3093 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC
3095 Read throughput in I/O operations per sec
3096 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC
3098 Total throughput in bytes per sec
3099 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC
3101 Total throughput in I/O operations per sec
3102 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC
3104 Write throughput in bytes per sec
3105 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC
3107 Write throughput in I/O operations per sec
3108 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX
3110 Maximum read throughput in bytes per sec
3111 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX
3113 Maximum read throughput in I/O operations per sec
3114 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX
3116 Maximum total throughput in bytes per sec
3117 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX
3119 Maximum total throughput in I/O operations per sec
3120 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX
3122 Maximum write throughput in bytes per sec
3123 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX
3125 Maximum write throughput in I/O operations per sec
3126 Sys::Virt::Domain::TUNABLE_BLKDEV_SIZE_IOPS_SEC
3128 The maximum I/O operations per second
3129 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH
3131 The duration in seconds allowed for maximum total bytes processed
3132 per second.
3133 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH
3135 The duration in seconds allowed for maximum bytes read per second.
3136 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH
3138 The duration in seconds allowed for maximum bytes written per
3139 second.
3140 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH
3142 The duration in seconds allowed for maximum total I/O operations
3143 processed per second.
3144 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH
3146 The duration in seconds allowed for maximum I/O operations read per
3147 second.
3148 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH
3150 The duration in seconds allowed for maximum I/O operations written
3151 per second.
3152 Sys::Virt::Domain::TUNABLE_BLKDEV_GROUP_NAME
3154 The name of the blkdev group
3155 Sys::Virt::Domain::TUNABLE_IOTHREADSPIN
3157 The I/O threads pinning
3158 DOMAIN LIFECYCLE CONSTANTS
3160 The following constants are useful when setting action for lifecycle
3161 events.
3162 Sys::Virt::Domain::LIFECYCLE_POWEROFF
3164 The poweroff lifecycle event type
3165 Sys::Virt::Domain::LIFECYCLE_REBOOT
3167 The reboot lifecycle event type
3168 Sys::Virt::Domain::LIFECYCLE_CRASH
3170 The crash lifecycle event type
3171 DOMAIN LIFECYCLE ACTION CONSTANTS
3173 Sys::Virt::Domain::LIFECYCLE_ACTION_DESTROY
3174 The destroy lifecycle action
3175 Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART
3177 The restart lifecycle action
3178 Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART_RENAME
3180 The restart-rename lifecycle action
3181 Sys::Virt::Domain::LIFECYCLE_ACTION_PRESERVE
3183 The preserve lifecycle action
3184 Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_DESTROY
3186 The coredump-destroy lifecycle action
3187 Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_RESTART
3189 The coredump-restart lifecycle action
3190
3192 Daniel P. Berrange <berrange@redhat.com>
3193
3195 Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
3196
3198 This program is free software; you can redistribute it and/or modify it
3199 under the terms of either the GNU General Public License as published
3200 by the Free Software Foundation (either version 2 of the License, or at
3201 your option any later version), or, the Artistic License, as specified
3202 in the Perl README file.
3203
3205 Sys::Virt, Sys::Virt::Error, "http://libvirt.org"
3206perl v5.28.1 2019-03-04 Sys::Virt::Domain(3)