ethernet_interfaces

API to get reports for Ethernet Interfaces (bandwidth is in Kbps and data is in KB)

Read/write properties

Read only properties

errors<Integer>

Errors.

region_name<String>

The region name.

packets_received<Integer>

Packets received.

ethernet_interface_name<String>

The name.

bandwidth_transmitted<Double>

Transmit bandwidth.

packets_transmitted<Integer>

Packets transmitted.

data_coverage<Double>

The amount, in percent of the selected time period for which there is data.

link_state<String>

The worst state observed during the time period.

site_name<String>

The site name.

bandwidth_received<Double>

Receive bandwidth.

Operations

get (all)

URL: http://<MGMT-IP>/sdwan_center/nitro/v1/reports/ethernet_interfaces

Description: Use this operation to get a report for Ethernet interfaces. The response payload also contains the meta_data block.

HTTP Method: GET

Response Payload: JSON

{"ethernet_interfaces":[{
      "errors":<Integer_value>,
      "region_name":<String_value>,
      "packets_received":<Integer_value>,
      "ethernet_interface_name":<String_value>,
      "bandwidth_transmitted":<Double_value>,
      "packets_transmitted":<Integer_value>,
      "data_coverage":<Double_value>,
      "link_state":<String_value>,
      "site_name":<String_value>,
      "bandwidth_received":<Double_value>}]}