<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
This file is autogenerated from hooks.html.in
Do not edit this file. Changes will be lost.
-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="main.css" />
<link rel="SHORTCUT ICON" href="32favicon.png" />
<title>libvirt: Hooks for specific system management</title>
<meta name="description" content="libvirt, virtualization, virtualization API" />
</head>
<body>
<div id="header">
<div id="headerLogo"></div>
<div id="headerSearch">
<form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
<input id="query" name="query" type="text" size="12" value="" />
<input id="submit" name="submit" type="submit" value="Search" />
</div></form>
</div>
</div>
<div id="body">
<div id="menu">
<ul class="l0"><li>
<div>
<a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
</div>
</li><li>
<div>
<a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
</div>
</li><li>
<div>
<a title="Applications known to use libvirt" class="inactive" href="apps.html">Applications</a>
</div>
</li><li>
<div>
<a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
</div>
</li><li>
<div>
<a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
<ul class="l1"><li>
<div>
<a title="How to compile libvirt" class="inactive" href="compiling.html">Compiling</a>
</div>
</li><li>
<div>
<a title="Information about deploying and using libvirt" class="active" href="deployment.html">Deployment</a>
<ul class="l2"><li>
<div>
<a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
</div>
</li><li>
<div>
<a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
</div>
</li><li>
<div>
<a title="Configure authentication for the libvirt daemon" class="inactive" href="auth.html">Authentication</a>
</div>
</li><li>
<div>
<a title="Migrating guests between machines" class="inactive" href="migration.html">Migration</a>
</div>
</li><li>
<div>
<a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
</div>
</li><li>
<div>
<a title="The library and the daemon logging support" class="inactive" href="logging.html">Logging</a>
</div>
</li><li>
<div>
<a title="Firewall and network filter configuration" class="inactive" href="firewall.html">Firewall</a>
</div>
</li><li>
<div>
<a title="Ensuring exclusive guest access to disks" class="inactive" href="locking.html">Disk locking</a>
</div>
</li><li>
<div>
<span class="active">Hooks</span>
</div>
</li></ul>
</div>
</li><li>
<div>
<a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
</div>
</li><li>
<div>
<a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
</div>
</li><li>
<div>
<a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
</div>
</li><li>
<div>
<a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
</div>
</li><li>
<div>
<a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
</div>
</li><li>
<div>
<a title="Working on the internals of libvirt API, driver and daemon code" class="inactive" href="internals.html">Internals</a>
</div>
</li><li>
<div>
<a title="A guide and reference for developing with libvirt" class="inactive" href="devguide.html">Development Guide</a>
</div>
</li><li>
<div>
<a title="Command reference for virsh" class="inactive" href="virshcmdref.html">Virsh Commands</a>
</div>
</li></ul>
</div>
</li><li>
<div>
<a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
</div>
</li><li>
<div>
<a title="Frequently asked questions" class="inactive" href="http://wiki.libvirt.org/page/FAQ">FAQ</a>
</div>
</li><li>
<div>
<a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
</div>
</li><li>
<div>
<a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
</div>
</li><li>
<div>
<a title="Available test suites for libvirt" class="inactive" href="testsuites.html">Test suites</a>
</div>
</li><li>
<div>
<a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
</div>
</li><li>
<div>
<a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
</div>
</li></ul>
</div>
<div id="content">
<h1>Hooks for specific system management</h1>
<ul><li>
<a href="#intro">Custom event scripts</a>
</li><li>
<a href="#location">Script location</a>
</li><li>
<a href="#names">Script names</a>
</li><li>
<a href="#structure">Script structure</a>
</li><li>
<a href="#arguments">Script arguments</a>
</li><li>
<a href="#execution">Script execution</a>
</li><li>
<a href="#qemu_migration">QEMU guest migration</a>
</li><li>
<a href="#recursive">Calling libvirt functions from within a hook script</a>
</li><li>
<a href="#return_codes">Return codes and logging</a>
</li></ul>
<h2>
<a name="intro" id="intro">Custom event scripts</a>
</h2>
<p>Beginning with libvirt 0.8.0, specific events on a host system will
trigger custom scripts.</p>
<p>These custom <b>hook</b> scripts are executed when any of the following
actions occur:</p>
<ul><li>The libvirt daemon starts, stops, or reloads its
configuration<br /><br /></li><li>A QEMU guest is started or stopped<br /><br /></li><li>An LXC guest is started or stopped<br /><br /></li></ul>
<h2>
<a name="location" id="location">Script location</a>
</h2>
<p>The libvirt hook scripts are located in the directory
<code>$SYSCONFDIR/libvirt/hooks/</code>.</p>
<ul><li>In Linux distributions such as Fedora and RHEL, this is
<code>/etc/libvirt/hooks/</code>. Other Linux distributions may do
this differently.</li><li>If your installation of libvirt has instead been compiled from
source, it is likely to be
<code>/usr/local/etc/libvirt/hooks/</code>.</li></ul>
<p>To use hook scripts, you will need to create this <code>hooks</code>
directory manually, place the desired hook scripts inside, then make
them executable.</p>
<br />
<h2>
<a name="names" id="names">Script names</a>
</h2>
<p>At present, there are three hook scripts that can be called:</p>
<ul><li><code>/etc/libvirt/hooks/daemon</code><br /><br />
Executed when the libvirt daemon is started, stopped, or reloads
its configuration<br /><br /></li><li><code>/etc/libvirt/hooks/qemu</code><br /><br />
Executed when a QEMU guest is started, stopped, or migrated<br /><br /></li><li><code>/etc/libvirt/hooks/lxc</code><br /><br />
Executed when an LXC guest is started or stopped</li></ul>
<br />
<h2>
<a name="structure" id="structure">Script structure</a>
</h2>
<p>The hook scripts are executed using standard Linux process creation
functions. Therefore, they must begin with the declaration of the
command interpreter to use.</p>
<p>For example:</p>
<pre>#!/bin/bash</pre>
<p>or:</p>
<pre>#!/usr/bin/python</pre>
<p>Other command interpreters are equally valid, as is any executable
binary, so you are welcome to use your favourite languages.</p>
<br />
<h2>
<a name="arguments" id="arguments">Script arguments</a>
</h2>
<p>The hook scripts are called with specific command line arguments,
depending upon the script, and the operation being performed.</p>
<p>The guest hook scripts, qemu and lxc, are also given the <b>full</b>
XML description for the domain on their stdin. This includes items
such the UUID of the domain and its storage information, and is
intended to provide all the libvirt information the script needs.</p>
<p>The command line arguments take this approach:</p>
<ol><li>The first argument is the name of the <b>object</b> involved in the
operation, or '-' if there is none.<br /><br />
For example, the name of a guest being started.<br /><br /></li><li>The second argument is the name of the <b>operation</b> being
performed.<br /><br />
For example, "start" if a guest is being started.<br /><br /></li><li>The third argument is a <b>sub-operation</b> indication, or '-' if there
is none.<br /><br /></li><li>The last argument is an <b>extra argument</b> string, or '-' if there is
none.</li></ol>
<h4>
<a name="arguments_specifics" id="arguments_specifics">Specifics</a>
</h4>
<p>This translates to the following specifics for each hook script:</p>
<h5>
<a name="daemon" id="daemon">/etc/libvirt/hooks/daemon</a>
</h5>
<ul><li>When the libvirt daemon is started, this script is called as:<br /><pre>/etc/libvirt/hooks/daemon - start - start</pre></li><li>When the libvirt daemon is shut down, this script is called as:<br /><pre>/etc/libvirt/hooks/daemon - shutdown - shutdown</pre></li><li>When the libvirt daemon receives the SIGHUP signal, it reloads its
configuration and triggers the hook script as:<br /><pre>/etc/libvirt/hooks/daemon - reload begin SIGHUP</pre></li></ul>
<p>Please note that when the libvirt daemon is restarted, the <i>daemon</i>
hook script is called once with the "shutdown" operation, and then once
with the "start" operation. There is no specific operation to indicate
a "restart" is occurring.</p>
<h5>
<a name="qemu" id="qemu">/etc/libvirt/hooks/qemu</a>
</h5>
<ul><li>Before a QEMU guest is started, the qemu hook script is
called in two locations; if either location fails, the guest
is not started. The first location, <span class="since">since
0.9.0</span>, is before libvirt performs any resource
labeling, and the hook can allocate resources not managed by
libvirt such as DRBD or missing bridges. This is called as:<br /><pre>/etc/libvirt/hooks/qemu guest_name prepare begin -</pre>
The second location, available <span class="since">Since
0.8.0</span>, occurs after libvirt has finished labeling
all resources, but has not yet started the guest, called as:<br /><pre>/etc/libvirt/hooks/qemu guest_name start begin -</pre></li><li>When a QEMU guest is stopped, the qemu hook script is called
in two locations, to match the startup.
First, <span class="since">since 0.8.0</span>, the hook is
called before libvirt restores any labels:<br /><pre>/etc/libvirt/hooks/qemu guest_name stopped end -</pre>
Then, after libvirt has released all resources, the hook is
called again, <span class="since">since 0.9.0</span>, to allow
any additional resource cleanup:<br /><pre>/etc/libvirt/hooks/qemu guest_name release end -</pre></li><li><span class="since">Since 0.9.11</span>, the qemu hook script
is also called at the beginning of incoming migration. It is called
as: <pre>/etc/libvirt/hooks/qemu guest_name migrate begin -</pre>
with domain XML sent to standard input of the script. In this case,
the script acts as a filter and is supposed to modify the domain
XML and print it out on its standard output. Empty output is
identical to copying the input XML without changing it. In case the
script returns failure or the output XML is not valid, incoming
migration will be canceled. This hook may be used, e.g., to change
location of disk images for incoming domains.</li></ul>
<h5>
<a name="lxc" id="lxc">/etc/libvirt/hooks/lxc</a>
</h5>
<ul><li>When an LXC guest is started, the lxc hook script is called as:<br /><pre>/etc/libvirt/hooks/lxc guest_name start begin -</pre></li><li>When a LXC guest is stopped, the lxc hook script is called
as:<br /><pre>/etc/libvirt/hooks/lxc guest_name stopped end -</pre></li></ul>
<br />
<h2>
<a name="execution" id="execution">Script execution</a>
</h2>
<ul><li>The "start" operation for the guest hook scripts, qemu and lxc,
executes <b>prior</b> to the guest being created. This allows the
guest start operation to be aborted if the script returns indicating
failure.<br /><br /></li><li>The "shutdown" operation for the guest hook scripts, qemu and lxc,
executes <b>after</b> the guest has stopped. If the hook script
indicates failure in its return, the shut down of the guest cannot
be aborted because it has already been performed.<br /><br /></li><li>Hook scripts execute in a synchronous fashion. Libvirt waits
for them to return before continuing the given operation.<br /><br />
This is most noticeable with the guest start operation, as a lengthy
operation in the hook script can mean an extended wait for the guest
to be available to end users.<br /><br /></li><li>For a hook script to be utilised, it must have its execute bit set
(ie. chmod o+rx <i>qemu</i>), and must be present when the libvirt
daemon is started.<br /><br /></li><li>If a hook script is added to a host after the libvirt daemon is
already running, it won't be used until the libvirt daemon
next starts.</li></ul>
<br />
<h2>
<a name="qemu_migration" id="qemu_migration">QEMU guest migration</a>
</h2>
<p>Migration of a QEMU guest involves running hook scripts on both the
source and destination hosts:</p>
<ol><li>At the beginning of the migration, the <i>qemu</i> hook script on
the <b>destination</b> host is executed with the "migrate"
operation.</li><li>Before QEMU process is spawned, the two operations ("prepare" and
"start") called for domain start are executed on
<b>destination</b> host.</li><li>If both of these hook script executions exit successfully (exit
status 0), the migration continues. Any other exit code indicates
failure, and the migration is aborted.</li><li>The QEMU guest is then migrated to the destination host.</li><li>Unless an error occurs during the migration process, the <i>qemu</i>
hook script on the <b>source</b> host is then executed with the
"stopped" and "release" operations to indicate it is no longer
running on this host. Regardless of the return codes, the
migration is not aborted as it has already been performed.</li></ol>
<br />
<h2>
<a name="recursive" id="recursive">Calling libvirt functions from within a hook script</a>
</h2>
<p>
<b>DO NOT DO THIS!</b>
</p>
<p>A hook script must not call back into libvirt, as the libvirt daemon
is already waiting for the script to exit.</p>
<p>A deadlock is likely to occur.</p>
<br />
<h2>
<a name="return_codes" id="return_codes">Return codes and logging</a>
</h2>
<p>If a hook script returns with an exit code of 0, the libvirt daemon
regards this as successful and performs no logging of it.</p>
<p>However, if a hook script returns with a non zero exit code, the libvirt
daemon regards this as a failure, logs it with return code 256, and
additionally logs anything on stderr the hook script returns.</p>
<p>For example, a hook script might use this code to indicate failure,
and send a text string to stderr:</p>
<pre>echo "Could not find required XYZZY" >&2
exit 1</pre>
<p>The resulting entry in the libvirt log will appear as:</p>
<pre>20:02:40.297: error : virHookCall:416 : Hook script execution failed: Hook script /etc/libvirt/hooks/qemu qemu failed with error code 256:Could not find required XYZZY</pre>
</div>
</div>
<div id="footer">
<p id="sponsor">
Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
</div>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
cd63cb6f90cc0190f381b8d56f10fc99
>
files
>
53
