<?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 formatsecret.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: Secret XML format</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="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="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a> </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="active" href="format.html">XML format</a> <ul class="l2"><li> <div> <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a> </div> </li><li> <div> <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a> </div> </li><li> <div> <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a> </div> </li><li> <div> <a title="Storage volume encryption XML format" class="inactive" href="formatstorageencryption.html">Storage Encryption</a> </div> </li><li> <div> <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a> </div> </li><li> <div> <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a> </div> </li><li> <div> <span class="active">Secrets</span> </div> </li><li> <div> <a title="The snapshot XML format" class="inactive" href="formatsnapshot.html">Snapshots</a> </div> </li></ul> </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></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="FAQ.html">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="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>Secret XML format</h1> <ul><li> <a href="#SecretAttributes">Secret XML</a> </li><li> <a href="#example">Example</a> </li></ul> <h2> <a name="SecretAttributes" id="SecretAttributes">Secret XML</a> </h2> <p> Secrets stored by libvirt may have attributes associated with them, using the <code>secret</code> element. The <code>secret</code> element has two optional attributes, each with values '<code>yes</code>' and '<code>no</code>', and defaulting to '<code>no</code>': </p> <dl><dt><code>ephemeral</code></dt><dd>This secret must only be kept in memory, never stored persistently. </dd><dt><code>private</code></dt><dd>The value of the secret must not be revealed to any caller of libvirt, nor to any other node. </dd></dl> <p> The top-level <code>secret</code> element may contain the following elements: </p> <dl><dt><code>uuid</code></dt><dd> An unique identifier for this secret (not necessarily in the UUID format). If omitted when defining a new secret, a random UUID is generated. </dd><dt><code>description</code></dt><dd>A human-readable description of the purpose of the secret. </dd><dt><code>usage</code></dt><dd> Specifies what this secret is used for. A mandatory <code>type</code> attribute specifies the usage category, currently only <code>volume</code> is defined. Specific usage categories are described below. </dd></dl> <h3>Usage type "volume"</h3> <p> This secret is associated with a volume, and it is safe to delete the secret after the volume is deleted. The <code><usage type='volume'></code> element must contain a single <code>volume</code> element that specifies the key of the volume this secret is associated with. </p> <h2> <a name="example" id="example">Example</a> </h2> <pre> <secret ephemeral='no' private='yes'> <description>LUKS passphrase for the main hard drive of our mail server</description> <usage type='volume'> <volume>/var/lib/libvirt/images/mail.img</volume> </usage> </secret></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>