Interface Management

Physical Interfaces are switch front panel ethernet ports which are ASIC ports. The physical ports are created by default and cannot be deleted.

Configure NPB Interface

Request URL	/api/config/npbinterface/<Interface-name>
Description	Use this API to configure the npb-interface specific parameters
Method	POST
Request Body	{ "name" : "Ethernet0" "type" : "network | tool", "comment" : "test", "mode" : "vlan-aware | vlan-unaware" "hybrid" : "enable | disable", "ingress-vlan" : "100", "egress-tagging" : "enable | disable", "truncate-offset": "0(disable) | 32-4088 (multiple of 4)" }
Response Body	NA
Status code	SERVER_ERROR(500) if there is any error with the server OK(200) if the request completes successfully

Get NPB Interface Information

Request URL	/api/info/npbinterface /api/info/npbinterface/<interface-name>
Description	Use this API to get the interface configuration
Method	GET
Request Body	NA
Response Body	{ "name": "Ethernet0",
	"comment": "test", "type": "network", "mode" : "vlan-aware" "egress-tagging": "disable", "ingress-vlan": "100", "truncate-offset": "0" }
Status code	SERVER_ERROR(500) if there is any error with the server OK(200) if the request completes successfully

Configure Interfaces

Request URL	api/config/interfaces/cfgs/<Interface-name>
Description	Use this API to configure the generic interface parameters
Method	POST
Request Body	{ "admin_status": "up", "speed": "100000", "mtu": "9100", "fec": "fc" }
Response Body	NA
Status code	SERVER_ERROR(500) if there is any error with the server OK(200) if the request completes successfully

Get interfaces Information

Request URL	/api/info/interfaces /api/info/interfaces/Ethernet0
Description	Use this GET-API to fetch the interface related information in the system
Method	GET
Request Body	NA
Response Body	{ "Ethernet56": { "lanes": "56,57,58,59", "alias": "Ethernet56", "oper_status": "down", "admin_status": "up", "speed": "100000", "mtu": "9100", "description": "N/A", "TRANSCEIVER": "Not Present" }, …. …. }
Status code	SERVER_ERROR(500) if there is any error with the server OK(200) if the request completes successfully

Get Interface Counters

Request URL	/api/info/interfaces/stats
	/api/info/interfaces/stats/Ethernet0
Description	Use this API to get the interface statistics related information
Method	GET
Request Body	NA
Response Body	{ "Ethernet0": { "IF_IN_OCTETS": 0, "IF_IN_UCAST_PKTS": 0, "IF_IN_NON_UCAST_PKTS": 0, "IF_IN_DISCARDS": 0, "IF_IN_ERRORS": 0, "IF_IN_UNKNOWN_PROTOS": 0, "IF_OUT_OCTETS": 0, "IF_OUT_UCAST_PKTS": 0, "IF_OUT_NON_UCAST_PKTS": 0, "IF_OUT_DISCARDS": 0, "IF_OUT_ERRORS": 0, "IF_OUT_QLEN": "N/A", "IF_IN_MULTICAST_PKTS": 0, "IF_IN_BROADCAST_PKTS": 0, "IF_OUT_MULTICAST_PKTS": 0, "IF_OUT_BROADCAST_PKTS": 0, "ETHER_RX_OVERSIZE_PKTS": 0, "ETHER_TX_OVERSIZE_PKTS": 0, "ETHER_STATS_TX_NO_ERRORS": 0, "IP_IN_UCAST_PKTS": "N/A", "ETHER_IN_PKTS_128_TO_255_OCTETS": 0, "PFC_0_TX_PKTS": 0, "PFC_1_TX_PKTS": 0, "PFC_2_TX_PKTS": 0, "PFC_3_TX_PKTS": 0, "PFC_4_TX_PKTS": 0, "PFC_5_TX_PKTS": 0, "PFC_6_TX_PKTS": 0, "PFC_7_TX_PKTS": 0, "PFC_0_RX_PKTS": 0, "PFC_1_RX_PKTS": 0, "PFC_2_RX_PKTS": 0, "PFC_3_RX_PKTS": 0, "PFC_4_RX_PKTS": 0, "PFC_5_RX_PKTS": 0, "PFC_6_RX_PKTS": 0, "PFC_7_RX_PKTS": 0 }, … … }
Status code	SERVER_ERROR(500) if there is any error with the server OK(200) if the request completes successfully

Get Interface Transceivers Information

Request URL	/api/info/interfaces/transceivers /api/info/interfaces/transceivers/Ethernet0
Description	Get interface transceivers information using this API
Method	GET
Request Body	NA
Response Body	"Ethernet44": {"type": "QSFP28 or later", "hardware_rev": "A3", "serial": "PRL7395F6311B", "manufacturer": "PROLABS", "model": "QSFP100GPDAC50CM", "specification_compliance": "{'Extended Specification compliance': '100GBASE-CR4, 25GBASE-CR CA-25G-L or 50GBASE-CR2 with RS'}" }
Status code	SERVER_ERROR(500) if there is any error with the server OK(200) if the request completes successfully