gns3-server/docs/api/virtualboxuuidcaptureadapteriddstart.rst

/virtualbox/{uuid}/capture/{adapter_id:\d+}/start
---------------------------------------------

.. contents::

POST /virtualbox/**{uuid}**/capture/**{adapter_id:\d+}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a packet capture on a VirtualBox VM instance

Parameters
**********
- **uuid**: Instance UUID
- **adapter_id**: Adapter to start a packet capture

Response status codes
**********************
- **200**: Capture started
- **400**: Invalid instance UUID
- **404**: Instance doesn't exist

Input
*******
.. raw:: html

    <table>
    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
    <tr><td>capture_filename</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Capture file name</td>                     </tr>
    </table>