startSiteRadioScanPacketCapture
POST {{host}}/api/v1/sites/:site_id/pcaps/capture
Parameters
| Name | Type | Description |
|---|---|---|
num_packets | int | number of packets to capture, 0 for unlimited, default is 1024 for client-capture |
duration | int | duration of the capture, in seconds, default is 600, maximum is 86400 |
max_pkt_len | int | max_len of each packet to capture, default is 512, minimum is 128 and maximum is 2048 |
ap_mac | string | optional filter by ap_mac |
format | string | pcap format, pcap / stream, default is pcap |
band | string | 24 / 5 / 6, default is 5 (for scan) and 24 (for other). Only Single value allowed, default value gets applied when user provides wrong values |
tcpdump_expression | string | tcpdump expression specific to radiotap |
client_mac | string | optional filter by client mac |
channel | int | specify the channel value where scan PCAP has to be started, default value gets applied when user provides wrong values |
bandwidth | int | channel width for the band, 20 / 40 / 80 / 160, 80 is only applicable for band5 and 160 is only for band6, defaults to ‘20’ when user provides wrong values |
aps | dict | dictionary key is AP mac and value is a dictionary which contains key “band”, “bandwidth”, “channel” and “tcpdump_expression”. In case keys are missed we will take parent value if parent values are not set we will use default value. |
Request Body
{"type"=>"scan", "num_packets"=>100, "duration"=>600, "max_pkt_len"=>68, "ap_mac"=>nil, "band"=>"24", "format"=>"stream", "tcpdump_expression"=>"tcp port 80", "client_mac"=>"38f9d3972ff1", "bandwidth"=>20, "channel"=>1, "aps"=>{"5c5b35000001"=>{"channel"=>7, "band"=>"5", "bandwidth"=>20, "tcpdump_expression"=>"..."}}}