1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

33 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2016-03-07 16:57:12 +00:00
/v2/hypervisor/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
------------------------------------------------------------------------------------------------------------------------------------------
2015-10-16 17:05:29 +00:00
.. contents::
2016-03-07 16:57:12 +00:00
POST /v2/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-10-16 17:05:29 +00:00
Start a packet capture on a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
2015-10-16 17:05:29 +00:00
- **vm_id**: UUID for the instance
2016-03-11 16:20:09 +00:00
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
2015-10-16 17:05:29 +00:00
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_file_name</td> <td>&#10004;</td> <td>string</td> <td>Capture file name</td> </tr>
2016-03-04 16:50:17 +00:00
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
2015-10-16 17:05:29 +00:00
</table>