back

/saveProfishark

This end point sets the hardware-related Profishark configuration.

{
    "profishark": {
        "model": string,
        "friendly_name": string,
        "mac": mac_address,
        "port_control" : { // see the `port_control` section documentation
            "port_a": {
                "_1000tx_fd": boolean,
                "_100tx_fd": boolen,
                "_100tx_hd": boolen,
                "_10tx_fd": boolen,
                "_10tx_hd": boolen,
                "asymmetric_pause": boolen,
                "auto_negotiation": boolen,
                "force_master_slave": boolean,
                "master": boolean,
                "symmetric_pause": boolen
            },
            "port_b": {
                "_1000tx_fd": boolen,
                "_100tx_fd": boolen,
                "_100tx_hd": boolen,
                "_10tx_fd": boolen,
                "_10tx_hd": boolen,
                "asymmetric_pause": boolen,
                "auto_negotiation": boolen,
                "force_master_slave": boolean,
                "master": boolean,
                "symmetric_pause": boolen
            },
            "span" : boolean
        },
        "filtering_features": { // this is optional
                                // see the `filtering_features` section documentation
            "packet_types": [ { "name" : packet_type_str, "enable" : boolean }, ... ]
        },
        "device_features": { // see the `device_features` section documentation
            "disable_port_a": boolean,
            "disable_port_b": boolean,
            "enable_timestamps_in_live_capture": boolean,
            "hw_firmware_id": hw_firmware_id,
            "keep_crc32": boolean,
            "package_slicing": boolean,
            "statistics_only": boolean,
            "transmit_crc_errors": boolean
        }
    }
}
{
    "command": "/saveProfishark",
    "command_result": {
        "analyzer": {
            "error": boolean,
            "message": string,
            "running": boolean
        }
    },
    "errors": boolean,
    "general_message": string
}

The algorithm which is used for processing of filtering_features/packet_types section.

  1. Disable all packet types except reserved ones (see filtering_features).
  2. Enable only those packet types which have "enabled" : true in the filtering_features/packet_types list and all from the reserved set.

Those packets which have "enabled" : false are just ignored by this end point and could be absent in the request. The available packet types are always defined by the hardware and could be requested by getProfisharks.

Errors
References