vm.export_disk_image

Exports a zvol to a formatted VM disk image.

Utilized qemu-img with the conversion functionality to export a zvol to any supported disk image format, from RAW -> ${OTHER}. The resulting file will be set to inherit the permissions of the target directory.

As of this implementation it supports the following {format} options :

  • QCOW2 - QED - RAW - VDI - VPC - VMDK

format is an required parameter for the exported disk image directory is an required parameter for the export disk image zvol is the source for the disk image

This method is a job.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: vm_export_disk_image

vm_export_disk_image

Type: object

VMExportDiskImageArgs parameters.

 No Additional Properties

Format

Type: string

Output format for the exported disk image (e.g., 'qcow2', 'raw').

Must be at least 1 characters long

Directory

Type: string

Directory path where the exported disk image will be saved.

Must be at least 1 characters long

Zvol

Type: string

Source ZFS volume to export as a disk image.

Must be at least 1 characters long

Result

Type: boolean

Whether the disk image export operation was successful.


Required roles: VM_WRITE