mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-27 09:18:09 +00:00
31 lines
1.0 KiB
ReStructuredText
31 lines
1.0 KiB
ReStructuredText
/v1/{project_id}/virtualbox/{vm_id}/capture/{adapter_id:\d+}/start
|
|
-----------------------------------------------------------
|
|
|
|
.. contents::
|
|
|
|
POST /v1/**{project_id}**/virtualbox/**{vm_id}**/capture/**{adapter_id:\d+}**/start
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Start a packet capture on a VirtualBox VM instance
|
|
|
|
Parameters
|
|
**********
|
|
- **vm_id**: UUID for the instance
|
|
- **project_id**: UUID for the project
|
|
- **adapter_id**: Adapter to start a packet capture
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Capture started
|
|
- **400**: Invalid request
|
|
- **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>✔</td> <td>string</td> <td>Capture file name</td> </tr>
|
|
</table>
|
|
|