packet_capture¶
Overview¶
Capture and download pcapng on different interfaces[Max File Size 575 MB]
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/diag/
Schemes : HTTP
Tags¶
- packet_capture : Operations related to packet_capture
Paths¶
POST operation for packet_capture¶
POST /packet_capture
Description¶
Use this operation to capture pcap on different interfaces SD-WAN Appliance
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
packet_capture_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | packet_capture_post_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- packet_capture
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
duration¶
Duration for which packets have to be captured in seconds
Type : enum (5, 10, 15, 30)
filter_str¶
Filter string is used to determine which packets are captured
Type : string
interface¶
Interfaces on which packets have to be captured. Multiple Interfaces need to separated using a double hyphen. Ex: MGMT, MGT--1--2, LTE-1--MGMT--1/2, etc.
Type : string
max_packets¶
Max Number of Packets to be captured
Type : enum (1000, 2000, 5000, MAX)
message¶
Message about the packet capture event
Type : string
packet_capture¶
| Name | Schema |
|---|---|
| duration optional |
duration |
| filter_str optional |
filter_str |
| interface optional |
interface |
| max_packets optional |
max_packets |
packet_capture_delete_success_schema¶
| Name | Schema |
|---|---|
| packet_capture optional |
packet_capture |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
packet_capture_post_success_schema¶
| Name | Schema |
|---|---|
| packet_capture optional |
packet_capture |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
packet_capture_put_success_schema¶
| Name | Schema |
|---|---|
| packet_capture optional |
packet_capture |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
packet_capture_request_schema¶
| Name | Schema |
|---|---|
| packet_capture optional |
packet_capture |
packet_capture_response_schema¶
Type : < packet_capture_response_schema > array
packet_capture_response_schema
| Name | Schema |
|---|---|
| duration optional |
duration |
| filter_str optional |
filter_str |
| interface optional |
interface |
| max_packets optional |
max_packets |
| message optional |
message |
| summary optional |
summary |
summary¶
Summary of Packets captured
Type : < summary > array
| Name | Description | Schema |
|---|---|---|
| dst_ip optional read-only |
Destination IP of the packet . | string |
| dst_mac optional read-only |
Destination MAC of the Packet . | string |
| dst_port optional read-only |
Destination Port of the Packet | string |
| length optional read-only |
Packet length in bytes | string |
| number optional read-only |
Packet Number | string |
| protocol optional read-only |
Protocol Used by the packet | string |
| src_ip optional read-only |
Source IP of the Packet | string |
| src_mac optional read-only |
Source MAC Address of Packet | string |
| src_port optional read-only |
Source Port of the Packet | string |
| time optional read-only |
Packet Time | string |