startOrgMxEdgePcap
POST https://{{host}}/api/v1/orgs/:org_id/pcaps/capture
Body Parameters
Name | Type | Description |
---|---|---|
num_packets | int | number of packets to capture, default is 1024, maximum of 10000 |
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 128, maximum is 2048 |
mxedges | dict | dict of mxedges which uses mxedge_id as the key, currently limited to one mxedge per org capture session |
interfaces | dict | dict of interfaces to capture for, for given mxedge (examples: port1, kni0, lacp0, ipsec, drop, oobm), currently limited to specifying one interface per mxedge |
tcpdump_expression | string | tcpdump expression, interface specific if specified under interfaces dict, otherwise applicable across interfaces if specified at top level of payload. Interface specific value overrides top level value when both exist. |
format | string | pcap format: stream (default, the only supported option) |
Request Body
{"type"=>"mxedge", "num_packets"=>100, "duration"=>600, "max_pkt_len"=>1500, "mxedges"=>{"00000000-0000-0000-1000-001122334455"=>{"interfaces"=>{"port1"=>{"tcpdump_expression"=>"udp port 67 or udp port 68"}}}}, "tcpdump_expression"=>"vlan 999", "format"=>"stream"}