back

/getProfisharks

This function will return a very detailed description of all the currently available and connected ProfiShark devices. In the examples below not all fields are being shown. It is recommended to run the API call in the browser.

ProfiShark 1G

{
  command: "/getProfisharks",
  command_result: {
    analyzer: {
      error: false,
      message: "You can run a capture session or import a capture file",
      running: false
    },
    definitions: { // this section is optional
      pps_compensation_range: {
        max: 32,
        min: 0
      },
      profishark_api_time_source: [
        "SNTP",
        "Manual",
        "None",
        "GPS",
        "RTC",
        "System"
      ],
      profishark_api_timestamp_moment: [
        "Egress",
        "Ingress",
        "Capture"
      ]
    },
    profisharks: [{ // this section is optional
        device_features: {
            disable_port_a: false,
            disable_port_b: false,
            enable_timestamps_in_live_capture: false,
            hw_firmware_id: 0,
            keep_crc32: true,
            package_slicing: true,
            statistics_only: false,
            transmit_crc_errors: true
        },
        friendly_name: "",
        information: {
            usb: "Super Speed"
        },
        link_status: {
          device_link_status: "Down",
          rj45_ports_status: {
            ports_count: "2",
            rj45_port_a_status: {
              duplex: "Full Duplex",
              mode: "Inline",
              speed: "Down"
            },
            rj45_port_b_status: {
              duplex: "Full Duplex",
              mode: "Inline",
              speed: "Down"
            }
          }
        },
        mac: "54:10:ec:a7:c4:9b",
        model: "ProfiShark 1G v5",
        model_id: 6,
        name: "ProfiShark 1G v5 (54:10:ec:a7:c4:9b)",
        port_control: {
          port_a: {
            _1000tx_fd: true,
            _100tx_fd: true,
            _100tx_hd: true,
            _10tx_fd: true,
            _10tx_hd: true,
            asymmetric_pause: true,
            auto_negotiation: true,
            force_master_slave: false,
            master: false,
            symmetric_pause: true
          },
          port_b: {
            _1000tx_fd: true,
            _100tx_fd: true,
            _100tx_hd: true,
            _10tx_fd: true,
            _10tx_hd: true,
            asymmetric_pause: true,
            auto_negotiation: true,
            force_master_slave: false,
            master: false,
            symmetric_pause: true
          },
          span: false
        },
        port_status: [...],
        statistics: {
          bogus_bytes: 0,
          date: 1557238289663,
          last_link_down_duration_s: 260,
          link_up_duration_s: 0,
          port_a_statistics: {
            between_64_and_1518: 0,
            bytes: 0,
            collision: 0,
            crc_error: 0,
            hardware_dropped_packets: 0,
            jabber: 0,
            less_than_64: 0,
            maximum_bytes: 3037694208,
            more_than_1518: 0,
            total_invalid: 0,
            total_valid: 0
          },
          port_b_statistics: {
            between_64_and_1518: 0,
            bytes: 0,
            collision: 0,
            crc_error: 0,
            hardware_dropped_packets: 0,
            jabber: 0,
            less_than_64: 0,
            maximum_bytes: 3037694208,
            more_than_1518: 0,
            total_invalid: 0,
            total_valid: 0
          },
          software_dropped_packets: 0,
          total_packets: 0
        },
        versions: {
          device_version: "1.9.28.0",
          hw_firmware_version: "0211",
          sw_firmware_version: "0.2.3.13"
        }
      }
    ]
  },
  errors: false,
  general_message: "Successfully retrieved ProfiSharks"
}

ProfiShark 10G

{
  command: "/getProfisharks",
  command_result: {
    analyzer: {
      error: false,
      message: "You can run a capture session or import a capture file",
      running: false
    },
    definitions: {
      pps_compensation_range: {
        max: 32,
        min: 0
      },
      profishark_api_time_source: [
        "SNTP",
        "Manual",
        "None",
        "GPS",
        "RTC",
        "System"
      ],
      profishark_api_timestamp_moment: [
        "Egress",
        "Ingress",
        "Capture"
      ]
    },
    profisharks: [
    {
      device_features: {
        disable_port_a: false,
        disable_port_b: false,
        enable_timestamps_in_live_capture: false,
        firmware_modes: [
          {
            hw_firmware_id: 0,
            name: "10Gbps firmware"
          },
          {
            hw_firmware_id: 1,
            name: "1Gbps firmware"
          }
        ],
        force_pps_generation: false,
        hw_firmware_id: 1,
        keep_crc32: true,
        package_slicing: false,
        port_a_timestamp_moment: "Capture",
        port_b_timestamp_moment: "Capture",
        pps_compensation: 29,
        pps_output: false,
        statistics_only: false,
        time_init_source: "System",
        transmit_crc_errors: false,
        wait_for_sync: false
      },
      friendly_name: "",
      information: {
        usb: "Super Speed"
      },
      link_status: {
        device_link_status: "Up",
        sfp_ports_status: [...]
      },
      mac: "54:10:ec:bb:31:1f",
      model: "ProfiShark 10G GPS",
      model_id: 12,
      name: "ProfiShark 10G GPS (54:10:ec:bb:31:1f)",
      port_control: {
        loopback: false,
        span: true
      },
      "filtering_features": { // this is optional
                              // see the `filtering_features` section documentation
          "packet_types": [ { "name" : packet_type_str, "enable" : boolean }, ... ]
      },
      statistics: {...},
      timing: {
        current_gps_time: {
          day: "7",
          hour: "14",
          minute: "0",
          month: "5",
          second: "40",
          year: "2019"
        },
        deviation: "-0.000000",
        external_pps: "No",
        fix: {
          text: "No Fix",
          value: false
        },
        glonass_satellites: "10",
        gps_pps: "No",
        gps_satellites: "13",
        precision: "9999",
        time_source: "System",
        timestamp_sync: "No",
        used_satellites: "0"
      },
      versions: {
        device_version: "1.9.28.0",
        hw_firmware_version: "0218",
        sw_firmware_version: "0.2.3.28"
      }
    }]
  },
  errors: false,
  general_message: "Successfully retrieved profisharks"
}
References