vm.get_guest_network_interfaces
===============================

Return the network interfaces visible inside a running VM as reported by the QEMU guest agent.

Requires the guest to have ``qemu-guest-agent`` installed and running.

.. note::
    This method polls the guest agent with a 30-second timeout. If the agent is not yet ready
    (e.g. the guest just booted), a :exc:`CallError` is raised and the caller should retry.

.. 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: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>ID of the virtual machine.</p>
    </span>
    </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: array of object</span><br/>
    <span class="description"><p>Network interfaces reported by the QEMU guest agent.</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_items">
    <h4>VMGuestNetworkInterface</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_items_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_items_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_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_name" id="Return_value_items_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>Interface name as seen in the guest OS (e.g. 'eth0', 'ens3').</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_hardware_address">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_hardware_address">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_hardware_address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_hardware_address" data-toggle="collapse" onclick="setAnchor('#Return_value_items_hardware_address')" type="button"><span class="property-name">hardware_address</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_hardware_address" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_hardware_address" id="Return_value_items_hardware_address">
    <div class="card-body pl-5">
    <h4>Hardware Address</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>MAC address of the interface.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_ip_addresses">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_ip_addresses">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_ip_addresses" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_ip_addresses" data-toggle="collapse" onclick="setAnchor('#Return_value_items_ip_addresses')" type="button"><span class="property-name">ip_addresses</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_ip_addresses" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_ip_addresses" id="Return_value_items_ip_addresses">
    <div class="card-body pl-5">
    <h4>Ip Addresses</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>IP addresses currently assigned to this interface.</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_items_ip_addresses_items">
    <h4>VMGuestNetworkInterfaceIPAddress</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_items_ip_addresses_items_ip_address">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_ip_addresses_items_ip_address">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_ip_addresses_items_ip_address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_ip_addresses_items_ip_address" data-toggle="collapse" onclick="setAnchor('#Return_value_items_ip_addresses_items_ip_address')" type="button"><span class="property-name">ip_address</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_ip_addresses_items_ip_address" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_ip_addresses_items_ip_address" id="Return_value_items_ip_addresses_items_ip_address">
    <div class="card-body pl-5">
    <h4>Ip Address</h4><br/>
    <span class="description"><p>IP address assigned to the interface.</p>
    </span><div class="any-of-value" id="Return_value_items_ip_addresses_items_ip_address_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_ip_addresses_items_ip_address_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_ip_addresses_items_ip_address_anyOf_i0" id="Return_value_items_ip_addresses_items_ip_address_anyOf_i0" onclick="setAnchor('#Return_value_items_ip_addresses_items_ip_address_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_items_ip_addresses_items_ip_address_anyOf_i1" id="Return_value_items_ip_addresses_items_ip_address_anyOf_i1" onclick="setAnchor('#Return_value_items_ip_addresses_items_ip_address_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_items_ip_addresses_items_ip_address_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Return_value_items_ip_addresses_items_ip_address_anyOf_i0_const">Specific value: <code>""</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_ip_addresses_items_ip_address_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_ip_addresses_items_prefix">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_ip_addresses_items_prefix">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_ip_addresses_items_prefix" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_ip_addresses_items_prefix" data-toggle="collapse" onclick="setAnchor('#Return_value_items_ip_addresses_items_prefix')" type="button"><span class="property-name">prefix</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_ip_addresses_items_prefix" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_ip_addresses_items_prefix" id="Return_value_items_ip_addresses_items_prefix">
    <div class="card-body pl-5">
    <h4>Prefix</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Prefix length (subnet mask bits).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_ip_addresses_items_ip_address_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_ip_addresses_items_ip_address_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_ip_addresses_items_ip_address_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_ip_addresses_items_ip_address_type" data-toggle="collapse" onclick="setAnchor('#Return_value_items_ip_addresses_items_ip_address_type')" type="button"><span class="property-name">ip_address_type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_ip_addresses_items_ip_address_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_ip_addresses_items_ip_address_type" id="Return_value_items_ip_addresses_items_ip_address_type">
    <div class="card-body pl-5">
    <h4>Ip Address Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Address family: 'IPV4' or 'IPV6'.</p>
    </span><div class="enum-value" id="Return_value_items_ip_addresses_items_ip_address_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"IPV4"</li><li class="list-group-item enum-item">"IPV6"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* VM_READ