OPBNOS R2.8
Release
  • Open Packet Broker
  • What's New?
  • Getting Started
    • Licensing
    • Limitations
    • Image Management
      • Installing OPBNOS from ONIE
      • Installing OPBNOS from USB Drive
      • Image Upgrade from OPBNOS
      • Selecting OPBNOS on next boot
      • Removing available images
      • Rebooting the Switch
    • Supported Platforms
    • Scalability
    • Downloads
  • CLI Configuration Guide
    • Configuring License
    • Configuring Hostname
    • Configuring Username
    • On-Box FlowVision
    • Configuring AAA
      • Configuring AAA
      • Configuring TACACS
      • Configuring RADIUS
    • Configure Packet Timestamping
    • Interface Management
      • Configuring Management Interface
      • Configuring Physical Interface
    • Link Layer Discovery Protocol (LLDP)
      • Enabling LLDP
      • Displaying LLDP Neighbors
    • Configuring Interface Description
    • Configuring Auto Negotiation
    • Configuring FEC
    • Configuring Maximum Transition Unit
    • Configuring Port Speed
    • Configuring Port Breakout
    • Configuring Interface Type
    • Configuring VLAN Modes
    • Configuring Loopback Mode
    • Configuring Packet Slicing
    • Configuring Ingress VLAN
    • Configuring Egress Tagging
    • Configuring Rx-only
    • Configuring Tx-only
    • Configuring An-clause
    • Configuring PortChannel
    • Configuring LAG Hash
    • Configuring Flows and Rules
      • Configuring Network Ports
      • Configuring Tool Ports
      • Configuring Flows
      • Configuring Flow Description
      • Configuring Flow Rules (NVIDIA)
      • Configuring Flow Rules (Broadcom)
      • Configuring Flow Match Expression Rules
      • Configuring Flow UDF Rules
      • Configuring Push/Pop VLAN
      • Configuring Flow Override Action(s)
      • Display Flow Information
      • Clear Flow Counters
    • Configuring GTP Flow
    • Configuring IPv6 Reachability Check
    • Configuring VXLAN Flow
    • Configuring VXLAN Stripping
    • Configuring SNMP
      • Configure SNMP community
      • Configuring SNMP Trap
      • Configuring SNMP Threshold
      • Configuring SNMP User
      • Configuring SNMP Location
      • Configuring SNMP Contact
    • Configuring SYSLOG
    • Ping
    • Traceroute
    • Configuring NTP
    • Configuring Timezone
    • Configuring sFlow
    • Display Interface Information
      • Front Panel Port Mapping
    • Display System Information
      • Interface Transceiver Information
      • System Uptime
      • Reboot Cause
      • Show Environment
      • Show System Memory
      • Show Docker Memory
      • Show Services
      • Show Platform Fan
      • Show platform pcieinfo
      • Show Platform PSU
      • Show Platform SSD
      • Show Platform Summary
      • Show Platform Syseeprom
      • Show Platform Temperature
    • Configuration Management
      • Copying Configuration from Switch
      • Copying Running and Startup Configuration
      • Saving Configuration
      • Display Configuration
      • Clearing Startup configuration
    • Zero Touch Provisioning
      • DHCP Discovery
      • ZTP Boot File
      • Enable ZTP
    • Troubleshooting
  • Aviz FlowVision Graphical User Interface Guide
    • FlowVision Controller Installation
      • FV ESXi Host Installation
      • FV VirtualBox Installation
    • System
      • Viewing the Dashboard
      • Accessing System and Device Information
      • Managing Topologies
      • Managing Devices
      • Viewing System Log
      • Managing Users
      • Performing Backup and Restore
      • Viewing Audit Logs
    • Configuration
      • Configuring Ports
      • Configuring Port Groups
      • Configuring Rule Templates
      • Configuring Vxlan Tunnel
      • Configuring Flows
      • Configuring VLAN
      • Configuring SNMP Trap
    • Statistics
      • Viewing Port Statistics
      • Viewing Flow Statistics
    • Help
  • REST API Guide
    • FLOW
    • Interface Management
    • Port Channel
    • LLDP
    • SNMP
    • System and Platform
    • Statistics
  • Use Cases
    • For Engineers
      • VxLAN Deployment (NVIDIA)
      • GTP Deployment
      • Truncation and Load Balancing
      • Ingress VLAN and Egress Tagging
      • Loopback-mode Port
      • VXLAN Stripping
      • VLAN Mode/Tag Actions
    • Command Reference
      • Converting Network-to-Tool port
      • Configuring 1G Electrical SFP
      • Enabling FlowVision On-box Support
  • Solution Integration
    • Network Visibility and Analysis with OPB, Arkime, Elasticsearch & Kibana
      • Installation Pre-Requisites
      • Solution Components
      • Configuring OPBNOS
      • Installing Arkime
      • Installing Kibana
      • Troubleshooting
  • Support
    • How to contact Aviz Networks Support?
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. REST API Guide

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/opbinterfaces/<Interface-name>

Description

Use this API to configure the opb-interface specific parameters

Method

POST

Request Body

Nvidia:

{

"name" : "Ethernet1_1"

"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)"

}

Broadcom:

{

"name":"Ethernet1_1",

"ingress-vlan":"700",

"egress-tagging":"enable | disable"

}

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/opbinterfaces

/api/info/opbinterfaces/<interface-name>

Description

Use this API to get the interface configuration

Method

GET

Request Body

NA

Response Body

Nvidia:

{

"name": "Ethernet1_1",

"comment": "test",

"type": "network",

"mode" : "vlan-aware"

"egress-tagging": "disable",

"ingress-vlan": "100",

"truncate-offset": "0"

}

Broadcom:

{

"name": "Ethernet1_1",

"egress-tagging": "disable",

"ingress-vlan": "100",

}

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/config/<Interface-name>

Description

Use this API to configure the generic interface parameters

Method

POST

Request Body

{

"admin_status": "up",

"speed": "100000",

"mtu": "9100",

"fec": "rs"

}

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/<interface_name>

Description

Use this GET-API to fetch the interface related information in the system

Method

GET

Request Body

NA

Response Body

{

"Ethernet1_1": {

"lanes": "13",

"alias": "tenGigE1",

"oper_status": "down",

"admin_status": "up",

"speed": "10000",

"mtu": "9100",

"description": "N/A",

"autoneg": "N/A",

"TRANSCEIVER": "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 or /api/info/interfaces/stats/Ethernet1_1

Description

Use this API to get the interface statistics related information

Method

GET

Request Body

NA

Response Body

{

"Ethernet1_1": {

"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/Ethernet1_1

Description

Get interface transceivers information using this API

Method

GET

Request Body

NA

Response Body

{

"Ethernet1_1": {

"type": "SFP/SFP+/SFP28",

"hardware_rev": "A",

"serial": "16CN48200170",

"manufacturer": "Volex Inc.",

"model": "700512588", "specification_compliance": "{'SFP+CableTechnology': 'Passive Cable'}"

}

}

Status code

  • SERVER_ERROR(500) if there is any error with the server

  • OK(200) if the request completes successfully

PreviousFLOWNextPort Channel

Was this helpful?