include: Define constant for save image format

Add a new VIR_DOMAIN_SAVE_PARAM_IMAGE_FORMAT typed parameter for
specifying the save image format. A format specified via the
virDomainSaveParams API overrides the save_image_format setting
in qemu.conf. The 'raw' format remains the default.

Signed-off-by: Jim Fehlig <jfehlig@suse.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 2d27f96be94db342bb5d0e922fc4a13ef0f0e9a9..0121620e9cd5de7a262bf2118dfd136cb4fb1b49 100644 (file)
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -1700,6 +1700,19 @@ int                     virDomainRestoreParams  (virConnectPtr conn,
  */
 # define VIR_DOMAIN_SAVE_PARAM_DXML             "dxml"
 
+/**
+ * VIR_DOMAIN_SAVE_PARAM_IMAGE_FORMAT:
+ *
+ * an optional parameter used to specify the format of the save image.
+ * Valid formats are raw, zstd, lzop, gzip, bzip2, and xz. If not
+ * specified, the save_image_format setting in qemu.conf is used, which
+ * defaults to raw. As VIR_TYPED_PARAM_STRING.
+ *
+ * Since: 11.2.0
+ */
+# define VIR_DOMAIN_SAVE_PARAM_IMAGE_FORMAT     "image_format"
+
+
 /* See below for virDomainSaveImageXMLFlags */
 char *          virDomainSaveImageGetXMLDesc    (virConnectPtr conn,
                                                  const char *file,

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 05101756a15d607abda9179296e15712d9300601..18451ebdb9b6a3cfa40a4e210fb5681decf40689 100644 (file)
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -1010,6 +1010,9 @@ virDomainSaveFlags(virDomainPtr domain, const char *to,
  * If VIR_DOMAIN_SAVE_PARAM_FILE is not provided then a managed save is
  * performed (see virDomainManagedSave).
  *
+ * See VIR_DOMAIN_SAVE_PARAM_* for detailed description of accepted save
+ * parameters.
+ *
  * Returns 0 in case of success and -1 in case of failure.
  *
  * Since: 8.4.0