[PATCH v2 6/8] Update NVRAM documentation

Rohit Kumar rohit.kumar3 at nutanix.com
Fri Apr 8 17:48:49 UTC 2022


Updating the doc as now NVRAM can be remote as well.

Signed-off-by: Prerna Saxena <prerna.saxena at nutanix.com>
Signed-off-by: Florian Schmidt <flosch at nutanix.com>
Signed-off-by: Rohit Kumar <rohit.kumar3 at nutanix.com>
---
 docs/formatdomain.rst | 43 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 35 insertions(+), 8 deletions(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 24fbfd8670..53361c7996 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -141,6 +141,31 @@ harddisk, cdrom, network) determining where to obtain/find the boot image.
    </os>
    ...
 
+   <!-- QEMU with UEFI manual firmware, secure boot and with NVRAM type 'file'-->
+   ...
+   <os>
+     <type>hvm</type>
+     <loader readonly='yes' secure='yes' type='pflash'>/usr/share/OVMF/OVMF_CODE.fd</loader>
+     <nvram type='file' template='/usr/share/OVMF/OVMF_VARS.fd'>
+       <source file='/var/lib/libvirt/nvram/guest_VARS.fd'/>
+     <boot dev='hd'/>
+   </os>
+   ...
+
+   <!-- QEMU with UEFI manual firmware, secure boot and with network backed NVRAM'-->
+   ...
+   <os>
+     <type>hvm</type>
+     <loader readonly='yes' secure='yes' type='pflash'>/usr/share/OVMF/OVMF_CODE.fd</loader>
+     <nvram type='network'>
+       <source protocol='iscsi' name='iqn.2013-07.com.example:iscsi-nopool/0'>
+         <host name='example.com' port='6000'/>
+       </source>
+     </nvram>
+     <boot dev='hd'/>
+   </os>
+   ...
+
    <!-- QEMU with automatic UEFI firmware and secure boot -->
    ...
    <os firmware='efi'>
@@ -222,14 +247,16 @@ harddisk, cdrom, network) determining where to obtain/find the boot image.
    :since:`Since 2.1.0`
 ``nvram``
    Some UEFI firmwares may want to use a non-volatile memory to store some
-   variables. In the host, this is represented as a file and the absolute path
-   to the file is stored in this element. Moreover, when the domain is started
-   up libvirt copies so called master NVRAM store file defined in ``qemu.conf``.
-   If needed, the ``template`` attribute can be used to per domain override map
-   of master NVRAM stores from the config file. Note, that for transient domains
-   if the NVRAM file has been created by libvirt it is left behind and it is
-   management application's responsibility to save and remove file (if needed to
-   be persistent). :since:`Since 1.2.8`
+   variables. They can be present on host or on some network storage.
+   In the host, this is represented as a file and the absolute path
+   to the file is stored in this element. On network storage,
+   this can be accessed by providing network path. Moreover, when the domain
+   is started up libvirt copies so called master NVRAM store file defined
+   in ``qemu.conf``. If needed, the ``template`` attribute can be used to per
+   domain override map of master NVRAM stores from the config file. Note, that
+   for transient domains if the NVRAM file has been created by libvirt
+   it is left behind and it is management application's responsibility to
+   save and remove file (if needed to be persistent). :since:`Since 1.2.8`
 ``boot``
    The ``dev`` attribute takes one of the values "fd", "hd", "cdrom" or
    "network" and is used to specify the next boot device to consider. The
-- 
2.25.1



More information about the libvir-list mailing list