interface.choices
=================

Choices of available network interfaces.

.. 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: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Options for filtering interface choices.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_bridge_members">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_bridge_members">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_bridge_members" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_bridge_members" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_bridge_members')" type="button"><span class="property-name">bridge_members</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_bridge_members" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_bridge_members" id="Call_parameters_items_i0_bridge_members">
    <div class="card-body pl-5">
    <h4>Bridge Members</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Include BRIDGE members.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_lag_ports">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_lag_ports">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_lag_ports" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_lag_ports" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_lag_ports')" type="button"><span class="property-name">lag_ports</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_lag_ports" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_lag_ports" id="Call_parameters_items_i0_lag_ports">
    <div class="card-body pl-5">
    <h4>Lag Ports</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Include LINK_AGGREGATION ports.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_vlan_parent">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_vlan_parent">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_vlan_parent" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_vlan_parent" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_vlan_parent')" type="button"><span class="property-name">vlan_parent</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_vlan_parent" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_vlan_parent" id="Call_parameters_items_i0_vlan_parent">
    <div class="card-body pl-5">
    <h4>Vlan Parent</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Include VLAN parent interface.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_exclude">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_exclude">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_exclude')" type="button"><span class="property-name">exclude</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_exclude" id="Call_parameters_items_i0_exclude">
    <div class="card-body pl-5">
    <h4>Exclude</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: ["epair", "tap", "vnet"]</span><br/>
    <span class="description"><p>Prefixes of interfaces to exclude from the result.</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="Call_parameters_items_i0_exclude_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_exclude_types">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_exclude_types">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_exclude_types" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_exclude_types" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_exclude_types')" type="button"><span class="property-name">exclude_types</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_exclude_types" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_exclude_types" id="Call_parameters_items_i0_exclude_types">
    <div class="card-body pl-5">
    <h4>Exclude Types</h4><span class="badge badge-dark value-type">Type: array of enum (of string)</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Types of interfaces to exclude from the result.</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="Call_parameters_items_i0_exclude_types_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Call_parameters_items_i0_exclude_types_items_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"BRIDGE"</li><li class="list-group-item enum-item">"LINK_AGGREGATION"</li><li class="list-group-item enum-item">"PHYSICAL"</li><li class="list-group-item enum-item">"UNKNOWN"</li><li class="list-group-item enum-item">"VLAN"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_include">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_include">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_include" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_include" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_include')" type="button"><span class="property-name">include</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_include" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_include" id="Call_parameters_items_i0_include">
    <div class="card-body pl-5">
    <h4>Include</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Specific interfaces to include even if they would normally be excluded.</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="Call_parameters_items_i0_include_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </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>Result</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Names and descriptions of available network interfaces.</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>
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* NETWORK_INTERFACE_READ