.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sys::Virt::Domain 3pm"
.TH Sys::Virt::Domain 3pm "2021-01-30" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sys::Virt::Domain \- Represent & manage a libvirt guest domain
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::Domain\*(C'\fR module represents a guest domain managed
by the virtual machine monitor.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "my $id = $dom\->\fBget_id()\fR" 4
.el .IP "my \f(CW$id\fR = \f(CW$dom\fR\->\fBget_id()\fR" 4
.IX Item "my $id = $dom->get_id()"
Returns an integer with a locally unique identifier for the
domain.
.ie n .IP "my $uuid = $dom\->\fBget_uuid()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$dom\fR\->\fBget_uuid()\fR" 4
.IX Item "my $uuid = $dom->get_uuid()"
Returns a 16 byte long string containing the raw globally unique identifier
(\s-1UUID\s0) for the domain.
.ie n .IP "my $uuid = $dom\->\fBget_uuid_string()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$dom\fR\->\fBget_uuid_string()\fR" 4
.IX Item "my $uuid = $dom->get_uuid_string()"
Returns a printable string representation of the raw \s-1UUID,\s0 in the format
\&'\s-1XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX\s0'.
.ie n .IP "my $name = $dom\->\fBget_name()\fR" 4
.el .IP "my \f(CW$name\fR = \f(CW$dom\fR\->\fBget_name()\fR" 4
.IX Item "my $name = $dom->get_name()"
Returns a string with a locally unique name of the domain
.ie n .IP "my $hostname = $dom\->get_hostname($flags=0)" 4
.el .IP "my \f(CW$hostname\fR = \f(CW$dom\fR\->get_hostname($flags=0)" 4
.IX Item "my $hostname = $dom->get_hostname($flags=0)"
Returns a string representing the hostname of the guest.  \f(CW$flags\fR
can be zero or more of
.RS 4
.IP "Sys::Virt::Domain::GET_HOSTNAME_AGENT" 4
.IX Item "Sys::Virt::Domain::GET_HOSTNAME_AGENT"
Report the guest agent hostname
.IP "Sys::Virt::Domain::GET_HOSTNAME_LEASE" 4
.IX Item "Sys::Virt::Domain::GET_HOSTNAME_LEASE"
Report the \s-1DHCP\s0 lease hostname
.RE
.RS 4
.RE
.ie n .IP "my $str = $dom\->get_metadata($type, $uri, $flags =0)" 4
.el .IP "my \f(CW$str\fR = \f(CW$dom\fR\->get_metadata($type, \f(CW$uri\fR, \f(CW$flags\fR =0)" 4
.IX Item "my $str = $dom->get_metadata($type, $uri, $flags =0)"
Returns the metadata element of type \f(CW$type\fR associated
with the domain. If \f(CW$type\fR is \f(CW\*(C`Sys::Virt::Domain::METADATA_ELEMENT\*(C'\fR
then the \f(CW$uri\fR parameter specifies the \s-1XML\s0 namespace to
retrieve, otherwise \f(CW$uri\fR should be \f(CW\*(C`undef\*(C'\fR. The optional
\&\f(CW$flags\fR parameter defaults to zero.
.ie n .IP "$dom\->set_metadata($type, $val, $key, $uri, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_metadata($type, \f(CW$val\fR, \f(CW$key\fR, \f(CW$uri\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_metadata($type, $val, $key, $uri, $flags=0)"
Sets the metadata element of type \f(CW$type\fR to hold the value
\&\f(CW$val\fR. If \f(CW$type\fR is  \f(CW\*(C`Sys::Virt::Domain::METADATA_ELEMENT\*(C'\fR
then the \f(CW$key\fR and \f(CW$uri\fR elements specify an \s-1XML\s0 namespace
to use, otherwise they should both be \f(CW\*(C`undef\*(C'\fR. The optional
\&\f(CW$flags\fR parameter defaults to zero.
.ie n .IP "$dom\->\fBis_active()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBis_active()\fR" 4
.IX Item "$dom->is_active()"
Returns a true value if the domain is currently running
.ie n .IP "$dom\->\fBis_persistent()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBis_persistent()\fR" 4
.IX Item "$dom->is_persistent()"
Returns a true value if the domain has a persistent configuration
file defined
.ie n .IP "$dom\->\fBis_updated()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBis_updated()\fR" 4
.IX Item "$dom->is_updated()"
Returns a true value if the domain is running and has a persistent
configuration file defined that is out of date compared to the
current live config.
.ie n .IP "my $xml = $dom\->get_xml_description($flags=0)" 4
.el .IP "my \f(CW$xml\fR = \f(CW$dom\fR\->get_xml_description($flags=0)" 4
.IX Item "my $xml = $dom->get_xml_description($flags=0)"
Returns an \s-1XML\s0 document containing a complete description of
the domain's configuration. The optional \f(CW$flags\fR parameter
controls generation of the \s-1XML\s0 document, defaulting to 0 if
omitted. It can be one or more of the \s-1XML DUMP\s0 constants
listed later in this document.
.ie n .IP "my $type = $dom\->\fBget_os_type()\fR" 4
.el .IP "my \f(CW$type\fR = \f(CW$dom\fR\->\fBget_os_type()\fR" 4
.IX Item "my $type = $dom->get_os_type()"
Returns a string containing the name of the \s-1OS\s0 type running
within the domain.
.ie n .IP "$dom\->create($flags)" 4
.el .IP "\f(CW$dom\fR\->create($flags)" 4
.IX Item "$dom->create($flags)"
Start a domain whose configuration was previously defined using the
\&\f(CW\*(C`define_domain\*(C'\fR method in Sys::Virt. The \f(CW$flags\fR parameter
accepts one of the \s-1DOMAIN CREATION\s0 constants documented later, and
defaults to 0 if omitted.
.ie n .IP "$dom\->create_with_files($fds, $flags)" 4
.el .IP "\f(CW$dom\fR\->create_with_files($fds, \f(CW$flags\fR)" 4
.IX Item "$dom->create_with_files($fds, $flags)"
Start a domain whose configuration was previously defined using the
\&\f(CW\*(C`define_domain\*(C'\fR method in Sys::Virt. The \f(CW$fds\fR parameter is an
array of \s-1UNIX\s0 file descriptors which will be passed to the init
process of the container. This is only supported with container based
virtualization.The \f(CW$flags\fR parameter accepts one of the \s-1DOMAIN
CREATION\s0 constants documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->\fBundefine()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBundefine()\fR" 4
.IX Item "$dom->undefine()"
Remove the configuration associated with a domain previously defined
with the \f(CW\*(C`define_domain\*(C'\fR method in Sys::Virt. If the domain is
running, you probably want to use the \f(CW\*(C`shutdown\*(C'\fR or \f(CW\*(C`destroy\*(C'\fR
methods instead.
.ie n .IP "$dom\->\fBsuspend()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBsuspend()\fR" 4
.IX Item "$dom->suspend()"
Temporarily stop execution of the domain, allowing later continuation
by calling the \f(CW\*(C`resume\*(C'\fR method.
.ie n .IP "$dom\->\fBresume()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBresume()\fR" 4
.IX Item "$dom->resume()"
Resume execution of a domain previously halted with the \f(CW\*(C`suspend\*(C'\fR
method.
.ie n .IP "$dom\->\fBpm_wakeup()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBpm_wakeup()\fR" 4
.IX Item "$dom->pm_wakeup()"
Wakeup the guest from power management suspend state
.ie n .IP "$dom\->pm_suspend_for_duration($target, $duration, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->pm_suspend_for_duration($target, \f(CW$duration\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->pm_suspend_for_duration($target, $duration, $flags=0)"
Tells the guest \s-1OS\s0 to enter the power management suspend state
identified by \f(CW$target\fR. The \f(CW$target\fR parameter should be
one of the \s-1NODE SUSPEND CONTANTS\s0 listed in \f(CW\*(C`Sys::Virt\*(C'\fR. The
\&\f(CW$duration\fR specifies when the guest should automatically
wakeup. The \f(CW$flags\fR parameter is optional and defaults to
zero.
.ie n .IP "$dom\->save($filename)" 4
.el .IP "\f(CW$dom\fR\->save($filename)" 4
.IX Item "$dom->save($filename)"
Take a snapshot of the domain's state and save the information to
the file named in the \f(CW$filename\fR parameter. The domain can later
be restored from this file with the \f(CW\*(C`restore_domain\*(C'\fR method on
the Sys::Virt object.
.ie n .IP "$dom\->managed_save($flags=0)" 4
.el .IP "\f(CW$dom\fR\->managed_save($flags=0)" 4
.IX Item "$dom->managed_save($flags=0)"
Take a snapshot of the domain's state and save the information to
a managed save location. The domain will be automatically restored
with this state when it is next started. The \f(CW$flags\fR parameter is
unused and defaults to zero.
.ie n .IP "$bool = $dom\->has_managed_save_image($flags=0)" 4
.el .IP "\f(CW$bool\fR = \f(CW$dom\fR\->has_managed_save_image($flags=0)" 4
.IX Item "$bool = $dom->has_managed_save_image($flags=0)"
Return a non-zero value if the domain has a managed save image
that will be used at next start. The \f(CW$flags\fR parameter is
unused and defaults to zero.
.ie n .IP "$dom\->managed_save_remove($flags=0)" 4
.el .IP "\f(CW$dom\fR\->managed_save_remove($flags=0)" 4
.IX Item "$dom->managed_save_remove($flags=0)"
Remove the current managed save image, causing the guest to perform
a full boot next time it is started. The \f(CW$flags\fR parameter is
unused and defaults to zero.
.ie n .IP "$dom\->managed_save_define_xml($xml, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->managed_save_define_xml($xml, \f(CW$flags\fR=0)" 4
.IX Item "$dom->managed_save_define_xml($xml, $flags=0)"
Update the \s-1XML\s0 of the managed save image to \f(CW$xml\fR. The \f(CW$flags\fR
parameter is unused and defaults to zero.
.ie n .IP "$xml = $dom\->managed_save_get_xml_description($flags=0)" 4
.el .IP "\f(CW$xml\fR = \f(CW$dom\fR\->managed_save_get_xml_description($flags=0)" 4
.IX Item "$xml = $dom->managed_save_get_xml_description($flags=0)"
Get the \s-1XML\s0 in the managed save image. The \f(CW$flags\fR
parameter accepts the following constants
.RS 4
.IP "Sys::Virt::Domain::SAVE_IMAGE_XML_SECURE" 4
.IX Item "Sys::Virt::Domain::SAVE_IMAGE_XML_SECURE"
Include security sensitive information in the \s-1XML\s0 dump, such as
passwords.
.RE
.RS 4
.RE
.ie n .IP "$dom\->core_dump($filename[, $flags])" 4
.el .IP "\f(CW$dom\fR\->core_dump($filename[, \f(CW$flags\fR])" 4
.IX Item "$dom->core_dump($filename[, $flags])"
Trigger a core dump of the guest virtual machine, saving its memory
image to \f(CW$filename\fR so it can be analysed by tools such as \f(CW\*(C`crash\*(C'\fR.
The optional \f(CW$flags\fR flags parameter is currently unused and if
omitted will default to 0.
.ie n .IP "$dom\->core_dump_format($filename, $format, [, $flags])" 4
.el .IP "\f(CW$dom\fR\->core_dump_format($filename, \f(CW$format\fR, [, \f(CW$flags\fR])" 4
.IX Item "$dom->core_dump_format($filename, $format, [, $flags])"
Trigger a core dump of the guest virtual machine, saving its memory
image to \f(CW$filename\fR so it can be analysed by tools such as \f(CW\*(C`crash\*(C'\fR.
The \f(CW$format\fR parameter is one of the core dump format constants.
The optional \f(CW$flags\fR flags parameter is currently unused and if
omitted will default to 0.
.RS 4
.IP "Sys::Virt::Domain::CORE_DUMP_FORMAT_RAW" 4
.IX Item "Sys::Virt::Domain::CORE_DUMP_FORMAT_RAW"
The raw \s-1ELF\s0 format
.IP "Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_ZLIB" 4
.IX Item "Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_ZLIB"
The zlib compressed \s-1ELF\s0 format
.IP "Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_SNAPPY" 4
.IX Item "Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_SNAPPY"
The snappy compressed \s-1ELF\s0 format
.IP "Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_LZO" 4
.IX Item "Sys::Virt::Domain::CORE_DUMP_FORMAT_KDUMP_LZO"
The lzo compressed \s-1ELF\s0 format
.RE
.RS 4
.RE
.ie n .IP "$dom\->\fBdestroy()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBdestroy()\fR" 4
.IX Item "$dom->destroy()"
Immediately poweroff the machine. This is equivalent to removing the
power plug. The guest \s-1OS\s0 is given no time to cleanup / save state.
For a clean poweroff sequence, use the \f(CW\*(C`shutdown\*(C'\fR method instead.
.ie n .IP "my $info = $dom\->\fBget_info()\fR" 4
.el .IP "my \f(CW$info\fR = \f(CW$dom\fR\->\fBget_info()\fR" 4
.IX Item "my $info = $dom->get_info()"
Returns a hash reference summarising the execution state of the
domain. The elements of the hash are as follows:
.RS 4
.IP "maxMem" 4
.IX Item "maxMem"
The maximum memory allowed for this domain, in kilobytes
.IP "memory" 4
.IX Item "memory"
The current memory allocated to the domain in kilobytes
.IP "cpuTime" 4
.IX Item "cpuTime"
The amount of \s-1CPU\s0 time used by the domain
.IP "nrVirtCpu" 4
.IX Item "nrVirtCpu"
The current number of virtual CPUs enabled in the domain
.IP "state" 4
.IX Item "state"
The execution state of the machine, which will be one of the
constants &Sys::Virt::Domain::STATE_*.
.RE
.RS 4
.RE
.ie n .IP "my ($state, $reason) = $dom\->\fBget_state()\fR" 4
.el .IP "my ($state, \f(CW$reason\fR) = \f(CW$dom\fR\->\fBget_state()\fR" 4
.IX Item "my ($state, $reason) = $dom->get_state()"
Returns an array whose values specify the current state
of the guest, and the reason for it being in that state.
The \f(CW$state\fR values are the same as for the \f(CW\*(C`get_info\*(C'\fR
\&\s-1API,\s0 and the \f(CW$reason\fR values come from:
.RS 4
.IP "Sys::Virt::Domain::STATE_CRASHED_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_CRASHED_UNKNOWN"
It is not known why the domain has crashed
.IP "Sys::Virt::Domain::STATE_CRASHED_PANICKED" 4
.IX Item "Sys::Virt::Domain::STATE_CRASHED_PANICKED"
The domain has crashed due to a kernel panic
.IP "Sys::Virt::Domain::STATE_NOSTATE_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_NOSTATE_UNKNOWN"
It is not known why the domain has no state
.IP "Sys::Virt::Domain::STATE_PAUSED_DUMP" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_DUMP"
The guest is paused due to a core dump operation
.IP "Sys::Virt::Domain::STATE_PAUSED_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_FROM_SNAPSHOT"
The guest is paused due to a snapshot
.IP "Sys::Virt::Domain::STATE_PAUSED_IOERROR" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_IOERROR"
The guest is paused due to an I/O error
.IP "Sys::Virt::Domain::STATE_PAUSED_MIGRATION" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_MIGRATION"
The guest is paused due to migration
.IP "Sys::Virt::Domain::STATE_PAUSED_SAVE" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_SAVE"
The guest is paused due to a save operation
.IP "Sys::Virt::Domain::STATE_PAUSED_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_UNKNOWN"
It is not known why the domain has paused
.IP "Sys::Virt::Domain::STATE_PAUSED_USER" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_USER"
The guest is paused at admin request
.IP "Sys::Virt::Domain::STATE_PAUSED_WATCHDOG" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_WATCHDOG"
The guest is paused due to the watchdog
.IP "Sys::Virt::Domain::STATE_PAUSED_SHUTTING_DOWN" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_SHUTTING_DOWN"
The guest is paused while domain shutdown takes place
.IP "Sys::Virt::Domain::STATE_PAUSED_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_SNAPSHOT"
The guest is paused while a snapshot takes place
.IP "Sys::Virt::Domain::STATE_PAUSED_CRASHED" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_CRASHED"
The guest is paused due to a kernel panic
.IP "Sys::Virt::Domain::STATE_PAUSED_STARTING_UP" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_STARTING_UP"
The guest is paused as it is being started up.
.IP "Sys::Virt::Domain::STATE_PAUSED_POSTCOPY" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_POSTCOPY"
The guest is paused as post-copy migration is taking place
.IP "Sys::Virt::Domain::STATE_PAUSED_POSTCOPY_FAILED" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED_POSTCOPY_FAILED"
The guest is paused as post-copy migration failed
.IP "Sys::Virt::Domain::STATE_RUNNING_BOOTED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_BOOTED"
The guest is running after being booted
.IP "Sys::Virt::Domain::STATE_RUNNING_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_FROM_SNAPSHOT"
The guest is running after restore from snapshot
.IP "Sys::Virt::Domain::STATE_RUNNING_MIGRATED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_MIGRATED"
The guest is running after migration
.IP "Sys::Virt::Domain::STATE_RUNNING_MIGRATION_CANCELED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_MIGRATION_CANCELED"
The guest is running after migration abort
.IP "Sys::Virt::Domain::STATE_RUNNING_RESTORED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_RESTORED"
The guest is running after restore from file
.IP "Sys::Virt::Domain::STATE_RUNNING_SAVE_CANCELED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_SAVE_CANCELED"
The guest is running after save cancel
.IP "Sys::Virt::Domain::STATE_RUNNING_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_UNKNOWN"
It is not known why the domain has started
.IP "Sys::Virt::Domain::STATE_RUNNING_UNPAUSED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_UNPAUSED"
The guest is running after a resume
.IP "Sys::Virt::Domain::STATE_RUNNING_WAKEUP" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_WAKEUP"
The guest is running after wakeup from power management suspend
.IP "Sys::Virt::Domain::STATE_RUNNING_CRASHED" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_CRASHED"
The guest was restarted after crashing
.IP "Sys::Virt::Domain::STATE_RUNNING_POSTCOPY" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING_POSTCOPY"
The guest is running but post-copy is taking place
.IP "Sys::Virt::Domain::STATE_BLOCKED_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_BLOCKED_UNKNOWN"
The guest is blocked for an unknown reason
.IP "Sys::Virt::Domain::STATE_SHUTDOWN_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTDOWN_UNKNOWN"
It is not known why the domain has shutdown
.IP "Sys::Virt::Domain::STATE_SHUTDOWN_USER" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTDOWN_USER"
The guest is shutdown due to admin request
.IP "Sys::Virt::Domain::STATE_SHUTOFF_CRASHED" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_CRASHED"
The guest is shutoff after a crash
.IP "Sys::Virt::Domain::STATE_SHUTOFF_DESTROYED" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_DESTROYED"
The guest is shutoff after being destroyed
.IP "Sys::Virt::Domain::STATE_SHUTOFF_FAILED" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_FAILED"
The guest is shutoff due to a virtualization failure
.IP "Sys::Virt::Domain::STATE_SHUTOFF_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_FROM_SNAPSHOT"
The guest is shutoff after a snapshot
.IP "Sys::Virt::Domain::STATE_SHUTOFF_MIGRATED" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_MIGRATED"
The guest is shutoff after migration
.IP "Sys::Virt::Domain::STATE_SHUTOFF_SAVED" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_SAVED"
The guest is shutoff after a save
.IP "Sys::Virt::Domain::STATE_SHUTOFF_SHUTDOWN" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_SHUTDOWN"
The guest is shutoff due to controlled shutdown
.IP "Sys::Virt::Domain::STATE_SHUTOFF_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_UNKNOWN"
It is not known why the domain has shutoff
.IP "Sys::Virt::Domain::STATE_SHUTOFF_DAEMON" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF_DAEMON"
The daemon stopped the guest due to a failure
.IP "Sys::Virt::Domain::STATE_PMSUSPENDED_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_PMSUSPENDED_UNKNOWN"
It is not known why the domain was suspended to \s-1RAM\s0
.IP "Sys::Virt::Domain::STATE_PMSUSPENDED_DISK_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::STATE_PMSUSPENDED_DISK_UNKNOWN"
It is not known why the domain was suspended to disk
.RE
.RS 4
.RE
.ie n .IP "my $info = $dom\->get_control_info($flags=0)" 4
.el .IP "my \f(CW$info\fR = \f(CW$dom\fR\->get_control_info($flags=0)" 4
.IX Item "my $info = $dom->get_control_info($flags=0)"
Returns a hash reference providing information about
the control channel. The returned keys in the hash
are
.RS 4
.ie n .IP """state""" 4
.el .IP "\f(CWstate\fR" 4
.IX Item "state"
One of the \s-1CONTROL INFO\s0 constants listed later
.ie n .IP """details""" 4
.el .IP "\f(CWdetails\fR" 4
.IX Item "details"
Currently unused, always 0.
.ie n .IP """stateTime""" 4
.el .IP "\f(CWstateTime\fR" 4
.IX Item "stateTime"
The elapsed time since the control channel entered
the current state.
.RE
.RS 4
.RE
.ie n .IP "my $time = $dom\->get_time($flags=0);" 4
.el .IP "my \f(CW$time\fR = \f(CW$dom\fR\->get_time($flags=0);" 4
.IX Item "my $time = $dom->get_time($flags=0);"
Get the current time of the guest, in seconds and nanoseconds.
The \f(CW$flags\fR parameter is currently unused and defaults to
zero. The return value is an array ref with two elements,
the first contains the time in seconds, the second contains
the remaining nanoseconds.
.ie n .IP "$dom\->set_time($secs, $nsecs, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->set_time($secs, \f(CW$nsecs\fR, \f(CW$flags\fR=0);" 4
.IX Item "$dom->set_time($secs, $nsecs, $flags=0);"
Set the current time of the guest, in seconds and nanoseconds.
The \f(CW$flags\fR parameter accepts one of
.RS 4
.ie n .IP """Sys::Virt::Domain::TIME_SYNC""" 4
.el .IP "\f(CWSys::Virt::Domain::TIME_SYNC\fR" 4
.IX Item "Sys::Virt::Domain::TIME_SYNC"
Re-sync domain time from domain's \s-1RTC.\s0
.RE
.RS 4
.RE
.ie n .IP "$dom\->set_user_password($username, $password, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->set_user_password($username, \f(CW$password\fR, \f(CW$flags\fR=0);" 4
.IX Item "$dom->set_user_password($username, $password, $flags=0);"
Update the password for account \f(CW$username\fR to be
\&\f(CW$password\fR. \f(CW$password\fR is the clear-text password
string unless the \s-1PASSWORD_ENCRYPTED\s0 flag is set.
.RS 4
.ie n .IP """Sys::Virt::Domain::PASSWORD_ENCRYPTED""" 4
.el .IP "\f(CWSys::Virt::Domain::PASSWORD_ENCRYPTED\fR" 4
.IX Item "Sys::Virt::Domain::PASSWORD_ENCRYPTED"
The \f(CW$password\fR is encrypted with the password scheme required
by the guest \s-1OS.\s0
.RE
.RS 4
.RE
.ie n .IP "$dom\->rename($newname, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->rename($newname, \f(CW$flags\fR=0)" 4
.IX Item "$dom->rename($newname, $flags=0)"
Change the name of an inactive guest to be \f(CW$newname\fR.
The \f(CW$flags\fR parameter is currently unused and defaults
to zero.
.ie n .IP "my @errs = $dom\->get_disk_errors($flags=0)" 4
.el .IP "my \f(CW@errs\fR = \f(CW$dom\fR\->get_disk_errors($flags=0)" 4
.IX Item "my @errs = $dom->get_disk_errors($flags=0)"
Returns a list of all disk errors that have occurred on
the backing store for the guest's virtual disks. The
returned array elements are hash references, containing
two keys
.RS 4
.ie n .IP """path""" 4
.el .IP "\f(CWpath\fR" 4
.IX Item "path"
The path of the disk with an error
.ie n .IP """error""" 4
.el .IP "\f(CWerror\fR" 4
.IX Item "error"
The error type
.RE
.RS 4
.RE
.ie n .IP "$dom\->send_key($keycodeset, $holdtime, \e@keycodes, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->send_key($keycodeset, \f(CW$holdtime\fR, \e@keycodes, \f(CW$flags\fR=0)" 4
.IX Item "$dom->send_key($keycodeset, $holdtime, @keycodes, $flags=0)"
Sends a sequence of keycodes to the guest domain. The
\&\f(CW$keycodeset\fR should be one of the constants listed
later in the \s-1KEYCODE SET\s0 section. \f(CW$holdtiem\fR is the
duration, in milliseconds, to keep the key pressed
before releasing it and sending the next keycode.
\&\f(CW@keycodes\fR is an array reference containing the list
of keycodes to send to the guest. The elements in the
array should be keycode values from the specified
keycode set. \f(CW$flags\fR is currently unused.
.ie n .IP "my $info = $dom\->get_block_info($dev, $flags=0)" 4
.el .IP "my \f(CW$info\fR = \f(CW$dom\fR\->get_block_info($dev, \f(CW$flags\fR=0)" 4
.IX Item "my $info = $dom->get_block_info($dev, $flags=0)"
Returns a hash reference summarising the disk usage of
the host backing store for a guest block device. The
\&\f(CW$dev\fR parameter should be the path to the backing
store on the host. \f(CW$flags\fR is currently unused and
defaults to 0 if omitted. The returned hash contains
the following elements
.RS 4
.IP "capacity" 4
.IX Item "capacity"
Logical size in bytes of the block device backing image *
.IP "allocation" 4
.IX Item "allocation"
Highest allocated extent in bytes of the block device backing image
.IP "physical" 4
.IX Item "physical"
Physical size in bytes of the container of the backing image
.RE
.RS 4
.RE
.ie n .IP "$dom\->set_max_memory($mem)" 4
.el .IP "\f(CW$dom\fR\->set_max_memory($mem)" 4
.IX Item "$dom->set_max_memory($mem)"
Set the maximum memory for the domain to the value \f(CW$mem\fR. The
value of the \f(CW$mem\fR parameter is specified in kilobytes.
.ie n .IP "$mem = $dom\->\fBget_max_memory()\fR" 4
.el .IP "\f(CW$mem\fR = \f(CW$dom\fR\->\fBget_max_memory()\fR" 4
.IX Item "$mem = $dom->get_max_memory()"
Returns the current maximum memory allowed for this domain in
kilobytes.
.ie n .IP "$dom\->set_memory($mem, $flags)" 4
.el .IP "\f(CW$dom\fR\->set_memory($mem, \f(CW$flags\fR)" 4
.IX Item "$dom->set_memory($mem, $flags)"
Set the current memory for the domain to the value \f(CW$mem\fR. The
value of the \f(CW$mem\fR parameter is specified in kilobytes. This
must be less than, or equal to the domain's max memory limit.
The \f(CW$flags\fR parameter can control whether the update affects
the live guest, or inactive config, defaulting to modifying
the current state.
.ie n .IP "$dom\->set_memory_stats_period($period, $flags)" 4
.el .IP "\f(CW$dom\fR\->set_memory_stats_period($period, \f(CW$flags\fR)" 4
.IX Item "$dom->set_memory_stats_period($period, $flags)"
Set the period on which guests memory stats are refreshed,
with \f(CW$period\fR being a value in seconds. The \f(CW$flags\fR
parameter is currently unused.
.ie n .IP "$dom\->\fBshutdown()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBshutdown()\fR" 4
.IX Item "$dom->shutdown()"
Request that the guest \s-1OS\s0 perform a graceful shutdown and
poweroff. This usually requires some form of cooperation
from the guest operating system, such as responding to an
\&\s-1ACPI\s0 signal, or a guest agent process. For an immediate,
forceful poweroff, use the \f(CW\*(C`destroy\*(C'\fR method instead.
.ie n .IP "$dom\->reboot([$flags])" 4
.el .IP "\f(CW$dom\fR\->reboot([$flags])" 4
.IX Item "$dom->reboot([$flags])"
Request that the guest \s-1OS\s0 perform a graceful shutdown and
optionally restart. The optional \f(CW$flags\fR parameter is
currently unused and if omitted defaults to zero.
.ie n .IP "$dom\->reset([$flags])" 4
.el .IP "\f(CW$dom\fR\->reset([$flags])" 4
.IX Item "$dom->reset([$flags])"
Perform a hardware reset of the virtual machine. The guest
\&\s-1OS\s0 is given no opportunity to shutdown gracefully. The
optional \f(CW$flags\fR parameter is currently unused and if
omitted defaults to zero.
.ie n .IP "$dom\->\fBget_max_vcpus()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBget_max_vcpus()\fR" 4
.IX Item "$dom->get_max_vcpus()"
Return the maximum number of vcpus that are configured
for the domain
.ie n .IP "$dom\->attach_device($xml[, $flags])" 4
.el .IP "\f(CW$dom\fR\->attach_device($xml[, \f(CW$flags\fR])" 4
.IX Item "$dom->attach_device($xml[, $flags])"
Hotplug a new device whose configuration is given by \f(CW$xml\fR,
to the running guest. The optional <$flags> parameter defaults
to 0, but can accept one of the device hotplug flags described
later.
.ie n .IP "$dom\->detach_device($xml[, $flags])" 4
.el .IP "\f(CW$dom\fR\->detach_device($xml[, \f(CW$flags\fR])" 4
.IX Item "$dom->detach_device($xml[, $flags])"
Hotunplug an existing device whose configuration is given by \f(CW$xml\fR,
from the running guest. The optional <$flags> parameter defaults
to 0, but can accept one of the device hotplug flags described
later.
.ie n .IP "$dom\->detach_device_alias($alias[, $flags])" 4
.el .IP "\f(CW$dom\fR\->detach_device_alias($alias[, \f(CW$flags\fR])" 4
.IX Item "$dom->detach_device_alias($alias[, $flags])"
Hotunplug an existing device which is identified by \f(CW$alias\fR.
The optional <$flags> parameter defaults to 0, but can accept one
of the device hotplug flags described later.
.ie n .IP "$dom\->update_device($xml[, $flags])" 4
.el .IP "\f(CW$dom\fR\->update_device($xml[, \f(CW$flags\fR])" 4
.IX Item "$dom->update_device($xml[, $flags])"
Update the configuration of an existing device. The new configuration
is given by \f(CW$xml\fR. The optional <$flags> parameter defaults to
0 but can accept one of the device hotplug flags described later.
.ie n .IP "$data = $dom\->block_peek($path, $offset, $size[, $flags])" 4
.el .IP "\f(CW$data\fR = \f(CW$dom\fR\->block_peek($path, \f(CW$offset\fR, \f(CW$size\fR[, \f(CW$flags\fR])" 4
.IX Item "$data = $dom->block_peek($path, $offset, $size[, $flags])"
Peek into the guest disk \f(CW$path\fR, at byte \f(CW$offset\fR capturing
\&\f(CW$size\fR bytes of data. The returned scalar may contain embedded
NULLs. The optional \f(CW$flags\fR parameter is currently unused and
if omitted defaults to zero.
.ie n .IP "$data = $dom\->memory_peek($offset, $size[, $flags])" 4
.el .IP "\f(CW$data\fR = \f(CW$dom\fR\->memory_peek($offset, \f(CW$size\fR[, \f(CW$flags\fR])" 4
.IX Item "$data = $dom->memory_peek($offset, $size[, $flags])"
Peek into the guest memory at byte \f(CW$offset\fR virtual address,
capturing \f(CW$size\fR bytes of memory. The return scalar may
contain embedded NULLs. The optional \f(CW$flags\fR parameter is
currently unused and if omitted defaults to zero.
.ie n .IP "$flag = $dom\->\fBget_autostart()\fR;" 4
.el .IP "\f(CW$flag\fR = \f(CW$dom\fR\->\fBget_autostart()\fR;" 4
.IX Item "$flag = $dom->get_autostart();"
Return a true value if the guest domain is configured to automatically
start upon boot. Return false, otherwise
.ie n .IP "$dom\->set_autostart($flag)" 4
.el .IP "\f(CW$dom\fR\->set_autostart($flag)" 4
.IX Item "$dom->set_autostart($flag)"
Set the state of the autostart flag, which determines whether the
guest will automatically start upon boot of the host \s-1OS\s0
.ie n .IP "$dom\->set_vcpus($count, [$flags])" 4
.el .IP "\f(CW$dom\fR\->set_vcpus($count, [$flags])" 4
.IX Item "$dom->set_vcpus($count, [$flags])"
Set the number of virtual CPUs in the guest \s-1VM\s0 to \f(CW$count\fR.
The optional \f(CW$flags\fR parameter can be used to control whether
the setting changes the live config or inactive config.
.ie n .IP "$dom\->set_vcpu($cpumap, $state, [$flags])" 4
.el .IP "\f(CW$dom\fR\->set_vcpu($cpumap, \f(CW$state\fR, [$flags])" 4
.IX Item "$dom->set_vcpu($cpumap, $state, [$flags])"
Set the state of the CPUs in \f(CW$cpumap\fR to \f(CW$state\fR. The
\&\f(CW$flags\fR parameter defaults to zero if not present.
.ie n .IP "$count = $dom\->get_vcpus([$flags])" 4
.el .IP "\f(CW$count\fR = \f(CW$dom\fR\->get_vcpus([$flags])" 4
.IX Item "$count = $dom->get_vcpus([$flags])"
Get the number of virtual CPUs in the guest \s-1VM.\s0
The optional \f(CW$flags\fR parameter can be used to control whether
to query the setting of the live config or inactive config.
.ie n .IP "$dom\->set_guest_vcpus($cpumap, $state, [$flags=0])" 4
.el .IP "\f(CW$dom\fR\->set_guest_vcpus($cpumap, \f(CW$state\fR, [$flags=0])" 4
.IX Item "$dom->set_guest_vcpus($cpumap, $state, [$flags=0])"
Set the online status of the guest \s-1OS\s0 CPUs. The \f(CW$cpumap\fR
parameter describes the set of CPUs to modify (eg \*(L"0\-3,^1\*(R").
\&\f(CW$state\fR is either \fB1\fR to set the CPUs online, or \fB0\fR
to set them offline. The \f(CW$flags\fR parameter is currently
unused and defaults to 0.
.ie n .IP "$info $dom\->get_guest_vcpus([$flags=0])" 4
.el .IP "\f(CW$info\fR \f(CW$dom\fR\->get_guest_vcpus([$flags=0])" 4
.IX Item "$info $dom->get_guest_vcpus([$flags=0])"
Query information about the guest \s-1OS\s0 CPUs. The returned
data is a hash reference with the following keys.
.RS 4
.IP "\fBvcpus\fR" 4
.IX Item "vcpus"
String containing bitmap representing \s-1CPU\s0 ids reported
currently known to the guest.
.IP "\fBonline\fR" 4
.IX Item "online"
String containing bitmap representing \s-1CPU\s0 ids that are
currently online in the guest.
.IP "\fBofflinable\fR" 4
.IX Item "offlinable"
String containing bitmap representing \s-1CPU\s0 ids that can
be offlined in the guest.
.RE
.RS 4
.Sp
The \f(CW$flags\fR parameter is currently unused and defaults to 0.
.RE
.ie n .IP "$type = $dom\->\fBget_scheduler_type()\fR" 4
.el .IP "\f(CW$type\fR = \f(CW$dom\fR\->\fBget_scheduler_type()\fR" 4
.IX Item "$type = $dom->get_scheduler_type()"
Return the scheduler type for the guest domain
.ie n .IP "$stats = $dom\->block_stats($path)" 4
.el .IP "\f(CW$stats\fR = \f(CW$dom\fR\->block_stats($path)" 4
.IX Item "$stats = $dom->block_stats($path)"
Fetch the current I/O statistics for the block device given by \f(CW$path\fR.
The returned hash reference contains keys for
.RS 4
.ie n .IP """rd_req""" 4
.el .IP "\f(CWrd_req\fR" 4
.IX Item "rd_req"
Number of read requests
.ie n .IP """rd_bytes""" 4
.el .IP "\f(CWrd_bytes\fR" 4
.IX Item "rd_bytes"
Number of bytes read
.ie n .IP """wr_req""" 4
.el .IP "\f(CWwr_req\fR" 4
.IX Item "wr_req"
Number of write requests
.ie n .IP """wr_bytes""" 4
.el .IP "\f(CWwr_bytes\fR" 4
.IX Item "wr_bytes"
Number of bytes written
.ie n .IP """errs""" 4
.el .IP "\f(CWerrs\fR" 4
.IX Item "errs"
Some kind of error count
.RE
.RS 4
.RE
.ie n .IP "my $params = $dom\->get_scheduler_parameters($flags=0)" 4
.el .IP "my \f(CW$params\fR = \f(CW$dom\fR\->get_scheduler_parameters($flags=0)" 4
.IX Item "my $params = $dom->get_scheduler_parameters($flags=0)"
Return the set of scheduler tunable parameters for the guest,
as a hash reference. The precise set of keys in the hash
are specific to the hypervisor.
.ie n .IP "$dom\->set_scheduler_parameters($params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_scheduler_parameters($params, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_scheduler_parameters($params, $flags=0)"
Update the set of scheduler tunable parameters. The value names for
tunables vary, and can be discovered using the \f(CW\*(C`get_scheduler_params\*(C'\fR
call
.ie n .IP "my $params = $dom\->get_memory_parameters($flags=0)" 4
.el .IP "my \f(CW$params\fR = \f(CW$dom\fR\->get_memory_parameters($flags=0)" 4
.IX Item "my $params = $dom->get_memory_parameters($flags=0)"
Return a hash reference containing the set of memory tunable
parameters for the guest. The keys in the hash are one of the
constants \s-1MEMORY PARAMETERS\s0 described later. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->set_memory_parameters($params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_memory_parameters($params, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_memory_parameters($params, $flags=0)"
Update the memory tunable parameters for the guest. The
\&\f(CW$params\fR should be a hash reference whose keys are one
of the \s-1MEMORY PARAMETERS\s0 constants. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "my $params = $dom\->get_blkio_parameters($flags=0)" 4
.el .IP "my \f(CW$params\fR = \f(CW$dom\fR\->get_blkio_parameters($flags=0)" 4
.IX Item "my $params = $dom->get_blkio_parameters($flags=0)"
Return a hash reference containing the set of blkio tunable
parameters for the guest. The keys in the hash are one of the
constants \s-1BLKIO PARAMETERS\s0 described later. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->set_blkio_parameters($params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_blkio_parameters($params, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_blkio_parameters($params, $flags=0)"
Update the blkio tunable parameters for the guest. The
\&\f(CW$params\fR should be a hash reference whose keys are one
of the \s-1BLKIO PARAMETERS\s0 constants. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$stats = $dom\->get_block_iotune($disk, $flags=0)" 4
.el .IP "\f(CW$stats\fR = \f(CW$dom\fR\->get_block_iotune($disk, \f(CW$flags\fR=0)" 4
.IX Item "$stats = $dom->get_block_iotune($disk, $flags=0)"
Return a hash reference containing the set of blkio tunable
parameters for the guest disk \f(CW$disk\fR. The keys in the hash
are one of the constants \s-1BLOCK IOTUNE PARAMETERS\s0 described later.
.ie n .IP "$dom\->set_block_iotune($disk, $params, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->set_block_iotune($disk, \f(CW$params\fR, \f(CW$flags\fR=0);" 4
.IX Item "$dom->set_block_iotune($disk, $params, $flags=0);"
Update the blkio tunable parameters for the guest disk \f(CW$disk\fR. The
\&\f(CW$params\fR should be a hash reference whose keys are one
of the \s-1BLOCK IOTUNE PARAMETERS\s0 constants.
.ie n .IP "my $params = $dom\->get_interface_parameters($intf, $flags=0)" 4
.el .IP "my \f(CW$params\fR = \f(CW$dom\fR\->get_interface_parameters($intf, \f(CW$flags\fR=0)" 4
.IX Item "my $params = $dom->get_interface_parameters($intf, $flags=0)"
Return a hash reference containing the set of interface tunable
parameters for the guest. The keys in the hash are one of the
constants \s-1INTERFACE PARAMETERS\s0 described later.
.ie n .IP "$dom\->set_interface_parameters($intf, $params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_interface_parameters($intf, \f(CW$params\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_interface_parameters($intf, $params, $flags=0)"
Update the interface tunable parameters for the guest. The
\&\f(CW$params\fR should be a hash reference whose keys are one
of the \s-1INTERFACE PARAMETERS\s0 constants.
.ie n .IP "my $params = $dom\->get_numa_parameters($flags=0)" 4
.el .IP "my \f(CW$params\fR = \f(CW$dom\fR\->get_numa_parameters($flags=0)" 4
.IX Item "my $params = $dom->get_numa_parameters($flags=0)"
Return a hash reference containing the set of numa tunable
parameters for the guest. The keys in the hash are one of the
constants \s-1NUMA PARAMETERS\s0 described later. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->set_numa_parameters($params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_numa_parameters($params, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_numa_parameters($params, $flags=0)"
Update the numa tunable parameters for the guest. The
\&\f(CW$params\fR should be a hash reference whose keys are one
of the \s-1NUMA PARAMETERS\s0 constants. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "my $params = $dom\->get_perf_events($flags=0)" 4
.el .IP "my \f(CW$params\fR = \f(CW$dom\fR\->get_perf_events($flags=0)" 4
.IX Item "my $params = $dom->get_perf_events($flags=0)"
Return a hash reference containing the set of performance
events that are available for the guest. The keys in the
hash are one of the constants \s-1PERF EVENTS\s0 described later.
The \f(CW$flags\fR parameter accepts one or more the \s-1CONFIG
OPTION\s0 constants documented later, and defaults to 0 if
omitted.
.ie n .IP "$dom\->set_perf_events($params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_perf_events($params, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_perf_events($params, $flags=0)"
Update the enabled state for performance events for the
guest. The \f(CW$params\fR should be a hash reference whose
keys are one of the \s-1PERF EVENTS\s0 constants. The \f(CW$flags\fR
parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->block_resize($disk, $newsize, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->block_resize($disk, \f(CW$newsize\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->block_resize($disk, $newsize, $flags=0)"
Resize the disk \f(CW$disk\fR to have new size \f(CW$newsize\fR \s-1KB.\s0 If the disk
is backed by a special image format, the actual resize is done by the
hypervisor. If the disk is backed by a raw file, or block device,
the resize must be done prior to invoking this \s-1API\s0 call, and it
merely updates the hypervisor's view of the disk size. The following
flags may be used
.RS 4
.IP "Sys::Virt::Domain::BLOCK_RESIZE_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_RESIZE_BYTES"
Treat \f(CW$newsize\fR as if it were in bytes, rather than \s-1KB.\s0
.RE
.RS 4
.RE
.ie n .IP "$dom\->interface_stats($path)" 4
.el .IP "\f(CW$dom\fR\->interface_stats($path)" 4
.IX Item "$dom->interface_stats($path)"
Fetch the current I/O statistics for the block device given by \f(CW$path\fR.
The returned hash containins keys for
.RS 4
.ie n .IP """rx_bytes""" 4
.el .IP "\f(CWrx_bytes\fR" 4
.IX Item "rx_bytes"
Total bytes received
.ie n .IP """rx_packets""" 4
.el .IP "\f(CWrx_packets\fR" 4
.IX Item "rx_packets"
Total packets received
.ie n .IP """rx_errs""" 4
.el .IP "\f(CWrx_errs\fR" 4
.IX Item "rx_errs"
Total packets received with errors
.ie n .IP """rx_drop""" 4
.el .IP "\f(CWrx_drop\fR" 4
.IX Item "rx_drop"
Total packets drop at reception
.ie n .IP """tx_bytes""" 4
.el .IP "\f(CWtx_bytes\fR" 4
.IX Item "tx_bytes"
Total bytes transmitted
.ie n .IP """tx_packets""" 4
.el .IP "\f(CWtx_packets\fR" 4
.IX Item "tx_packets"
Total packets transmitted
.ie n .IP """tx_errs""" 4
.el .IP "\f(CWtx_errs\fR" 4
.IX Item "tx_errs"
Total packets transmitted with errors
.ie n .IP """tx_drop""" 4
.el .IP "\f(CWtx_drop\fR" 4
.IX Item "tx_drop"
Total packets dropped at transmission.
.RE
.RS 4
.RE
.ie n .IP "$dom\->memory_stats($flags=0)" 4
.el .IP "\f(CW$dom\fR\->memory_stats($flags=0)" 4
.IX Item "$dom->memory_stats($flags=0)"
Fetch the current memory statistics for the guest domain. The
\&\f(CW$flags\fR parameter is currently unused and can be omitted.
The returned hash containins keys for
.RS 4
.ie n .IP """swap_in""" 4
.el .IP "\f(CWswap_in\fR" 4
.IX Item "swap_in"
Data read from swap space
.ie n .IP """swap_out""" 4
.el .IP "\f(CWswap_out\fR" 4
.IX Item "swap_out"
Data written to swap space
.ie n .IP """major_fault""" 4
.el .IP "\f(CWmajor_fault\fR" 4
.IX Item "major_fault"
Page fault involving disk I/O
.ie n .IP """minor_fault""" 4
.el .IP "\f(CWminor_fault\fR" 4
.IX Item "minor_fault"
Page fault not involving disk I/O
.ie n .IP """unused""" 4
.el .IP "\f(CWunused\fR" 4
.IX Item "unused"
Memory not used by the system
.ie n .IP """available""" 4
.el .IP "\f(CWavailable\fR" 4
.IX Item "available"
Total memory seen by guest
.ie n .IP """rss""" 4
.el .IP "\f(CWrss\fR" 4
.IX Item "rss"
Resident set size. Size of memory resident in host \s-1RAM.\s0
.RE
.RS 4
.RE
.ie n .IP "$info = $dom\->\fBget_security_label()\fR" 4
.el .IP "\f(CW$info\fR = \f(CW$dom\fR\->\fBget_security_label()\fR" 4
.IX Item "$info = $dom->get_security_label()"
Fetch information about the security label assigned to the guest
domain. The returned hash reference has two keys, \f(CW\*(C`model\*(C'\fR gives
the name of the security model in effect (eg \f(CW\*(C`selinux\*(C'\fR), while
\&\f(CW\*(C`label\*(C'\fR provides the name of the security label applied to the
domain. This method only returns information about the first
security label. To retrieve all labels, use \f(CW\*(C`get_security_label_list\*(C'\fR.
.ie n .IP "@info = $dom\->\fBget_security_label_list()\fR" 4
.el .IP "\f(CW@info\fR = \f(CW$dom\fR\->\fBget_security_label_list()\fR" 4
.IX Item "@info = $dom->get_security_label_list()"
Fetches information about all security labels assigned to the
guest domain. The elements in the returned array are all
hash references, whose keys are as described for \f(CW\*(C`get_security_label\*(C'\fR.
.ie n .IP "$ddom = $dom\->migrate(destcon, \e%params, flags=0)" 4
.el .IP "\f(CW$ddom\fR = \f(CW$dom\fR\->migrate(destcon, \e%params, flags=0)" 4
.IX Item "$ddom = $dom->migrate(destcon, %params, flags=0)"
Migrate a domain to an alternative host. The \f(CW\*(C`destcon\*(C'\fR parameter
should be a \f(CW\*(C`Sys::Virt\*(C'\fR connection to the remote target host.
The \f(CW\*(C`flags\*(C'\fR parameter takes one or more of the \f(CW\*(C`Sys::Virt::Domain::MIGRATE_XXX\*(C'\fR
constants described later in this document. The \f(CW%params\fR parameter is
a hash reference used to set various parameters for the migration
operation, with the following valid keys.
.RS 4
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_URI""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_URI\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_URI"
The \s-1URI\s0 to use for initializing the domain migration. It takes a
hypervisor specific format. The uri_transports element of the hypervisor
capabilities \s-1XML\s0 includes details of the supported \s-1URI\s0 schemes. When
omitted libvirt will auto-generate suitable default \s-1URI.\s0 It is typically
only necessary to specify this \s-1URI\s0 if the destination host has multiple
interfaces and a specific interface is required to transmit migration data.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_DEST_NAME""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_DEST_NAME\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_DEST_NAME"
The name to be used for the domain on the destination host. Omitting
this parameter keeps the domain name the same. This field is only
allowed to be used with hypervisors that support domain renaming
during migration.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_DEST_XML""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_DEST_XML\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_DEST_XML"
The new configuration to be used for the domain on the destination host.
The configuration must include an identical set of virtual devices, to
ensure a stable guest \s-1ABI\s0 across migration. Only parameters related to
host side configuration can be changed in the \s-1XML.\s0 Hypervisors which
support this field will forbid migration if the provided \s-1XML\s0 would cause
a change in the guest \s-1ABI.\s0 This field cannot be used to rename the domain
during migration (use \s-1VIR_MIGRATE_PARAM_DEST_NAME\s0 field for that purpose).
Domain name in the destination \s-1XML\s0 must match the original domain name.
.Sp
Omitting this parameter keeps the original domain configuration. Using this
field with hypervisors that do not support changing domain configuration
during migration will result in a failure.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_GRAPHICS_URI""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_GRAPHICS_URI\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_GRAPHICS_URI"
\&\s-1URI\s0 to use for migrating client's connection to domain's graphical console
as \s-1VIR_TYPED_PARAM_STRING.\s0 If specified, the client will be asked to
automatically reconnect using these parameters instead of the automatically
computed ones. This can be useful if, e.g., the client does not have a direct
access to the network virtualization hosts are connected to and needs to
connect through a proxy. The \s-1URI\s0 is formed as follows:
.Sp
.Vb 1
\&      protocol://hostname[:port]/[?parameters]
.Ve
.Sp
where protocol is either \*(L"spice\*(R" or \*(L"vnc\*(R" and parameters is a list of
protocol specific parameters separated by '&'. Currently recognized
parameters are \*(L"tlsPort\*(R" and \*(L"tlsSubject\*(R". For example,
.Sp
.Vb 1
\&      spice://target.host.com:1234/?tlsPort=4567
.Ve
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH"
The maximum bandwidth (in MiB/s) that will be used for migration. If
set to 0 or omitted, libvirt will choose a suitable default. Some
hypervisors do not support this feature and will return an error if
this field is used and is not 0.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH_POSTCOPY""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH_POSTCOPY\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_BANDWIDTH_POSTCOPY"
The maximum bandwidth (in MiB/s) that will be used for migration
during post-copy phase. If set to 0 or omitted, libvirt will choose
a suitable default. Some hypervisors do not support this feature and
return an error if this field is used and is not 0.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_LISTEN_ADDRESS""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_LISTEN_ADDRESS\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_LISTEN_ADDRESS"
The address on which to listen for incoming migration connections.
If omitted, libvirt will listen on the wildcard address (0.0.0.0
or ::). This default may be a security risk if guests, or other
untrusted users have the ability to connect to the virtualization
host, thus use of an explicit restricted listen address is recommended.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_DISK_PORT""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_DISK_PORT\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_DISK_PORT"
Port that destination server should use for incoming disks migration. Type is
\&\s-1VIR_TYPED_PARAM_INT.\s0 If set to 0 or omitted, libvirt will choose a suitable
default. At the moment this is only supported by the \s-1QEMU\s0 driver.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_MIGRATE_DISKS""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_MIGRATE_DISKS\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_MIGRATE_DISKS"
The list of disks to migrate when doing block storage migration.
In contrast to other parameters whose values are plain strings,
the parameter value should be an array reference, whose elements
are in turn strings representing the disk target names.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_COMPRESSION\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION"
The type of compression method use use, either \f(CW\*(C`xbzrle\*(C'\fR or
\&\f(CW\*(C`mt\*(C'\fR.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_THREADS""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_THREADS\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_THREADS"
The number of compression threads to use
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_DTHREADS""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_DTHREADS\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_DTHREADS"
The number of decompression threads
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_LEVEL""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_LEVEL\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_MT_LEVEL"
The compression level from 0 (no compression) to 9 (maximum
compression)
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE"
The size of the cache for xbzrle compression
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_PERSIST_XML""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_PERSIST_XML\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_PERSIST_XML"
The alternative persistent \s-1XML\s0 config to copy
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INITIAL""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INITIAL\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INITIAL"
The initial percentage to throttle guest vCPUs
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT"
The additional percentage step size to throttle guest vCPUs if
progress is not made
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_PARALLEL_CONNECTIONS""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_PARALLEL_CONNECTIONS\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_PARALLEL_CONNECTIONS"
The number of connections used during parallel migration.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_TLS_DESTINATION""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_TLS_DESTINATION\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_TLS_DESTINATION"
Override the destination host name used for \s-1TLS\s0 verification.
Normally the \s-1TLS\s0 certificate from the destination host must match
the host's name for \s-1TLS\s0 verification to succeed. When the
certificate does not match the destination hostname and the
expected cetificate's hostname is known, this parameter can be
used to pass this expected hostname when starting the migration.
.ie n .IP """Sys::Virt::Domain::MIGRATE_PARAM_DISKS_URI""" 4
.el .IP "\f(CWSys::Virt::Domain::MIGRATE_PARAM_DISKS_URI\fR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARAM_DISKS_URI"
The \s-1URI\s0 to use for initializing the domain migration for storage. It takes
a hypervisor specific format. The uri_transports element of the hypervisor
capabilities \s-1XML\s0 includes details of the supported \s-1URI\s0 schemes. When
omitted libvirt will auto-generate suitable default \s-1URI.\s0 It is typically
only necessary to specify this \s-1URI\s0 if the destination host has multiple
interfaces and a specific interface is required to transmit storage data.
.RE
.RS 4
.RE
.ie n .IP "$ddom = $dom\->migrate(destcon, flags=0, dname=undef, uri=undef, bandwidth=0)" 4
.el .IP "\f(CW$ddom\fR = \f(CW$dom\fR\->migrate(destcon, flags=0, dname=undef, uri=undef, bandwidth=0)" 4
.IX Item "$ddom = $dom->migrate(destcon, flags=0, dname=undef, uri=undef, bandwidth=0)"
Migrate a domain to an alternative host. Use of positional parameters
with \f(CW\*(C`migrate\*(C'\fR is deprecated in favour of passing a hash reference
as described above.
.ie n .IP "$ddom = $dom\->migrate2(destcon, dxml, flags, dname, uri, bandwidth)" 4
.el .IP "\f(CW$ddom\fR = \f(CW$dom\fR\->migrate2(destcon, dxml, flags, dname, uri, bandwidth)" 4
.IX Item "$ddom = $dom->migrate2(destcon, dxml, flags, dname, uri, bandwidth)"
Migrate a domain to an alternative host. This method is deprecated in
favour of passing a hash ref to \f(CW\*(C`migrate\*(C'\fR.
.ie n .IP "$ddom = $dom\->migrate_to_uri(desturi, \e%params, flags=0)" 4
.el .IP "\f(CW$ddom\fR = \f(CW$dom\fR\->migrate_to_uri(desturi, \e%params, flags=0)" 4
.IX Item "$ddom = $dom->migrate_to_uri(desturi, %params, flags=0)"
Migrate a domain to an alternative host. The \f(CW\*(C`desturi\*(C'\fR parameter
should be a valid libvirt connection \s-1URI\s0 for the remote target host.
The \f(CW\*(C`flags\*(C'\fR parameter takes one or more of the \f(CW\*(C`Sys::Virt::Domain::MIGRATE_XXX\*(C'\fR
constants described later in this document. The \f(CW%params\fR parameter is
a hash reference used to set various parameters for the migration
operation, with the same keys described for the \f(CW\*(C`migrate\*(C'\fR \s-1API.\s0
.ie n .IP "$dom\->migrate_to_uri(desturi, flags, dname, bandwidth)" 4
.el .IP "\f(CW$dom\fR\->migrate_to_uri(desturi, flags, dname, bandwidth)" 4
.IX Item "$dom->migrate_to_uri(desturi, flags, dname, bandwidth)"
Migrate a domain to an alternative host. Use of positional parameters
with \f(CW\*(C`migrate_to_uri\*(C'\fR is deprecated in favour of passing a hash reference
as described above.
.ie n .IP "$dom\->migrate_to_uri2(dconnuri, miguri, dxml, flags, dname, bandwidth)" 4
.el .IP "\f(CW$dom\fR\->migrate_to_uri2(dconnuri, miguri, dxml, flags, dname, bandwidth)" 4
.IX Item "$dom->migrate_to_uri2(dconnuri, miguri, dxml, flags, dname, bandwidth)"
Migrate a domain to an alternative host. This method is deprecated in
favour of passing a hash ref to \f(CW\*(C`migrate_to_uri\*(C'\fR.
.ie n .IP "$dom\->migrate_set_max_downtime($downtime, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->migrate_set_max_downtime($downtime, \f(CW$flags\fR=0)" 4
.IX Item "$dom->migrate_set_max_downtime($downtime, $flags=0)"
Set the maximum allowed downtime during migration of the guest. A
longer downtime makes it more likely that migration will complete,
at the cost of longer time blackout for the guest \s-1OS\s0 at the switch
over point. The \f(CW\*(C`downtime\*(C'\fR parameter is measured in milliseconds.
The \f(CW$flags\fR parameter is currently unused and defaults to zero.
.ie n .IP "$downtime = $dom\->migrate_get_max_downtime($flags=0) Get the current value of the maximum downtime allowed during a migration of a guest. The returned <downtime> value is measured in milliseconds. The $flags parameter is currently unused and defaults to zero." 4
.el .IP "\f(CW$downtime\fR = \f(CW$dom\fR\->migrate_get_max_downtime($flags=0) Get the current value of the maximum downtime allowed during a migration of a guest. The returned <downtime> value is measured in milliseconds. The \f(CW$flags\fR parameter is currently unused and defaults to zero." 4
.IX Item "$downtime = $dom->migrate_get_max_downtime($flags=0) Get the current value of the maximum downtime allowed during a migration of a guest. The returned <downtime> value is measured in milliseconds. The $flags parameter is currently unused and defaults to zero."
.PD 0
.ie n .IP "$dom\->migrate_set_max_speed($bandwidth, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->migrate_set_max_speed($bandwidth, \f(CW$flags\fR=0)" 4
.IX Item "$dom->migrate_set_max_speed($bandwidth, $flags=0)"
.PD
Set the maximum allowed bandwidth during migration of the guest.
The \f(CW\*(C`bandwidth\*(C'\fR parameter is measured in MB/second.
The \f(CW$flags\fR parameter takes zero or more of the constants:
.RS 4
.ie n .IP "$Sys::Virt::Domain::MIGRATE_MAX_SPEED_POSTCOPY" 4
.el .IP "\f(CW$Sys::Virt::Domain::MIGRATE_MAX_SPEED_POSTCOPY\fR" 4
.IX Item "$Sys::Virt::Domain::MIGRATE_MAX_SPEED_POSTCOPY"
Set the post-copy speed instead of the pre-copy speed.
.RE
.RS 4
.RE
.ie n .IP "$bandwidth = $dom\->migrate_get_max_speed($flags=0)" 4
.el .IP "\f(CW$bandwidth\fR = \f(CW$dom\fR\->migrate_get_max_speed($flags=0)" 4
.IX Item "$bandwidth = $dom->migrate_get_max_speed($flags=0)"
Get the maximum allowed bandwidth during migration fo the guest.
The returned <bandwidth> value is measured in MB/second.
The \f(CW$flags\fR parameter is accepts the same constants as
\&\f(CW\*(C`migrate_set_max_speed\*(C'\fR.
.ie n .IP "$dom\->migrate_set_compression_cache($cacheSize, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->migrate_set_compression_cache($cacheSize, \f(CW$flags\fR=0)" 4
.IX Item "$dom->migrate_set_compression_cache($cacheSize, $flags=0)"
Set the maximum allowed compression cache size during migration of
the guest. The \f(CW\*(C`cacheSize\*(C'\fR parameter is measured in bytes.
The \f(CW$flags\fR parameter is currently unused and defaults to zero.
.ie n .IP "$cacheSize = $dom\->migrate_get_compression_cache($flags=0)" 4
.el .IP "\f(CW$cacheSize\fR = \f(CW$dom\fR\->migrate_get_compression_cache($flags=0)" 4
.IX Item "$cacheSize = $dom->migrate_get_compression_cache($flags=0)"
Get the maximum allowed compression cache size during migration of
the guest. The returned <bandwidth> value is measured in bytes.
The \f(CW$flags\fR parameter is currently unused and defaults to zero.
.ie n .IP "$dom\->migrate_start_post_copy($flags=0)" 4
.el .IP "\f(CW$dom\fR\->migrate_start_post_copy($flags=0)" 4
.IX Item "$dom->migrate_start_post_copy($flags=0)"
Switch the domain from pre-copy to post-copy mode. This requires
that the original migrate command had the \f(CW\*(C`Sys::Virt::Domain::MIGRATE_POST_COPY\*(C'\fR
flag specified.
.ie n .IP "$dom\->inject_nmi($flags)" 4
.el .IP "\f(CW$dom\fR\->inject_nmi($flags)" 4
.IX Item "$dom->inject_nmi($flags)"
Trigger an \s-1NMI\s0 in the guest virtual machine. The \f(CW$flags\fR parameter
is currently unused and defaults to 0.
.ie n .IP "$dom\->open_console($st, $devname, $flags)" 4
.el .IP "\f(CW$dom\fR\->open_console($st, \f(CW$devname\fR, \f(CW$flags\fR)" 4
.IX Item "$dom->open_console($st, $devname, $flags)"
Open the text console for a serial, parallel or paravirt console
device identified by \f(CW$devname\fR, connecting it to the stream
\&\f(CW$st\fR. If \f(CW$devname\fR is undefined, the default console will be
opened. \f(CW$st\fR must be a \f(CW\*(C`Sys::Virt::Stream\*(C'\fR object used for
bi-directional communication with the console. \f(CW$flags\fR is
currently unused, defaulting to 0.
.ie n .IP "$dom\->open_channel($st, $devname, $flags)" 4
.el .IP "\f(CW$dom\fR\->open_channel($st, \f(CW$devname\fR, \f(CW$flags\fR)" 4
.IX Item "$dom->open_channel($st, $devname, $flags)"
Open the text console for a data channel device identified by
\&\f(CW$devname\fR, connecting it to the stream \f(CW$st\fR. \f(CW$st\fR must
be a \f(CW\*(C`Sys::Virt::Stream\*(C'\fR object used for bi-directional
communication with the channel. \f(CW$flags\fR is currently unused,
defaulting to 0.
.ie n .IP "$dom\->open_graphics($idx, $fd, $flags)" 4
.el .IP "\f(CW$dom\fR\->open_graphics($idx, \f(CW$fd\fR, \f(CW$flags\fR)" 4
.IX Item "$dom->open_graphics($idx, $fd, $flags)"
Open the graphics console for a guest, identified by \f(CW$idx\fR,
counting from 0. The \f(CW$fd\fR should be a file descriptor for an
anoymous socket pair. The \f(CW$flags\fR argument should be one of
the constants listed at the end of this document, and defaults
to 0.
.ie n .IP "$fd = $dom\->open_graphics_fd($idx, $flags)" 4
.el .IP "\f(CW$fd\fR = \f(CW$dom\fR\->open_graphics_fd($idx, \f(CW$flags\fR)" 4
.IX Item "$fd = $dom->open_graphics_fd($idx, $flags)"
Open the graphics console for a guest, identified by \f(CW$idx\fR,
counting from 0. The \f(CW$flags\fR argument should be one of the
constants listed at the end of this document, and defaults
to 0. The return value will be a file descriptor connected
to the console which must be closed when no longer needed.
This method is preferred over \f(CW\*(C`open_graphics\*(C'\fR since it will
work correctly under sVirt mandatory access control policies.
.ie n .IP "my $mimetype = $dom\->screenshot($st, $screen, $flags)" 4
.el .IP "my \f(CW$mimetype\fR = \f(CW$dom\fR\->screenshot($st, \f(CW$screen\fR, \f(CW$flags\fR)" 4
.IX Item "my $mimetype = $dom->screenshot($st, $screen, $flags)"
Capture a screenshot of the virtual machine's monitor. The \f(CW$screen\fR
parameter controls which monitor is captured when using a multi-head
or multi-card configuration. \f(CW$st\fR must be a \f(CW\*(C`Sys::Virt::Stream\*(C'\fR
object from which the data can be read. \f(CW$flags\fR is currently unused
and defaults to 0. The mimetype of the screenshot is returned
.ie n .IP "@vcpuinfo = $dom\->get_vcpu_info($flags=0)" 4
.el .IP "\f(CW@vcpuinfo\fR = \f(CW$dom\fR\->get_vcpu_info($flags=0)" 4
.IX Item "@vcpuinfo = $dom->get_vcpu_info($flags=0)"
Obtain information about the state of all virtual CPUs in a running
guest domain. The returned list will have one element for each vCPU,
where each elements contains a hash reference. The keys in the hash
are, \f(CW\*(C`number\*(C'\fR the vCPU number, \f(CW\*(C`cpu\*(C'\fR the physical \s-1CPU\s0 on which the
vCPU is currently scheduled, \f(CW\*(C`cpuTime\*(C'\fR the cumulative execution
time of the vCPU, \f(CW\*(C`state\*(C'\fR the running state and \f(CW\*(C`affinity\*(C'\fR giving
the allowed shedular placement. The value for \f(CW\*(C`affinity\*(C'\fR is a
string representing a bitmask against physical CPUs, 8 cpus per
character. To extract the bits use the \f(CW\*(C`unpack\*(C'\fR function with
the \f(CW\*(C`b*\*(C'\fR template. \s-1NB\s0 The \f(CW\*(C`state\*(C'\fR, \f(CW\*(C`cpuTime\*(C'\fR, \f(CW\*(C`cpu\*(C'\fR values are
only available if using \f(CW$flags\fR value of 0, and the domain is
currently running; otherwise they will all be set to zero.
.ie n .IP "$dom\->pin_vcpu($vcpu, $mask)" 4
.el .IP "\f(CW$dom\fR\->pin_vcpu($vcpu, \f(CW$mask\fR)" 4
.IX Item "$dom->pin_vcpu($vcpu, $mask)"
Pin the virtual \s-1CPU\s0 given by index \f(CW$vcpu\fR to physical CPUs
given by \f(CW$mask\fR. The \f(CW$mask\fR is a string representing a bitmask
against physical CPUs, 8 cpus per character.
.ie n .IP "$mask = $dom\->\fBget_emulator_pin_info()\fR" 4
.el .IP "\f(CW$mask\fR = \f(CW$dom\fR\->\fBget_emulator_pin_info()\fR" 4
.IX Item "$mask = $dom->get_emulator_pin_info()"
Obtain information about the \s-1CPU\s0 affinity of the emulator process.
The returned \f(CW$mask\fR is a bitstring against physical CPUs, 8 cpus
per character. To extract the bits use the \f(CW\*(C`unpack\*(C'\fR function with
the \f(CW\*(C`b*\*(C'\fR template.
.ie n .IP "$dom\->pin_emulator($newmask, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->pin_emulator($newmask, \f(CW$flags\fR=0)" 4
.IX Item "$dom->pin_emulator($newmask, $flags=0)"
Pin the emulator threads to the physical CPUs identified by the
affinity in \f(CW$newmask\fR. The \f(CW$newmask\fR is a bitstring against
the physical CPUa, 8 cpus per character. To create a suitable
bitstring, use the \f(CW\*(C`vec\*(C'\fR function with a value of \f(CW1\fR for the
\&\f(CW\*(C`BITS\*(C'\fR parameter.
.ie n .IP "@iothreadinfo = $dom\->get_iothread_info($flags=0)" 4
.el .IP "\f(CW@iothreadinfo\fR = \f(CW$dom\fR\->get_iothread_info($flags=0)" 4
.IX Item "@iothreadinfo = $dom->get_iothread_info($flags=0)"
Obtain information about the state of all IOThreads in a running
guest domain. The returned list will have one element for each IOThread,
where each elements contains a hash reference. The keys in the hash
are, \f(CW\*(C`number\*(C'\fR the IOThread number and \f(CW\*(C`affinity\*(C'\fR giving the allowed
schedular placement. The value for \f(CW\*(C`affinity\*(C'\fR is a
string representing a bitmask against physical CPUs, 8 cpus per
character. To extract the bits use the \f(CW\*(C`unpack\*(C'\fR function with
the \f(CW\*(C`b*\*(C'\fR template.
.ie n .IP "$dom\->pin_iothread($iothread, $mask)" 4
.el .IP "\f(CW$dom\fR\->pin_iothread($iothread, \f(CW$mask\fR)" 4
.IX Item "$dom->pin_iothread($iothread, $mask)"
Pin the IOThread given by index \f(CW$iothread\fR to physical CPUs
given by \f(CW$mask\fR. The \f(CW$mask\fR is a string representing a bitmask
against physical CPUs, 8 cpus per character.
.ie n .IP "$dom\->add_iothread($iothread, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->add_iothread($iothread, \f(CW$flags\fR=0)" 4
.IX Item "$dom->add_iothread($iothread, $flags=0)"
Add a new IOThread by the \f(CW$iothread\fR value to the guest domain.
The \f(CW$flags\fR parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->del_iothread($iothread, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->del_iothread($iothread, \f(CW$flags\fR=0)" 4
.IX Item "$dom->del_iothread($iothread, $flags=0)"
Delete an existing IOThread by the \f(CW$iothread\fR value from the guest domain.
The \f(CW$flags\fR parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "$dom\->set_iothread($iothread, $params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_iothread($iothread, \f(CW$params\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_iothread($iothread, $params, $flags=0)"
Set parameters for the IOThread by the \f(CW$iothread\fR value on the guest domain.
The \f(CW$params\fR parameter is a hash reference whose keys are the
\&\f(CW\*(C`IOTHREAD STATS\*(C'\fR constants documented later.
The \f(CW$flags\fR parameter accepts one or more the \s-1CONFIG OPTION\s0 constants
documented later, and defaults to 0 if omitted.
.ie n .IP "my @stats = $dom\->get_cpu_stats($startCpu, $numCpus, $flags=0)" 4
.el .IP "my \f(CW@stats\fR = \f(CW$dom\fR\->get_cpu_stats($startCpu, \f(CW$numCpus\fR, \f(CW$flags\fR=0)" 4
.IX Item "my @stats = $dom->get_cpu_stats($startCpu, $numCpus, $flags=0)"
Requests the guests host physical \s-1CPU\s0 usage statistics, starting
from host \s-1CPU\s0 <$startCpu> counting up to \f(CW$numCpus\fR. If \f(CW$startCpu\fR
is \-1 and \f(CW$numCpus\fR is 1, then the utilization across all CPUs
is returned. Returns an array of hash references, each element
containing stats for one \s-1CPU.\s0
.ie n .IP "my $info = $dom\->\fBget_job_info()\fR" 4
.el .IP "my \f(CW$info\fR = \f(CW$dom\fR\->\fBget_job_info()\fR" 4
.IX Item "my $info = $dom->get_job_info()"
Returns a hash reference summarising the execution state of the
background job. The elements of the hash are as follows:
.RS 4
.IP "type" 4
.IX Item "type"
The type of job, one of the \s-1JOB TYPE\s0 constants listed later in
this document.
.IP "timeElapsed" 4
.IX Item "timeElapsed"
The elapsed time in milliseconds
.IP "timeRemaining" 4
.IX Item "timeRemaining"
The expected remaining time in milliseconds. Only set if the
\&\f(CW\*(C`type\*(C'\fR is \s-1JOB_UNBOUNDED.\s0
.IP "dataTotal" 4
.IX Item "dataTotal"
The total amount of data expected to be processed by the job, in bytes.
.IP "dataProcessed" 4
.IX Item "dataProcessed"
The current amount of data processed by the job, in bytes.
.IP "dataRemaining" 4
.IX Item "dataRemaining"
The expected amount of data remaining to be processed by the job, in bytes.
.IP "memTotal" 4
.IX Item "memTotal"
The total amount of mem expected to be processed by the job, in bytes.
.IP "memProcessed" 4
.IX Item "memProcessed"
The current amount of mem processed by the job, in bytes.
.IP "memRemaining" 4
.IX Item "memRemaining"
The expected amount of mem remaining to be processed by the job, in bytes.
.IP "fileTotal" 4
.IX Item "fileTotal"
The total amount of file expected to be processed by the job, in bytes.
.IP "fileProcessed" 4
.IX Item "fileProcessed"
The current amount of file processed by the job, in bytes.
.IP "fileRemaining" 4
.IX Item "fileRemaining"
The expected amount of file remaining to be processed by the job, in bytes.
.RE
.RS 4
.RE
.ie n .IP "my ($type, $stats) = $dom\->get_job_stats($flags=0)" 4
.el .IP "my ($type, \f(CW$stats\fR) = \f(CW$dom\fR\->get_job_stats($flags=0)" 4
.IX Item "my ($type, $stats) = $dom->get_job_stats($flags=0)"
Returns an array summarising the execution state of the
background job. The \f(CW$type\fR value is one of the \s-1JOB TYPE\s0
constants listed later in this document. The \f(CW$stats\fR
value is a hash reference, whose elements are one of the
following constants.
.RS 4
.IP "type" 4
.IX Item "type"
The type of job, one of the \s-1JOB TYPE\s0 constants listed later in
this document.
.Sp
The \f(CW$flags\fR parameter defaults to zero and can take one of
the following constants.
.RS 4
.IP "Sys::Virt::Domain::JOB_STATS_COMPLETED" 4
.IX Item "Sys::Virt::Domain::JOB_STATS_COMPLETED"
Return the stats of the most recently completed job.
.IP "Sys::Virt::Domain::JOB_STATS_KEEP_COMPLETED" 4
.IX Item "Sys::Virt::Domain::JOB_STATS_KEEP_COMPLETED"
Don't clear the completed stats after reading them.
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::JOB_TIME_ELAPSED" 4
.IX Item "Sys::Virt::Domain::JOB_TIME_ELAPSED"
The elapsed time in milliseconds
.IP "Sys::Virt::Domain::JOB_TIME_ELAPSED_NET" 4
.IX Item "Sys::Virt::Domain::JOB_TIME_ELAPSED_NET"
Time in milliseconds since the beginning of the migration job \s-1NOT\s0
including the time required to transfer control flow from the
source host to the destination host.
.IP "Sys::Virt::Domain::JOB_TIME_REMAINING" 4
.IX Item "Sys::Virt::Domain::JOB_TIME_REMAINING"
The expected remaining time in milliseconds. Only set if the
\&\f(CW\*(C`type\*(C'\fR is \s-1JOB_UNBOUNDED.\s0
.IP "Sys::Virt::Domain::JOB_DATA_TOTAL" 4
.IX Item "Sys::Virt::Domain::JOB_DATA_TOTAL"
The total amount of data expected to be processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_DATA_PROCESSED" 4
.IX Item "Sys::Virt::Domain::JOB_DATA_PROCESSED"
The current amount of data processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_DATA_REMAINING" 4
.IX Item "Sys::Virt::Domain::JOB_DATA_REMAINING"
The expected amount of data remaining to be processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_MEMORY_TOTAL" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_TOTAL"
The total amount of mem expected to be processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_MEMORY_PROCESSED" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_PROCESSED"
The current amount of mem processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_MEMORY_REMAINING" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_REMAINING"
The expected amount of mem remaining to be processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_MEMORY_CONSTANT" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_CONSTANT"
The number of pages filled with a constant byte which have
been transferred
.IP "Sys::Virt::Domain::JOB_MEMORY_NORMAL" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_NORMAL"
The number of pages transferred without any compression
.IP "Sys::Virt::Domain::JOB_MEMORY_NORMAL_BYTES" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_NORMAL_BYTES"
The number of bytes transferred without any compression
.IP "Sys::Virt::Domain::JOB_MEMORY_BPS" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_BPS"
The bytes per second transferred
.IP "Sys::Virt::Domain::JOB_MEMORY_DIRTY_RATE" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_DIRTY_RATE"
The number of memory pages dirtied per second
.IP "Sys::Virt::Domain::JOB_MEMORY_PAGE_SIZE" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_PAGE_SIZE"
The memory page size in bytes
.IP "Sys::Virt::Domain::JOB_MEMORY_ITERATION" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_ITERATION"
The total number of iterations over guest memory
.IP "Sys::Virt::Domain::JOB_MEMORY_POSTCOPY_REQS" 4
.IX Item "Sys::Virt::Domain::JOB_MEMORY_POSTCOPY_REQS"
The number of page requests received from the destination host during post-copy migration.
.IP "Sys::Virt::Domain::JOB_DISK_TOTAL" 4
.IX Item "Sys::Virt::Domain::JOB_DISK_TOTAL"
The total amount of file expected to be processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_DISK_PROCESSED" 4
.IX Item "Sys::Virt::Domain::JOB_DISK_PROCESSED"
The current amount of file processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_DISK_REMAINING" 4
.IX Item "Sys::Virt::Domain::JOB_DISK_REMAINING"
The expected amount of file remaining to be processed by the job, in bytes.
.IP "Sys::Virt::Domain::JOB_DISK_BPS" 4
.IX Item "Sys::Virt::Domain::JOB_DISK_BPS"
The bytes per second transferred
.IP "Sys::Virt::Domain::JOB_AUTO_CONVERGE_THROTTLE" 4
.IX Item "Sys::Virt::Domain::JOB_AUTO_CONVERGE_THROTTLE"
The percentage by which vCPUs are currently throttled
.IP "Sys::Virt::Domain::JOB_COMPRESSION_CACHE" 4
.IX Item "Sys::Virt::Domain::JOB_COMPRESSION_CACHE"
The size of the compression cache in bytes
.IP "Sys::Virt::Domain::JOB_COMPRESSION_BYTES" 4
.IX Item "Sys::Virt::Domain::JOB_COMPRESSION_BYTES"
The number of compressed bytes transferred
.IP "Sys::Virt::Domain::JOB_COMPRESSION_PAGES" 4
.IX Item "Sys::Virt::Domain::JOB_COMPRESSION_PAGES"
The number of compressed pages transferred
.IP "Sys::Virt::Domain::JOB_COMPRESSION_CACHE_MISSES" 4
.IX Item "Sys::Virt::Domain::JOB_COMPRESSION_CACHE_MISSES"
The number of changing pages not in compression cache
.IP "Sys::Virt::Domain::JOB_COMPRESSION_OVERFLOW" 4
.IX Item "Sys::Virt::Domain::JOB_COMPRESSION_OVERFLOW"
The number of changing pages in the compression cache but sent
uncompressed since the compressed page was larger than the
non-compressed page.
.IP "Sys::Virt::Domain::JOB_DOWNTIME" 4
.IX Item "Sys::Virt::Domain::JOB_DOWNTIME"
The number of milliseconds of downtime expected during
migration switchover.
.IP "Sys::Virt::Domain::JOB_DOWNTIME_NET" 4
.IX Item "Sys::Virt::Domain::JOB_DOWNTIME_NET"
Real measured downtime (ms) \s-1NOT\s0 including the time required to
transfer control flow from the source host to the destination
host.
.IP "Sys::Virt::Domain::JOB_SETUP_TIME" 4
.IX Item "Sys::Virt::Domain::JOB_SETUP_TIME"
The number of milliseconds of time doing setup of the job
.IP "Sys::Virt::Domain::JOB_OPERATION" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION"
The type of operation associated with the job
.IP "Sys::Virt::Domain::JOB_SUCCESS" 4
.IX Item "Sys::Virt::Domain::JOB_SUCCESS"
Whether the job was successfully completed.
.IP "Sys::Virt::Domain::JOB_DISK_TEMP_TOTAL" 4
.IX Item "Sys::Virt::Domain::JOB_DISK_TEMP_TOTAL"
Possible total temporary disk space for the job in bytes
.IP "Sys::Virt::Domain::JOB_DISK_TEMP_USED" 4
.IX Item "Sys::Virt::Domain::JOB_DISK_TEMP_USED"
Current total temporary disk space for the job in bytes
.IP "Sys::Virt::Domain::JOB_ERRMSG" 4
.IX Item "Sys::Virt::Domain::JOB_ERRMSG"
The error message from a failed job
.RE
.RS 4
.Sp
The values for the Sys::Virt::Domain::JOB_OPERATION field are
.IP "Sys::Virt::Domain::JOB_OPERATION_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_UNKNOWN"
No known job type
.IP "Sys::Virt::Domain::JOB_OPERATION_START" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_START"
The guest is starting
.IP "Sys::Virt::Domain::JOB_OPERATION_SAVE" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_SAVE"
The guest is saving to disk
.IP "Sys::Virt::Domain::JOB_OPERATION_RESTORE" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_RESTORE"
The guest is restoring from disk
.IP "Sys::Virt::Domain::JOB_OPERATION_MIGRATION_IN" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_MIGRATION_IN"
The guest is migrating in from another host
.IP "Sys::Virt::Domain::JOB_OPERATION_MIGRATION_OUT" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_MIGRATION_OUT"
The guest is migrating out to another host
.IP "Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT"
The guest is saving a snapshot
.IP "Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT_REVERT" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_SNAPSHOT_REVERT"
The guest is reverting to a snapshot
.IP "Sys::Virt::Domain::JOB_OPERATION_DUMP" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_DUMP"
The guest is saving a crash dump
.IP "Sys::Virt::Domain::JOB_OPERATION_BACKUP" 4
.IX Item "Sys::Virt::Domain::JOB_OPERATION_BACKUP"
The guest is performing a block backup
.RE
.RS 4
.RE
.ie n .IP "$dom\->\fBabort_job()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBabort_job()\fR" 4
.IX Item "$dom->abort_job()"
Aborts the currently executing job
.ie n .IP "my $info = $dom\->get_block_job_info($path, $flags=0)" 4
.el .IP "my \f(CW$info\fR = \f(CW$dom\fR\->get_block_job_info($path, \f(CW$flags\fR=0)" 4
.IX Item "my $info = $dom->get_block_job_info($path, $flags=0)"
Returns a hash reference summarising the execution state of
the block job. The \f(CW$path\fR parameter should be the fully
qualified path of the block device being changed. Valid
\&\f(CW$flags\fR include:
.RS 4
.IP "Sys::Virt::Domain::BLOCK_JOB_INFO_BANDWIDTH_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_INFO_BANDWIDTH_BYTES"
Treat bandwidth value as bytes instead of MiB.
.RE
.RS 4
.RE
.ie n .IP "$dom\->set_block_job_speed($path, $bandwidth, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_block_job_speed($path, \f(CW$bandwidth\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_block_job_speed($path, $bandwidth, $flags=0)"
Change the maximum I/O bandwidth used by the block job that
is currently executing for \f(CW$path\fR. The \f(CW$bandwidth\fR argument
is specified in MB/s.  The \f(CW$flags\fR parameter
can take the bitwise union of the values:
.RS 4
.IP "Sys::Virt::Domain::BLOCK_JOB_SPEED_BANDWIDTH_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_SPEED_BANDWIDTH_BYTES"
The \f(CW$bandwidth\fR parameter value is measured in bytes/s
instead of MB/s.
.RE
.RS 4
.RE
.ie n .IP "$dom\->abort_block_job($path, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->abort_block_job($path, \f(CW$flags\fR=0)" 4
.IX Item "$dom->abort_block_job($path, $flags=0)"
Abort the current job that is executing for the block device
associated with \f(CW$path\fR
.ie n .IP "$dom\->block_pull($path, $bandwidth, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->block_pull($path, \f(CW$bandwidth\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->block_pull($path, $bandwidth, $flags=0)"
Merge the backing files associated with \f(CW$path\fR into the
top level file. The \f(CW$bandwidth\fR parameter specifies the
maximum I/O rate to allow in MB/s. The \f(CW$flags\fR parameter
can take the bitwise union of the values:
.RS 4
.IP "Sys::Virt::Domain::BLOCK_PULL_BANDWIDTH_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_PULL_BANDWIDTH_BYTES"
The \f(CW$bandwidth\fR parameter value is measured in bytes/s
instead of MB/s.
.RE
.RS 4
.RE
.ie n .IP "$dom\->block_rebase($path, $base, $bandwidth, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->block_rebase($path, \f(CW$base\fR, \f(CW$bandwidth\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->block_rebase($path, $base, $bandwidth, $flags=0)"
Switch the backing path associated with \f(CW$path\fR to instead
use \f(CW$base\fR. The \f(CW$bandwidth\fR parameter specifies the
maximum I/O rate to allow in MB/s. The \f(CW$flags\fR parameter
can take the bitwise union of the values:
.RS 4
.IP "Sys::Virt::Domain::BLOCK_REBASE_BANDWIDTH_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_BANDWIDTH_BYTES"
The \f(CW$bandwidth\fR parameter value is measured in bytes/s
instead of MB/s.
.RE
.RS 4
.RE
.ie n .IP "$dom\->block_copy($path, $destxml, $params, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->block_copy($path, \f(CW$destxml\fR, \f(CW$params\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->block_copy($path, $destxml, $params, $flags=0)"
Copy contents of a disk image <$path> into the target volume
described by \f(CW$destxml\fR which follows the schema of the
<disk> element in the domain \s-1XML.\s0 The \f(CW$params\fR parameter
is a hash of optional parameters to control the process
.RS 4
.IP "Sys::Virt::Domain::BLOCK_COPY_BANDWIDTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_COPY_BANDWIDTH"
The maximum bandwidth in bytes per second.
.IP "Sys::Virt::Domain::BLOCK_COPY_GRANULARITY" 4
.IX Item "Sys::Virt::Domain::BLOCK_COPY_GRANULARITY"
The granularity in bytes of the copy process
.IP "Sys::Virt::Domain::BLOCK_COPY_BUF_SIZE" 4
.IX Item "Sys::Virt::Domain::BLOCK_COPY_BUF_SIZE"
The maximum amount of data in flight in bytes.
.RE
.RS 4
.RE
.ie n .IP "$dom\->block_commit($path, $base, $top, $bandwidth, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->block_commit($path, \f(CW$base\fR, \f(CW$top\fR, \f(CW$bandwidth\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->block_commit($path, $base, $top, $bandwidth, $flags=0)"
Commit changes there were made to the temporary top level file \f(CW$top\fR.
Takes all the differences between \f(CW$top\fR and \f(CW$base\fR and merge them
into \f(CW$base\fR. The \f(CW$bandwidth\fR parameter specifies the
maximum I/O rate to allow in MB/s.  The \f(CW$flags\fR parameter
can take the bitwise union of the values:
.RS 4
.IP "Sys::Virt::Domain::BLOCK_COMMIT_BANDWIDTH_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_COMMIT_BANDWIDTH_BYTES"
The \f(CW$bandwidth\fR parameter value is measured in bytes
instead of MB/s.
.RE
.RS 4
.RE
.ie n .IP "$count = $dom\->\fBnum_of_snapshots()\fR" 4
.el .IP "\f(CW$count\fR = \f(CW$dom\fR\->\fBnum_of_snapshots()\fR" 4
.IX Item "$count = $dom->num_of_snapshots()"
Return the number of saved snapshots of the domain
.ie n .IP "@names = $dom\->\fBlist_snapshot_names()\fR" 4
.el .IP "\f(CW@names\fR = \f(CW$dom\fR\->\fBlist_snapshot_names()\fR" 4
.IX Item "@names = $dom->list_snapshot_names()"
List the names of all saved snapshots. The names can be
used with the \f(CW\*(C`lookup_snapshot_by_name\*(C'\fR
.ie n .IP "@snapshots = $dom\->\fBlist_snapshots()\fR" 4
.el .IP "\f(CW@snapshots\fR = \f(CW$dom\fR\->\fBlist_snapshots()\fR" 4
.IX Item "@snapshots = $dom->list_snapshots()"
Return a list of all snapshots currently known to the domain. The elements
in the returned list are instances of the Sys::Virt::DomainSnapshot class.
This method requires O(n) \s-1RPC\s0 calls, so the \f(CW\*(C`list_all_snapshots\*(C'\fR method is
recommended as a more efficient alternative.
.ie n .IP "my @snapshots = $dom\->list_all_snapshots($flags)" 4
.el .IP "my \f(CW@snapshots\fR = \f(CW$dom\fR\->list_all_snapshots($flags)" 4
.IX Item "my @snapshots = $dom->list_all_snapshots($flags)"
Return a list of all domain snapshots associated with this domain.
The elements in the returned list are instances of the
Sys::Virt::DomainSnapshot class. The \f(CW$flags\fR parameter can be
used to filter the list of return domain snapshots.
.ie n .IP "my $snapshot = $dom\->get_snapshot_by_name($name)" 4
.el .IP "my \f(CW$snapshot\fR = \f(CW$dom\fR\->get_snapshot_by_name($name)" 4
.IX Item "my $snapshot = $dom->get_snapshot_by_name($name)"
Return the domain snapshot with a name of \f(CW$name\fR. The returned object is
an instance of the Sys::Virt::DomainSnapshot class.
.ie n .IP "$dom\->\fBhas_current_snapshot()\fR" 4
.el .IP "\f(CW$dom\fR\->\fBhas_current_snapshot()\fR" 4
.IX Item "$dom->has_current_snapshot()"
Returns a true value if the domain has a currently active snapshot
.ie n .IP "$snapshot = $dom\->\fBcurrent_snapshot()\fR" 4
.el .IP "\f(CW$snapshot\fR = \f(CW$dom\fR\->\fBcurrent_snapshot()\fR" 4
.IX Item "$snapshot = $dom->current_snapshot()"
Returns the currently active snapshot for the domain.
.ie n .IP "$snapshot = $dom\->create_snapshot($xml[, $flags])" 4
.el .IP "\f(CW$snapshot\fR = \f(CW$dom\fR\->create_snapshot($xml[, \f(CW$flags\fR])" 4
.IX Item "$snapshot = $dom->create_snapshot($xml[, $flags])"
Create a new snapshot from the \f(CW$xml\fR. The \f(CW$flags\fR parameter accepts
the \fB\s-1SNAPSHOT CREATION\s0\fR constants listed in \f(CW\*(C`Sys::Virt::DomainSnapshots\*(C'\fR.
.ie n .IP "my @checkpoints = $dom\->list_all_checkpoints($flags)" 4
.el .IP "my \f(CW@checkpoints\fR = \f(CW$dom\fR\->list_all_checkpoints($flags)" 4
.IX Item "my @checkpoints = $dom->list_all_checkpoints($flags)"
Return a list of all domain checkpoints associated with this domain.
The elements in the returned list are instances of the
Sys::Virt::DomainCheckpoint class. The \f(CW$flags\fR parameter can be
used to filter the list of return domain checkpoints.
.ie n .IP "my $checkpoint = $dom\->get_checkpoint_by_name($name)" 4
.el .IP "my \f(CW$checkpoint\fR = \f(CW$dom\fR\->get_checkpoint_by_name($name)" 4
.IX Item "my $checkpoint = $dom->get_checkpoint_by_name($name)"
Return the domain checkpoint with a name of \f(CW$name\fR. The returned object is
an instance of the Sys::Virt::DomainCheckpoint class.
.ie n .IP "$checkpoint = $dom\->create_checkpoint($xml[, $flags])" 4
.el .IP "\f(CW$checkpoint\fR = \f(CW$dom\fR\->create_checkpoint($xml[, \f(CW$flags\fR])" 4
.IX Item "$checkpoint = $dom->create_checkpoint($xml[, $flags])"
Create a new checkpoint from the \f(CW$xml\fR. The \f(CW$flags\fR parameter accepts
the \fB\s-1CHECKPOINT CREATION\s0\fR constants listed in \f(CW\*(C`Sys::Virt::DomainCheckpoints\*(C'\fR.
.ie n .IP "$dom\->backup_begin($backupxml, $checkpointxml=undef, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->backup_begin($backupxml, \f(CW$checkpointxml\fR=undef, \f(CW$flags\fR=0);" 4
.IX Item "$dom->backup_begin($backupxml, $checkpointxml=undef, $flags=0);"
Start a point-in-time backup job for the specified disks of a
running domain. The \f(CW$backupxml\fR parameter describes the
backup operation, including which disks to use. The optional
\&\f(CW$checkpointxml\fR parameter can be used to create a checkpoint
covering to the same point in time as the backup. The optional
\&\f(CW$flags\fR parameter can be one of the following constants:
.RS 4
.IP "Sys::Virt::Domain::BACKUP_BEGIN_REUSE_EXTERNAL" 4
.IX Item "Sys::Virt::Domain::BACKUP_BEGIN_REUSE_EXTERNAL"
Assume that the output/temporary files for the backup have been
precreated by the caller with the correct size and format.
.RE
.RS 4
.RE
.ie n .IP "$xml = $dom\->backup_get_xml_description($flags=0);" 4
.el .IP "\f(CW$xml\fR = \f(CW$dom\fR\->backup_get_xml_description($flags=0);" 4
.IX Item "$xml = $dom->backup_get_xml_description($flags=0);"
Get the \s-1XML\s0 description of the currently executing backup
job. If there is no backup job then an error is raised.
.ie n .IP "$dom\->fs_trim($mountPoint, $minimum, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->fs_trim($mountPoint, \f(CW$minimum\fR, \f(CW$flags\fR=0);" 4
.IX Item "$dom->fs_trim($mountPoint, $minimum, $flags=0);"
Issue an \s-1FS_TRIM\s0 command to the device at \f(CW$mountPoint\fR
to remove chunks of unused space that are at least
\&\f(CW$minimum\fR bytes in length. \f(CW$flags\fR is currently
unused and defaults to zero.
.ie n .IP "$dom\->fs_freeze(\e@mountPoints, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->fs_freeze(\e@mountPoints, \f(CW$flags\fR=0);" 4
.IX Item "$dom->fs_freeze(@mountPoints, $flags=0);"
Freeze all the filesystems associated with the \f(CW@mountPoints\fR
array reference. If <@mountPoints> is an empty list, then all
filesystems will be frozen. \f(CW$flags\fR is currently
unused and defaults to zero.
.ie n .IP "$dom\->fs_thaw(\e@mountPoints, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->fs_thaw(\e@mountPoints, \f(CW$flags\fR=0);" 4
.IX Item "$dom->fs_thaw(@mountPoints, $flags=0);"
Thaw all the filesystems associated with the \f(CW@mountPoints\fR
array reference. If <@mountPoints> is an empty list, then all
filesystems will be thawed. \f(CW$flags\fR is currently
unused and defaults to zero.
.ie n .IP "@fslist = $dom\->get_fs_info($flags=0);" 4
.el .IP "\f(CW@fslist\fR = \f(CW$dom\fR\->get_fs_info($flags=0);" 4
.IX Item "@fslist = $dom->get_fs_info($flags=0);"
Obtain a list of all guest filesystems. The returned list will
contain one element for each filesystem, whose value will be
a hash reference with the following keys
.RS 4
.IP "name" 4
.IX Item "name"
The name of the guest device that is mounted
.IP "fstype" 4
.IX Item "fstype"
The filesystem type (eg 'ext4', 'fat', 'ntfs', etc)
.IP "mountpoint" 4
.IX Item "mountpoint"
The location in the filesystem tree of the mount
.IP "devalias" 4
.IX Item "devalias"
An array reference containing list of device aliases
associated with the guest device. The device aliases
correspond to disk target names in the guest \s-1XML\s0
configuration
.RE
.RS 4
.RE
.ie n .IP "@nics = $dom\->get_interface_addresses($src, $flags=0);" 4
.el .IP "\f(CW@nics\fR = \f(CW$dom\fR\->get_interface_addresses($src, \f(CW$flags\fR=0);" 4
.IX Item "@nics = $dom->get_interface_addresses($src, $flags=0);"
Obtain a list of all guest network interfaces. The \f(CW$src\fR
parameter is one of the constants
.RS 4
.IP "Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_LEASE" 4
.IX Item "Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_LEASE"
Extract the \s-1DHCP\s0 server lease information
.IP "Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_AGENT" 4
.IX Item "Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_AGENT"
Query the guest \s-1OS\s0 via an agent
.IP "Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_ARP" 4
.IX Item "Sys::Virt::Domain::INTERFACE_ADDRESSES_SRC_ARP"
Extract from the local \s-1ARP\s0 tables
.RE
.RS 4
.Sp
The returned list will contain one element for each interface.
The values in the list will be a hash reference with the
following keys
.IP "name" 4
.IX Item "name"
The name of the guest interface that is mounted
.IP "hwaddr" 4
.IX Item "hwaddr"
The hardware address, aka \s-1MAC,\s0 if available.
.IP "addrs" 4
.IX Item "addrs"
An array reference containing list of \s-1IP\s0 addresses
associated with the guest \s-1NIC.\s0 Each element in the
array is a further hash containing
.RS 4
.IP "addr" 4
.IX Item "addr"
The \s-1IP\s0 address string
.IP "prefix" 4
.IX Item "prefix"
The \s-1IP\s0 address network prefix
.IP "type" 4
.IX Item "type"
The \s-1IP\s0 address type (IPv4 vs IPv6)
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.ie n .IP "$dom\->send_process_signal($pid, $signum, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->send_process_signal($pid, \f(CW$signum\fR, \f(CW$flags\fR=0);" 4
.IX Item "$dom->send_process_signal($pid, $signum, $flags=0);"
Send the process \f(CW$pid\fR the signal \f(CW$signum\fR. The
\&\f(CW$signum\fR value must be one of the constants listed
later, not a \s-1POSIX\s0 or Linux signal value. \f(CW$flags\fR
is currently unused and defaults to zero.
.ie n .IP "$dom\->set_block_threshold($dev, $threshold, $flags=0);" 4
.el .IP "\f(CW$dom\fR\->set_block_threshold($dev, \f(CW$threshold\fR, \f(CW$flags\fR=0);" 4
.IX Item "$dom->set_block_threshold($dev, $threshold, $flags=0);"
Set the threshold level for delivering the
\&\s-1EVENT_ID_BLOCK_THRESHOLD\s0 if the device or backing chain element
described by \f(CW$dev\fR is written beyond the set \f(CW$threshold\fR
level. The threshold level is unset once the event fires. The
event might not be delivered at all if libvirtd was not running
at the moment when the threshold was reached.
.ie n .IP "$dom\->set_lifecycle_action($type, $action, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_lifecycle_action($type, \f(CW$action\fR, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_lifecycle_action($type, $action, $flags=0)"
Changes the actions of lifecycle events for domain represented as
<on_$type>$action</on_$type> in the domain \s-1XML.\s0
.ie n .IP "$info = $dom\->get_launch_security_info($flags=0)" 4
.el .IP "\f(CW$info\fR = \f(CW$dom\fR\->get_launch_security_info($flags=0)" 4
.IX Item "$info = $dom->get_launch_security_info($flags=0)"
Get information about the domain launch security policy. \f(CW$flags\fR
is currently unused and defaults to zero. The returned hash may
contain the following keys
.RS 4
.IP "Sys::Virt::Domain::LAUNCH_SECURITY_SEV_MEASUREMENT" 4
.IX Item "Sys::Virt::Domain::LAUNCH_SECURITY_SEV_MEASUREMENT"
The \s-1AMD SEV\s0 launch measurement
.RE
.RS 4
.RE
.ie n .IP "$info = $dom\->get_guest_info($types, $flags=0)" 4
.el .IP "\f(CW$info\fR = \f(CW$dom\fR\->get_guest_info($types, \f(CW$flags\fR=0)" 4
.IX Item "$info = $dom->get_guest_info($types, $flags=0)"
Get information about the domain guest configuration. The \f(CW$types\fR
parameter determines what pieces of information are returned and
should be the bitwise or of the following constants:
.RS 4
.IP "Sys::Virt::Domain::GUEST_INFO_USERS" 4
.IX Item "Sys::Virt::Domain::GUEST_INFO_USERS"
Active user information
.IP "Sys::Virt::Domain::GUEST_INFO_OS" 4
.IX Item "Sys::Virt::Domain::GUEST_INFO_OS"
Misc operating system information
.IP "Sys::Virt::Domain::GUEST_INFO_TIMEZONE" 4
.IX Item "Sys::Virt::Domain::GUEST_INFO_TIMEZONE"
The guest timezone
.IP "Sys::Virt::Domain::GUEST_INFO_HOSTNAME" 4
.IX Item "Sys::Virt::Domain::GUEST_INFO_HOSTNAME"
The guest hostname
.IP "Sys::Virt::Domain::GUEST_INFO_FILESYSTEM" 4
.IX Item "Sys::Virt::Domain::GUEST_INFO_FILESYSTEM"
Filesystem mount information
.IP "Sys::Virt::Domain::GUEST_INFO_DISKS" 4
.IX Item "Sys::Virt::Domain::GUEST_INFO_DISKS"
Block device information
.RE
.RS 4
.Sp
\&\f(CW$flags\fR is currently unused and defaults to zero.
.RE
.ie n .IP "$dom\->set_agent_response_timeout($timeout, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->set_agent_response_timeout($timeout, \f(CW$flags\fR=0)" 4
.IX Item "$dom->set_agent_response_timeout($timeout, $flags=0)"
Set the amount of time to wait for the agent to respond to a
command. \f(CW$timeout\fR is a positive integer representing the
number of seconds to wait, or one of the constants:
.RS 4
.IP "Sys::Virt::Domain::AGENT_RESPONSE_TIMEOUT_BLOCK" 4
.IX Item "Sys::Virt::Domain::AGENT_RESPONSE_TIMEOUT_BLOCK"
Wait forever with no timeout
.IP "Sys::Virt::Domain::AGENT_RESPONSE_TIMEOUT_NOWAIT" 4
.IX Item "Sys::Virt::Domain::AGENT_RESPONSE_TIMEOUT_NOWAIT"
Don't want at all, return immediately
.IP "Sys::Virt::Domain::AGENT_RESPONSE_TIMEOUT_DEFAULT" 4
.IX Item "Sys::Virt::Domain::AGENT_RESPONSE_TIMEOUT_DEFAULT"
Use the hypervisor driver's default timeout
.RE
.RS 4
.Sp
The \f(CW$flags\fR parameter is currently unused and defaults
to zero.
.RE
.ie n .IP "my @keys = $dom\->authorized_ssh_keys_get($user, $flags=0)" 4
.el .IP "my \f(CW@keys\fR = \f(CW$dom\fR\->authorized_ssh_keys_get($user, \f(CW$flags\fR=0)" 4
.IX Item "my @keys = $dom->authorized_ssh_keys_get($user, $flags=0)"
Retrieve the list of authorized \s-1SSH\s0 keys for the user account \f(CW$user\fR.
The \f(CW$flags\fR parameter is currently unused and defaults to zero.
.ie n .IP "$dom\->authorized_ssh_keys_set($user, \e@keys, $flags=0)" 4
.el .IP "\f(CW$dom\fR\->authorized_ssh_keys_set($user, \e@keys, \f(CW$flags\fR=0)" 4
.IX Item "$dom->authorized_ssh_keys_set($user, @keys, $flags=0)"
Update the list of authorized \s-1SSH\s0 keys for the user account \f(CW$user\fR.
The \f(CW@keys\fR parameter should be an array reference containing the
new keys, if any. The default behaviour is to set the authorized
\&\s-1SSH\s0 keys to the exact set specified in \f(CW@keys\fR. This can be modified
via the \f(CW$flags\fR parameter which takes the following constants
.RS 4
.IP "Sys::Virt::Domain::AUTHORIZED_SSH_KEYS_SET_APPEND" 4
.IX Item "Sys::Virt::Domain::AUTHORIZED_SSH_KEYS_SET_APPEND"
Append \f(CW@keys\fR to the current set of keys, rather than replacing
the existing keys.
.IP "Sys::Virt::Domain::AUTHORIZED_SSH_KEYS_SET_REMOVE" 4
.IX Item "Sys::Virt::Domain::AUTHORIZED_SSH_KEYS_SET_REMOVE"
Remove \f(CW@keys\fR from the current set of keys, rather than replacing
the existing keys. It is not an error if the keys do not exist.
.RE
.RS 4
.RE
.SH "CONSTANTS"
.IX Header "CONSTANTS"
A number of the APIs take a \f(CW\*(C`flags\*(C'\fR parameter. In most cases
passing a value of zero will be satisfactory. Some APIs, however,
accept named constants to alter their behaviour. This section
documents the current known constants.
.SS "\s-1DOMAIN STATE\s0"
.IX Subsection "DOMAIN STATE"
The domain state constants are useful in interpreting the
\&\f(CW\*(C`state\*(C'\fR key in the hash returned by the \f(CW\*(C`get_info\*(C'\fR method.
.IP "Sys::Virt::Domain::STATE_NOSTATE" 4
.IX Item "Sys::Virt::Domain::STATE_NOSTATE"
The domain is active, but is not running / blocked (eg idle)
.IP "Sys::Virt::Domain::STATE_RUNNING" 4
.IX Item "Sys::Virt::Domain::STATE_RUNNING"
The domain is active and running
.IP "Sys::Virt::Domain::STATE_BLOCKED" 4
.IX Item "Sys::Virt::Domain::STATE_BLOCKED"
The domain is active, but execution is blocked
.IP "Sys::Virt::Domain::STATE_PAUSED" 4
.IX Item "Sys::Virt::Domain::STATE_PAUSED"
The domain is active, but execution has been paused
.IP "Sys::Virt::Domain::STATE_SHUTDOWN" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTDOWN"
The domain is active, but in the shutdown phase
.IP "Sys::Virt::Domain::STATE_SHUTOFF" 4
.IX Item "Sys::Virt::Domain::STATE_SHUTOFF"
The domain is inactive, and shut down.
.IP "Sys::Virt::Domain::STATE_CRASHED" 4
.IX Item "Sys::Virt::Domain::STATE_CRASHED"
The domain is inactive, and crashed.
.IP "Sys::Virt::Domain::STATE_PMSUSPENDED" 4
.IX Item "Sys::Virt::Domain::STATE_PMSUSPENDED"
The domain is active, but in power management suspend state
.SS "\s-1CONTROL INFO\s0"
.IX Subsection "CONTROL INFO"
The following constants can be used to determine what the
guest domain control channel status is
.IP "Sys::Virt::Domain::CONTROL_ERROR" 4
.IX Item "Sys::Virt::Domain::CONTROL_ERROR"
The control channel has a fatal error
.IP "Sys::Virt::Domain::CONTROL_OK" 4
.IX Item "Sys::Virt::Domain::CONTROL_OK"
The control channel is ready for jobs
.IP "Sys::Virt::Domain::CONTROL_OCCUPIED" 4
.IX Item "Sys::Virt::Domain::CONTROL_OCCUPIED"
The control channel is busy
.IP "Sys::Virt::Domain::CONTROL_JOB" 4
.IX Item "Sys::Virt::Domain::CONTROL_JOB"
The control channel is busy with a job
.PP
If the status is \f(CW\*(C`Sys::Virt::Domain::CONTROL_ERROR\*(C'\fR, then one
of the following constants describes the reason
.IP "Sys::Virt::Domain::CONTROL_ERROR_REASON_NONE" 4
.IX Item "Sys::Virt::Domain::CONTROL_ERROR_REASON_NONE"
There is no reason for the error available
.IP "Sys::Virt::Domain::CONTROL_ERROR_REASON_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::CONTROL_ERROR_REASON_UNKNOWN"
The reason for the error is unknown
.IP "Sys::Virt::Domain::CONTROL_ERROR_REASON_INTERNAL" 4
.IX Item "Sys::Virt::Domain::CONTROL_ERROR_REASON_INTERNAL"
There was an internal error in libvirt
.IP "Sys::Virt::Domain::CONTROL_ERROR_REASON_MONITOR" 4
.IX Item "Sys::Virt::Domain::CONTROL_ERROR_REASON_MONITOR"
There was an error speaking to the monitor
.SS "\s-1DOMAIN CREATION\s0"
.IX Subsection "DOMAIN CREATION"
The following constants can be used to control the behaviour
of domain creation
.IP "Sys::Virt::Domain::START_PAUSED" 4
.IX Item "Sys::Virt::Domain::START_PAUSED"
Keep the guest vCPUs paused after starting the guest
.IP "Sys::Virt::Domain::START_AUTODESTROY" 4
.IX Item "Sys::Virt::Domain::START_AUTODESTROY"
Automatically destroy the guest when the connection is closed (or fails)
.IP "Sys::Virt::Domain::START_BYPASS_CACHE" 4
.IX Item "Sys::Virt::Domain::START_BYPASS_CACHE"
Do not use \s-1OS I/O\s0 cache if starting a domain with a saved state image
.IP "Sys::Virt::Domain::START_FORCE_BOOT" 4
.IX Item "Sys::Virt::Domain::START_FORCE_BOOT"
Boot the guest, even if there was a saved snapshot
.IP "Sys::Virt::Domain::START_VALIDATE" 4
.IX Item "Sys::Virt::Domain::START_VALIDATE"
Validate the \s-1XML\s0 document against the \s-1XML\s0 schema
.SS "\s-1DOMAIN DEFINE\s0"
.IX Subsection "DOMAIN DEFINE"
The following constants can be used to control the behaviour
of domain define operations
.IP "Sys::Virt::Domain::DEFINE_VALIDATE" 4
.IX Item "Sys::Virt::Domain::DEFINE_VALIDATE"
Validate the \s-1XML\s0 document against the \s-1XML\s0 schema
.SS "\s-1KEYCODE SETS\s0"
.IX Subsection "KEYCODE SETS"
The following constants define the set of supported keycode
sets
.IP "Sys::Virt::Domain::KEYCODE_SET_LINUX" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_LINUX"
The Linux event subsystem keycodes
.IP "Sys::Virt::Domain::KEYCODE_SET_XT" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_XT"
The original \s-1XT\s0 keycodes
.IP "Sys::Virt::Domain::KEYCODE_SET_ATSET1" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_ATSET1"
The \s-1AT\s0 Set1 keycodes (aka \s-1XT\s0)
.IP "Sys::Virt::Domain::KEYCODE_SET_ATSET2" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_ATSET2"
The \s-1AT\s0 Set2 keycodes (aka \s-1AT\s0)
.IP "Sys::Virt::Domain::KEYCODE_SET_ATSET3" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_ATSET3"
The \s-1AT\s0 Set3 keycodes (aka \s-1PS2\s0)
.IP "Sys::Virt::Domain::KEYCODE_SET_OSX" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_OSX"
The OS-X keycodes
.IP "Sys::Virt::Domain::KEYCODE_SET_XT_KBD" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_XT_KBD"
The \s-1XT\s0 keycodes from the Linux Keyboard driver
.IP "Sys::Virt::Domain::KEYCODE_SET_USB" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_USB"
The \s-1USB HID\s0 keycode set
.IP "Sys::Virt::Domain::KEYCODE_SET_WIN32" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_WIN32"
The Windows keycode set
.IP "Sys::Virt::Domain::KEYCODE_SET_QNUM" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_QNUM"
The \s-1XT\s0 keycode set, with the extended scancodes using the
high bit of the first byte, instead of the low bit of the
second byte.
.IP "Sys::Virt::Domain::KEYCODE_SET_RFB" 4
.IX Item "Sys::Virt::Domain::KEYCODE_SET_RFB"
A deprecated alias for \f(CW\*(C`Sys::Virt::Domain::KEYCODE_SET_QNUM\*(C'\fR
.SS "\s-1MEMORY PEEK\s0"
.IX Subsection "MEMORY PEEK"
The following constants can be used with the \f(CW\*(C`memory_peek\*(C'\fR
method's flags parameter
.IP "Sys::Virt::Domain::MEMORY_VIRTUAL" 4
.IX Item "Sys::Virt::Domain::MEMORY_VIRTUAL"
Indicates that the offset is using virtual memory addressing.
.IP "Sys::Virt::Domain::MEMORY_PHYSICAL" 4
.IX Item "Sys::Virt::Domain::MEMORY_PHYSICAL"
Indicates that the offset is using physical memory addressing.
.SS "\s-1VCPU STATE\s0"
.IX Subsection "VCPU STATE"
The following constants are useful when interpreting the
virtual \s-1CPU\s0 run state
.IP "Sys::Virt::Domain::VCPU_OFFLINE" 4
.IX Item "Sys::Virt::Domain::VCPU_OFFLINE"
The virtual \s-1CPU\s0 is not online
.IP "Sys::Virt::Domain::VCPU_RUNNING" 4
.IX Item "Sys::Virt::Domain::VCPU_RUNNING"
The virtual \s-1CPU\s0 is executing code
.IP "Sys::Virt::Domain::VCPU_BLOCKED" 4
.IX Item "Sys::Virt::Domain::VCPU_BLOCKED"
The virtual \s-1CPU\s0 is waiting to be scheduled
.SS "\s-1VCPU HOST PLACEMENT STATE\s0"
.IX Subsection "VCPU HOST PLACEMENT STATE"
The following constants are useful when interpreting the
virtual \s-1CPU\s0 host placement
.IP "Sys::Virt::Domain::VCPU_INFO_CPU_OFFLINE" 4
.IX Item "Sys::Virt::Domain::VCPU_INFO_CPU_OFFLINE"
The virtual \s-1CPU\s0 is not online
.IP "Sys::Virt::Domain::VCPU_INFO_CPU_UNAVAILABLE" 4
.IX Item "Sys::Virt::Domain::VCPU_INFO_CPU_UNAVAILABLE"
The virtual \s-1CPU\s0 placement is not available from this hypervisor
.SS "\s-1OPEN GRAPHICS CONSTANTS\s0"
.IX Subsection "OPEN GRAPHICS CONSTANTS"
The following constants are used when opening a connection
to the guest graphics server
.IP "Sys::Virt::Domain::OPEN_GRAPHICS_SKIPAUTH" 4
.IX Item "Sys::Virt::Domain::OPEN_GRAPHICS_SKIPAUTH"
Skip authentication of the client
.SS "\s-1OPEN CONSOLE CONSTANTS\s0"
.IX Subsection "OPEN CONSOLE CONSTANTS"
The following constants are used when opening a connection
to the guest console
.IP "Sys::Virt::Domain::OPEN_CONSOLE_FORCE" 4
.IX Item "Sys::Virt::Domain::OPEN_CONSOLE_FORCE"
Force opening of the console, disconnecting any other
open session
.IP "Sys::Virt::Domain::OPEN_CONSOLE_SAFE" 4
.IX Item "Sys::Virt::Domain::OPEN_CONSOLE_SAFE"
Check if the console driver supports safe operations
.SS "\s-1OPEN CHANNEL CONSTANTS\s0"
.IX Subsection "OPEN CHANNEL CONSTANTS"
The following constants are used when opening a connection
to the guest channel
.IP "Sys::Virt::Domain::OPEN_CHANNEL_FORCE" 4
.IX Item "Sys::Virt::Domain::OPEN_CHANNEL_FORCE"
Force opening of the channel, disconnecting any other
open session
.SS "\s-1XML DUMP OPTIONS\s0"
.IX Subsection "XML DUMP OPTIONS"
The following constants are used to control the information
included in the \s-1XML\s0 configuration dump
.IP "Sys::Virt::Domain::XML_INACTIVE" 4
.IX Item "Sys::Virt::Domain::XML_INACTIVE"
Report the persistent inactive configuration for the guest, even
if it is currently running.
.IP "Sys::Virt::Domain::XML_SECURE" 4
.IX Item "Sys::Virt::Domain::XML_SECURE"
Include security sensitive information in the \s-1XML\s0 dump, such as
passwords.
.IP "Sys::Virt::Domain::XML_UPDATE_CPU" 4
.IX Item "Sys::Virt::Domain::XML_UPDATE_CPU"
Update the \s-1CPU\s0 model definition to match the current executing
state.
.IP "Sys::Virt::Domain::XML_MIGRATABLE" 4
.IX Item "Sys::Virt::Domain::XML_MIGRATABLE"
Update the \s-1XML\s0 to allow migration to older versions of libvirt
.SS "\s-1DEVICE HOTPLUG OPTIONS\s0"
.IX Subsection "DEVICE HOTPLUG OPTIONS"
The following constants are used to control device hotplug
operations
.IP "Sys::Virt::Domain::DEVICE_MODIFY_CURRENT" 4
.IX Item "Sys::Virt::Domain::DEVICE_MODIFY_CURRENT"
Modify the domain in its current state
.IP "Sys::Virt::Domain::DEVICE_MODIFY_LIVE" 4
.IX Item "Sys::Virt::Domain::DEVICE_MODIFY_LIVE"
Modify only the live state of the domain
.IP "Sys::Virt::Domain::DEVICE_MODIFY_CONFIG" 4
.IX Item "Sys::Virt::Domain::DEVICE_MODIFY_CONFIG"
Modify only the persistent config of the domain
.IP "Sys::Virt::Domain::DEVICE_MODIFY_FORCE" 4
.IX Item "Sys::Virt::Domain::DEVICE_MODIFY_FORCE"
Force the device to be modified
.SS "\s-1MEMORY OPTIONS\s0"
.IX Subsection "MEMORY OPTIONS"
The following constants are used to control memory change
operations
.IP "Sys::Virt::Domain::MEM_CURRENT" 4
.IX Item "Sys::Virt::Domain::MEM_CURRENT"
Modify the current state
.IP "Sys::Virt::Domain::MEM_LIVE" 4
.IX Item "Sys::Virt::Domain::MEM_LIVE"
Modify only the live state of the domain
.IP "Sys::Virt::Domain::MEM_CONFIG" 4
.IX Item "Sys::Virt::Domain::MEM_CONFIG"
Modify only the persistent config of the domain
.IP "Sys::Virt::Domain::MEM_MAXIMUM" 4
.IX Item "Sys::Virt::Domain::MEM_MAXIMUM"
Modify the maximum memory value
.SS "\s-1CONFIG OPTIONS\s0"
.IX Subsection "CONFIG OPTIONS"
The following constants are used to control what configuration
a domain update changes
.IP "Sys::Virt::Domain::AFFECT_CURRENT" 4
.IX Item "Sys::Virt::Domain::AFFECT_CURRENT"
Modify the current state
.IP "Sys::Virt::Domain::AFFECT_LIVE" 4
.IX Item "Sys::Virt::Domain::AFFECT_LIVE"
Modify only the live state of the domain
.IP "Sys::Virt::Domain::AFFECT_CONFIG" 4
.IX Item "Sys::Virt::Domain::AFFECT_CONFIG"
Modify only the persistent config of the domain
.SS "\s-1MIGRATE OPTIONS\s0"
.IX Subsection "MIGRATE OPTIONS"
The following constants are used to control how migration
is performed
.IP "Sys::Virt::Domain::MIGRATE_LIVE" 4
.IX Item "Sys::Virt::Domain::MIGRATE_LIVE"
Migrate the guest without interrupting its execution on the source
host.
.IP "Sys::Virt::Domain::MIGRATE_PEER2PEER" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PEER2PEER"
Manage the migration process over a direct peer\-2\-peer connection between
the source and destination host libvirtd daemons.
.IP "Sys::Virt::Domain::MIGRATE_TUNNELLED" 4
.IX Item "Sys::Virt::Domain::MIGRATE_TUNNELLED"
Tunnel the migration data over the libvirt daemon connection, rather
than the native hypervisor data transport. Requires \s-1PEER2PEER\s0 flag to
be set.
.IP "Sys::Virt::Domain::MIGRATE_PERSIST_DEST" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PERSIST_DEST"
Make the domain persistent on the destination host, defining its
configuration file upon completion of migration.
.IP "Sys::Virt::Domain::MIGRATE_UNDEFINE_SOURCE" 4
.IX Item "Sys::Virt::Domain::MIGRATE_UNDEFINE_SOURCE"
Remove the domain's persistent configuration after migration
completes successfully.
.IP "Sys::Virt::Domain::MIGRATE_PAUSED" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PAUSED"
Do not re-start execution of the guest CPUs on the destination
host after migration completes.
.IP "Sys::Virt::Domain::MIGRATE_NON_SHARED_DISK" 4
.IX Item "Sys::Virt::Domain::MIGRATE_NON_SHARED_DISK"
Copy the complete contents of the disk images during migration
.IP "Sys::Virt::Domain::MIGRATE_NON_SHARED_INC" 4
.IX Item "Sys::Virt::Domain::MIGRATE_NON_SHARED_INC"
Copy the incrementally changed contents of the disk images
during migration
.IP "Sys::Virt::Domain::MIGRATE_CHANGE_PROTECTION" 4
.IX Item "Sys::Virt::Domain::MIGRATE_CHANGE_PROTECTION"
Do not allow changes to the virtual domain configuration while
migration is taking place. This option is automatically implied
if doing a peer\-2\-peer migration.
.IP "Sys::Virt::Domain::MIGRATE_UNSAFE" 4
.IX Item "Sys::Virt::Domain::MIGRATE_UNSAFE"
Migrate even if the compatibility check indicates the migration
will be unsafe to the guest.
.IP "Sys::Virt::Domain::MIGRATE_OFFLINE" 4
.IX Item "Sys::Virt::Domain::MIGRATE_OFFLINE"
Migrate the guest config if the guest is not currently running
.IP "Sys::Virt::Domain::MIGRATE_COMPRESSED" 4
.IX Item "Sys::Virt::Domain::MIGRATE_COMPRESSED"
Enable compression of the migration data stream
.IP "Sys::Virt::Domain::MIGRATE_ABORT_ON_ERROR" 4
.IX Item "Sys::Virt::Domain::MIGRATE_ABORT_ON_ERROR"
Abort if an I/O error occurrs on the disk
.IP "Sys::Virt::Domain::MIGRATE_AUTO_CONVERGE" 4
.IX Item "Sys::Virt::Domain::MIGRATE_AUTO_CONVERGE"
Force convergance of the migration operation by
throttling guest runtime
.IP "Sys::Virt::Domain::MIGRATE_RDMA_PIN_ALL" 4
.IX Item "Sys::Virt::Domain::MIGRATE_RDMA_PIN_ALL"
Pin memory for \s-1RDMA\s0 transfer
.IP "Sys::Virt::Domain::MIGRATE_POSTCOPY" 4
.IX Item "Sys::Virt::Domain::MIGRATE_POSTCOPY"
Enable support for post-copy migration
.IP "Sys::Virt::Domain::MIGRATE_TLS" 4
.IX Item "Sys::Virt::Domain::MIGRATE_TLS"
Setting this flag will cause the migration to attempt to use the
\&\s-1TLS\s0 environment configured by the hypervisor in order to perform
the migration. If incorrectly configured on either source or
destination, the migration will fail.
.IP "Sys::Virt::Domain::MIGRATE_PARALLEL" 4
.IX Item "Sys::Virt::Domain::MIGRATE_PARALLEL"
Send memory pages to the destination host through several network
connections. See \f(CW\*(C`Sys::Virt::Domain::MIGRATE_PARAM_PARALLEL_*\*(C'\fR
parameters for configuring the parallel migration.
.SS "\s-1UNDEFINE CONSTANTS\s0"
.IX Subsection "UNDEFINE CONSTANTS"
The following constants can be used when undefining virtual
domain configurations
.IP "Sys::Virt::Domain::UNDEFINE_MANAGED_SAVE" 4
.IX Item "Sys::Virt::Domain::UNDEFINE_MANAGED_SAVE"
Also remove any managed save image when undefining the virtual
domain
.IP "Sys::Virt::Domain::UNDEFINE_SNAPSHOTS_METADATA" 4
.IX Item "Sys::Virt::Domain::UNDEFINE_SNAPSHOTS_METADATA"
Also remove any snapshot metadata when undefining the virtual
domain.
.IP "Sys::Virt::Domain::UNDEFINE_NVRAM" 4
.IX Item "Sys::Virt::Domain::UNDEFINE_NVRAM"
Also remove any \s-1NVRAM\s0 state file when undefining the virtual
domain.
.IP "Sys::Virt::Domain::UNDEFINE_KEEP_NVRAM" 4
.IX Item "Sys::Virt::Domain::UNDEFINE_KEEP_NVRAM"
keep \s-1NVRAM\s0 state file when undefining the virtual
domain.
.IP "Sys::Virt::Domain::UNDEFINE_CHECKPOINTS_METADATA" 4
.IX Item "Sys::Virt::Domain::UNDEFINE_CHECKPOINTS_METADATA"
Also remove any checkpoint metadata when undefining the virtual
domain.
.SS "\s-1JOB TYPES\s0"
.IX Subsection "JOB TYPES"
The following constants describe the different background job
types.
.IP "Sys::Virt::Domain::JOB_NONE" 4
.IX Item "Sys::Virt::Domain::JOB_NONE"
No job is active
.IP "Sys::Virt::Domain::JOB_BOUNDED" 4
.IX Item "Sys::Virt::Domain::JOB_BOUNDED"
A job with a finite completion time is active
.IP "Sys::Virt::Domain::JOB_UNBOUNDED" 4
.IX Item "Sys::Virt::Domain::JOB_UNBOUNDED"
A job with an unbounded completion time is active
.IP "Sys::Virt::Domain::JOB_COMPLETED" 4
.IX Item "Sys::Virt::Domain::JOB_COMPLETED"
The job has finished, but isn't cleaned up
.IP "Sys::Virt::Domain::JOB_FAILED" 4
.IX Item "Sys::Virt::Domain::JOB_FAILED"
The job has hit an error, but isn't cleaned up
.IP "Sys::Virt::Domain::JOB_CANCELLED" 4
.IX Item "Sys::Virt::Domain::JOB_CANCELLED"
The job was aborted at user request, but isn't cleaned up
.SS "\s-1MEMORY PARAMETERS\s0"
.IX Subsection "MEMORY PARAMETERS"
The following constants are useful when getting/setting
memory parameters for guests
.IP "Sys::Virt::Domain::MEMORY_HARD_LIMIT" 4
.IX Item "Sys::Virt::Domain::MEMORY_HARD_LIMIT"
The maximum memory the guest can use.
.IP "Sys::Virt::Domain::MEMORY_SOFT_LIMIT" 4
.IX Item "Sys::Virt::Domain::MEMORY_SOFT_LIMIT"
The memory upper limit enforced during memory contention.
.IP "Sys::Virt::Domain::MEMORY_MIN_GUARANTEE" 4
.IX Item "Sys::Virt::Domain::MEMORY_MIN_GUARANTEE"
The minimum memory guaranteed to be reserved for the guest.
.IP "Sys::Virt::Domain::MEMORY_SWAP_HARD_LIMIT" 4
.IX Item "Sys::Virt::Domain::MEMORY_SWAP_HARD_LIMIT"
The maximum swap the guest can use.
.IP "Sys::Virt::Domain::MEMORY_PARAM_UNLIMITED" 4
.IX Item "Sys::Virt::Domain::MEMORY_PARAM_UNLIMITED"
The value of an unlimited memory parameter
.SS "\s-1BLKIO PARAMETERS\s0"
.IX Subsection "BLKIO PARAMETERS"
The following parameters control I/O tuning for the domain
as a whole
.IP "Sys::Virt::Domain::BLKIO_WEIGHT" 4
.IX Item "Sys::Virt::Domain::BLKIO_WEIGHT"
The I/O weight parameter
.IP "Sys::Virt::Domain::BLKIO_DEVICE_WEIGHT" 4
.IX Item "Sys::Virt::Domain::BLKIO_DEVICE_WEIGHT"
The per-device I/O weight parameter
.IP "Sys::Virt::Domain::BLKIO_DEVICE_READ_BPS" 4
.IX Item "Sys::Virt::Domain::BLKIO_DEVICE_READ_BPS"
The per-device I/O bytes read per second
.IP "Sys::Virt::Domain::BLKIO_DEVICE_READ_IOPS" 4
.IX Item "Sys::Virt::Domain::BLKIO_DEVICE_READ_IOPS"
The per-device I/O operations read per second
.IP "Sys::Virt::Domain::BLKIO_DEVICE_WRITE_BPS" 4
.IX Item "Sys::Virt::Domain::BLKIO_DEVICE_WRITE_BPS"
The per-device I/O bytes write per second
.IP "Sys::Virt::Domain::BLKIO_DEVICE_WRITE_IOPS" 4
.IX Item "Sys::Virt::Domain::BLKIO_DEVICE_WRITE_IOPS"
The per-device I/O operations write per second
.SS "\s-1BLKIO TUNING PARAMETERS\s0"
.IX Subsection "BLKIO TUNING PARAMETERS"
The following parameters control I/O tuning for an individual
guest disk.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC"
The total bytes processed per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC"
The bytes read per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC"
The bytes written per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC"
The total I/O operations processed per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC"
The I/O operations read per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC"
The I/O operations written per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX"
The maximum total bytes processed per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX"
The maximum bytes read per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX"
The maximum bytes written per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX"
The maximum total I/O operations processed per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX"
The maximum I/O operations read per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX"
The maximum I/O operations written per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_SIZE_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_SIZE_IOPS_SEC"
The maximum I/O operations per second
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_GROUP_NAME" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_GROUP_NAME"
A string representing a group name to allow sharing of I/O
throttling quota between multiple drives
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum total bytes processed per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum bytes read per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum bytes written per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum total I/O operations processed
per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum I/O operations read per second.
.IP "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum I/O operations written per second.
.SS "\s-1SCHEDULER CONSTANTS\s0"
.IX Subsection "SCHEDULER CONSTANTS"
.IP "Sys::Virt::Domain::SCHEDULER_CAP" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_CAP"
The \s-1VM\s0 cap tunable
.IP "Sys::Virt::Domain::SCHEDULER_CPU_SHARES" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_CPU_SHARES"
The \s-1CPU\s0 shares tunable
.IP "Sys::Virt::Domain::SCHEDULER_LIMIT" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_LIMIT"
The \s-1VM\s0 limit tunable
.IP "Sys::Virt::Domain::SCHEDULER_RESERVATION" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_RESERVATION"
The \s-1VM\s0 reservation tunable
.IP "Sys::Virt::Domain::SCHEDULER_SHARES" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_SHARES"
The \s-1VM\s0 shares tunable
.IP "Sys::Virt::Domain::SCHEDULER_VCPU_PERIOD" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_VCPU_PERIOD"
The \s-1VCPU\s0 period tunable
.IP "Sys::Virt::Domain::SCHEDULER_VCPU_QUOTA" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_VCPU_QUOTA"
The \s-1VCPU\s0 quota tunable
.IP "Sys::Virt::Domain::SCHEDULER_GLOBAL_PERIOD" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_GLOBAL_PERIOD"
The \s-1VM\s0 global period tunable
.IP "Sys::Virt::Domain::SCHEDULER_GLOBAL_QUOTA" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_GLOBAL_QUOTA"
The \s-1VM\s0 global quota tunable
.IP "Sys::Virt::Domain::SCHEDULER_WEIGHT" 4
.IX Item "Sys::Virt::Domain::SCHEDULER_WEIGHT"
The \s-1VM\s0 weight tunable
.SS "\s-1NUMA PARAMETERS\s0"
.IX Subsection "NUMA PARAMETERS"
The following constants are useful when getting/setting the
guest \s-1NUMA\s0 memory policy
.IP "Sys::Virt::Domain::NUMA_MODE" 4
.IX Item "Sys::Virt::Domain::NUMA_MODE"
The \s-1NUMA\s0 policy mode
.IP "Sys::Virt::Domain::NUMA_NODESET" 4
.IX Item "Sys::Virt::Domain::NUMA_NODESET"
The \s-1NUMA\s0 nodeset mask
.PP
The following constants are useful when interpreting the
\&\f(CW\*(C`Sys::Virt::Domain::NUMA_MODE\*(C'\fR parameter value
.IP "Sys::Virt::Domain::NUMATUNE_MEM_STRICT" 4
.IX Item "Sys::Virt::Domain::NUMATUNE_MEM_STRICT"
Allocation is mandatory from the mask nodes
.IP "Sys::Virt::Domain::NUMATUNE_MEM_PREFERRED" 4
.IX Item "Sys::Virt::Domain::NUMATUNE_MEM_PREFERRED"
Allocation is preferred from the masked nodes
.IP "Sys::Virt::Domain::NUMATUNE_MEM_INTERLEAVE" 4
.IX Item "Sys::Virt::Domain::NUMATUNE_MEM_INTERLEAVE"
Allocation is interleaved across all masked nods
.SS "\s-1INTERFACE PARAMETERS\s0"
.IX Subsection "INTERFACE PARAMETERS"
The following constants are useful when getting/setting the
per network interface tunable parameters
.IP "Sys::Virt::Domain::BANDWIDTH_IN_AVERAGE" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_IN_AVERAGE"
The average inbound bandwidth
.IP "Sys::Virt::Domain::BANDWIDTH_IN_PEAK" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_IN_PEAK"
The peak inbound bandwidth
.IP "Sys::Virt::Domain::BANDWIDTH_IN_BURST" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_IN_BURST"
The burstable inbound bandwidth
.IP "Sys::Virt::Domain::BANDWIDTH_IN_FLOOR" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_IN_FLOOR"
The minimum inbound bandwidth
.IP "Sys::Virt::Domain::BANDWIDTH_OUT_AVERAGE" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_OUT_AVERAGE"
The average outbound bandwidth
.IP "Sys::Virt::Domain::BANDWIDTH_OUT_PEAK" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_OUT_PEAK"
The peak outbound bandwidth
.IP "Sys::Virt::Domain::BANDWIDTH_OUT_BURST" 4
.IX Item "Sys::Virt::Domain::BANDWIDTH_OUT_BURST"
The burstable outbound bandwidth
.SS "\s-1PERF EVENTS\s0"
.IX Subsection "PERF EVENTS"
The following constants defined performance events
which can be monitored for a guest
.IP "Sys::Virt::Domain::PERF_PARAM_CMT" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CMT"
The \s-1CMT\s0 event counter which can be used to measure the usage of
cache (bytes) by applications running on the platform. It
corresponds to the \*(L"perf.cmt\*(R" field in the *Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_MBML" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_MBML"
The \s-1MBML\s0 event counter which can be used to monitor the amount of
data (bytes/s) sent through the memory controller on the socket.
It corresponds to the \*(L"perf.mbml\*(R" field in the *Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_MBMT" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_MBMT"
The \s-1MBMT\s0 event counter which can be used to monitor total system
bandwidth (bytes/s) from one level of cache to another. It
corresponds to the \*(L"perf.mbmt\*(R" field in the *Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_CACHE_MISSES" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CACHE_MISSES"
The cache_misses perf event counter which can be used to measure
the count of cache misses by applications running on the
platform. It corresponds to the \*(L"perf.cache_misses\*(R" field in the
*Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_CACHE_REFERENCES" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CACHE_REFERENCES"
The cache_references perf event counter which can be used to
measure the count of cache hits by applications running on the
platform. It corresponds to the \*(L"perf.cache_references\*(R" field in
the *Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_CPU_CYCLES" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CPU_CYCLES"
The cpu_cycles perf event counter which can be used to measure
how many cpu cycles one instruction needs.  It corresponds to the
\&\*(L"perf.cpu_cycles\*(R" field in the *Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_INSTRUCTIONS" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_INSTRUCTIONS"
The instructions perf event counter which can be used to measure
the count of instructions by applications running on the
platform. It corresponds to the \*(L"perf.instructions\*(R" field in the
*Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_BRANCH_INSTRUCTIONS" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_BRANCH_INSTRUCTIONS"
The branch_instructions perf event counter which can be used to measure
the count of instructions by applications running on the
platform. It corresponds to the \*(L"perf.branch_instructions\*(R" field in the
*Stats APIs.
.IP "Sys::Virt::Domain::PERF_PARAM_BRANCH_MISSES" 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_BRANCH_MISSES"
The branch_misses perf event which can be used to measure the
count of branch misses by applications running on the platform.
It corresponds to the \*(L"perf.branch_misses\*(R" field in the *Stats
APIs.
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_BUS_CYCLES The bus_cycles perf event counter which can be used to measure the count of bus cycles by applications running on the platform. It corresponds to the ""perf.bus_cycles"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_BUS_CYCLES The bus_cycles perf event counter which can be used to measure the count of bus cycles by applications running on the platform. It corresponds to the ``perf.bus_cycles'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_BUS_CYCLES The bus_cycles perf event counter which can be used to measure the count of bus cycles by applications running on the platform. It corresponds to the perf.bus_cycles field in the *Stats APIs."
.PD 0
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_FRONTEND The stalled_cycles_frontend perf event counter which can be used to measure the count of stalled cpu cycles in the frontend of the instruction processor pipeline by applications running on the platform. It corresponds to the ""perf.stalled_cycles_frontend"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_FRONTEND The stalled_cycles_frontend perf event counter which can be used to measure the count of stalled cpu cycles in the frontend of the instruction processor pipeline by applications running on the platform. It corresponds to the ``perf.stalled_cycles_frontend'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_FRONTEND The stalled_cycles_frontend perf event counter which can be used to measure the count of stalled cpu cycles in the frontend of the instruction processor pipeline by applications running on the platform. It corresponds to the perf.stalled_cycles_frontend field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_BACKEND The stalled_cycles_backend perf event counter which can be used to measure the count of stalled cpu cycles in the backend of the instruction processor pipeline by application running on the platform. It corresponds to the ""perf.stalled_cycles_backend"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_BACKEND The stalled_cycles_backend perf event counter which can be used to measure the count of stalled cpu cycles in the backend of the instruction processor pipeline by application running on the platform. It corresponds to the ``perf.stalled_cycles_backend'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_STALLED_CYCLES_BACKEND The stalled_cycles_backend perf event counter which can be used to measure the count of stalled cpu cycles in the backend of the instruction processor pipeline by application running on the platform. It corresponds to the perf.stalled_cycles_backend field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_REF_CPU_CYCLES The ref_cpu_cycles perf event counter which can be used to measure the count of total cpu cycles not affected by \s-1CPU\s0 frequency scaling by applications running on the platform. It corresponds to the ""perf.ref_cpu_cycles"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_REF_CPU_CYCLES The ref_cpu_cycles perf event counter which can be used to measure the count of total cpu cycles not affected by \s-1CPU\s0 frequency scaling by applications running on the platform. It corresponds to the ``perf.ref_cpu_cycles'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_REF_CPU_CYCLES The ref_cpu_cycles perf event counter which can be used to measure the count of total cpu cycles not affected by CPU frequency scaling by applications running on the platform. It corresponds to the perf.ref_cpu_cycles field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_CPU_CLOCK The cpu_clock perf event counter which can be used to measure the count of cpu clock time by applications running on the platform. It corresponds to the ""perf.cpu_clock"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_CPU_CLOCK The cpu_clock perf event counter which can be used to measure the count of cpu clock time by applications running on the platform. It corresponds to the ``perf.cpu_clock'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CPU_CLOCK The cpu_clock perf event counter which can be used to measure the count of cpu clock time by applications running on the platform. It corresponds to the perf.cpu_clock field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_TASK_CLOCK The task_clock perf event counter which can be used to measure the count of task clock time by applications running on the platform. It corresponds to the ""perf.task_clock"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_TASK_CLOCK The task_clock perf event counter which can be used to measure the count of task clock time by applications running on the platform. It corresponds to the ``perf.task_clock'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_TASK_CLOCK The task_clock perf event counter which can be used to measure the count of task clock time by applications running on the platform. It corresponds to the perf.task_clock field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS The page_faults perf event counter which can be used to measure the count of page faults by applications running on the platform. It corresponds to the ""perf.page_faults"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS The page_faults perf event counter which can be used to measure the count of page faults by applications running on the platform. It corresponds to the ``perf.page_faults'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS The page_faults perf event counter which can be used to measure the count of page faults by applications running on the platform. It corresponds to the perf.page_faults field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_CONTEXT_SWITCHES The context_switches perf event counter which can be used to measure the count of context switches by applications running on the platform. It corresponds to the ""perf.context_switches"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_CONTEXT_SWITCHES The context_switches perf event counter which can be used to measure the count of context switches by applications running on the platform. It corresponds to the ``perf.context_switches'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CONTEXT_SWITCHES The context_switches perf event counter which can be used to measure the count of context switches by applications running on the platform. It corresponds to the perf.context_switches field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_CPU_MIGRATIONS The cpu_migrations perf event counter which can be used to measure the count of cpu migrations by applications running on the platform. It corresponds to the ""perf.cpu_migrations"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_CPU_MIGRATIONS The cpu_migrations perf event counter which can be used to measure the count of cpu migrations by applications running on the platform. It corresponds to the ``perf.cpu_migrations'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_CPU_MIGRATIONS The cpu_migrations perf event counter which can be used to measure the count of cpu migrations by applications running on the platform. It corresponds to the perf.cpu_migrations field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MIN The page_faults_min perf event counter which can be used to measure the count of minor page faults by applications running on the platform. It corresponds to the ""perf.page_faults_min"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MIN The page_faults_min perf event counter which can be used to measure the count of minor page faults by applications running on the platform. It corresponds to the ``perf.page_faults_min'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MIN The page_faults_min perf event counter which can be used to measure the count of minor page faults by applications running on the platform. It corresponds to the perf.page_faults_min field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MAJ The page_faults_maj perf event counter which can be used to measure the count of major page faults by applications running on the platform. It corresponds to the ""perf.page_faults_maj"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MAJ The page_faults_maj perf event counter which can be used to measure the count of major page faults by applications running on the platform. It corresponds to the ``perf.page_faults_maj'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_PAGE_FAULTS_MAJ The page_faults_maj perf event counter which can be used to measure the count of major page faults by applications running on the platform. It corresponds to the perf.page_faults_maj field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_ALIGNMENT_FAULTS The alignment_faults perf event counter which can be used to measure the count of alignment faults by applications running on the platform. It corresponds to the ""perf.alignment_faults"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_ALIGNMENT_FAULTS The alignment_faults perf event counter which can be used to measure the count of alignment faults by applications running on the platform. It corresponds to the ``perf.alignment_faults'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_ALIGNMENT_FAULTS The alignment_faults perf event counter which can be used to measure the count of alignment faults by applications running on the platform. It corresponds to the perf.alignment_faults field in the *Stats APIs."
.ie n .IP "Sys::Virt::Domain::PERF_PARAM_EMULATION_FAULTS The emulation_faults perf event counter which can be used to measure the count of emulation faults by applications running on the platform. It corresponds to the ""perf.emulation_faults"" field in the *Stats APIs." 4
.el .IP "Sys::Virt::Domain::PERF_PARAM_EMULATION_FAULTS The emulation_faults perf event counter which can be used to measure the count of emulation faults by applications running on the platform. It corresponds to the ``perf.emulation_faults'' field in the *Stats APIs." 4
.IX Item "Sys::Virt::Domain::PERF_PARAM_EMULATION_FAULTS The emulation_faults perf event counter which can be used to measure the count of emulation faults by applications running on the platform. It corresponds to the perf.emulation_faults field in the *Stats APIs."
.PD
.SS "\s-1IOTHREAD STATS\s0"
.IX Subsection "IOTHREAD STATS"
The following constants defined IOThread statistics which
can be monitored for a guest
.IP "Sys::Virt::Domain::IOTHREAD_PARAM_POLL_MAX_NS" 4
.IX Item "Sys::Virt::Domain::IOTHREAD_PARAM_POLL_MAX_NS"
The maximum polling time that can be used by polling algorithm in ns.
The polling time starts at 0 (zero) and is the time spent by the guest
to process IOThread data before returning the \s-1CPU\s0 to the host. The
polling time will be dynamically modified over time based on the
poll_grow and poll_shrink parameters provided.
.IP "Sys::Virt::Domain::IOTHREAD_PARAM_POLL_GROW" 4
.IX Item "Sys::Virt::Domain::IOTHREAD_PARAM_POLL_GROW"
This provides a value for the dynamic polling adjustment algorithm to
use to grow its polling interval up to the poll_max_ns value.
.IP "Sys::Virt::Domain::IOTHREAD_PARAM_POLL_SHRINK" 4
.IX Item "Sys::Virt::Domain::IOTHREAD_PARAM_POLL_SHRINK"
This provides a value for the dynamic polling adjustment algorithm to
use to shrink its polling interval when the polling interval exceeds
the poll_max_ns value.
.SS "\s-1VCPU FLAGS\s0"
.IX Subsection "VCPU FLAGS"
The following constants are useful when getting/setting the
\&\s-1VCPU\s0 count for a guest
.IP "Sys::Virt::Domain::VCPU_LIVE" 4
.IX Item "Sys::Virt::Domain::VCPU_LIVE"
Flag to request the live value
.IP "Sys::Virt::Domain::VCPU_CONFIG" 4
.IX Item "Sys::Virt::Domain::VCPU_CONFIG"
Flag to request the persistent config value
.IP "Sys::Virt::Domain::VCPU_CURRENT" 4
.IX Item "Sys::Virt::Domain::VCPU_CURRENT"
Flag to request the current config value
.IP "Sys::Virt::Domain::VCPU_MAXIMUM" 4
.IX Item "Sys::Virt::Domain::VCPU_MAXIMUM"
Flag to request adjustment of the maximum vCPU value
.IP "Sys::Virt::Domain::VCPU_GUEST" 4
.IX Item "Sys::Virt::Domain::VCPU_GUEST"
Flag to request the guest \s-1VCPU\s0 mask
.IP "Sys::Virt::Domain::VCPU_HOTPLUGGABLE" 4
.IX Item "Sys::Virt::Domain::VCPU_HOTPLUGGABLE"
Flag to make vcpus added hot(un)pluggable
.SS "\s-1STATE CHANGE EVENTS\s0"
.IX Subsection "STATE CHANGE EVENTS"
The following constants allow domain state change events to be
interpreted. The events contain both a state change, and a
reason.
.IP "Sys::Virt::Domain::EVENT_DEFINED" 4
.IX Item "Sys::Virt::Domain::EVENT_DEFINED"
Indicates that a persistent configuration has been defined for
the domain.
.RS 4
.IP "Sys::Virt::Domain::EVENT_DEFINED_ADDED" 4
.IX Item "Sys::Virt::Domain::EVENT_DEFINED_ADDED"
The defined configuration is newly added
.IP "Sys::Virt::Domain::EVENT_DEFINED_UPDATED" 4
.IX Item "Sys::Virt::Domain::EVENT_DEFINED_UPDATED"
The defined configuration is an update to an existing configuration
.IP "Sys::Virt::Domain::EVENT_DEFINED_RENAMED" 4
.IX Item "Sys::Virt::Domain::EVENT_DEFINED_RENAMED"
The defined configuration is a rename of an existing configuration
.IP "Sys::Virt::Domain::EVENT_DEFINED_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::EVENT_DEFINED_FROM_SNAPSHOT"
The defined configuration was restored from a snapshot
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_RESUMED" 4
.IX Item "Sys::Virt::Domain::EVENT_RESUMED"
The domain has resumed execution
.RS 4
.IP "Sys::Virt::Domain::EVENT_RESUMED_MIGRATED" 4
.IX Item "Sys::Virt::Domain::EVENT_RESUMED_MIGRATED"
The domain resumed because migration has completed. This is
emitted on the destination host.
.IP "Sys::Virt::Domain::EVENT_RESUMED_UNPAUSED" 4
.IX Item "Sys::Virt::Domain::EVENT_RESUMED_UNPAUSED"
The domain resumed because the admin unpaused it.
.IP "Sys::Virt::Domain::EVENT_RESUMED_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::EVENT_RESUMED_FROM_SNAPSHOT"
The domain resumed because it was restored from a snapshot
.IP "Sys::Virt::Domain::EVENT_RESUMED_POSTCOPY" 4
.IX Item "Sys::Virt::Domain::EVENT_RESUMED_POSTCOPY"
The domain resumed but post-copy is running in background
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_STARTED" 4
.IX Item "Sys::Virt::Domain::EVENT_STARTED"
The domain has started running
.RS 4
.IP "Sys::Virt::Domain::EVENT_STARTED_BOOTED" 4
.IX Item "Sys::Virt::Domain::EVENT_STARTED_BOOTED"
The domain was booted from shutoff state
.IP "Sys::Virt::Domain::EVENT_STARTED_MIGRATED" 4
.IX Item "Sys::Virt::Domain::EVENT_STARTED_MIGRATED"
The domain started due to an incoming migration
.IP "Sys::Virt::Domain::EVENT_STARTED_RESTORED" 4
.IX Item "Sys::Virt::Domain::EVENT_STARTED_RESTORED"
The domain was restored from saved state file
.IP "Sys::Virt::Domain::EVENT_STARTED_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::EVENT_STARTED_FROM_SNAPSHOT"
The domain was restored from a snapshot
.IP "Sys::Virt::Domain::EVENT_STARTED_WAKEUP" 4
.IX Item "Sys::Virt::Domain::EVENT_STARTED_WAKEUP"
The domain was woken up from suspend
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_STOPPED" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED"
The domain has stopped running
.RS 4
.IP "Sys::Virt::Domain::EVENT_STOPPED_CRASHED" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_CRASHED"
The domain stopped because guest operating system has crashed
.IP "Sys::Virt::Domain::EVENT_STOPPED_DESTROYED" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_DESTROYED"
The domain stopped because administrator issued a destroy
command.
.IP "Sys::Virt::Domain::EVENT_STOPPED_FAILED" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_FAILED"
The domain stopped because of a fault in the host virtualization
environment.
.IP "Sys::Virt::Domain::EVENT_STOPPED_MIGRATED" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_MIGRATED"
The domain stopped because it was migrated to another machine.
.IP "Sys::Virt::Domain::EVENT_STOPPED_SAVED" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_SAVED"
The domain was saved to a state file
.IP "Sys::Virt::Domain::EVENT_STOPPED_SHUTDOWN" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_SHUTDOWN"
The domain stopped due to graceful shutdown of the guest.
.IP "Sys::Virt::Domain::EVENT_STOPPED_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::EVENT_STOPPED_FROM_SNAPSHOT"
The domain was stopped due to a snapshot
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_SHUTDOWN" 4
.IX Item "Sys::Virt::Domain::EVENT_SHUTDOWN"
The domain has shutdown but is not yet stopped
.RS 4
.IP "Sys::Virt::Domain::EVENT_SHUTDOWN_FINISHED" 4
.IX Item "Sys::Virt::Domain::EVENT_SHUTDOWN_FINISHED"
The domain finished shutting down
.IP "Sys::Virt::Domain::EVENT_SHUTDOWN_HOST" 4
.IX Item "Sys::Virt::Domain::EVENT_SHUTDOWN_HOST"
The domain shutdown due to host trigger
.IP "Sys::Virt::Domain::EVENT_SHUTDOWN_GUEST" 4
.IX Item "Sys::Virt::Domain::EVENT_SHUTDOWN_GUEST"
The domain shutdown due to guest trigger
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_SUSPENDED" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED"
The domain has stopped executing, but still exists
.RS 4
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_MIGRATED" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_MIGRATED"
The domain has been suspended due to offline migration
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_PAUSED" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_PAUSED"
The domain has been suspended due to administrator pause
request.
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_IOERROR" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_IOERROR"
The domain has been suspended due to a block device I/O
error.
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_FROM_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_FROM_SNAPSHOT"
The domain has been suspended due to resume from snapshot
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_WATCHDOG" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_WATCHDOG"
The domain has been suspended due to the watchdog triggering
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_RESTORED" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_RESTORED"
The domain has been suspended due to restore from saved state
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_API_ERROR" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_API_ERROR"
The domain has been suspended due to an \s-1API\s0 error
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY"
The domain has been suspended for post-copy migration
.IP "Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY_FAILED" 4
.IX Item "Sys::Virt::Domain::EVENT_SUSPENDED_POSTCOPY_FAILED"
The domain has been suspended due post-copy migration failing
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_UNDEFINED" 4
.IX Item "Sys::Virt::Domain::EVENT_UNDEFINED"
The persistent configuration has gone away
.RS 4
.IP "Sys::Virt::Domain::EVENT_UNDEFINED_REMOVED" 4
.IX Item "Sys::Virt::Domain::EVENT_UNDEFINED_REMOVED"
The domain configuration has gone away due to it being
removed by administrator.
.IP "Sys::Virt::Domain::EVENT_UNDEFINED_RENAMED" 4
.IX Item "Sys::Virt::Domain::EVENT_UNDEFINED_RENAMED"
The undefined configuration is a rename of an existing configuration
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_PMSUSPENDED" 4
.IX Item "Sys::Virt::Domain::EVENT_PMSUSPENDED"
The domain has stopped running
.RS 4
.IP "Sys::Virt::Domain::EVENT_PMSUSPENDED_MEMORY" 4
.IX Item "Sys::Virt::Domain::EVENT_PMSUSPENDED_MEMORY"
The domain has suspend to \s-1RAM.\s0
.IP "Sys::Virt::Domain::EVENT_PMSUSPENDED_DISK" 4
.IX Item "Sys::Virt::Domain::EVENT_PMSUSPENDED_DISK"
The domain has suspend to Disk.
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_CRASHED" 4
.IX Item "Sys::Virt::Domain::EVENT_CRASHED"
The domain has crashed
.RS 4
.IP "Sys::Virt::Domain::EVENT_CRASHED_PANICKED" 4
.IX Item "Sys::Virt::Domain::EVENT_CRASHED_PANICKED"
The domain has crashed due to a kernel panic
.IP "Sys::Virt::Domain::EVENT_CRASHED_CRASHLOADED" 4
.IX Item "Sys::Virt::Domain::EVENT_CRASHED_CRASHLOADED"
The domain has crashed and reloaded itself
.RE
.RS 4
.RE
.SS "\s-1EVENT ID CONSTANTS\s0"
.IX Subsection "EVENT ID CONSTANTS"
.IP "Sys::Virt::Domain::EVENT_ID_LIFECYCLE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_LIFECYCLE"
Domain lifecycle events
.IP "Sys::Virt::Domain::EVENT_ID_REBOOT" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_REBOOT"
Soft / warm reboot events
.IP "Sys::Virt::Domain::EVENT_ID_RTC_CHANGE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_RTC_CHANGE"
\&\s-1RTC\s0 clock adjustments
.IP "Sys::Virt::Domain::EVENT_ID_IO_ERROR" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_IO_ERROR"
File \s-1IO\s0 errors, typically from disks
.IP "Sys::Virt::Domain::EVENT_ID_WATCHDOG" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_WATCHDOG"
Watchdog device triggering
.IP "Sys::Virt::Domain::EVENT_ID_GRAPHICS" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_GRAPHICS"
Graphics client connections.
.IP "Sys::Virt::Domain::EVENT_ID_IO_ERROR_REASON" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_IO_ERROR_REASON"
File \s-1IO\s0 errors, typically from disks, with a root cause
.IP "Sys::Virt::Domain::EVENT_ID_CONTROL_ERROR" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_CONTROL_ERROR"
Errors from the virtualization control channel
.IP "Sys::Virt::Domain::EVENT_ID_BLOCK_JOB" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_BLOCK_JOB"
Completion status of asynchronous block jobs,
identified by source file name.
.IP "Sys::Virt::Domain::EVENT_ID_BLOCK_JOB_2" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_BLOCK_JOB_2"
Completion status of asynchronous block jobs,
identified by target device name.
.IP "Sys::Virt::Domain::EVENT_ID_DISK_CHANGE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_DISK_CHANGE"
Changes in disk media
.IP "Sys::Virt::Domain::EVENT_ID_TRAY_CHANGE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_TRAY_CHANGE"
\&\s-1CDROM\s0 media tray state
.IP "Sys::Virt::Domain::EVENT_ID_PMSUSPEND" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_PMSUSPEND"
Power management initiated suspend to \s-1RAM\s0
.IP "Sys::Virt::Domain::EVENT_ID_PMSUSPEND_DISK" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_PMSUSPEND_DISK"
Power management initiated suspend to Disk
.IP "Sys::Virt::Domain::EVENT_ID_PMWAKEUP" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_PMWAKEUP"
Power management initiated wakeup
.IP "Sys::Virt::Domain::EVENT_ID_BALLOON_CHANGE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_BALLOON_CHANGE"
Balloon target changes
.IP "Sys::Virt::Domain::EVENT_ID_DEVICE_ADDED" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_DEVICE_ADDED"
Asynchronous guest device addition
.IP "Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVED" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVED"
Asynchronous guest device removal
.IP "Sys::Virt::Domain::EVENT_ID_TUNABLE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_TUNABLE"
Changes of any domain tuning parameters. The callback
will be provided with a hash listing all changed parameters.
The later \s-1DOMAIN TUNABLE\s0 constants can be useful when accessing
the hash keys
.IP "Sys::Virt::Domain::EVENT_ID_AGENT_LIFECYCLE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_AGENT_LIFECYCLE"
Domain guest agent lifecycle events. The \f(CW\*(C`state\*(C'\fR parameter
to the callback will match one of the constants
.RS 4
.IP "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_CONNECTED" 4
.IX Item "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_CONNECTED"
The agent is now connected
.IP "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED" 4
.IX Item "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED"
The agent is now disconnected
.RE
.RS 4
.Sp
The second parameter, \f(CW\*(C`reason\*(C'\fR, matches one of the following
constants
.RE
.IP "Sys::Virt::Domain::EVENT_ID_MIGRATION_ITERATION" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_MIGRATION_ITERATION"
Domain migration progress iteration. The \f(CW\*(C`iteration\*(C'\fR parameter
to the callback will specify the number of iterations migration
has made over guest \s-1RAM.\s0
.RS 4
.IP "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN"
The reason is unknown
.IP "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED" 4
.IX Item "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED"
The domain was initially booted
.IP "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_CHANNEL" 4
.IX Item "Sys::Virt::Domain::EVENT_AGENT_LIFECYCLE_REASON_CHANNEL"
The channel on a running guest changed state
.RE
.RS 4
.RE
.IP "Sys::Virt::Domain::EVENT_ID_JOB_COMPLETED" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_JOB_COMPLETED"
Domain background job completion notification. The callback
provides a hash containing the job stats. The keyus in the
hash are the same as those used with the \f(CW\*(C`Sys::Virt::Domain::get_job_stats()\*(C'\fR
method.
.IP "Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVAL_FAILED" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_DEVICE_REMOVAL_FAILED"
Guest device removal has failed.
.IP "Sys::Virt::Domain::EVENT_ID_METADATA_CHANGE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_METADATA_CHANGE"
The domain metadata has changed
.IP "Sys::Virt::Domain::EVENT_ID_BLOCK_THRESHOLD" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_BLOCK_THRESHOLD"
The event occurs when the hypervisor detects that the given
storage element was written beyond the point specified by
threshold. The event is useful for thin-provisioned storage.
.IP "Sys::Virt::Domain::EVENT_ID_MEMORY_FAILURE" 4
.IX Item "Sys::Virt::Domain::EVENT_ID_MEMORY_FAILURE"
The event occurs when the hypervisor detects hardware
memory corruption.
.SS "\s-1IO ERROR EVENT CONSTANTS\s0"
.IX Subsection "IO ERROR EVENT CONSTANTS"
These constants describe what action was taken due to the
\&\s-1IO\s0 error.
.IP "Sys::Virt::Domain::EVENT_IO_ERROR_NONE" 4
.IX Item "Sys::Virt::Domain::EVENT_IO_ERROR_NONE"
No action was taken, the error was ignored & reported as success to guest
.IP "Sys::Virt::Domain::EVENT_IO_ERROR_PAUSE" 4
.IX Item "Sys::Virt::Domain::EVENT_IO_ERROR_PAUSE"
The guest is paused since the error occurred
.IP "Sys::Virt::Domain::EVENT_IO_ERROR_REPORT" 4
.IX Item "Sys::Virt::Domain::EVENT_IO_ERROR_REPORT"
The error has been reported to the guest \s-1OS\s0
.SS "\s-1WATCHDOG EVENT CONSTANTS\s0"
.IX Subsection "WATCHDOG EVENT CONSTANTS"
These constants describe what action was taken due to the
watchdog firing
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_NONE" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_NONE"
No action was taken, the watchdog was ignored
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_PAUSE" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_PAUSE"
The guest is paused since the watchdog fired
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_POWEROFF" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_POWEROFF"
The guest is powered off after the watchdog fired
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_RESET" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_RESET"
The guest is reset after the watchdog fired
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_SHUTDOWN" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_SHUTDOWN"
The guest attempted to gracefully shutdown after the watchdog fired
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_DEBUG" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_DEBUG"
No action was taken, the watchdog was logged
.IP "Sys::Virt::Domain::EVENT_WATCHDOG_INJECTNMI" 4
.IX Item "Sys::Virt::Domain::EVENT_WATCHDOG_INJECTNMI"
An \s-1NMI\s0 was injected into the guest after the watchdog fired
.SS "\s-1GRAPHICS EVENT PHASE CONSTANTS\s0"
.IX Subsection "GRAPHICS EVENT PHASE CONSTANTS"
These constants describe the phase of the graphics connection
.IP "Sys::Virt::Domain::EVENT_GRAPHICS_CONNECT" 4
.IX Item "Sys::Virt::Domain::EVENT_GRAPHICS_CONNECT"
The initial client connection
.IP "Sys::Virt::Domain::EVENT_GRAPHICS_INITIALIZE" 4
.IX Item "Sys::Virt::Domain::EVENT_GRAPHICS_INITIALIZE"
The client has been authenticated & the connection is running
.IP "Sys::Virt::Domain::EVENT_GRAPHICS_DISCONNECT" 4
.IX Item "Sys::Virt::Domain::EVENT_GRAPHICS_DISCONNECT"
The client has disconnected
.SS "\s-1GRAPHICS EVENT ADDRESS CONSTANTS\s0"
.IX Subsection "GRAPHICS EVENT ADDRESS CONSTANTS"
These constants describe the format of the address
.IP "Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV4" 4
.IX Item "Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV4"
An IPv4 address
.IP "Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV6" 4
.IX Item "Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_IPV6"
An IPv6 address
.IP "Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_UNIX" 4
.IX Item "Sys::Virt::Domain::EVENT_GRAPHICS_ADDRESS_UNIX"
An \s-1UNIX\s0 socket path address
.SS "\s-1DISK CHANGE EVENT CONSTANTS\s0"
.IX Subsection "DISK CHANGE EVENT CONSTANTS"
These constants describe the reason for a disk change event
.IP "Sys::Virt::Domain::EVENT_DISK_CHANGE_MISSING_ON_START" 4
.IX Item "Sys::Virt::Domain::EVENT_DISK_CHANGE_MISSING_ON_START"
The disk media was cleared, as its source was missing when attempting to start the guest
.IP "Sys::Virt::Domain::EVENT_DISK_DROP_MISSING_ON_START" 4
.IX Item "Sys::Virt::Domain::EVENT_DISK_DROP_MISSING_ON_START"
The disk device was dropped, as its source was missing when  attempting to start the guest
.SS "\s-1TRAY CHANGE CONSTANTS\s0"
.IX Subsection "TRAY CHANGE CONSTANTS"
These constants describe the reason for a tray change event
.IP "Sys::Virt::Domain::EVENT_TRAY_CHANGE_CLOSE" 4
.IX Item "Sys::Virt::Domain::EVENT_TRAY_CHANGE_CLOSE"
The tray was closed
.IP "Sys::Virt::Domain::EVENT_TRAY_CHANGE_OPEN" 4
.IX Item "Sys::Virt::Domain::EVENT_TRAY_CHANGE_OPEN"
The tray was opened
.SS "\s-1DOMAIN BLOCK JOB TYPE CONSTANTS\s0"
.IX Subsection "DOMAIN BLOCK JOB TYPE CONSTANTS"
The following constants identify the different types of domain
block jobs
.IP "Sys::Virt::Domain::BLOCK_JOB_TYPE_UNKNOWN" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_TYPE_UNKNOWN"
An unknown block job type
.IP "Sys::Virt::Domain::BLOCK_JOB_TYPE_PULL" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_TYPE_PULL"
The block pull job type
.IP "Sys::Virt::Domain::BLOCK_JOB_TYPE_COPY" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_TYPE_COPY"
The block copy job type
.IP "Sys::Virt::Domain::BLOCK_JOB_TYPE_COMMIT" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_TYPE_COMMIT"
The block commit job type
.IP "Sys::Virt::Domain::BLOCK_JOB_TYPE_ACTIVE_COMMIT" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_TYPE_ACTIVE_COMMIT"
The block active commit job type
.IP "Sys::Virt::Domain::BLOCK_JOB_TYPE_BACKUP" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_TYPE_BACKUP"
The block backup job type
.SS "\s-1DOMAIN BLOCK JOB COMPLETION CONSTANTS\s0"
.IX Subsection "DOMAIN BLOCK JOB COMPLETION CONSTANTS"
The following constants can be used to determine the completion
status of a block job
.IP "Sys::Virt::Domain::BLOCK_JOB_COMPLETED" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_COMPLETED"
A successfully completed block job
.IP "Sys::Virt::Domain::BLOCK_JOB_FAILED" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_FAILED"
An unsuccessful block job
.IP "Sys::Virt::Domain::BLOCK_JOB_CANCELED" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_CANCELED"
A block job canceled byy the user
.IP "Sys::Virt::Domain::BLOCK_JOB_READY" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_READY"
A block job is running
.SS "\s-1DOMAIN BLOCK REBASE CONSTANTS\s0"
.IX Subsection "DOMAIN BLOCK REBASE CONSTANTS"
The following constants are useful when rebasing block devices
.IP "Sys::Virt::Domain::BLOCK_REBASE_SHALLOW" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_SHALLOW"
Limit copy to top of source backing chain
.IP "Sys::Virt::Domain::BLOCK_REBASE_REUSE_EXT" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_REUSE_EXT"
Reuse existing external file for copy
.IP "Sys::Virt::Domain::BLOCK_REBASE_COPY_RAW" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_COPY_RAW"
Make destination file raw
.IP "Sys::Virt::Domain::BLOCK_REBASE_COPY" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_COPY"
Start a copy job
.IP "Sys::Virt::Domain::BLOCK_REBASE_COPY_DEV" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_COPY_DEV"
Treat destination as a block device instead of file
.IP "Sys::Virt::Domain::BLOCK_REBASE_RELATIVE" 4
.IX Item "Sys::Virt::Domain::BLOCK_REBASE_RELATIVE"
Keep backing chain referenced using relative names
.SS "\s-1DOMAIN BLOCK COPY CONSTANTS\s0"
.IX Subsection "DOMAIN BLOCK COPY CONSTANTS"
The following constants are useful when copying block devices
.IP "Sys::Virt::Domain::BLOCK_COPY_SHALLOW" 4
.IX Item "Sys::Virt::Domain::BLOCK_COPY_SHALLOW"
Limit copy to top of source backing chain
.IP "Sys::Virt::Domain::BLOCK_COPY_REUSE_EXT" 4
.IX Item "Sys::Virt::Domain::BLOCK_COPY_REUSE_EXT"
Reuse existing external file for copy
.IP "Sys::Virt::Domain::BLOCK_COPY_TRANSIENT_JOB" 4
.IX Item "Sys::Virt::Domain::BLOCK_COPY_TRANSIENT_JOB"
Don't force usage of recoverable job for the copy operation
.SS "\s-1DOMAIN BLOCK JOB ABORT CONSTANTS\s0"
.IX Subsection "DOMAIN BLOCK JOB ABORT CONSTANTS"
The following constants are useful when aborting job copy jobs
.IP "Sys::Virt::Domain::BLOCK_JOB_ABORT_ASYNC" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_ABORT_ASYNC"
Request only, do not wait for completion
.IP "Sys::Virt::Domain::BLOCK_JOB_ABORT_PIVOT" 4
.IX Item "Sys::Virt::Domain::BLOCK_JOB_ABORT_PIVOT"
Pivot to mirror when ending a copy job
.SS "\s-1DOMAIN BLOCK COMMIT JOB CONSTANTS\s0"
.IX Subsection "DOMAIN BLOCK COMMIT JOB CONSTANTS"
The following constants are useful with block commit job types
.IP "Sys::Virt::Domain::BLOCK_COMMIT_DELETE" 4
.IX Item "Sys::Virt::Domain::BLOCK_COMMIT_DELETE"
Delete any files that are invalid after commit
.IP "Sys::Virt::Domain::BLOCK_COMMIT_SHALLOW" 4
.IX Item "Sys::Virt::Domain::BLOCK_COMMIT_SHALLOW"
\&\s-1NULL\s0 base means next backing file, not whole chain
.IP "Sys::Virt::Domain::BLOCK_COMMIT_ACTIVE" 4
.IX Item "Sys::Virt::Domain::BLOCK_COMMIT_ACTIVE"
Allow two phase commit when top is active layer
.IP "Sys::Virt::Domain::BLOCK_COMMIT_RELATIVE" 4
.IX Item "Sys::Virt::Domain::BLOCK_COMMIT_RELATIVE"
Keep backing chain referenced using relative names
.SS "\s-1DOMAIN SAVE / RESTORE CONSTANTS\s0"
.IX Subsection "DOMAIN SAVE / RESTORE CONSTANTS"
The following constants can be used when saving or restoring
virtual machines
.IP "Sys::Virt::Domain::SAVE_BYPASS_CACHE" 4
.IX Item "Sys::Virt::Domain::SAVE_BYPASS_CACHE"
Do not use \s-1OS I/O\s0 cache when saving state.
.IP "Sys::Virt::Domain::SAVE_PAUSED" 4
.IX Item "Sys::Virt::Domain::SAVE_PAUSED"
Mark the saved state as paused to prevent the guest CPUs
starting upon restore.
.IP "Sys::Virt::Domain::SAVE_RUNNING" 4
.IX Item "Sys::Virt::Domain::SAVE_RUNNING"
Mark the saved state as running to allow the guest CPUs
to start upon restore.
.SS "\s-1DOMAIN CORE DUMP CONSTANTS\s0"
.IX Subsection "DOMAIN CORE DUMP CONSTANTS"
The following constants can be used when triggering domain
core dumps
.IP "Sys::Virt::Domain::DUMP_LIVE" 4
.IX Item "Sys::Virt::Domain::DUMP_LIVE"
Do not pause execution while dumping the guest
.IP "Sys::Virt::Domain::DUMP_CRASH" 4
.IX Item "Sys::Virt::Domain::DUMP_CRASH"
Crash the guest after completing the core dump
.IP "Sys::Virt::Domain::DUMP_BYPASS_CACHE" 4
.IX Item "Sys::Virt::Domain::DUMP_BYPASS_CACHE"
Do not use \s-1OS I/O\s0 cache when writing core dump
.IP "Sys::Virt::Domain::DUMP_RESET" 4
.IX Item "Sys::Virt::Domain::DUMP_RESET"
Reset the virtual machine after finishing the dump
.IP "Sys::Virt::Domain::DUMP_MEMORY_ONLY" 4
.IX Item "Sys::Virt::Domain::DUMP_MEMORY_ONLY"
Only include guest \s-1RAM\s0 in the dump, not the device
state
.SS "\s-1DESTROY CONSTANTS\s0"
.IX Subsection "DESTROY CONSTANTS"
The following constants are useful when terminating guests
using the \f(CW\*(C`destroy\*(C'\fR \s-1API.\s0
.IP "Sys::Virt::Domain::DESTROY_DEFAULT" 4
.IX Item "Sys::Virt::Domain::DESTROY_DEFAULT"
Destroy the guest using the default approach
.IP "Sys::Virt::Domain::DESTROY_GRACEFUL" 4
.IX Item "Sys::Virt::Domain::DESTROY_GRACEFUL"
Destroy the guest in a graceful manner
.SS "\s-1SHUTDOWN CONSTANTS\s0"
.IX Subsection "SHUTDOWN CONSTANTS"
The following constants are useful when requesting that a
guest terminate using the \f(CW\*(C`shutdown\*(C'\fR \s-1API\s0
.IP "Sys::Virt::Domain::SHUTDOWN_DEFAULT" 4
.IX Item "Sys::Virt::Domain::SHUTDOWN_DEFAULT"
Shutdown using the hypervisor's default mechanism
.IP "Sys::Virt::Domain::SHUTDOWN_GUEST_AGENT" 4
.IX Item "Sys::Virt::Domain::SHUTDOWN_GUEST_AGENT"
Shutdown by issuing a command to a guest agent
.IP "Sys::Virt::Domain::SHUTDOWN_ACPI_POWER_BTN" 4
.IX Item "Sys::Virt::Domain::SHUTDOWN_ACPI_POWER_BTN"
Shutdown by injecting an \s-1ACPI\s0 power button press
.IP "Sys::Virt::Domain::SHUTDOWN_INITCTL" 4
.IX Item "Sys::Virt::Domain::SHUTDOWN_INITCTL"
Shutdown by talking to initctl (containers only)
.IP "Sys::Virt::Domain::SHUTDOWN_SIGNAL" 4
.IX Item "Sys::Virt::Domain::SHUTDOWN_SIGNAL"
Shutdown by sending \s-1SIGTERM\s0 to the init process
.IP "Sys::Virt::Domain::SHUTDOWN_PARAVIRT" 4
.IX Item "Sys::Virt::Domain::SHUTDOWN_PARAVIRT"
Shutdown by issuing a paravirt power control command
.SS "\s-1REBOOT CONSTANTS\s0"
.IX Subsection "REBOOT CONSTANTS"
The following constants are useful when requesting that a
guest terminate using the \f(CW\*(C`reboot\*(C'\fR \s-1API\s0
.IP "Sys::Virt::Domain::REBOOT_DEFAULT" 4
.IX Item "Sys::Virt::Domain::REBOOT_DEFAULT"
Reboot using the hypervisor's default mechanism
.IP "Sys::Virt::Domain::REBOOT_GUEST_AGENT" 4
.IX Item "Sys::Virt::Domain::REBOOT_GUEST_AGENT"
Reboot by issuing a command to a guest agent
.IP "Sys::Virt::Domain::REBOOT_ACPI_POWER_BTN" 4
.IX Item "Sys::Virt::Domain::REBOOT_ACPI_POWER_BTN"
Reboot by injecting an \s-1ACPI\s0 power button press
.IP "Sys::Virt::Domain::REBOOT_INITCTL" 4
.IX Item "Sys::Virt::Domain::REBOOT_INITCTL"
Reboot by talking to initctl (containers only)
.IP "Sys::Virt::Domain::REBOOT_SIGNAL" 4
.IX Item "Sys::Virt::Domain::REBOOT_SIGNAL"
Reboot by sending \s-1SIGHUP\s0 to the init process
.IP "Sys::Virt::Domain::REBOOT_PARAVIRT" 4
.IX Item "Sys::Virt::Domain::REBOOT_PARAVIRT"
Reboot by issuing a paravirt power control command
.SS "\s-1METADATA CONSTANTS\s0"
.IX Subsection "METADATA CONSTANTS"
The following constants are useful when reading/writing
metadata about a guest
.IP "Sys::Virt::Domain::METADATA_TITLE" 4
.IX Item "Sys::Virt::Domain::METADATA_TITLE"
The short human friendly title of the guest
.IP "Sys::Virt::Domain::METADATA_DESCRIPTION" 4
.IX Item "Sys::Virt::Domain::METADATA_DESCRIPTION"
The long free text description of the guest
.IP "Sys::Virt::Domain::METADATA_ELEMENT" 4
.IX Item "Sys::Virt::Domain::METADATA_ELEMENT"
The structured metadata elements for the guest
.SS "\s-1DISK ERROR CONSTANTS\s0"
.IX Subsection "DISK ERROR CONSTANTS"
The following constants are useful when interpreting
disk error codes
.IP "Sys::Virt::Domain::DISK_ERROR_NONE" 4
.IX Item "Sys::Virt::Domain::DISK_ERROR_NONE"
No error
.IP "Sys::Virt::Domain::DISK_ERROR_NO_SPACE" 4
.IX Item "Sys::Virt::Domain::DISK_ERROR_NO_SPACE"
The host storage has run out of free space
.IP "Sys::Virt::Domain::DISK_ERROR_UNSPEC" 4
.IX Item "Sys::Virt::Domain::DISK_ERROR_UNSPEC"
An unspecified error has occurred.
.SS "\s-1MEMORY STATISTIC CONSTANTS\s0"
.IX Subsection "MEMORY STATISTIC CONSTANTS"
.IP "Sys::Virt::Domain::MEMORY_STAT_SWAP_IN" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_SWAP_IN"
Swap in
.IP "Sys::Virt::Domain::MEMORY_STAT_SWAP_OUT" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_SWAP_OUT"
Swap out
.IP "Sys::Virt::Domain::MEMORY_STAT_MINOR_FAULT" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_MINOR_FAULT"
Minor faults
.IP "Sys::Virt::Domain::MEMORY_STAT_MAJOR_FAULT" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_MAJOR_FAULT"
Major faults
.IP "Sys::Virt::Domain::MEMORY_STAT_RSS" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_RSS"
Resident memory
.IP "Sys::Virt::Domain::MEMORY_STAT_UNUSED" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_UNUSED"
Unused memory
.IP "Sys::Virt::Domain::MEMORY_STAT_AVAILABLE" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_AVAILABLE"
Available memory
.IP "Sys::Virt::Domain::MEMORY_STAT_ACTUAL_BALLOON" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_ACTUAL_BALLOON"
Actual balloon limit
.IP "Sys::Virt::Domain::MEMORY_STAT_USABLE" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_USABLE"
Amount of usable memory
.IP "Sys::Virt::Domain::MEMORY_STAT_LAST_UPDATE" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_LAST_UPDATE"
Time of last stats refresh from guest
.IP "Sys::Virt::Domain::MEMORY_STAT_DISK_CACHES" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_DISK_CACHES"
Disk cache size
.IP "Sys::Virt::Domain::MEMORY_STAT_HUGETLB_PGALLOC" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_HUGETLB_PGALLOC"
The amount of successful huge page allocations
.IP "Sys::Virt::Domain::MEMORY_STAT_HUGETLB_PGFAIL" 4
.IX Item "Sys::Virt::Domain::MEMORY_STAT_HUGETLB_PGFAIL"
The amount of failed huge page allocations
.SS "\s-1DOMAIN LIST CONSTANTS\s0"
.IX Subsection "DOMAIN LIST CONSTANTS"
The following constants can be used when listing domains
.IP "Sys::Virt::Domain::LIST_ACTIVE" 4
.IX Item "Sys::Virt::Domain::LIST_ACTIVE"
Only list domains that are currently active (running, or paused)
.IP "Sys::Virt::Domain::LIST_AUTOSTART" 4
.IX Item "Sys::Virt::Domain::LIST_AUTOSTART"
Only list domains that are set to automatically start on boot
.IP "Sys::Virt::Domain::LIST_HAS_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::LIST_HAS_SNAPSHOT"
Only list domains that have a stored snapshot
.IP "Sys::Virt::Domain::LIST_INACTIVE" 4
.IX Item "Sys::Virt::Domain::LIST_INACTIVE"
Only list domains that are currently inactive (shutoff, saved)
.IP "Sys::Virt::Domain::LIST_MANAGEDSAVE" 4
.IX Item "Sys::Virt::Domain::LIST_MANAGEDSAVE"
Only list domains that have current managed save state
.IP "Sys::Virt::Domain::LIST_NO_AUTOSTART" 4
.IX Item "Sys::Virt::Domain::LIST_NO_AUTOSTART"
Only list domains that are not set to automatically start on boto
.IP "Sys::Virt::Domain::LIST_NO_MANAGEDSAVE" 4
.IX Item "Sys::Virt::Domain::LIST_NO_MANAGEDSAVE"
Only list domains that do not have any managed save state
.IP "Sys::Virt::Domain::LIST_NO_SNAPSHOT" 4
.IX Item "Sys::Virt::Domain::LIST_NO_SNAPSHOT"
Only list domains that do not have a stored snapshot
.IP "Sys::Virt::Domain::LIST_OTHER" 4
.IX Item "Sys::Virt::Domain::LIST_OTHER"
Only list domains that are not running, paused or shutoff
.IP "Sys::Virt::Domain::LIST_PAUSED" 4
.IX Item "Sys::Virt::Domain::LIST_PAUSED"
Only list domains that are paused
.IP "Sys::Virt::Domain::LIST_PERSISTENT" 4
.IX Item "Sys::Virt::Domain::LIST_PERSISTENT"
Only list domains which have a persistent config
.IP "Sys::Virt::Domain::LIST_RUNNING" 4
.IX Item "Sys::Virt::Domain::LIST_RUNNING"
Only list domains that are currently running
.IP "Sys::Virt::Domain::LIST_SHUTOFF" 4
.IX Item "Sys::Virt::Domain::LIST_SHUTOFF"
Only list domains that are currently shutoff
.IP "Sys::Virt::Domain::LIST_TRANSIENT" 4
.IX Item "Sys::Virt::Domain::LIST_TRANSIENT"
Only list domains that do not have a persistent config
.IP "Sys::Virt::Domain::LIST_HAS_CHECKPOINT" 4
.IX Item "Sys::Virt::Domain::LIST_HAS_CHECKPOINT"
Only list domains that have a stored checkpoint
.IP "Sys::Virt::Domain::LIST_NO_CHECKPOINT" 4
.IX Item "Sys::Virt::Domain::LIST_NO_CHECKPOINT"
Only list domains that do not have a stored checkpoint
.SS "\s-1SEND KEY CONSTANTS\s0"
.IX Subsection "SEND KEY CONSTANTS"
The following constants are to be used with the \f(CW\*(C`send_key\*(C'\fR
\&\s-1API\s0
.IP "Sys::Virt::Domain::SEND_KEY_MAX_KEYS" 4
.IX Item "Sys::Virt::Domain::SEND_KEY_MAX_KEYS"
The maximum number of keys that can be sent in a single
call to \f(CW\*(C`send_key\*(C'\fR
.SS "\s-1BLOCK STATS CONSTANTS\s0"
.IX Subsection "BLOCK STATS CONSTANTS"
The following constants provide the names of well known
block stats fields
.IP "Sys::Virt::Domain::BLOCK_STATS_ERRS" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_ERRS"
The number of I/O errors
.IP "Sys::Virt::Domain::BLOCK_STATS_FLUSH_REQ" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_FLUSH_REQ"
The number of flush requests
.IP "Sys::Virt::Domain::BLOCK_STATS_FLUSH_TOTAL_TIMES" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_FLUSH_TOTAL_TIMES"
The time spent processing flush requests
.IP "Sys::Virt::Domain::BLOCK_STATS_READ_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_READ_BYTES"
The amount of data read
.IP "Sys::Virt::Domain::BLOCK_STATS_READ_REQ" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_READ_REQ"
The number of read requests
.IP "Sys::Virt::Domain::BLOCK_STATS_READ_TOTAL_TIMES" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_READ_TOTAL_TIMES"
The time spent processing read requests
.IP "Sys::Virt::Domain::BLOCK_STATS_WRITE_BYTES" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_WRITE_BYTES"
The amount of data written
.IP "Sys::Virt::Domain::BLOCK_STATS_WRITE_REQ" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_WRITE_REQ"
The number of write requests
.IP "Sys::Virt::Domain::BLOCK_STATS_WRITE_TOTAL_TIMES" 4
.IX Item "Sys::Virt::Domain::BLOCK_STATS_WRITE_TOTAL_TIMES"
The time spent processing write requests
.SS "\s-1CPU STATS CONSTANTS\s0"
.IX Subsection "CPU STATS CONSTANTS"
The following constants provide the names of well known
cpu stats fields
.IP "Sys::Virt::Domain::CPU_STATS_CPUTIME" 4
.IX Item "Sys::Virt::Domain::CPU_STATS_CPUTIME"
The total \s-1CPU\s0 time, including both hypervisor and
vCPU time.
.IP "Sys::Virt::Domain::CPU_STATS_USERTIME" 4
.IX Item "Sys::Virt::Domain::CPU_STATS_USERTIME"
THe total time in kernel
.IP "Sys::Virt::Domain::CPU_STATS_SYSTEMTIME" 4
.IX Item "Sys::Virt::Domain::CPU_STATS_SYSTEMTIME"
The total time in userspace
.IP "Sys::Virt::Domain::CPU_STATS_VCPUTIME" 4
.IX Item "Sys::Virt::Domain::CPU_STATS_VCPUTIME"
The total vCPU time.
.SS "\s-1CPU STATS CONSTANTS\s0"
.IX Subsection "CPU STATS CONSTANTS"
The following constants provide the names of well known
schedular parameters
.IP "Sys::Virt::SCHEDULER_EMULATOR_PERIOD" 4
.IX Item "Sys::Virt::SCHEDULER_EMULATOR_PERIOD"
The duration of the time period for scheduling the emulator
.IP "Sys::Virt::SCHEDULER_EMULATOR_QUOTA" 4
.IX Item "Sys::Virt::SCHEDULER_EMULATOR_QUOTA"
The quota for the emulator in one schedular time period
.IP "Sys::Virt::SCHEDULER_IOTHREAD_PERIOD" 4
.IX Item "Sys::Virt::SCHEDULER_IOTHREAD_PERIOD"
The duration of the time period for scheduling the iothread
.IP "Sys::Virt::SCHEDULER_IOTHREAD_QUOTA" 4
.IX Item "Sys::Virt::SCHEDULER_IOTHREAD_QUOTA"
The quota for the iothread in one schedular time period
.SS "\s-1DOMAIN STATS FLAG CONSTANTS\s0"
.IX Subsection "DOMAIN STATS FLAG CONSTANTS"
The following constants are used as flags when requesting
bulk domain stats from \f(CW\*(C`Sys::Virt::get_all_domain_stats\*(C'\fR.
.IP "Sys::Virt::Domain::GET_ALL_STATS_ACTIVE" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_ACTIVE"
Include stats for active domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_INACTIVE" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_INACTIVE"
Include stats for inactive domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_OTHER" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_OTHER"
Include stats for other domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_PAUSED" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_PAUSED"
Include stats for paused domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_PERSISTENT" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_PERSISTENT"
Include stats for persistent domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_RUNNING" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_RUNNING"
Include stats for running domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_SHUTOFF" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_SHUTOFF"
Include stats for shutoff domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_TRANSIENT" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_TRANSIENT"
Include stats for transient domains
.IP "Sys::Virt::Domain::GET_ALL_STATS_ENFORCE_STATS" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_ENFORCE_STATS"
Require that all requested stats fields are returned
.IP "Sys::Virt::Domain::GET_ALL_STATS_BACKING" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_BACKING"
Get stats for image backing files too
.IP "Sys::Virt::Domain::GET_ALL_STATS_NOWAIT" 4
.IX Item "Sys::Virt::Domain::GET_ALL_STATS_NOWAIT"
Skip stats if they can't be acquired without waiting
.SS "\s-1DOMAIN STATS FIELD CONSTANTS\s0"
.IX Subsection "DOMAIN STATS FIELD CONSTANTS"
The following constants are used to control which fields
are returned for stats queries.
.IP "Sys::Virt::Domain::STATS_BALLOON" 4
.IX Item "Sys::Virt::Domain::STATS_BALLOON"
Balloon statistics
.IP "Sys::Virt::Domain::STATS_BLOCK" 4
.IX Item "Sys::Virt::Domain::STATS_BLOCK"
Block device info
.IP "Sys::Virt::Domain::STATS_CPU_TOTAL" 4
.IX Item "Sys::Virt::Domain::STATS_CPU_TOTAL"
\&\s-1CPU\s0 usage info
.IP "Sys::Virt::Domain::STATS_INTERFACE" 4
.IX Item "Sys::Virt::Domain::STATS_INTERFACE"
Network interface info
.IP "Sys::Virt::Domain::STATS_STATE" 4
.IX Item "Sys::Virt::Domain::STATS_STATE"
General lifecycle state
.IP "Sys::Virt::Domain::STATS_VCPU" 4
.IX Item "Sys::Virt::Domain::STATS_VCPU"
Virtual \s-1CPU\s0 info
.IP "Sys::Virt::Domain::STATS_PERF" 4
.IX Item "Sys::Virt::Domain::STATS_PERF"
Performance event counter values
.IP "Sys::Virt::Domain::STATS_IOTHREAD" 4
.IX Item "Sys::Virt::Domain::STATS_IOTHREAD"
IOThread performance statistics values
.IP "Sys::Virt::Domain::STATS_MEMORY" 4
.IX Item "Sys::Virt::Domain::STATS_MEMORY"
Memory bandwidth statistics values
.SS "\s-1PROCESS SIGNALS\s0"
.IX Subsection "PROCESS SIGNALS"
The following constants provide the names of signals
which can be sent to guest processes. They mostly
correspond to \s-1POSIX\s0 signal names.
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_NOP" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_NOP"
\&\s-1SIGNOP\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_HUP" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_HUP"
\&\s-1SIGHUP\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_INT" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_INT"
\&\s-1SIGINT\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_QUIT" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_QUIT"
\&\s-1SIGQUIT\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_ILL" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_ILL"
\&\s-1SIGILL\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_TRAP" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_TRAP"
\&\s-1SIGTRAP\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_ABRT" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_ABRT"
\&\s-1SIGABRT\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_BUS" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_BUS"
\&\s-1SIGBUS\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_FPE" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_FPE"
\&\s-1SIGFPE\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_KILL" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_KILL"
\&\s-1SIGKILL\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_USR1" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_USR1"
\&\s-1SIGUSR1\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_SEGV" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_SEGV"
\&\s-1SIGSEGV\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_USR2" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_USR2"
\&\s-1SIGUSR2\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_PIPE" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_PIPE"
\&\s-1SIGPIPE\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_ALRM" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_ALRM"
\&\s-1SIGALRM\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_TERM" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_TERM"
\&\s-1SIGTERM\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_STKFLT" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_STKFLT"
\&\s-1SIGSTKFLT\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_CHLD" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_CHLD"
\&\s-1SIGCHLD\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_CONT" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_CONT"
\&\s-1SIGCONT\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_STOP" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_STOP"
\&\s-1SIGSTOP\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_TSTP" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_TSTP"
\&\s-1SIGTSTP\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_TTIN" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_TTIN"
\&\s-1SIGTTIN\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_TTOU" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_TTOU"
\&\s-1SIGTTOU\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_URG" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_URG"
\&\s-1SIGURG\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_XCPU" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_XCPU"
\&\s-1SIGXCPU\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_XFSZ" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_XFSZ"
\&\s-1SIGXFSZ\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_VTALRM" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_VTALRM"
\&\s-1SIGVTALRM\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_PROF" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_PROF"
\&\s-1SIGPROF\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_WINCH" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_WINCH"
\&\s-1SIGWINCH\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_POLL" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_POLL"
\&\s-1SIGPOLL\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_PWR" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_PWR"
\&\s-1SIGPWR\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_SYS" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_SYS"
\&\s-1SIGSYS\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT0" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT0"
\&\s-1SIGRT0\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT1" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT1"
\&\s-1SIGRT1\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT2" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT2"
\&\s-1SIGRT2\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT3" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT3"
\&\s-1SIGRT3\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT4" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT4"
\&\s-1SIGRT4\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT5" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT5"
\&\s-1SIGRT5\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT6" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT6"
\&\s-1SIGRT6\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT7" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT7"
\&\s-1SIGRT7\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT8" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT8"
\&\s-1SIGRT8\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT9" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT9"
\&\s-1SIGRT9\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT10" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT10"
\&\s-1SIGRT10\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT11" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT11"
\&\s-1SIGRT11\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT12" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT12"
\&\s-1SIGRT12\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT13" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT13"
\&\s-1SIGRT13\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT14" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT14"
\&\s-1SIGRT14\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT15" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT15"
\&\s-1SIGRT15\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT16" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT16"
\&\s-1SIGRT16\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT17" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT17"
\&\s-1SIGRT17\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT18" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT18"
\&\s-1SIGRT18\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT19" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT19"
\&\s-1SIGRT19\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT20" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT20"
\&\s-1SIGRT20\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT21" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT21"
\&\s-1SIGRT21\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT22" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT22"
\&\s-1SIGRT22\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT23" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT23"
\&\s-1SIGRT23\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT24" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT24"
\&\s-1SIGRT24\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT25" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT25"
\&\s-1SIGRT25\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT26" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT26"
\&\s-1SIGRT26\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT27" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT27"
\&\s-1SIGRT27\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT28" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT28"
\&\s-1SIGRT28\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT29" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT29"
\&\s-1SIGRT29\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT30" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT30"
\&\s-1SIGRT30\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT31" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT31"
\&\s-1SIGRT31\s0
.IP "Sys::Virt::Domain::PROCESS_SIGNAL_RT32" 4
.IX Item "Sys::Virt::Domain::PROCESS_SIGNAL_RT32"
\&\s-1SIGRT32\s0
.SS "\s-1DOMAIN TUNABLE CONSTANTS\s0"
.IX Subsection "DOMAIN TUNABLE CONSTANTS"
The following constants are useful when accessing domain
tuning parameters in APIs and events
.IP "Sys::Virt::Domain::TUNABLE_CPU_CPU_SHARES" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_CPU_SHARES"
Proportional \s-1CPU\s0 weight
.IP "Sys::Virt::Domain::TUNABLE_CPU_EMULATORPIN" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_EMULATORPIN"
Emulator thread \s-1CPU\s0 pinning mask
.IP "Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_PERIOD" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_PERIOD"
Emulator thread \s-1CPU\s0 period
.IP "Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_QUOTA" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_EMULATOR_QUOTA"
Emulator thread \s-1CPU\s0 quota
.IP "Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_PERIOD" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_PERIOD"
Iothread thread \s-1CPU\s0 period
.IP "Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_QUOTA" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_IOTHREAD_QUOTA"
Iothread thread \s-1CPU\s0 quota
.IP "Sys::Virt::Domain::TUNABLE_CPU_VCPUPIN" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_VCPUPIN"
\&\s-1VCPU\s0 thread pinning mask
.IP "Sys::Virt::Domain::TUNABLE_CPU_VCPU_PERIOD" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_VCPU_PERIOD"
\&\s-1VCPU\s0 thread period
.IP "Sys::Virt::Domain::TUNABLE_CPU_VCPU_QUOTA" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_VCPU_QUOTA"
\&\s-1VCPU\s0 thread quota
.IP "Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_PERIOD" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_PERIOD"
\&\s-1VM\s0 global period
.IP "Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_QUOTA" 4
.IX Item "Sys::Virt::Domain::TUNABLE_CPU_GLOBAL_QUOTA"
\&\s-1VM\s0 global quota
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_DISK" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_DISK"
The name of guest disks
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC"
Read throughput in bytes per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC"
Read throughput in I/O operations per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC"
Total throughput in bytes per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC"
Total throughput in I/O operations per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC"
Write throughput in bytes per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC"
Write throughput in I/O operations per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX"
Maximum read throughput in bytes per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX"
Maximum read throughput in I/O operations per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX"
Maximum total throughput in bytes per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX"
Maximum total throughput in I/O operations per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX"
Maximum write throughput in bytes per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX"
Maximum write throughput in I/O operations per sec
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_SIZE_IOPS_SEC" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_SIZE_IOPS_SEC"
The maximum I/O operations per second
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum total bytes processed per second.
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum bytes read per second.
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum bytes written per second.
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum total I/O operations processed
per second.
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum I/O operations read per second.
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH"
The duration in seconds allowed for maximum I/O operations written per second.
.IP "Sys::Virt::Domain::TUNABLE_BLKDEV_GROUP_NAME" 4
.IX Item "Sys::Virt::Domain::TUNABLE_BLKDEV_GROUP_NAME"
The name of the blkdev group
.IP "Sys::Virt::Domain::TUNABLE_IOTHREADSPIN" 4
.IX Item "Sys::Virt::Domain::TUNABLE_IOTHREADSPIN"
The I/O threads pinning
.SS "\s-1DOMAIN LIFECYCLE CONSTANTS\s0"
.IX Subsection "DOMAIN LIFECYCLE CONSTANTS"
The following constants are useful when setting action for
lifecycle events.
.IP "Sys::Virt::Domain::LIFECYCLE_POWEROFF" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_POWEROFF"
The poweroff lifecycle event type
.IP "Sys::Virt::Domain::LIFECYCLE_REBOOT" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_REBOOT"
The reboot lifecycle event type
.IP "Sys::Virt::Domain::LIFECYCLE_CRASH" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_CRASH"
The crash lifecycle event type
.SS "\s-1DOMAIN LIFECYCLE ACTION CONSTANTS\s0"
.IX Subsection "DOMAIN LIFECYCLE ACTION CONSTANTS"
.IP "Sys::Virt::Domain::LIFECYCLE_ACTION_DESTROY" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_ACTION_DESTROY"
The destroy lifecycle action
.IP "Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART"
The restart lifecycle action
.IP "Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART_RENAME" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_ACTION_RESTART_RENAME"
The restart-rename lifecycle action
.IP "Sys::Virt::Domain::LIFECYCLE_ACTION_PRESERVE" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_ACTION_PRESERVE"
The preserve lifecycle action
.IP "Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_DESTROY" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_DESTROY"
The coredump-destroy lifecycle action
.IP "Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_RESTART" 4
.IX Item "Sys::Virt::Domain::LIFECYCLE_ACTION_COREDUMP_RESTART"
The coredump-restart lifecycle action
.SS "\s-1MEMORY FAILURE ACTION CONSTANTS\s0"
.IX Subsection "MEMORY FAILURE ACTION CONSTANTS"
.IP "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_IGNORE" 4
.IX Item "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_IGNORE"
The failure could be ignored
.IP "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_INJECT" 4
.IX Item "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_INJECT"
An \s-1MCE\s0 was injected to the guest
.IP "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_FATAL" 4
.IX Item "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_FATAL"
The failure is non-recoverable and the hypervisor was
not able to handle it
.IP "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_RESET" 4
.IX Item "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_ACTION_RESET"
The failure is non-recoverable and the guest was
not able to handle it.
.SS "\s-1MEMORY FAILURE RECIPIENT CONSTANTS\s0"
.IX Subsection "MEMORY FAILURE RECIPIENT CONSTANTS"
.IP "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_RECIPIENT_HYPERVISOR" 4
.IX Item "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_RECIPIENT_HYPERVISOR"
The memory failure was in hypervisor address space
.IP "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_RECIPIENT_GUEST" 4
.IX Item "Sys::Virt::Domain::EVENT_MEMORY_FAILURE_RECIPIENT_GUEST"
The memory failure was in guest address space
.SS "\s-1MEMORY FAILURE FLAG CONSTANTS\s0"
.IX Subsection "MEMORY FAILURE FLAG CONSTANTS"
.IP "Sys::Virt::Domain::MEMORY_FAILURE_ACTION_REQUIRED" 4
.IX Item "Sys::Virt::Domain::MEMORY_FAILURE_ACTION_REQUIRED"
Whether the flag is action-required or action-optional
.IP "Sys::Virt::Domain::MEMORY_FAILURE_RECURSIVE" 4
.IX Item "Sys::Virt::Domain::MEMORY_FAILURE_RECURSIVE"
The failure occurred while the previous fault was being
handled.
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006 Red Hat
Copyright (C) 2006\-2007 Daniel P. Berrange
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of either the \s-1GNU\s0 General Public License as published
by the Free Software Foundation (either version 2 of the License, or at
your option any later version), or, the Artistic License, as specified
in the Perl \s-1README\s0 file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR