back

filtering_features

The filtering_features JSON section could be a part of both request and response. As a part of a request it configures the device hardware capturing and as a part of a response it returns the current configuration stored in the hardware.

This section could be absent in the earlier versions of profishark. To check whether to include this section in the saveProfishark request call the getProfisharks end point first. If you see this section in the response of getProfisharks that means that this feature (section) is supported.

"filtering_features": { // this is optional
                        // see the `filtering_features` section documentation
     "packet_types": [ { "name" : packet_type_str, "enable" : boolean }, ... ]
}

• packet_types section is responsible for that part of the hardware configuration which allows to capture network packets by their types.

  • name - a name of the packet type. Any of these:
    • IPv4
    • IPv6
    • ARP
    • TCP
    • UDP
    • ICMP
    • IGMP
    • HTTPS
    • HTTP
    • FTP
    • DNS
    • SMTP
    • POP3
    • DHCP
    • SSH
    • SIP
    • SMB
    • TCPFlags_FIN
    • TCPFlags_SYN
    • TCPFlags_RST
    • TCPFlags_PSH
    • TCPFlags_ACK
    • ZeroWindow
    • QUIC
    • L2Other
    • L4Other
    • any from the reserved set (having the form _RESERVEDXX where XX is a 2 digit number)
  • enable - if true then the packet of this type should be enabled for passing through the device.

  To get a list of supported packet_type_str call the getProfisharks end point. (The packet types from the reserved set will not be shown).

##### Notes

This section could be a part of the following end point JSONs:

• getProfisharks response
• saveProfishark request