1
0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-20 18:03:50 +03:00

virDomainSetBlockThreshold: Document values of '@dev' better

Mention where to obtain the index and how it's treated.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Peter Krempa 2020-07-15 13:02:24 +02:00
parent bb4e0596d9
commit 794d7d97d8

View File

@ -12371,6 +12371,12 @@ int virDomainGetGuestInfo(virDomainPtr domain,
* 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.
*
* @dev can either be a disk target name (vda, sda) or disk target with index (
* vda[4]). Without the index the top image in the backing chain will have the
* threshold set. The index corresponds to the 'index' attribute reported in the
* live VM XML for 'backingStore' or 'source' elements of a disk. If index is
* given the threshold is set for the corresponding image.
*
* Hypervisors report the last written sector of an image in the bulk stats API
* (virConnectGetAllDomainStats/virDomainListGetStats) as
* "block.<num>.allocation" in the VIR_DOMAIN_STATS_BLOCK group. The current