virt.volume.create
==================

.. 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_volume_create</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>virt_volume_create</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>VirtVolumeCreateArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_name" id="Call_parameters_items_i0_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name for the new virtualization volume (alphanumeric, dashes, dots, underscores).</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_name_minLength">Must be at least <code>1</code> characters long</span></p><p><span class="badge badge-light restriction max-length-restriction" id="Call_parameters_items_i0_name_maxLength">Must be at most <code>63</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_content_type">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_content_type">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_content_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_content_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_content_type')" type="button"><span class="property-name">content_type</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_content_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_content_type" id="Call_parameters_items_i0_content_type">
    <div class="card-body pl-5">
    <h4>Content Type</h4><span class="badge badge-dark value-type">Type: const</span> <span class="badge badge-success default-value">Default: "BLOCK"</span><br/>
    <span class="const-value" id="Call_parameters_items_i0_content_type_const">Specific value: <code>"BLOCK"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_size">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_size">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_size" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_size" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_size')" type="button"><span class="property-name">size</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_size" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_size" id="Call_parameters_items_i0_size">
    <div class="card-body pl-5">
    <h4>Size</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 1024</span><br/>
    <span class="description"><p>Size of volume in MB and it should at least be 512 MB.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_size_number">Value must be greater or equal to <code>512</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_storage_pool">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_storage_pool">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_storage_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_storage_pool" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_storage_pool')" type="button"><span class="property-name">storage_pool</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_storage_pool" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_storage_pool" id="Call_parameters_items_i0_storage_pool">
    <div class="card-body pl-5">
    <h4>Storage Pool</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Storage pool in which to create the volume. This must be one of pools listed     in virt.global.config output under <code>storage_pools</code>. If the value is None, then     the pool defined as <code>pool</code> in virt.global.config will be used.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_storage_pool_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_storage_pool_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_storage_pool_anyOf_i0" id="Call_parameters_items_i0_storage_pool_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_storage_pool_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_storage_pool_anyOf_i1" id="Call_parameters_items_i0_storage_pool_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_storage_pool_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_storage_pool_anyOf_i0" role="tabpanel">
    <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_storage_pool_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_storage_pool_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </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>VirtVolumeEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The newly created virtualization volume configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for the virtualization volume.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_id_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_name" data-toggle="collapse" onclick="setAnchor('#Return_value_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_name" id="Return_value_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Human-readable name of the virtualization volume.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_storage_pool">
    <div class="card">
    <div class="card-header" id="headingReturn_value_storage_pool">
    <h2 class="mb-0">
    <button aria-controls="Return_value_storage_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_storage_pool" data-toggle="collapse" onclick="setAnchor('#Return_value_storage_pool')" type="button"><span class="property-name">storage_pool</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_storage_pool" class="collapse property-definition-div" data-parent="#accordionReturn_value_storage_pool" id="Return_value_storage_pool">
    <div class="card-body pl-5">
    <h4>Storage Pool</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the storage pool containing this volume.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_storage_pool_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_content_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_content_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_content_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_content_type" data-toggle="collapse" onclick="setAnchor('#Return_value_content_type')" type="button"><span class="property-name">content_type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_content_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_content_type" id="Return_value_content_type">
    <div class="card-body pl-5">
    <h4>Content Type</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Type of content stored in this volume (e.g., 'BLOCK', 'ISO').</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_content_type_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_created_at">
    <div class="card">
    <div class="card-header" id="headingReturn_value_created_at">
    <h2 class="mb-0">
    <button aria-controls="Return_value_created_at" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_created_at" data-toggle="collapse" onclick="setAnchor('#Return_value_created_at')" type="button"><span class="property-name">created_at</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_created_at" class="collapse property-definition-div" data-parent="#accordionReturn_value_created_at" id="Return_value_created_at">
    <div class="card-body pl-5">
    <h4>Created At</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Timestamp when this volume was created.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_type" data-toggle="collapse" onclick="setAnchor('#Return_value_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_type" id="Return_value_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Volume type indicating its storage backend and characteristics.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_type_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_config">
    <div class="card">
    <div class="card-header" id="headingReturn_value_config">
    <h2 class="mb-0">
    <button aria-controls="Return_value_config" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_config" data-toggle="collapse" onclick="setAnchor('#Return_value_config')" type="button"><span class="property-name">config</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_config" class="collapse property-definition-div" data-parent="#accordionReturn_value_config" id="Return_value_config">
    <div class="card-body pl-5">
    <h4>Config</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Object containing detailed configuration parameters for this volume.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_used_by">
    <div class="card">
    <div class="card-header" id="headingReturn_value_used_by">
    <h2 class="mb-0">
    <button aria-controls="Return_value_used_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_used_by" data-toggle="collapse" onclick="setAnchor('#Return_value_used_by')" type="button"><span class="property-name">used_by</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_used_by" class="collapse property-definition-div" data-parent="#accordionReturn_value_used_by" id="Return_value_used_by">
    <div class="card-body pl-5">
    <h4>Used By</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of virtual instance names currently using this volume.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_used_by_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_used_by_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* VIRT_IMAGE_WRITE