virt.device.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 a required parameter for the exported disk image `directory` is a required parameter for the export disk image `zvol` is the source for the disk image

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: virt_device_export_disk_image</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>virt_device_export_disk_image</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_format"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_format"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_format" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_format" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_format')" type="button"><span class="property-name">format</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_format" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_format" id="Call_parameters_items_i0_format"> <div class="card-body pl-5"> <h4>Format</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_format_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_directory"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_directory"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_directory" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_directory" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_directory')" type="button"><span class="property-name">directory</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_directory" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_directory" id="Call_parameters_items_i0_directory"> <div class="card-body pl-5"> <h4>Directory</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_directory_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_zvol"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_zvol"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_zvol" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_zvol" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_zvol')" type="button"><span class="property-name">zvol</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_zvol" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_zvol" id="Call_parameters_items_i0_zvol"> <div class="card-body pl-5"> <h4>Zvol</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_zvol_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> </div><br><br>

*Required roles:* VIRT_INSTANCE_WRITE