gns3-server/docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst

33 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2016-06-04 11:40:39 +03:00
/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
2016-04-18 17:58:06 +03:00
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
2016-06-04 11:40:39 +03:00
POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
2016-04-18 17:58:06 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-04 11:40:39 +03:00
Start a packet capture on an ATM switch instance
2016-04-18 17:58:06 +03:00
Parameters
**********
2017-03-06 15:35:39 +02:00
- **node_id**: Node UUID
2018-01-08 06:57:07 +02:00
- **project_id**: Project UUID
2016-11-03 19:20:51 +02:00
- **port_number**: Port on the switch
2018-01-08 06:57:07 +02:00
- **adapter_number**: Adapter on the switch (always 0)
2016-04-18 17:58:06 +03: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>
2017-03-06 15:35:39 +02:00
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
2016-04-18 17:58:06 +03:00
</table>