docs: Document user aliases

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Michal Privoznik 2017-10-18 13:48:46 +02:00
parent 0429e52f19
commit 93bc2c2126

View File

@ -2256,6 +2256,29 @@
</dd>
</dl>
<p>
To help users identifying devices they care about, every
device can have direct child <code>alias</code> element
which then has <code>name</code> attribute where users can
store identifier for the device. The identifier has to have
"ua-" prefix and must be unique within the domain. Additionally, the
identifier must consist only of the following characters:
<code>[a-zA-Z0-9_-]</code>.
<span class="since">Since 3.9.0</span>
</p>
<pre>
&lt;devices&gt;
&lt;disk type='file'&gt;
&lt;alias name='ua-myDisk'/&gt;
&lt;/disk&gt;
&lt;interface type='network' trustGuestRxFilters='yes'&gt;
&lt;alias name='ua-myNIC'/&gt;
&lt;/interface&gt;
...
&lt;/devices&gt;
</pre>
<h4><a id="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>
<p>