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 "Sys::Virt::Domain::MIGRATE_PARAM_PARALLEL_CONNECTIONS"
826 The number of connections used during parallel migration.
827 $ddom = $dom->migrate(destcon, flags=0, dname=undef, uri=undef,
829 bandwidth=0)
830 Migrate a domain to an alternative host. Use of positional
831 parameters with "migrate" is deprecated in favour of passing a hash
832 reference as described above.
833 $ddom = $dom->migrate2(destcon, dxml, flags, dname, uri, bandwidth)
835 Migrate a domain to an alternative host. This method is deprecated
836 in favour of passing a hash ref to "migrate".
837 $ddom = $dom->migrate_to_uri(desturi, \%params, flags=0)
839 Migrate a domain to an alternative host. The "desturi" parameter
840 should be a valid libvirt connection URI for the remote target
841 host. The "flags" parameter takes one or more of the
842 "Sys::Virt::Domain::MIGRATE_XXX" constants described later in this
843 document. The %params parameter is a hash reference used to set
844 various parameters for the migration operation, with the same keys
845 described for the "migrate" API.
846 $dom->migrate_to_uri(desturi, flags, dname, bandwidth)
848 Migrate a domain to an alternative host. Use of positional
849 parameters with "migrate_to_uri" is deprecated in favour of passing
850 a hash reference as described above.
851 $dom->migrate_to_uri2(dconnuri, miguri, dxml, flags, dname, bandwidth)
853 Migrate a domain to an alternative host. This method is deprecated
854 in favour of passing a hash ref to "migrate_to_uri".
855 $dom->migrate_set_max_downtime($downtime, $flags=0)
857 Set the maximum allowed downtime during migration of the guest. A
858 longer downtime makes it more likely that migration will complete,
859 at the cost of longer time blackout for the guest OS at the switch
860 over point. The "downtime" parameter is measured in milliseconds.
861 The $flags parameter is currently unused and defaults to zero.
862 $downtime = $dom->migrate_get_max_downtime($flags=0) Get the current
864 value of the maximum downtime allowed during a migration of a guest.
865 The returned <downtime> value is measured in milliseconds. The $flags
866 parameter is currently unused and defaults to zero.
867 $dom->migrate_set_max_speed($bandwidth, $flags=0)
868 Set the maximum allowed bandwidth during migration of the guest.
869 The "bandwidth" parameter is measured in MB/second. The $flags
870 parameter takes zero or more of the constants:
871 $Sys::Virt::Domain::MIGRATE_MAX_SPEED_POSTCOPY
873 Set the post-copy speed instead of the pre-copy speed.
874 $bandwidth = $dom->migrate_get_max_speed($flags=0)
876 Get the maximum allowed bandwidth during migration fo the guest.
877 The returned <bandwidth> value is measured in MB/second. The
878 $flags parameter is accepts the same constants as
879 "migrate_set_max_speed".
880 $dom->migrate_set_compression_cache($cacheSize, $flags=0)
882 Set the maximum allowed compression cache size during migration of
883 the guest. The "cacheSize" parameter is measured in bytes. The
884 $flags parameter is currently unused and defaults to zero.
885 $cacheSize = $dom->migrate_get_compression_cache($flags=0)
887 Get the maximum allowed compression cache size during migration of
888 the guest. The returned <bandwidth> value is measured in bytes.
889 The $flags parameter is currently unused and defaults to zero.
890 $dom->migrate_start_post_copy($flags=0)
892 Switch the domain from pre-copy to post-copy mode. This requires
893 that the original migrate command had the
894 "Sys::Virt::Domain::MIGRATE_POST_COPY" flag specified.
895 $dom->inject_nmi($flags)
897 Trigger an NMI in the guest virtual machine. The $flags parameter
898 is currently unused and defaults to 0.
899 $dom->open_console($st, $devname, $flags)
901 Open the text console for a serial, parallel or paravirt console
902 device identified by $devname, connecting it to the stream $st. If
903 $devname is undefined, the default console will be opened. $st must
904 be a "Sys::Virt::Stream" object used for bi-directional
905 communication with the console. $flags is currently unused,
906 defaulting to 0.
907 $dom->open_channel($st, $devname, $flags)
909 Open the text console for a data channel device identified by
910 $devname, connecting it to the stream $st. $st must be a
911 "Sys::Virt::Stream" object used for bi-directional communication
912 with the channel. $flags is currently unused, defaulting to 0.
913 $dom->open_graphics($idx, $fd, $flags)
915 Open the graphics console for a guest, identified by $idx, counting
916 from 0. The $fd should be a file descriptor for an anoymous socket
917 pair. The $flags argument should be one of the constants listed at
918 the end of this document, and defaults to 0.
919 $fd = $dom->open_graphics_fd($idx, $flags)
921 Open the graphics console for a guest, identified by $idx, counting
922 from 0. The $flags argument should be one of the constants listed
923 at the end of this document, and defaults to 0. The return value
924 will be a file descriptor connected to the console which must be
925 closed when no longer needed. This method is preferred over
926 "open_graphics" since it will work correctly under sVirt mandatory
927 access control policies.
928 my $mimetype = $dom->screenshot($st, $screen, $flags)
930 Capture a screenshot of the virtual machine's monitor. The $screen
931 parameter controls which monitor is captured when using a multi-
932 head or multi-card configuration. $st must be a "Sys::Virt::Stream"
933 object from which the data can be read. $flags is currently unused
934 and defaults to 0. The mimetype of the screenshot is returned
935 @vcpuinfo = $dom->get_vcpu_info($flags=0)
937 Obtain information about the state of all virtual CPUs in a running
938 guest domain. The returned list will have one element for each
939 vCPU, where each elements contains a hash reference. The keys in
940 the hash are, "number" the vCPU number, "cpu" the physical CPU on
941 which the vCPU is currently scheduled, "cpuTime" the cumulative
942 execution time of the vCPU, "state" the running state and
943 "affinity" giving the allowed shedular placement. The value for
944 "affinity" is a string representing a bitmask against physical
945 CPUs, 8 cpus per character. To extract the bits use the "unpack"
946 function with the "b*" template. NB The "state", "cpuTime", "cpu"
947 values are only available if using $flags value of 0, and the
948 domain is currently running; otherwise they will all be set to
949 zero.
950 $dom->pin_vcpu($vcpu, $mask)
952 Pin the virtual CPU given by index $vcpu to physical CPUs given by
953 $mask. The $mask is a string representing a bitmask against
954 physical CPUs, 8 cpus per character.
955 $mask = $dom->get_emulator_pin_info()
957 Obtain information about the CPU affinity of the emulator process.
958 The returned $mask is a bitstring against physical CPUs, 8 cpus per
959 character. To extract the bits use the "unpack" function with the
960 "b*" template.
961 $dom->pin_emulator($newmask, $flags=0)
963 Pin the emulator threads to the physical CPUs identified by the
964 affinity in $newmask. The $newmask is a bitstring against the
965 physical CPUa, 8 cpus per character. To create a suitable
966 bitstring, use the "vec" function with a value of 1 for the "BITS"
967 parameter.
968 @iothreadinfo = $dom->get_iothread_info($flags=0)
970 Obtain information about the state of all IOThreads in a running
971 guest domain. The returned list will have one element for each
972 IOThread, where each elements contains a hash reference. The keys
973 in the hash are, "number" the IOThread number and "affinity" giving
974 the allowed schedular placement. The value for "affinity" is a
975 string representing a bitmask against physical CPUs, 8 cpus per
976 character. To extract the bits use the "unpack" function with the
977 "b*" template.
978 $dom->pin_iothread($iothread, $mask)
980 Pin the IOThread given by index $iothread to physical CPUs given by
981 $mask. The $mask is a string representing a bitmask against
982 physical CPUs, 8 cpus per character.
983 $dom->add_iothread($iothread, $flags=0)
985 Add a new IOThread by the $iothread value to the guest domain. The
986 $flags parameter accepts one or more the CONFIG OPTION constants
987 documented later, and defaults to 0 if omitted.
988 $dom->del_iothread($iothread, $flags=0)
990 Delete an existing IOThread by the $iothread value from the guest
991 domain. The $flags parameter accepts one or more the CONFIG OPTION
992 constants documented later, and defaults to 0 if omitted.
993 $dom->set_iothread($iothread, $params, $flags=0)
995 Set parameters for the IOThread by the $iothread value on the guest
996 domain. The $params parameter is a hash reference whose keys are
997 the "IOTHREAD STATS" constants documented later. The $flags
998 parameter accepts one or more the CONFIG OPTION constants
999 documented later, and defaults to 0 if omitted.
1000 my @stats = $dom->get_cpu_stats($startCpu, $numCpus, $flags=0)
1002 Requests the guests host physical CPU usage statistics, starting
1003 from host CPU <$startCpu> counting up to $numCpus. If $startCpu is
1004 -1 and $numCpus is 1, then the utilization across all CPUs is
1005 returned. Returns an array of hash references, each element
1006 containing stats for one CPU.
1007 my $info = $dom->get_job_info()
1009 Returns a hash reference summarising the execution state of the
1010 background job. The elements of the hash are as follows:
1011 type
1013 The type of job, one of the JOB TYPE constants listed later in
1014 this document.
1015 timeElapsed
1017 The elapsed time in milliseconds
1018 timeRemaining
1020 The expected remaining time in milliseconds. Only set if the
1021 "type" is JOB_UNBOUNDED.
1022 dataTotal
1024 The total amount of data expected to be processed by the job,
1025 in bytes.
1026 dataProcessed
1028 The current amount of data processed by the job, in bytes.
1029 dataRemaining
1031 The expected amount of data remaining to be processed by the
1032 job, in bytes.
1033 memTotal
1035 The total amount of mem expected to be processed by the job, in
1036 bytes.
1037 memProcessed
1039 The current amount of mem processed by the job, in bytes.
1040 memRemaining
1042 The expected amount of mem remaining to be processed by the
1043 job, in bytes.
1044 fileTotal
1046 The total amount of file expected to be processed by the job,
1047 in bytes.
1048 fileProcessed
1050 The current amount of file processed by the job, in bytes.
1051 fileRemaining
1053 The expected amount of file remaining to be processed by the
1054 job, in bytes.
1055 my ($type, $stats) = $dom->get_job_stats($flags=0)
1057 Returns an array summarising the execution state of the background
1058 job. The $type value is one of the JOB TYPE constants listed later
1059 in this document. The $stats value is a hash reference, whose
1060 elements are one of the following constants.
1061 type
1063 The type of job, one of the JOB TYPE constants listed later in
1064 this document.
1065 The $flags parameter defaults to zero and can take one of the
1067 following constants.
1068 Sys::Virt::Domain::JOB_STATS_COMPLETED
1070 Return the stats of the most recently completed job.
1071 Sys::Virt::Domain::JOB_TIME_ELAPSED
1073 The elapsed time in milliseconds
1074 Sys::Virt::Domain::JOB_TIME_ELAPSED_NET
1076 Time in milliseconds since the beginning of the migration job
1077 NOT including the time required to transfer control flow from
1078 the source host to the destination host.
1079 Sys::Virt::Domain::JOB_TIME_REMAINING
1081 The expected remaining time in milliseconds. Only set if the
1082 "type" is JOB_UNBOUNDED.
1083 Sys::Virt::Domain::JOB_DATA_TOTAL
1085 The total amount of data expected to be processed by the job,
1086 in bytes.
1087 Sys::Virt::Domain::JOB_DATA_PROCESSED
1089 The current amount of data processed by the job, in bytes.
1090 Sys::Virt::Domain::JOB_DATA_REMAINING
1092 The expected amount of data remaining to be processed by the
1093 job, in bytes.
1094 Sys::Virt::Domain::JOB_MEMORY_TOTAL
1096 The total amount of mem expected to be processed by the job, in
1097 bytes.
1098 Sys::Virt::Domain::JOB_MEMORY_PROCESSED
1100 The current amount of mem processed by the job, in bytes.
1101 Sys::Virt::Domain::JOB_MEMORY_REMAINING
1103 The expected amount of mem remaining to be processed by the
1104 job, in bytes.
1105 Sys::Virt::Domain::JOB_MEMORY_CONSTANT
1107 The number of pages filled with a constant byte which have been
1108 transferred
1109 Sys::Virt::Domain::JOB_MEMORY_NORMAL
1111 The number of pages transferred without any compression
1112 Sys::Virt::Domain::JOB_MEMORY_NORMAL_BYTES
1114 The number of bytes transferred without any compression
1115 Sys::Virt::Domain::JOB_MEMORY_BPS
1117 The bytes per second transferred
1118 Sys::Virt::Domain::JOB_MEMORY_DIRTY_RATE
1120 The number of memory pages dirtied per second
1121 Sys::Virt::Domain::JOB_MEMORY_PAGE_SIZE
1123 The memory page size in bytes
1124 Sys::Virt::Domain::JOB_MEMORY_ITERATION
1126 The total number of iterations over guest memory
1127 Sys::Virt::Domain::JOB_MEMORY_POSTCOPY_REQS
1129 The number of page requests received from the destination host
1130 during post-copy migration.
1131 Sys::Virt::Domain::JOB_DISK_TOTAL
1133 The total amount of file expected to be processed by the job,
1134 in bytes.
1135 Sys::Virt::Domain::JOB_DISK_PROCESSED
1137 The current amount of file processed by the job, in bytes.
1138 Sys::Virt::Domain::JOB_DISK_REMAINING
1140 The expected amount of file remaining to be processed by the
1141 job, in bytes.
1142 Sys::Virt::Domain::JOB_DISK_BPS
1144 The bytes per second transferred
1145 Sys::Virt::Domain::JOB_AUTO_CONVERGE_THROTTLE
1147 The percentage by which vCPUs are currently throttled
1148 Sys::Virt::Domain::JOB_COMPRESSION_CACHE
1150 The size of the compression cache in bytes
1151 Sys::Virt::Domain::JOB_COMPRESSION_BYTES
1153 The number of compressed bytes transferred
1154 Sys::Virt::Domain::JOB_COMPRESSION_PAGES
1156 The number of compressed pages transferred
1157 Sys::Virt::Domain::JOB_COMPRESSION_CACHE_MISSES
1159 The number of changing pages not in compression cache
1160 Sys::Virt::Domain::JOB_COMPRESSION_OVERFLOW
1162 The number of changing pages in the compression cache but sent
1163 uncompressed since the compressed page was larger than the non-
1164 compressed page.
1165 Sys::Virt::Domain::JOB_DOWNTIME
1167 The number of milliseconds of downtime expected during
1168 migration switchover.
1169 Sys::Virt::Domain::JOB_DOWNTIME_NET
1171 Real measured downtime (ms) NOT including the time required to
1172 transfer control flow from the source host to the destination
1173 host.
1174 Sys::Virt::Domain::JOB_SETUP_TIME
1176 The number of milliseconds of time doing setup of the job
1177 Sys::Virt::Domain::JOB_OPERATION
1179 The type of operation associated with the job
1180 The values for the Sys::Virt::Domain::JOB_OPERATION field are
1182 Sys::Virt::Domain::JOB_OPERATION_UNKNOWN
1184 No known job type
1185 Sys::Virt::Domain::JOB_OPERATION_START
1187 The guest is starting
1188 Sys::Virt::Domain::JOB_OPERATION_SAVE
1190 The guest is saving to disk
1191 Sys::Virt::Domain::JOB_OPERATION_RESTORE
1193 The guest is restoring from disk
1194 Sys::Virt::Domain::JOB_OPERATION_MIGRATION_IN
1196 The guest is migrating in from another host
1197 Sys::Virt::Domain::JOB_OPERATION_MIGRATION_OUT
1199 The guest is migrating out to another host
1200 Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT
1202 The guest is saving a snapshot
1203 Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT_REVERT
1205 The guest is reverting to a snapshot
1206 Sys::Virt::Domain::JOB_OPERATION_DUMP
1208 The guest is saving a crash dump
1209 $dom->abort_job()
1211 Aborts the currently executing job
1212 my $info = $dom->get_block_job_info($path, $flags=0)
1214 Returns a hash reference summarising the execution state of the
1215 block job. The $path parameter should be the fully qualified path
1216 of the block device being changed. Valid $flags include:
1217 Sys::Virt::Domain::BLOCK_JOB_INFO_BANDWIDTH_BYTES
1219 Treat bandwidth value as bytes instead of MiB.
1220 $dom->set_block_job_speed($path, $bandwidth, $flags=0)
1222 Change the maximum I/O bandwidth used by the block job that is
1223 currently executing for $path. The $bandwidth argument is specified
1224 in MB/s. The $flags parameter can take the bitwise union of the
1225 values:
1226 Sys::Virt::Domain::BLOCK_JOB_SPEED_BANDWIDTH_BYTES
1228 The $bandwidth parameter value is measured in bytes/s instead
1229 of MB/s.
1230 $dom->abort_block_job($path, $flags=0)
1232 Abort the current job that is executing for the block device
1233 associated with $path
1234 $dom->block_pull($path, $bandwidth, $flags=0)
1236 Merge the backing files associated with $path into the top level
1237 file. The $bandwidth parameter specifies the maximum I/O rate to
1238 allow in MB/s. The $flags parameter can take the bitwise union of
1239 the values:
1240 Sys::Virt::Domain::BLOCK_PULL_BANDWIDTH_BYTES
1242 The $bandwidth parameter value is measured in bytes/s instead
1243 of MB/s.
1244 $dom->block_rebase($path, $base, $bandwidth, $flags=0)
1246 Switch the backing path associated with $path to instead use $base.
1247 The $bandwidth parameter specifies the maximum I/O rate to allow in
1248 MB/s. The $flags parameter can take the bitwise union of the
1249 values:
1250 Sys::Virt::Domain::BLOCK_REBASE_BANDWIDTH_BYTES
1252 The $bandwidth parameter value is measured in bytes/s instead
1253 of MB/s.
1254 $dom->block_copy($path, $destxml, $params, $flags=0)
1256 Copy contents of a disk image <$path> into the target volume
1257 described by $destxml which follows the schema of the <disk>
1258 element in the domain XML. The $params parameter is a hash of
1259 optional parameters to control the process
1260 Sys::Virt::Domain::BLOCK_COPY_BANDWIDTH
1262 The maximum bandwidth in bytes per second.
1263 Sys::Virt::Domain::BLOCK_COPY_GRANULARITY
1265 The granularity in bytes of the copy process
1266 Sys::Virt::Domain::BLOCK_COPY_BUF_SIZE
1268 The maximum amount of data in flight in bytes.
1269 $dom->block_commit($path, $base, $top, $bandwidth, $flags=0)
1271 Commit changes there were made to the temporary top level file
1272 $top. Takes all the differences between $top and $base and merge
1273 them into $base. The $bandwidth parameter specifies the maximum I/O
1274 rate to allow in MB/s. The $flags parameter can take the bitwise
1275 union of the values:
1276 Sys::Virt::Domain::BLOCK_COMMIT_BANDWIDTH_BYTES
1278 The $bandwidth parameter value is measured in bytes instead of
1279 MB/s.
1280 $count = $dom->num_of_snapshots()
1282 Return the number of saved snapshots of the domain
1283 @names = $dom->list_snapshot_names()
1285 List the names of all saved snapshots. The names can be used with
1286 the "lookup_snapshot_by_name"
1287 @snapshots = $dom->list_snapshots()
1289 Return a list of all snapshots currently known to the domain. The
1290 elements in the returned list are instances of the
1291 Sys::Virt::DomainSnapshot class. This method requires O(n) RPC
1292 calls, so the "list_all_snapshots" method is recommended as a more
1293 efficient alternative.
1294 my @snapshots = $dom->list_all_snapshots($flags)
1296 Return a list of all domain snapshots associated with this domain.
1297 The elements in the returned list are instances of the
1298 Sys::Virt::DomainSnapshot class. The $flags parameter can be used
1299 to filter the list of return domain snapshots.
1300 my $snapshot = $dom->get_snapshot_by_name($name)
1302 Return the domain snapshot with a name of $name. The returned
1303 object is an instance of the Sys::Virt::DomainSnapshot class.
1304 $dom->has_current_snapshot()
1306 Returns a true value if the domain has a currently active snapshot
1307 $snapshot = $dom->current_snapshot()
1309 Returns the currently active snapshot for the domain.
1310 $snapshot = $dom->create_snapshot($xml[, $flags])
1312 Create a new snapshot from the $xml. The $flags parameter accepts
1313 the SNAPSHOT CREATION constants listed in
1314 "Sys::Virt::DomainSnapshots".
1315 my @checkpoints = $dom->list_all_checkpoints($flags)
1317 Return a list of all domain checkpoints associated with this
1318 domain. The elements in the returned list are instances of the
1319 Sys::Virt::DomainCheckpoint class. The $flags parameter can be used
1320 to filter the list of return domain checkpoints.
1321 my $checkpoint = $dom->get_checkpoint_by_name($name)
1323 Return the domain checkpoint with a name of $name. The returned
1324 object is an instance of the Sys::Virt::DomainCheckpoint class.
1325 $dom->fs_trim($mountPoint, $minimum, $flags=0);
1327 Issue an FS_TRIM command to the device at $mountPoint to remove
1328 chunks of unused space that are at least $minimum bytes in length.
1329 $flags is currently unused and defaults to zero.
1330 $dom->fs_freeze(\@mountPoints, $flags=0);
1332 Freeze all the filesystems associated with the @mountPoints array
1333 reference. If <@mountPoints> is an empty list, then all filesystems
1334 will be frozen. $flags is currently unused and defaults to zero.
1335 $dom->fs_thaw(\@mountPoints, $flags=0);
1337 Thaw all the filesystems associated with the @mountPoints array
1338 reference. If <@mountPoints> is an empty list, then all filesystems
1339 will be thawed. $flags is currently unused and defaults to zero.
1340 @fslist = $dom->get_fs_info($flags=0);
1342 Obtain a list of all guest filesystems. The returned list will
1343 contain one element for each filesystem, whose value will be a hash
1344 reference with the following keys
1345 name
1347 The name of the guest device that is mounted
1348 fstype
1350 The filesystem type (eg 'ext4', 'fat', 'ntfs', etc)
1351 mountpoint
1353 The location in the filesystem tree of the mount
1354 devalias
1356 An array reference containing list of device aliases associated
1357 with the guest device. The device aliases correspond to disk
1358 target names in the guest XML configuration
1359 @nics = $dom->get_interface_addresses($src, $flags=0);
1361 Obtain a list of all guest network interfaces. The $src parameter
1362 is one of the constants
1363 Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_LEASE
1365 Extract the DHCP server lease information
1366 Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_AGENT
1368 Query the guest OS via an agent
1369 Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_ARP
1371 Extract from the local ARP tables
1372 The returned list will contain one element for each interface. The
1374 values in the list will be a hash reference with the following keys
1375 name
1377 The name of the guest interface that is mounted
1378 hwaddr
1380 The hardware address, aka MAC, if available.
1381 addrs
1383 An array reference containing list of IP addresses associated
1384 with the guest NIC. Each element in the array is a further hash
1385 containing
1386 addr
1388 The IP address string
1389 prefix
1391 The IP address network prefix
1392 type
1394 The IP address type (IPv4 vs IPv6)
1395 $dom->send_process_signal($pid, $signum, $flags=0);
1397 Send the process $pid the signal $signum. The $signum value must be
1398 one of the constants listed later, not a POSIX or Linux signal
1399 value. $flags is currently unused and defaults to zero.
1400 $dom->set_block_threshold($dev, $threshold, $flags=0);
1402 Set the threshold level for delivering the EVENT_ID_BLOCK_THRESHOLD
1403 if the device or backing chain element described by $dev is written
1404 beyond the set $threshold level. The threshold level is unset once
1405 the event fires. The event might not be delivered at all if
1406 libvirtd was not running at the moment when the threshold was
1407 reached.
1408 $dom->set_lifecycle_action($type, $action, $flags=0)
1410 Changes the actions of lifecycle events for domain represented as
1411 <on_$type>$action</on_$type> in the domain XML.
1412 $info = $dom->get_launch_security_info($flags=0)
1414 Get information about the domaim launch security policy. $flags is
1415 currently unused and defaults to zero. The returned hash may
1416 contain the following keys
1417 Sys::Virt::Domain::LAUNCH_SECURITY_SEV_MEASUREMENT
1419 The AMD SEV launch measurement
1420
1422 A number of the APIs take a "flags" parameter. In most cases passing a
1423 value of zero will be satisfactory. Some APIs, however, accept named
1424 constants to alter their behaviour. This section documents the current
1425 known constants.
1426 DOMAIN STATE
1428 The domain state constants are useful in interpreting the "state" key
1429 in the hash returned by the "get_info" method.
1430 Sys::Virt::Domain::STATE_NOSTATE
1432 The domain is active, but is not running / blocked (eg idle)
1433 Sys::Virt::Domain::STATE_RUNNING
1435 The domain is active and running
1436 Sys::Virt::Domain::STATE_BLOCKED
1438 The domain is active, but execution is blocked
1439 Sys::Virt::Domain::STATE_PAUSED
1441 The domain is active, but execution has been paused
1442 Sys::Virt::Domain::STATE_SHUTDOWN
1444 The domain is active, but in the shutdown phase
1445 Sys::Virt::Domain::STATE_SHUTOFF
1447 The domain is inactive, and shut down.
1448 Sys::Virt::Domain::STATE_CRASHED
1450 The domain is inactive, and crashed.
1451 Sys::Virt::Domain::STATE_PMSUSPENDED
1453 The domain is active, but in power management suspend state
1454 CONTROL INFO
1456 The following constants can be used to determine what the guest domain
1457 control channel status is
1458 Sys::Virt::Domain::CONTROL_ERROR
1460 The control channel has a fatal error
1461 Sys::Virt::Domain::CONTROL_OK
1463 The control channel is ready for jobs
1464 Sys::Virt::Domain::CONTROL_OCCUPIED
1466 The control channel is busy
1467 Sys::Virt::Domain::CONTROL_JOB
1469 The control channel is busy with a job
1470 If the status is "Sys::Virt::Domain::CONTROL_ERROR", then one of the
1472 following constants describes the reason
1473 Sys::Virt::Domain::CONTROL_ERROR_REASON_NONE
1475 There is no reason for the error available
1476 Sys::Virt::Domain::CONTROL_ERROR_REASON_UNKNOWN
1478 The reason for the error is unknown
1479 Sys::Virt::Domain::CONTROL_ERROR_REASON_INTERNAL
1481 There was an internal error in libvirt
1482 Sys::Virt::Domain::CONTROL_ERROR_REASON_MONITOR
1484 There was an error speaking to the monitor
1485 DOMAIN CREATION
1487 The following constants can be used to control the behaviour of domain
1488 creation
1489 Sys::Virt::Domain::START_PAUSED
1491 Keep the guest vCPUs paused after starting the guest
1492 Sys::Virt::Domain::START_AUTODESTROY
1494 Automatically destroy the guest when the connection is closed (or
1495 fails)
1496 Sys::Virt::Domain::START_BYPASS_CACHE
1498 Do not use OS I/O cache if starting a domain with a saved state
1499 image
1500 Sys::Virt::Domain::START_FORCE_BOOT
1502 Boot the guest, even if there was a saved snapshot
1503 Sys::Virt::Domain::START_VALIDATE
1505 Validate the XML document against the XML schema
1506 DOMAIN DEFINE
1508 The following constants can be used to control the behaviour of domain
1509 define operations
1510 Sys::Virt::Domain::DEFINE_VALIDATE
1512 Validate the XML document against the XML schema
1513 KEYCODE SETS
1515 The following constants define the set of supported keycode sets
1516 Sys::Virt::Domain::KEYCODE_SET_LINUX
1518 The Linux event subsystem keycodes
1519 Sys::Virt::Domain::KEYCODE_SET_XT
1521 The original XT keycodes
1522 Sys::Virt::Domain::KEYCODE_SET_ATSET1
1524 The AT Set1 keycodes (aka XT)
1525 Sys::Virt::Domain::KEYCODE_SET_ATSET2
1527 The AT Set2 keycodes (aka AT)
1528 Sys::Virt::Domain::KEYCODE_SET_ATSET3
1530 The AT Set3 keycodes (aka PS2)
1531 Sys::Virt::Domain::KEYCODE_SET_OSX
1533 The OS-X keycodes
1534 Sys::Virt::Domain::KEYCODE_SET_XT_KBD
1536 The XT keycodes from the Linux Keyboard driver
1537 Sys::Virt::Domain::KEYCODE_SET_USB
1539 The USB HID keycode set
1540 Sys::Virt::Domain::KEYCODE_SET_WIN32
1542 The Windows keycode set
1543 Sys::Virt::Domain::KEYCODE_SET_QNUM
1545 The XT keycode set, with the extended scancodes using the high bit
1546 of the first byte, instead of the low bit of the second byte.
1547 Sys::Virt::Domain::KEYCODE_SET_RFB
1549 A deprecated alias for "Sys::Virt::Domain::KEYCODE_SET_QNUM"
1550 MEMORY PEEK
1552 The following constants can be used with the "memory_peek" method's
1553 flags parameter
1554 Sys::Virt::Domain::MEMORY_VIRTUAL
1556 Indicates that the offset is using virtual memory addressing.
1557 Sys::Virt::Domain::MEMORY_PHYSICAL
1559 Indicates that the offset is using physical memory addressing.
1560 VCPU STATE
1562 The following constants are useful when interpreting the virtual CPU
1563 run state
1564 Sys::Virt::Domain::VCPU_OFFLINE
1566 The virtual CPU is not online
1567 Sys::Virt::Domain::VCPU_RUNNING
1569 The virtual CPU is executing code
1570 Sys::Virt::Domain::VCPU_BLOCKED
1572 The virtual CPU is waiting to be scheduled
1573 OPEN GRAPHICS CONSTANTS
1575 The following constants are used when opening a connection to the guest
1576 graphics server
1577 Sys::Virt::Domain::OPEN_GRAPHICS_SKIPAUTH
1579 Skip authentication of the client
1580 OPEN CONSOLE CONSTANTS
1582 The following constants are used when opening a connection to the guest
1583 console
1584 Sys::Virt::Domain::OPEN_CONSOLE_FORCE
1586 Force opening of the console, disconnecting any other open session
1587 Sys::Virt::Domain::OPEN_CONSOLE_SAFE
1589 Check if the console driver supports safe operations
1590 OPEN CHANNEL CONSTANTS
1592 The following constants are used when opening a connection to the guest
1593 channel
1594 Sys::Virt::Domain::OPEN_CHANNEL_FORCE
1596 Force opening of the channel, disconnecting any other open session
1597 XML DUMP OPTIONS
1599 The following constants are used to control the information included in
1600 the XML configuration dump
1601 Sys::Virt::Domain::XML_INACTIVE
1603 Report the persistent inactive configuration for the guest, even if
1604 it is currently running.
1605 Sys::Virt::Domain::XML_SECURE
1607 Include security sensitive information in the XML dump, such as
1608 passwords.
1609 Sys::Virt::Domain::XML_UPDATE_CPU
1611 Update the CPU model definition to match the current executing
1612 state.
1613 Sys::Virt::Domain::XML_MIGRATABLE
1615 Update the XML to allow migration to older versions of libvirt
1616 DEVICE HOTPLUG OPTIONS
1618 The following constants are used to control device hotplug operations
1619 Sys::Virt::Domain::DEVICE_MODIFY_CURRENT
1621 Modify the domain in its current state
1622 Sys::Virt::Domain::DEVICE_MODIFY_LIVE
1624 Modify only the live state of the domain
1625 Sys::Virt::Domain::DEVICE_MODIFY_CONFIG
1627 Modify only the persistent config of the domain
1628 Sys::Virt::Domain::DEVICE_MODIFY_FORCE
1630 Force the device to be modified
1631 MEMORY OPTIONS
1633 The following constants are used to control memory change operations
1634 Sys::Virt::Domain::MEM_CURRENT
1636 Modify the current state
1637 Sys::Virt::Domain::MEM_LIVE
1639 Modify only the live state of the domain
1640 Sys::Virt::Domain::MEM_CONFIG
1642 Modify only the persistent config of the domain
1643 Sys::Virt::Domain::MEM_MAXIMUM
1645 Modify the maximum memory value
1646 CONFIG OPTIONS
1648 The following constants are used to control what configuration a domain
1649 update changes
1650 Sys::Virt::Domain::AFFECT_CURRENT
1652 Modify the current state
1653 Sys::Virt::Domain::AFFECT_LIVE
1655 Modify only the live state of the domain
1656 Sys::Virt::Domain::AFFECT_CONFIG
1658 Modify only the persistent config of the domain
1659 MIGRATE OPTIONS
1661 The following constants are used to control how migration is performed
1662 Sys::Virt::Domain::MIGRATE_LIVE
1664 Migrate the guest without interrupting its execution on the source
1665 host.
1666 Sys::Virt::Domain::MIGRATE_PEER2PEER
1668 Manage the migration process over a direct peer-2-peer connection
1669 between the source and destination host libvirtd daemons.
1670 Sys::Virt::Domain::MIGRATE_TUNNELLED
1672 Tunnel the migration data over the libvirt daemon connection,
1673 rather than the native hypervisor data transport. Requires
1674 PEER2PEER flag to be set.
1675 Sys::Virt::Domain::MIGRATE_PERSIST_DEST
1677 Make the domain persistent on the destination host, defining its
1678 configuration file upon completion of migration.
1679 Sys::Virt::Domain::MIGRATE_UNDEFINE_SOURCE
1681 Remove the domain's persistent configuration after migration
1682 completes successfully.
1683 Sys::Virt::Domain::MIGRATE_PAUSED
1685 Do not re-start execution of the guest CPUs on the destination host
1686 after migration completes.
1687 Sys::Virt::Domain::MIGRATE_NON_SHARED_DISK
1689 Copy the complete contents of the disk images during migration
1690 Sys::Virt::Domain::MIGRATE_NON_SHARED_INC
1692 Copy the incrementally changed contents of the disk images during
1693 migration
1694 Sys::Virt::Domain::MIGRATE_CHANGE_PROTECTION
1696 Do not allow changes to the virtual domain configuration while
1697 migration is taking place. This option is automatically implied if
1698 doing a peer-2-peer migration.
1699 Sys::Virt::Domain::MIGRATE_UNSAFE
1701 Migrate even if the compatibility check indicates the migration
1702 will be unsafe to the guest.
1703 Sys::Virt::Domain::MIGRATE_OFFLINE
1705 Migrate the guest config if the guest is not currently running
1706 Sys::Virt::Domain::MIGRATE_COMPRESSED
1708 Enable compression of the migration data stream
1709 Sys::Virt::Domain::MIGRATE_ABORT_ON_ERROR
1711 Abort if an I/O error occurrs on the disk
1712 Sys::Virt::Domain::MIGRATE_AUTO_CONVERGE
1714 Force convergance of the migration operation by throttling guest
1715 runtime
1716 Sys::Virt::Domain::MIGRATE_RDMA_PIN_ALL
1718 Pin memory for RDMA transfer
1719 Sys::Virt::Domain::MIGRATE_POSTCOPY
1721 Enable support for post-copy migration
1722 Sys::Virt::Domain::MIGRATE_TLS
1724 Setting this flag will cause the migration to attempt to use the
1725 TLS environment configured by the hypervisor in order to perform
1726 the migration. If incorrectly configured on either source or
1727 destination, the migration will fail.
1728 Sys::Virt::Domain::MIGRATE_PARALLEL
1730 Send memory pages to the destination host through several network
1731 connections. See "Sys::Virt::Domain::MIGRATE_PARAM_PARALLEL_*"
1732 parameters for configuring the parallel migration.
1733 UNDEFINE CONSTANTS
1735 The following constants can be used when undefining virtual domain
1736 configurations
1737 Sys::Virt::Domain::UNDEFINE_MANAGED_SAVE
1739 Also remove any managed save image when undefining the virtual
1740 domain
1741 Sys::Virt::Domain::UNDEFINE_SNAPSHOTS_METADATA
1743 Also remove any snapshot metadata when undefining the virtual
1744 domain.
1745 Sys::Virt::Domain::UNDEFINE_NVRAM
1747 Also remove any NVRAM state file when undefining the virtual
1748 domain.
1749 Sys::Virt::Domain::UNDEFINE_KEEP_NVRAM
1751 keep NVRAM state file when undefining the virtual domain.
1752 Sys::Virt::Domain::UNDEFINE_CHECKPOINTS_METADATA
1754 Also remove any checkpoint metadata when undefining the virtual
1755 domain.
1756 JOB TYPES
1758 The following constants describe the different background job types.
1759 Sys::Virt::Domain::JOB_NONE
1761 No job is active
1762 Sys::Virt::Domain::JOB_BOUNDED
1764 A job with a finite completion time is active
1765 Sys::Virt::Domain::JOB_UNBOUNDED
1767 A job with an unbounded completion time is active
1768 Sys::Virt::Domain::JOB_COMPLETED
1770 The job has finished, but isn't cleaned up
1771 Sys::Virt::Domain::JOB_FAILED
1773 The job has hit an error, but isn't cleaned up
1774 Sys::Virt::Domain::JOB_CANCELLED
1776 The job was aborted at user request, but isn't cleaned up
1777 MEMORY PARAMETERS
1779 The following constants are useful when getting/setting memory
1780 parameters for guests
1781 Sys::Virt::Domain::MEMORY_HARD_LIMIT
1783 The maximum memory the guest can use.
1784 Sys::Virt::Domain::MEMORY_SOFT_LIMIT
1786 The memory upper limit enforced during memory contention.
1787 Sys::Virt::Domain::MEMORY_MIN_GUARANTEE
1789 The minimum memory guaranteed to be reserved for the guest.
1790 Sys::Virt::Domain::MEMORY_SWAP_HARD_LIMIT
1792 The maximum swap the guest can use.
1793 Sys::Virt::Domain::MEMORY_PARAM_UNLIMITED
1795 The value of an unlimited memory parameter
1796 BLKIO PARAMETERS
1798 The following parameters control I/O tuning for the domain as a whole
1799 Sys::Virt::Domain::BLKIO_WEIGHT
1801 The I/O weight parameter
1802 Sys::Virt::Domain::BLKIO_DEVICE_WEIGHT
1804 The per-device I/O weight parameter
1805 Sys::Virt::Domain::BLKIO_DEVICE_READ_BPS
1807 The per-device I/O bytes read per second
1808 Sys::Virt::Domain::BLKIO_DEVICE_READ_IOPS
1810 The per-device I/O operations read per second
1811 Sys::Virt::Domain::BLKIO_DEVICE_WRITE_BPS
1813 The per-device I/O bytes write per second
1814 Sys::Virt::Domain::BLKIO_DEVICE_WRITE_IOPS
1816 The per-device I/O operations write per second
1817 BLKIO TUNING PARAMETERS
1819 The following parameters control I/O tuning for an individual guest
1820 disk.
1821 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC
1823 The total bytes processed per second.
1824 Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC
1826 The bytes read per second.
1827 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC
1829 The bytes written per second.
1830 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC
1832 The total I/O operations processed per second.
1833 Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC
1835 The I/O operations read per second.
1836 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC
1838 The I/O operations written per second.
1839 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX
1841 The maximum total bytes processed per second.
1842 Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX
1844 The maximum bytes read per second.
1845 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX
1847 The maximum bytes written per second.
1848 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX
1850 The maximum total I/O operations processed per second.
1851 Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX
1853 The maximum I/O operations read per second.
1854 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX
1856 The maximum I/O operations written per second.
1857 Sys::Virt::Domain::BLOCK_IOTUNE_SIZE_IOPS_SEC
1859 The maximum I/O operations per second
1860 Sys::Virt::Domain::BLOCK_IOTUNE_GROUP_NAME
1862 A string representing a group name to allow sharing of I/O
1863 throttling quota between multiple drives
1864 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH
1866 The duration in seconds allowed for maximum total bytes processed
1867 per second.
1868 Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH
1870 The duration in seconds allowed for maximum bytes read per second.
1871 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH
1873 The duration in seconds allowed for maximum bytes written per
1874 second.
1875 Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH
1877 The duration in seconds allowed for maximum total I/O operations
1878 processed per second.
1879 Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH
1881 The duration in seconds allowed for maximum I/O operations read per
1882 second.
1883 Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH
1885 The duration in seconds allowed for maximum I/O operations written
1886 per second.
1887 SCHEDULER CONSTANTS
1889 Sys::Virt::Domain::SCHEDULER_CAP
1890 The VM cap tunable
1891 Sys::Virt::Domain::SCHEDULER_CPU_SHARES
1893 The CPU shares tunable
1894 Sys::Virt::Domain::SCHEDULER_LIMIT
1896 The VM limit tunable
1897 Sys::Virt::Domain::SCHEDULER_RESERVATION
1899 The VM reservation tunable
1900 Sys::Virt::Domain::SCHEDULER_SHARES
1902 The VM shares tunable
1903 Sys::Virt::Domain::SCHEDULER_VCPU_PERIOD
1905 The VCPU period tunable
1906 Sys::Virt::Domain::SCHEDULER_VCPU_QUOTA
1908 The VCPU quota tunable
1909 Sys::Virt::Domain::SCHEDULER_GLOBAL_PERIOD
1911 The VM global period tunable
1912 Sys::Virt::Domain::SCHEDULER_GLOBAL_QUOTA
1914 The VM global quota tunable
1915 Sys::Virt::Domain::SCHEDULER_WEIGHT
1917 The VM weight tunable
1918 NUMA PARAMETERS
1920 The following constants are useful when getting/setting the guest NUMA
1921 memory policy
1922 Sys::Virt::Domain::NUMA_MODE
1924 The NUMA policy mode
1925 Sys::Virt::Domain::NUMA_NODESET
1927 The NUMA nodeset mask
1928 The following constants are useful when interpreting the
1930 "Sys::Virt::Domain::NUMA_MODE" parameter value
1931 Sys::Virt::Domain::NUMATUNE_MEM_STRICT
1933 Allocation is mandatory from the mask nodes
1934 Sys::Virt::Domain::NUMATUNE_MEM_PREFERRED
1936 Allocation is preferred from the masked nodes
1937 Sys::Virt::Domain::NUMATUNE_MEM_INTERLEAVE
1939 Allocation is interleaved across all masked nods
1940 INTERFACE PARAMETERS
1942 The following constants are useful when getting/setting the per network
1943 interface tunable parameters
1944 Sys::Virt::Domain::BANDWIDTH_IN_AVERAGE
1946 The average inbound bandwidth
1947 Sys::Virt::Domain::BANDWIDTH_IN_PEAK
1949 The peak inbound bandwidth
1950 Sys::Virt::Domain::BANDWIDTH_IN_BURST
1952 The burstable inbound bandwidth
1953 Sys::Virt::Domain::BANDWIDTH_IN_FLOOR
1955 The minimum inbound bandwidth
1956 Sys::Virt::Domain::BANDWIDTH_OUT_AVERAGE
1958 The average outbound bandwidth
1959 Sys::Virt::Domain::BANDWIDTH_OUT_PEAK
1961 The peak outbound bandwidth
1962 Sys::Virt::Domain::BANDWIDTH_OUT_BURST
1964 The burstable outbound bandwidth
1965 PERF EVENTS
1967 The following constants defined performance events which can be
1968 monitored for a guest
1969 Sys::Virt::Domain::PERF_PARAM_CMT
1971 The CMT event counter which can be used to measure the usage of
1972 cache (bytes) by applications running on the platform. It
1973 corresponds to the "perf.cmt" field in the *Stats APIs.
1974 Sys::Virt::Domain::PERF_PARAM_MBML
1976 The MBML event counter which can be used to monitor the amount of
1977 data (bytes/s) sent through the memory controller on the socket.
1978 It corresponds to the "perf.mbml" field in the *Stats APIs.
1979 Sys::Virt::Domain::PERF_PARAM_MBMT
1981 The MBMT event counter which can be used to monitor total system
1982 bandwidth (bytes/s) from one level of cache to another. It
1983 corresponds to the "perf.mbmt" field in the *Stats APIs.
1984 Sys::Virt::Domain::PERF_PARAM_CACHE_MISSES
1986 The cache_misses perf event counter which can be used to measure
1987 the count of cache misses by applications running on the platform.
1988 It corresponds to the "perf.cache_misses" field in the *Stats APIs.
1989 Sys::Virt::Domain::PERF_PARAM_CACHE_REFERENCES
1991 The cache_references perf event counter which can be used to
1992 measure the count of cache hits by applications running on the
1993 platform. It corresponds to the "perf.cache_references" field in
1994 the *Stats APIs.
1995 Sys::Virt::Domain::PERF_PARAM_CPU_CYCLES
1997 The cpu_cycles perf event counter which can be used to measure how
1998 many cpu cycles one instruction needs. It corresponds to the
1999 "perf.cpu_cycles" field in the *Stats APIs.
2000 Sys::Virt::Domain::PERF_PARAM_INSTRUCTIONS
2002 The instructions perf event counter which can be used to measure
2003 the count of instructions by applications running on the platform.
2004 It corresponds to the "perf.instructions" field in the *Stats APIs.
2005 Sys::Virt::Domain::PERF_PARAM_BRANCH_INSTRUCTIONS
2007 The branch_instructions perf event counter which can be used to
2008 measure the count of instructions by applications running on the
2009 platform. It corresponds to the "perf.branch_instructions" field in
2010 the *Stats APIs.
2011 Sys::Virt::Domain::PERF_PARAM_BRANCH_MISSES
2013 The branch_misses perf event which can be used to measure the count
2014 of branch misses by applications running on the platform. It
2015 corresponds to the "perf.branch_misses" field in the *Stats APIs.
2016 Sys::Virt::Domain::PERF_PARAM_BUS_CYCLES The bus_cycles perf event
2018 counter which can be used to measure the count of bus cycles by
2019 applications running on the platform. It corresponds to the
2020 "perf.bus_cycles" field in the *Stats APIs.
2021 Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_FRONTEND The
2022 stalled_cycles_frontend perf event counter which can be used to measure
2023 the count of stalled cpu cycles in the frontend of the instruction
2024 processor pipeline by applications running on the platform. It
2025 corresponds to the "perf.stalled_cycles_frontend" field in the *Stats
2026 APIs.
2027 Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_BACKEND The
2028 stalled_cycles_backend perf event counter which can be used to measure
2029 the count of stalled cpu cycles in the backend of the instruction
2030 processor pipeline by application running on the platform. It
2031 corresponds to the "perf.stalled_cycles_backend" field in the *Stats
2032 APIs.
2033 Sys::Virt::Domain::PERF_PARAM_REF_CPU_CYCLES The ref_cpu_cycles perf
2034 event counter which can be used to measure the count of total cpu
2035 cycles not affected by CPU frequency scaling by applications running on
2036 the platform. It corresponds to the "perf.ref_cpu_cycles" field in the
2037 *Stats APIs.
2038 Sys::Virt::Domain::PERF_PARAM_CPU_CLOCK The cpu_clock perf event
2039 counter which can be used to measure the count of cpu clock time by
2040 applications running on the platform. It corresponds to the
2041 "perf.cpu_clock" field in the *Stats APIs.
2042 Sys::Virt::Domain::PERF_PARAM_TASK_CLOCK The task_clock perf event
2043 counter which can be used to measure the count of task clock time by
2044 applications running on the platform. It corresponds to the
2045 "perf.task_clock" field in the *Stats APIs.
2046 Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS The page_faults perf event
2047 counter which can be used to measure the count of page faults by
2048 applications running on the platform. It corresponds to the
2049 "perf.page_faults" field in the *Stats APIs.
2050 Sys::Virt::Domain::PERF_PARAM_CONTEXT_SWITCHES The context_switches
2051 perf event counter which can be used to measure the count of context
2052 switches by applications running on the platform. It corresponds to the
2053 "perf.context_switches" field in the *Stats APIs.
2054 Sys::Virt::Domain::PERF_PARAM_CPU_MIGRATIONS The cpu_migrations perf
2055 event counter which can be used to measure the count of cpu migrations
2056 by applications running on the platform. It corresponds to the
2057 "perf.cpu_migrations" field in the *Stats APIs.
2058 Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MIN The page_faults_min perf
2059 event counter which can be used to measure the count of minor page
2060 faults by applications running on the platform. It corresponds to the
2061 "perf.page_faults_min" field in the *Stats APIs.
2062 Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MAJ The page_faults_maj perf
2063 event counter which can be used to measure the count of major page
2064 faults by applications running on the platform. It corresponds to the
2065 "perf.page_faults_maj" field in the *Stats APIs.
2066 Sys::Virt::Domain::PERF_PARAM_ALIGNMENT_FAULTS The alignment_faults
2067 perf event counter which can be used to measure the count of alignment
2068 faults by applications running on the platform. It corresponds to the
2069 "perf.alignment_faults" field in the *Stats APIs.
2070 Sys::Virt::Domain::PERF_PARAM_EMULATION_FAULTS The emulation_faults
2071 perf event counter which can be used to measure the count of emulation
2072 faults by applications running on the platform. It corresponds to the
2073 "perf.emulation_faults" field in the *Stats APIs.
2074 IOTHREAD STATS
2076 The following constants defined IOThread statistics which can be
2077 monitored for a guest
2078 Sys::Virt::Domain::IOTHREAD_PARAM_POLL_MAX_NS
2080 The maximum polling time that can be used by polling algorithm in
2081 ns. The polling time starts at 0 (zero) and is the time spent by
2082 the guest to process IOThread data before returning the CPU to the
2083 host. The polling time will be dynamically modified over time based
2084 on the poll_grow and poll_shrink parameters provided.
2085 Sys::Virt::Domain::IOTHREAD_PARAM_POLL_GROW
2087 This provides a value for the dynamic polling adjustment algorithm
2088 to use to grow its polling interval up to the poll_max_ns value.
2089 Sys::Virt::Domain::IOTHREAD_PARAM_POLL_SHRINK
2091 This provides a value for the dynamic polling adjustment algorithm
2092 to use to shrink its polling interval when the polling interval
2093 exceeds the poll_max_ns value.
2094 VCPU FLAGS
2096 The following constants are useful when getting/setting the VCPU count
2097 for a guest
2098 Sys::Virt::Domain::VCPU_LIVE
2100 Flag to request the live value
2101 Sys::Virt::Domain::VCPU_CONFIG
2103 Flag to request the persistent config value
2104 Sys::Virt::Domain::VCPU_CURRENT
2106 Flag to request the current config value
2107 Sys::Virt::Domain::VCPU_MAXIMUM
2109 Flag to request adjustment of the maximum vCPU value
2110 Sys::Virt::Domain::VCPU_GUEST
2112 Flag to request the guest VCPU mask
2113 Sys::Virt::Domain::VCPU_HOTPLUGGABLE
2115 Flag to make vcpus added hot(un)pluggable
2116 STATE CHANGE EVENTS
2118 The following constants allow domain state change events to be
2119 interpreted. The events contain both a state change, and a reason.
2120 Sys::Virt::Domain::EVENT_DEFINED
2122 Indicates that a persistent configuration has been defined for the
2123 domain.
2124 Sys::Virt::Domain::EVENT_DEFINED_ADDED
2126 The defined configuration is newly added
2127 Sys::Virt::Domain::EVENT_DEFINED_UPDATED
2129 The defined configuration is an update to an existing
2130 configuration
2131 Sys::Virt::Domain::EVENT_DEFINED_RENAMED
2133 The defined configuration is a rename of an existing
2134 configuration
2135 Sys::Virt::Domain::EVENT_DEFINED_FROM_SNAPSHOT
2137 The defined configuration was restored from a snapshot
2138 Sys::Virt::Domain::EVENT_RESUMED
2140 The domain has resumed execution
2141 Sys::Virt::Domain::EVENT_RESUMED_MIGRATED
2143 The domain resumed because migration has completed. This is
2144 emitted on the destination host.
2145 Sys::Virt::Domain::EVENT_RESUMED_UNPAUSED
2147 The domain resumed because the admin unpaused it.
2148 Sys::Virt::Domain::EVENT_RESUMED_FROM_SNAPSHOT
2150 The domain resumed because it was restored from a snapshot
2151 Sys::Virt::Domain::EVENT_RESUMED_POSTCOPY
2153 The domain resumed but post-copy is running in background
2154 Sys::Virt::Domain::EVENT_STARTED
2156 The domain has started running
2157 Sys::Virt::Domain::EVENT_STARTED_BOOTED
2159 The domain was booted from shutoff state
2160 Sys::Virt::Domain::EVENT_STARTED_MIGRATED
2162 The domain started due to an incoming migration
2163 Sys::Virt::Domain::EVENT_STARTED_RESTORED
2165 The domain was restored from saved state file
2166 Sys::Virt::Domain::EVENT_STARTED_FROM_SNAPSHOT
2168 The domain was restored from a snapshot
2169 Sys::Virt::Domain::EVENT_STARTED_WAKEUP
2171 The domain was woken up from suspend
2172 Sys::Virt::Domain::EVENT_STOPPED
2174 The domain has stopped running
2175 Sys::Virt::Domain::EVENT_STOPPED_CRASHED
2177 The domain stopped because guest operating system has crashed
2178 Sys::Virt::Domain::EVENT_STOPPED_DESTROYED
2180 The domain stopped because administrator issued a destroy
2181 command.
2182 Sys::Virt::Domain::EVENT_STOPPED_FAILED
2184 The domain stopped because of a fault in the host
2185 virtualization environment.
2186 Sys::Virt::Domain::EVENT_STOPPED_MIGRATED
2188 The domain stopped because it was migrated to another machine.
2189 Sys::Virt::Domain::EVENT_STOPPED_SAVED
2191 The domain was saved to a state file
2192 Sys::Virt::Domain::EVENT_STOPPED_SHUTDOWN
2194 The domain stopped due to graceful shutdown of the guest.
2195 Sys::Virt::Domain::EVENT_STOPPED_FROM_SNAPSHOT
2197 The domain was stopped due to a snapshot
2198 Sys::Virt::Domain::EVENT_SHUTDOWN
2200 The domain has shutdown but is not yet stopped
2201 Sys::Virt::Domain::EVENT_SHUTDOWN_FINISHED
2203 The domain finished shutting down
2204 Sys::Virt::Domain::EVENT_SHUTDOWN_HOST
2206 The domain shutdown due to host trigger
2207 Sys::Virt::Domain::EVENT_SHUTDOWN_GUEST
2209 The domain shutdown due to guest trigger
2210 Sys::Virt::Domain::EVENT_SUSPENDED
2212 The domain has stopped executing, but still exists
2213 Sys::Virt::Domain::EVENT_SUSPENDED_MIGRATED
2215 The domain has been suspended due to offline migration
2216 Sys::Virt::Domain::EVENT_SUSPENDED_PAUSED
2218 The domain has been suspended due to administrator pause
2219 request.
2220 Sys::Virt::Domain::EVENT_SUSPENDED_IOERROR
2222 The domain has been suspended due to a block device I/O error.
2223 Sys::Virt::Domain::EVENT_SUSPENDED_FROM_SNAPSHOT
2225 The domain has been suspended due to resume from snapshot
2226 Sys::Virt::Domain::EVENT_SUSPENDED_WATCHDOG
2228 The domain has been suspended due to the watchdog triggering
2229 Sys::Virt::Domain::EVENT_SUSPENDED_RESTORED
2231 The domain has been suspended due to restore from saved state
2232 Sys::Virt::Domain::EVENT_SUSPENDED_API_ERROR
2234 The domain has been suspended due to an API error
2235 Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY
2237 The domain has been suspended for post-copy migration
2238 Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY_FAILED
2240 The domain has been suspended due post-copy migration failing
2241 Sys::Virt::Domain::EVENT_UNDEFINED
2243 The persistent configuration has gone away
2244 Sys::Virt::Domain::EVENT_UNDEFINED_REMOVED
2246 The domain configuration has gone away due to it being removed
2247 by administrator.
2248 Sys::Virt::Domain::EVENT_UNDEFINED_RENAMED
2250 The undefined configuration is a rename of an existing
2251 configuration
2252 Sys::Virt::Domain::EVENT_PMSUSPENDED
2254 The domain has stopped running
2255 Sys::Virt::Domain::EVENT_PMSUSPENDED_MEMORY
2257 The domain has suspend to RAM.
2258 Sys::Virt::Domain::EVENT_PMSUSPENDED_DISK
2260 The domain has suspend to Disk.
2261 Sys::Virt::Domain::EVENT_CRASHED
2263 The domain has crashed
2264 Sys::Virt::Domain::EVENT_CRASHED_PANICKED
2266 The domain has crashed due to a kernel panic
2267 EVENT ID CONSTANTS
2269 Sys::Virt::Domain::EVENT_ID_LIFECYCLE
2270 Domain lifecycle events
2271 Sys::Virt::Domain::EVENT_ID_REBOOT
2273 Soft / warm reboot events
2274 Sys::Virt::Domain::EVENT_ID_RTC_CHANGE
2276 RTC clock adjustments
2277 Sys::Virt::Domain::EVENT_ID_IO_ERROR
2279 File IO errors, typically from disks
2280 Sys::Virt::Domain::EVENT_ID_WATCHDOG
2282 Watchdog device triggering
2283 Sys::Virt::Domain::EVENT_ID_GRAPHICS
2285 Graphics client connections.
2286 Sys::Virt::Domain::EVENT_ID_IO_ERROR_REASON
2288 File IO errors, typically from disks, with a root cause
2289 Sys::Virt::Domain::EVENT_ID_CONTROL_ERROR
2291 Errors from the virtualization control channel
2292 Sys::Virt::Domain::EVENT_ID_BLOCK_JOB
2294 Completion status of asynchronous block jobs, identified by source
2295 file name.
2296 Sys::Virt::Domain::EVENT_ID_BLOCK_JOB_2
2298 Completion status of asynchronous block jobs, identified by target
2299 device name.
2300 Sys::Virt::Domain::EVENT_ID_DISK_CHANGE
2302 Changes in disk media
2303 Sys::Virt::Domain::EVENT_ID_TRAY_CHANGE
2305 CDROM media tray state
2306 Sys::Virt::Domain::EVENT_ID_PMSUSPEND
2308 Power management initiated suspend to RAM
2309 Sys::Virt::Domain::EVENT_ID_PMSUSPEND_DISK
2311 Power management initiated suspend to Disk
2312 Sys::Virt::Domain::EVENT_ID_PMWAKEUP
2314 Power management initiated wakeup
2315 Sys::Virt::Domain::EVENT_ID_BALLOON_CHANGE
2317 Balloon target changes
2318 Sys::Virt::Domain::EVENT_ID_DEVICE_ADDED
2320 Asynchronous guest device addition
2321 Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVED
2323 Asynchronous guest device removal
2324 Sys::Virt::Domain::EVENT_ID_TUNABLE
2326 Changes of any domain tuning parameters. The callback will be
2327 provided with a hash listing all changed parameters. The later
2328 DOMAIN TUNABLE constants can be useful when accessing the hash keys
2329 Sys::Virt::Domain::EVENT_ID_AGENT_LIFECYCLE
2331 Domain guest agent lifecycle events. The "state" parameter to the
2332 callback will match one of the constants
2333 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_CONNECTED
2335 The agent is now connected
2336 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED
2338 The agent is now disconnected
2339 The second parameter, "reason", matches one of the following
2341 constants
2342 Sys::Virt::Domain::EVENT_ID_MIGRATION_ITERATION
2344 Domain migration progress iteration. The "iteration" parameter to
2345 the callback will specify the number of iterations migration has
2346 made over guest RAM.
2347 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN
2349 The reason is unknown
2350 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED
2352 The domain was initially booted
2353 Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_CHANNEL
2355 The channel on a running guest changed state
2356 Sys::Virt::Domain::EVENT_ID_JOB_COMPLETED
2358 Domain background job completion notification. The callback
2359 provides a hash containing the job stats. The keyus in the hash are
2360 the same as those used with the
2361 "Sys::Virt::Domain::get_job_stats()" method.
2362 Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVAL_FAILED
2364 Guest device removal has failed.
2365 Sys::Virt::Domain::EVENT_ID_METADATA_CHANGE
2367 The domain metadata has changed
2368 Sys::Virt::Domain::EVENT_ID_BLOCK_THRESHOLD
2370 The event occurs when the hypervisor detects that the given storage
2371 element was written beyond the point specified by threshold. The
2372 event is useful for thin-provisioned storage.
2373 IO ERROR EVENT CONSTANTS
2375 These constants describe what action was taken due to the IO error.
2376 Sys::Virt::Domain::EVENT_IO_ERROR_NONE
2378 No action was taken, the error was ignored & reported as success to
2379 guest
2380 Sys::Virt::Domain::EVENT_IO_ERROR_PAUSE
2382 The guest is paused since the error occurred
2383 Sys::Virt::Domain::EVENT_IO_ERROR_REPORT
2385 The error has been reported to the guest OS
2386 WATCHDOG EVENT CONSTANTS
2388 These constants describe what action was taken due to the watchdog
2389 firing
2390 Sys::Virt::Domain::EVENT_WATCHDOG_NONE
2392 No action was taken, the watchdog was ignored
2393 Sys::Virt::Domain::EVENT_WATCHDOG_PAUSE
2395 The guest is paused since the watchdog fired
2396 Sys::Virt::Domain::EVENT_WATCHDOG_POWEROFF
2398 The guest is powered off after the watchdog fired
2399 Sys::Virt::Domain::EVENT_WATCHDOG_RESET
2401 The guest is reset after the watchdog fired
2402 Sys::Virt::Domain::EVENT_WATCHDOG_SHUTDOWN
2404 The guest attempted to gracefully shutdown after the watchdog fired
2405 Sys::Virt::Domain::EVENT_WATCHDOG_DEBUG
2407 No action was taken, the watchdog was logged
2408 Sys::Virt::Domain::EVENT_WATCHDOG_INJECTNMI
2410 An NMI was injected into the guest after the watchdog fired
2411 GRAPHICS EVENT PHASE CONSTANTS
2413 These constants describe the phase of the graphics connection
2414 Sys::Virt::Domain::EVENT_GRAPHICS_CONNECT
2416 The initial client connection
2417 Sys::Virt::Domain::EVENT_GRAPHICS_INITIALIZE
2419 The client has been authenticated & the connection is running
2420 Sys::Virt::Domain::EVENT_GRAPHICS_DISCONNECT
2422 The client has disconnected
2423 GRAPHICS EVENT ADDRESS CONSTANTS
2425 These constants describe the format of the address
2426 Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV4
2428 An IPv4 address
2429 Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV6
2431 An IPv6 address
2432 Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_UNIX
2434 An UNIX socket path address
2435 DISK CHANGE EVENT CONSTANTS
2437 These constants describe the reason for a disk change event
2438 Sys::Virt::Domain::EVENT_DISK_CHANGE_MISSING_ON_START
2440 The disk media was cleared, as its source was missing when
2441 attempting to start the guest
2442 Sys::Virt::Domain::EVENT_DISK_DROP_MISSING_ON_START
2444 The disk device was dropped, as its source was missing when
2445 attempting to start the guest
2446 TRAY CHANGE CONSTANTS
2448 These constants describe the reason for a tray change event
2449 Sys::Virt::Domain::EVENT_TRAY_CHANGE_CLOSE
2451 The tray was closed
2452 Sys::Virt::Domain::EVENT_TRAY_CHANGE_OPEN
2454 The tray was opened
2455 DOMAIN BLOCK JOB TYPE CONSTANTS
2457 The following constants identify the different types of domain block
2458 jobs
2459 Sys::Virt::Domain::BLOCK_JOB_TYPE_UNKNOWN
2461 An unknown block job type
2462 Sys::Virt::Domain::BLOCK_JOB_TYPE_PULL
2464 The block pull job type
2465 Sys::Virt::Domain::BLOCK_JOB_TYPE_COPY
2467 The block copy job type
2468 Sys::Virt::Domain::BLOCK_JOB_TYPE_COMMIT
2470 The block commit job type
2471 Sys::Virt::Domain::BLOCK_JOB_TYPE_ACTIVE_COMMIT
2473 The block active commit job type
2474 DOMAIN BLOCK JOB COMPLETION CONSTANTS
2476 The following constants can be used to determine the completion status
2477 of a block job
2478 Sys::Virt::Domain::BLOCK_JOB_COMPLETED
2480 A successfully completed block job
2481 Sys::Virt::Domain::BLOCK_JOB_FAILED
2483 An unsuccessful block job
2484 Sys::Virt::Domain::BLOCK_JOB_CANCELED
2486 A block job canceled byy the user
2487 Sys::Virt::Domain::BLOCK_JOB_READY
2489 A block job is running
2490 DOMAIN BLOCK REBASE CONSTANTS
2492 The following constants are useful when rebasing block devices
2493 Sys::Virt::Domain::BLOCK_REBASE_SHALLOW
2495 Limit copy to top of source backing chain
2496 Sys::Virt::Domain::BLOCK_REBASE_REUSE_EXT
2498 Reuse existing external file for copy
2499 Sys::Virt::Domain::BLOCK_REBASE_COPY_RAW
2501 Make destination file raw
2502 Sys::Virt::Domain::BLOCK_REBASE_COPY
2504 Start a copy job
2505 Sys::Virt::Domain::BLOCK_REBASE_COPY_DEV
2507 Treat destination as a block device instead of file
2508 Sys::Virt::Domain::BLOCK_REBASE_RELATIVE
2510 Keep backing chain referenced using relative names
2511 DOMAIN BLOCK COPY CONSTANTS
2513 The following constants are useful when copying block devices
2514 Sys::Virt::Domain::BLOCK_COPY_SHALLOW
2516 Limit copy to top of source backing chain
2517 Sys::Virt::Domain::BLOCK_COPY_REUSE_EXT
2519 Reuse existing external file for copy
2520 Sys::Virt::Domain::BLOCK_COPY_TRANSIENT_JOB
2522 Don't force usage of recoverable job for the copy operation
2523 DOMAIN BLOCK JOB ABORT CONSTANTS
2525 The following constants are useful when aborting job copy jobs
2526 Sys::Virt::Domain::BLOCK_JOB_ABORT_ASYNC
2528 Request only, do not wait for completion
2529 Sys::Virt::Domain::BLOCK_JOB_ABORT_PIVOT
2531 Pivot to mirror when ending a copy job
2532 DOMAIN BLOCK COMMIT JOB CONSTANTS
2534 The following constants are useful with block commit job types
2535 Sys::Virt::Domain::BLOCK_COMMIT_DELETE
2537 Delete any files that are invalid after commit
2538 Sys::Virt::Domain::BLOCK_COMMIT_SHALLOW
2540 NULL base means next backing file, not whole chain
2541 Sys::Virt::Domain::BLOCK_COMMIT_ACTIVE
2543 Allow two phase commit when top is active layer
2544 Sys::Virt::Domain::BLOCK_COMMIT_RELATIVE
2546 Keep backing chain referenced using relative names
2547 DOMAIN SAVE / RESTORE CONSTANTS
2549 The following constants can be used when saving or restoring virtual
2550 machines
2551 Sys::Virt::Domain::SAVE_BYPASS_CACHE
2553 Do not use OS I/O cache when saving state.
2554 Sys::Virt::Domain::SAVE_PAUSED
2556 Mark the saved state as paused to prevent the guest CPUs starting
2557 upon restore.
2558 Sys::Virt::Domain::SAVE_RUNNING
2560 Mark the saved state as running to allow the guest CPUs to start
2561 upon restore.
2562 DOMAIN CORE DUMP CONSTANTS
2564 The following constants can be used when triggering domain core dumps
2565 Sys::Virt::Domain::DUMP_LIVE
2567 Do not pause execution while dumping the guest
2568 Sys::Virt::Domain::DUMP_CRASH
2570 Crash the guest after completing the core dump
2571 Sys::Virt::Domain::DUMP_BYPASS_CACHE
2573 Do not use OS I/O cache when writing core dump
2574 Sys::Virt::Domain::DUMP_RESET
2576 Reset the virtual machine after finishing the dump
2577 Sys::Virt::Domain::DUMP_MEMORY_ONLY
2579 Only include guest RAM in the dump, not the device state
2580 DESTROY CONSTANTS
2582 The following constants are useful when terminating guests using the
2583 "destroy" API.
2584 Sys::Virt::Domain::DESTROY_DEFAULT
2586 Destroy the guest using the default approach
2587 Sys::Virt::Domain::DESTROY_GRACEFUL
2589 Destroy the guest in a graceful manner
2590 SHUTDOWN CONSTANTS
2592 The following constants are useful when requesting that a guest
2593 terminate using the "shutdown" API
2594 Sys::Virt::Domain::SHUTDOWN_DEFAULT
2596 Shutdown using the hypervisor's default mechanism
2597 Sys::Virt::Domain::SHUTDOWN_GUEST_AGENT
2599 Shutdown by issuing a command to a guest agent
2600 Sys::Virt::Domain::SHUTDOWN_ACPI_POWER_BTN
2602 Shutdown by injecting an ACPI power button press
2603 Sys::Virt::Domain::SHUTDOWN_INITCTL
2605 Shutdown by talking to initctl (containers only)
2606 Sys::Virt::Domain::SHUTDOWN_SIGNAL
2608 Shutdown by sending SIGTERM to the init process
2609 Sys::Virt::Domain::SHUTDOWN_PARAVIRT
2611 Shutdown by issuing a paravirt power control command
2612 REBOOT CONSTANTS
2614 The following constants are useful when requesting that a guest
2615 terminate using the "reboot" API
2616 Sys::Virt::Domain::REBOOT_DEFAULT
2618 Reboot using the hypervisor's default mechanism
2619 Sys::Virt::Domain::REBOOT_GUEST_AGENT
2621 Reboot by issuing a command to a guest agent
2622 Sys::Virt::Domain::REBOOT_ACPI_POWER_BTN
2624 Reboot by injecting an ACPI power button press
2625 Sys::Virt::Domain::REBOOT_INITCTL
2627 Reboot by talking to initctl (containers only)
2628 Sys::Virt::Domain::REBOOT_SIGNAL
2630 Reboot by sending SIGHUP to the init process
2631 Sys::Virt::Domain::REBOOT_PARAVIRT
2633 Reboot by issuing a paravirt power control command
2634 METADATA CONSTANTS
2636 The following constants are useful when reading/writing metadata about
2637 a guest
2638 Sys::Virt::Domain::METADATA_TITLE
2640 The short human friendly title of the guest
2641 Sys::Virt::Domain::METADATA_DESCRIPTION
2643 The long free text description of the guest
2644 Sys::Virt::Domain::METADATA_ELEMENT
2646 The structured metadata elements for the guest
2647 DISK ERROR CONSTANTS
2649 The following constants are useful when interpreting disk error codes
2650 Sys::Virt::Domain::DISK_ERROR_NONE
2652 No error
2653 Sys::Virt::Domain::DISK_ERROR_NO_SPACE
2655 The host storage has run out of free space
2656 Sys::Virt::Domain::DISK_ERROR_UNSPEC
2658 An unspecified error has occurred.
2659 MEMORY STATISTIC CONSTANTS
2661 Sys::Virt::Domain::MEMORY_STAT_SWAP_IN
2662 Swap in
2663 Sys::Virt::Domain::MEMORY_STAT_SWAP_OUT
2665 Swap out
2666 Sys::Virt::Domain::MEMORY_STAT_MINOR_FAULT
2668 Minor faults
2669 Sys::Virt::Domain::MEMORY_STAT_MAJOR_FAULT
2671 Major faults
2672 Sys::Virt::Domain::MEMORY_STAT_RSS
2674 Resident memory
2675 Sys::Virt::Domain::MEMORY_STAT_UNUSED
2677 Unused memory
2678 Sys::Virt::Domain::MEMORY_STAT_AVAILABLE
2680 Available memory
2681 Sys::Virt::Domain::MEMORY_STAT_ACTUAL_BALLOON
2683 Actual balloon limit
2684 Sys::Virt::Domain::MEMORY_STAT_USABLE
2686 Amount of usable memory
2687 Sys::Virt::Domain::MEMORY_STAT_LAST_UPDATE
2689 Time of last stats refresh from guest
2690 Sys::Virt::Domain::MEMORY_STAT_DISK_CACHES
2692 Disk cache size
2693 Sys::Virt::Domain::MEMORY_STAT_HUGETLB_PGALLOC
2695 The amount of successful huge page allocations
2696 Sys::Virt::Domain::MEMORY_STAT_HUGETLB_PGFAIL
2698 The amount of failed huge page allocations
2699 DOMAIN LIST CONSTANTS
2701 The following constants can be used when listing domains
2702 Sys::Virt::Domain::LIST_ACTIVE
2704 Only list domains that are currently active (running, or paused)
2705 Sys::Virt::Domain::LIST_AUTOSTART
2707 Only list domains that are set to automatically start on boot
2708 Sys::Virt::Domain::LIST_HAS_SNAPSHOT
2710 Only list domains that have a stored snapshot
2711 Sys::Virt::Domain::LIST_INACTIVE
2713 Only list domains that are currently inactive (shutoff, saved)
2714 Sys::Virt::Domain::LIST_MANAGEDSAVE
2716 Only list domains that have current managed save state
2717 Sys::Virt::Domain::LIST_NO_AUTOSTART
2719 Only list domains that are not set to automatically start on boto
2720 Sys::Virt::Domain::LIST_NO_MANAGEDSAVE
2722 Only list domains that do not have any managed save state
2723 Sys::Virt::Domain::LIST_NO_SNAPSHOT
2725 Only list domains that do not have a stored snapshot
2726 Sys::Virt::Domain::LIST_OTHER
2728 Only list domains that are not running, paused or shutoff
2729 Sys::Virt::Domain::LIST_PAUSED
2731 Only list domains that are paused
2732 Sys::Virt::Domain::LIST_PERSISTENT
2734 Only list domains which have a persistent config
2735 Sys::Virt::Domain::LIST_RUNNING
2737 Only list domains that are currently running
2738 Sys::Virt::Domain::LIST_SHUTOFF
2740 Only list domains that are currently shutoff
2741 Sys::Virt::Domain::LIST_TRANSIENT
2743 Only list domains that do not have a persistent config
2744 Sys::Virt::Domain::LIST_HAS_CHECKPOINT
2746 Only list domains that have a stored checkpoint
2747 Sys::Virt::Domain::LIST_NO_CHECKPOINT
2749 Only list domains that do not have a stored checkpoint
2750 SEND KEY CONSTANTS
2752 The following constants are to be used with the "send_key" API
2753 Sys::Virt::Domain::SEND_KEY_MAX_KEYS
2755 The maximum number of keys that can be sent in a single call to
2756 "send_key"
2757 BLOCK STATS CONSTANTS
2759 The following constants provide the names of well known block stats
2760 fields
2761 Sys::Virt::Domain::BLOCK_STATS_ERRS
2763 The number of I/O errors
2764 Sys::Virt::Domain::BLOCK_STATS_FLUSH_REQ
2766 The number of flush requests
2767 Sys::Virt::Domain::BLOCK_STATS_FLUSH_TOTAL_TIMES
2769 The time spent processing flush requests
2770 Sys::Virt::Domain::BLOCK_STATS_READ_BYTES
2772 The amount of data read
2773 Sys::Virt::Domain::BLOCK_STATS_READ_REQ
2775 The number of read requests
2776 Sys::Virt::Domain::BLOCK_STATS_READ_TOTAL_TIMES
2778 The time spent processing read requests
2779 Sys::Virt::Domain::BLOCK_STATS_WRITE_BYTES
2781 The amount of data written
2782 Sys::Virt::Domain::BLOCK_STATS_WRITE_REQ
2784 The number of write requests
2785 Sys::Virt::Domain::BLOCK_STATS_WRITE_TOTAL_TIMES
2787 The time spent processing write requests
2788 CPU STATS CONSTANTS
2790 The following constants provide the names of well known cpu stats
2791 fields
2792 Sys::Virt::Domain::CPU_STATS_CPUTIME
2794 The total CPU time, including both hypervisor and vCPU time.
2795 Sys::Virt::Domain::CPU_STATS_USERTIME
2797 THe total time in kernel
2798 Sys::Virt::Domain::CPU_STATS_SYSTEMTIME
2800 The total time in userspace
2801 Sys::Virt::Domain::CPU_STATS_VCPUTIME
2803 The total vCPU time.
2804 CPU STATS CONSTANTS
2806 The following constants provide the names of well known schedular
2807 parameters
2808 Sys::Virt::SCHEDULER_EMULATOR_PERIOD
2810 The duration of the time period for scheduling the emulator
2811 Sys::Virt::SCHEDULER_EMULATOR_QUOTA
2813 The quota for the emulator in one schedular time period
2814 Sys::Virt::SCHEDULER_IOTHREAD_PERIOD
2816 The duration of the time period for scheduling the iothread
2817 Sys::Virt::SCHEDULER_IOTHREAD_QUOTA
2819 The quota for the iothread in one schedular time period
2820 DOMAIN STATS FLAG CONSTANTS
2822 The following constants are used as flags when requesting bulk domain
2823 stats from "Sys::Virt::get_all_domain_stats".
2824 Sys::Virt::Domain::GET_ALL_STATS_ACTIVE
2826 Include stats for active domains
2827 Sys::Virt::Domain::GET_ALL_STATS_INACTIVE
2829 Include stats for inactive domains
2830 Sys::Virt::Domain::GET_ALL_STATS_OTHER
2832 Include stats for other domains
2833 Sys::Virt::Domain::GET_ALL_STATS_PAUSED
2835 Include stats for paused domains
2836 Sys::Virt::Domain::GET_ALL_STATS_PERSISTENT
2838 Include stats for persistent domains
2839 Sys::Virt::Domain::GET_ALL_STATS_RUNNING
2841 Include stats for running domains
2842 Sys::Virt::Domain::GET_ALL_STATS_SHUTOFF
2844 Include stats for shutoff domains
2845 Sys::Virt::Domain::GET_ALL_STATS_TRANSIENT
2847 Include stats for transient domains
2848 Sys::Virt::Domain::GET_ALL_STATS_ENFORCE_STATS
2850 Require that all requested stats fields are returned
2851 Sys::Virt::Domain::GET_ALL_STATS_BACKING
2853 Get stats for image backing files too
2854 Sys::Virt::Domain::GET_ALL_STATS_NOWAIT
2856 Skip stats if they can't be acquired without waiting
2857 DOMAIN STATS FIELD CONSTANTS
2859 The following constants are used to control which fields are returned
2860 for stats queries.
2861 Sys::Virt::Domain::STATS_BALLOON
2863 Balloon statistics
2864 Sys::Virt::Domain::STATS_BLOCK
2866 Block device info
2867 Sys::Virt::Domain::STATS_CPU_TOTAL
2869 CPU usage info
2870 Sys::Virt::Domain::STATS_INTERFACE
2872 Network interface info
2873 Sys::Virt::Domain::STATS_STATE
2875 General lifecycle state
2876 Sys::Virt::Domain::STATS_VCPU
2878 Virtual CPU info
2879 Sys::Virt::Domain::STATS_PERF
2881 Performance event counter values
2882 Sys::Virt::Domain::STATS_IOTHREAD
2884 IOThread performance statistics values
2885 PROCESS SIGNALS
2887 The following constants provide the names of signals which can be sent
2888 to guest processes. They mostly correspond to POSIX signal names.
2889 Sys::Virt::Domain::PROCESS_SIGNAL_NOP
2891 SIGNOP
2892 Sys::Virt::Domain::PROCESS_SIGNAL_HUP
2894 SIGHUP
2895 Sys::Virt::Domain::PROCESS_SIGNAL_INT
2897 SIGINT
2898 Sys::Virt::Domain::PROCESS_SIGNAL_QUIT
2900 SIGQUIT
2901 Sys::Virt::Domain::PROCESS_SIGNAL_ILL
2903 SIGILL
2904 Sys::Virt::Domain::PROCESS_SIGNAL_TRAP
2906 SIGTRAP
2907 Sys::Virt::Domain::PROCESS_SIGNAL_ABRT
2909 SIGABRT
2910 Sys::Virt::Domain::PROCESS_SIGNAL_BUS
2912 SIGBUS
2913 Sys::Virt::Domain::PROCESS_SIGNAL_FPE
2915 SIGFPE
2916 Sys::Virt::Domain::PROCESS_SIGNAL_KILL
2918 SIGKILL
2919 Sys::Virt::Domain::PROCESS_SIGNAL_USR1
2921 SIGUSR1
2922 Sys::Virt::Domain::PROCESS_SIGNAL_SEGV
2924 SIGSEGV
2925 Sys::Virt::Domain::PROCESS_SIGNAL_USR2
2927 SIGUSR2
2928 Sys::Virt::Domain::PROCESS_SIGNAL_PIPE
2930 SIGPIPE
2931 Sys::Virt::Domain::PROCESS_SIGNAL_ALRM
2933 SIGALRM
2934 Sys::Virt::Domain::PROCESS_SIGNAL_TERM
2936 SIGTERM
2937 Sys::Virt::Domain::PROCESS_SIGNAL_STKFLT
2939 SIGSTKFLT
2940 Sys::Virt::Domain::PROCESS_SIGNAL_CHLD
2942 SIGCHLD
2943 Sys::Virt::Domain::PROCESS_SIGNAL_CONT
2945 SIGCONT
2946 Sys::Virt::Domain::PROCESS_SIGNAL_STOP
2948 SIGSTOP
2949 Sys::Virt::Domain::PROCESS_SIGNAL_TSTP
2951 SIGTSTP
2952 Sys::Virt::Domain::PROCESS_SIGNAL_TTIN
2954 SIGTTIN
2955 Sys::Virt::Domain::PROCESS_SIGNAL_TTOU
2957 SIGTTOU
2958 Sys::Virt::Domain::PROCESS_SIGNAL_URG
2960 SIGURG
2961 Sys::Virt::Domain::PROCESS_SIGNAL_XCPU
2963 SIGXCPU
2964 Sys::Virt::Domain::PROCESS_SIGNAL_XFSZ
2966 SIGXFSZ
2967 Sys::Virt::Domain::PROCESS_SIGNAL_VTALRM
2969 SIGVTALRM
2970 Sys::Virt::Domain::PROCESS_SIGNAL_PROF
2972 SIGPROF
2973 Sys::Virt::Domain::PROCESS_SIGNAL_WINCH
2975 SIGWINCH
2976 Sys::Virt::Domain::PROCESS_SIGNAL_POLL
2978 SIGPOLL
2979 Sys::Virt::Domain::PROCESS_SIGNAL_PWR
2981 SIGPWR
2982 Sys::Virt::Domain::PROCESS_SIGNAL_SYS
2984 SIGSYS
2985 Sys::Virt::Domain::PROCESS_SIGNAL_RT0
2987 SIGRT0
2988 Sys::Virt::Domain::PROCESS_SIGNAL_RT1
2990 SIGRT1
2991 Sys::Virt::Domain::PROCESS_SIGNAL_RT2
2993 SIGRT2
2994 Sys::Virt::Domain::PROCESS_SIGNAL_RT3
2996 SIGRT3
2997 Sys::Virt::Domain::PROCESS_SIGNAL_RT4
2999 SIGRT4
3000 Sys::Virt::Domain::PROCESS_SIGNAL_RT5
3002 SIGRT5
3003 Sys::Virt::Domain::PROCESS_SIGNAL_RT6
3005 SIGRT6
3006 Sys::Virt::Domain::PROCESS_SIGNAL_RT7
3008 SIGRT7
3009 Sys::Virt::Domain::PROCESS_SIGNAL_RT8
3011 SIGRT8
3012 Sys::Virt::Domain::PROCESS_SIGNAL_RT9
3014 SIGRT9
3015 Sys::Virt::Domain::PROCESS_SIGNAL_RT10
3017 SIGRT10
3018 Sys::Virt::Domain::PROCESS_SIGNAL_RT11
3020 SIGRT11
3021 Sys::Virt::Domain::PROCESS_SIGNAL_RT12
3023 SIGRT12
3024 Sys::Virt::Domain::PROCESS_SIGNAL_RT13
3026 SIGRT13
3027 Sys::Virt::Domain::PROCESS_SIGNAL_RT14
3029 SIGRT14
3030 Sys::Virt::Domain::PROCESS_SIGNAL_RT15
3032 SIGRT15
3033 Sys::Virt::Domain::PROCESS_SIGNAL_RT16
3035 SIGRT16
3036 Sys::Virt::Domain::PROCESS_SIGNAL_RT17
3038 SIGRT17
3039 Sys::Virt::Domain::PROCESS_SIGNAL_RT18
3041 SIGRT18
3042 Sys::Virt::Domain::PROCESS_SIGNAL_RT19
3044 SIGRT19
3045 Sys::Virt::Domain::PROCESS_SIGNAL_RT20
3047 SIGRT20
3048 Sys::Virt::Domain::PROCESS_SIGNAL_RT21
3050 SIGRT21
3051 Sys::Virt::Domain::PROCESS_SIGNAL_RT22
3053 SIGRT22
3054 Sys::Virt::Domain::PROCESS_SIGNAL_RT23
3056 SIGRT23
3057 Sys::Virt::Domain::PROCESS_SIGNAL_RT24
3059 SIGRT24
3060 Sys::Virt::Domain::PROCESS_SIGNAL_RT25
3062 SIGRT25
3063 Sys::Virt::Domain::PROCESS_SIGNAL_RT26
3065 SIGRT26
3066 Sys::Virt::Domain::PROCESS_SIGNAL_RT27
3068 SIGRT27
3069 Sys::Virt::Domain::PROCESS_SIGNAL_RT28
3071 SIGRT28
3072 Sys::Virt::Domain::PROCESS_SIGNAL_RT29
3074 SIGRT29
3075 Sys::Virt::Domain::PROCESS_SIGNAL_RT30
3077 SIGRT30
3078 Sys::Virt::Domain::PROCESS_SIGNAL_RT31
3080 SIGRT31
3081 Sys::Virt::Domain::PROCESS_SIGNAL_RT32
3083 SIGRT32
3084 DOMAIN TUNABLE CONSTANTS
3086 The following constants are useful when accessing domain tuning
3087 parameters in APIs and events
3088 Sys::Virt::Domain::TUNABLE_CPU_CPU_SHARES
3090 Proportional CPU weight
3091 Sys::Virt::Domain::TUNABLE_CPU_EMULATORPIN
3093 Emulator thread CPU pinning mask
3094 Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_PERIOD
3096 Emulator thread CPU period
3097 Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_QUOTA
3099 Emulator thread CPU quota
3100 Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_PERIOD
3102 Iothread thread CPU period
3103 Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_QUOTA
3105 Iothread thread CPU quota
3106 Sys::Virt::Domain::TUNABLE_CPU_VCPUPIN
3108 VCPU thread pinning mask
3109 Sys::Virt::Domain::TUNABLE_CPU_VCPU_PERIOD
3111 VCPU thread period
3112 Sys::Virt::Domain::TUNABLE_CPU_VCPU_QUOTA
3114 VCPU thread quota
3115 Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_PERIOD
3117 VM global period
3118 Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_QUOTA
3120 VM global quota
3121 Sys::Virt::Domain::TUNABLE_BLKDEV_DISK
3123 The name of guest disks
3124 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC
3126 Read throughput in bytes per sec
3127 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC
3129 Read throughput in I/O operations per sec
3130 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC
3132 Total throughput in bytes per sec
3133 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC
3135 Total throughput in I/O operations per sec
3136 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC
3138 Write throughput in bytes per sec
3139 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC
3141 Write throughput in I/O operations per sec
3142 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX
3144 Maximum read throughput in bytes per sec
3145 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX
3147 Maximum read throughput in I/O operations per sec
3148 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX
3150 Maximum total throughput in bytes per sec
3151 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX
3153 Maximum total throughput in I/O operations per sec
3154 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX
3156 Maximum write throughput in bytes per sec
3157 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX
3159 Maximum write throughput in I/O operations per sec
3160 Sys::Virt::Domain::TUNABLE_BLKDEV_SIZE_IOPS_SEC
3162 The maximum I/O operations per second
3163 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH
3165 The duration in seconds allowed for maximum total bytes processed
3166 per second.
3167 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH
3169 The duration in seconds allowed for maximum bytes read per second.
3170 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH
3172 The duration in seconds allowed for maximum bytes written per
3173 second.
3174 Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH
3176 The duration in seconds allowed for maximum total I/O operations
3177 processed per second.
3178 Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH
3180 The duration in seconds allowed for maximum I/O operations read per
3181 second.
3182 Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH
3184 The duration in seconds allowed for maximum I/O operations written
3185 per second.
3186 Sys::Virt::Domain::TUNABLE_BLKDEV_GROUP_NAME
3188 The name of the blkdev group
3189 Sys::Virt::Domain::TUNABLE_IOTHREADSPIN
3191 The I/O threads pinning
3192 DOMAIN LIFECYCLE CONSTANTS
3194 The following constants are useful when setting action for lifecycle
3195 events.
3196 Sys::Virt::Domain::LIFECYCLE_POWEROFF
3198 The poweroff lifecycle event type
3199 Sys::Virt::Domain::LIFECYCLE_REBOOT
3201 The reboot lifecycle event type
3202 Sys::Virt::Domain::LIFECYCLE_CRASH
3204 The crash lifecycle event type
3205 DOMAIN LIFECYCLE ACTION CONSTANTS
3207 Sys::Virt::Domain::LIFECYCLE_ACTION_DESTROY
3208 The destroy lifecycle action
3209 Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART
3211 The restart lifecycle action
3212 Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART_RENAME
3214 The restart-rename lifecycle action
3215 Sys::Virt::Domain::LIFECYCLE_ACTION_PRESERVE
3217 The preserve lifecycle action
3218 Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_DESTROY
3220 The coredump-destroy lifecycle action
3221 Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_RESTART
3223 The coredump-restart lifecycle action
3224
3226 Daniel P. Berrange <berrange@redhat.com>
3227
3229 Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
3230
3232 This program is free software; you can redistribute it and/or modify it
3233 under the terms of either the GNU General Public License as published
3234 by the Free Software Foundation (either version 2 of the License, or at
3235 your option any later version), or, the Artistic License, as specified
3236 in the Perl README file.
3237
3239 Sys::Virt, Sys::Virt::Error, "http://libvirt.org"
3240perl v5.30.0 2019-08-06 Sys::Virt::Domain(3)