virt.instance.image_choices
===========================

Provide choices for instance image from a remote repository.

.. 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_instances_image_choices</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>virt_instances_image_choices</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {"remote": "LINUX_CONTAINERS"}</span><br/>
    <span class="description"><p>Options for filtering available images.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_remote">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_remote">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_remote" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_remote" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_remote')" type="button"><span class="property-name">remote</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_remote" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_remote" id="Call_parameters_items_i0_remote">
    <div class="card-body pl-5">
    <h4>Remote</h4><span class="badge badge-dark value-type">Type: const</span> <span class="badge badge-success default-value">Default: "LINUX_CONTAINERS"</span><br/>
    <span class="description"><p>Remote image source to query for available images.</p>
    </span><span class="const-value" id="Call_parameters_items_i0_remote_const">Specific value: <code>"LINUX_CONTAINERS"</code></span>
    </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: object</span><br/>
    <span class="description"><p>Available images indexed by image identifier.</p>
    </span>
    <div class="accordion" id="accordionReturn_value_additionalProperties">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties" id="Return_value_additionalProperties">
    <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p>
    <h4>ImageChoiceItem</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="accordionReturn_value_additionalProperties_label">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_label">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_label" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_label" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_label')" type="button"><span class="property-name">label</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_label" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_label" id="Return_value_additionalProperties_label">
    <div class="card-body pl-5">
    <h4>Label</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Human-readable label for the image.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_os">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_os">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_os" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_os" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_os')" type="button"><span class="property-name">os</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_os" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_os" id="Return_value_additionalProperties_os">
    <div class="card-body pl-5">
    <h4>Os</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Operating system family of the image.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_release">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_release">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_release" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_release" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_release')" type="button"><span class="property-name">release</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_release" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_release" id="Return_value_additionalProperties_release">
    <div class="card-body pl-5">
    <h4>Release</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Version or release name of the operating system.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_archs">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_archs">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_archs" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_archs" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_archs')" type="button"><span class="property-name">archs</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_archs" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_archs" id="Return_value_additionalProperties_archs">
    <div class="card-body pl-5">
    <h4>Archs</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of supported hardware architectures.</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_additionalProperties_archs_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_variant">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_variant">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_variant" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_variant" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_variant')" type="button"><span class="property-name">variant</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_variant" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_variant" id="Return_value_additionalProperties_variant">
    <div class="card-body pl-5">
    <h4>Variant</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Image variant (default, cloud, minimal, etc.).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_instance_types">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_instance_types">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_instance_types" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_instance_types" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_instance_types')" type="button"><span class="property-name">instance_types</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_instance_types" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_instance_types" id="Return_value_additionalProperties_instance_types">
    <div class="card-body pl-5">
    <h4>Instance Types</h4><span class="badge badge-dark value-type">Type: array of enum (of string)</span><br/>
    <span class="description"><p>Array of instance types this image supports.</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_additionalProperties_instance_types_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_additionalProperties_instance_types_items_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"CONTAINER"</li><li class="list-group-item enum-item">"VM"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_secureboot">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_secureboot">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_secureboot" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_secureboot" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_secureboot')" type="button"><span class="property-name">secureboot</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_secureboot" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_secureboot" id="Return_value_additionalProperties_secureboot">
    <div class="card-body pl-5">
    <h4>Secureboot</h4><br/>
    <span class="description"><p>Whether the image supports UEFI Secure Boot or <code>null</code> if not applicable.</p>
    </span><div class="any-of-value" id="Return_value_additionalProperties_secureboot_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_additionalProperties_secureboot_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_additionalProperties_secureboot_anyOf_i0" id="Return_value_additionalProperties_secureboot_anyOf_i0" onclick="setAnchor('#Return_value_additionalProperties_secureboot_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_additionalProperties_secureboot_anyOf_i1" id="Return_value_additionalProperties_secureboot_anyOf_i1" onclick="setAnchor('#Return_value_additionalProperties_secureboot_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_Return_value_additionalProperties_secureboot_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: boolean</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_additionalProperties_secureboot_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>
    </div>
    </div><br><br>

*Required roles:* READONLY_ADMIN | VIRT_INSTANCE_READ

