Interfaces

Manage interfaces of the system

The endpoints are applicable for IOTA Core10 system only.

API

• Get all available interfaces:

  • Path: /interfaces

  • Method: GET

  • Minimum user role: viewer

  • Response:

    [
        {
            "id": 1,
            "name": "Port 1",
            "capture_enabled": false,
            "can_change_capture_state": true,
            "capture_session": null,
            "type": "sfp",
            "speed": "Unknown",
            "state": {
                "status": "idle",
                "comment": "",
                "last_error_time": 0,
                "last_error": ""
            },
            "statistics": {
                "received_packets_per_second": 0,
                "received_bytes_per_second": 0,
                "received_packets": 0,
                "received_bytes": 0,
                "received_missed": 0,
                "received_dropped": 0,
                "received_sw_dropped_pkts": 0,
                "write_packets": 0,
                "write_bytes": 0
            }
        },
        ...
    ]

    • id - unique ID of the interface
    • name - human-readable name of the interface
    • capture_enabled - if the capture is enabled on this interface
    • can_change_capture_state - if it is allowed to enable/disable capture on this interface
    • capture_session - id of the capture_session this interface belongs to; can be null or numeric value
    • type - type of the interface
    • speed - string value of the speed of this interface
    • state - object with the current state of this interface
    • statistics - object with statistics of this interface
• Change the interface

  • Path: /interfaces/{ID}

  • Method: PUT

  • Minimum user role: operator

  • Request body:

    {
        "capture_enabled": true
    }

  • Response:

    {
        "message": "Success",
        "data": {
            "id": 2,
            "name": "Port 2",
            "capture_enabled": true,
            "can_change_capture_state": true,
            "capture_session": 1,
            "type": "sfp",
            "speed": "Unknown",
            "state": {
                "status": "capturing",
                "comment": "",
                "last_error_time": 0,
                "last_error": ""
            }
        }
    }

  • notes:

    • the field capture_enabled is mandatory and only field which must be provided in the request
    • it is only possible to change capture_enabled field if can_change_capture_state of the interface is true
    • if the interface does not belong to any capture session, it will be created, and the interfaces will be attached to it
• Reset the statistics of one interface
  • Path: /interfaces/{ID}
  • Method: DELETE
  • Minimum user role: operator
  • Response: success or error message
• Reset the statistics of all interfaces
  • Path: /interfaces
  • Method: DELETE
  • Minimum user role: operator
  • Response: success or error message

Notes

There are some validations during the requests processing: * The interface {ID} must be in a range 1…6.

Back to Index