Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Cisco Nexus

Monitor Cisco Nexus switches

Data Collection Setup

Metrics are collected via the NX-API v1.0+ on Cisco Nexus and MDS devices.

🚧

Enable NX-API on all Nexus Switches

NOTE: If using NX-API, you must enable NX-API on all switches (Run the command feature nxapi from the NX-OS CLI).

📘

Troubleshooting and Checking NX-API

Check NX-API status on port. Use CLI command show nxapi on the switch to see configured NX-API ports.

Networking Requirements

Port: 80 (HTTP) or 443 (HTTPS) to the Nexus or MDS devices.

Least Privileged User

A least privileged user (LPU) of Network Operator (read-only) for NX-API.

Supported Versions

Hardware:
Nexus models supported:

  • 1000 series
  • 3000 series
  • 4000 series
  • 5000 series
  • 6000 series
  • 7000 series
  • 9000 series

MDS Models supported:

  • 9000 series

Software:
*All NX-OS versions that support NX-API v1.0+

Connection Parameters

NameRequired?Description
HostRequired
Port
Protocol
Validate Certificate Against Truststore
UsernameRequired
PasswordRequired
Max Threads

Metrics

Fan

NameDescription
ModelFan Model
NameFan Name
Status TextStatus Text for this Fan.
Switch IDFan Switch ID

HSRP Group

NameDescription
Active Router IDActive Router ID of the HSRP Group
Group AddressGroup Address of the HSRP Group
HSRP Group NumberGroup Number of the HSRP Group
Standby Router IDStandby Router ID of the HSRP Group
Virtual MAC AddressVirtual MAC Address of the HSRP Group

HSRP Group Member

NameDescription
Active Router IDActive Router ID of the HSRP Group
Group AddressHSRP Group Member group address
Hello TimeHSRP Group Member hello time
Hold TimeHSRP Group Member hold time
HSRP Group NumberHSRP Group Number
Preemption DelayHSRP Group Member preemption delay
PriorityHSRP Group Member priority
State TextHSRP Group Member State Text
Switch IDHSRP Group Member Switch ID

L3 Interface

NameDescription
Broadcast Packets Received (Packets)L3 Interface Broadcast Packets Received
Broadcast Packets Sent (Packets)L3 Interface Broadcast Packets Sent
IODIf-Ordinal of Interface of this L3 Interface
IP PrefixIP Prefix of this L3 Interface
IP SubnetL3 Interface IP Subnet
Multicast Packets Received (Packets)L3 Interface Multicast Packets Received
Multicast Packets Sent (Packets)L3 Interface Multicast Packets Sent
Multicast Received Throughput (Bits)L3 Interface Multicast Bits Received
Multicast Sent Throughput (Bits)L3 Interface Multicast Bits Sent
Packets Received (Packets)L3 Interface Packets Received
Packets Sent (Packets)L3 Interface Packets Sent
Received Throughput (Bits)L3 Interface Bits Received
Sent Throughput (Bits)L3 Interface Bits Sent
Switch IDL3 Interface Switch ID

Port

NameDescription
Admin Status TextThe Admin Status Text of this Port
Bandwidth (Kilobits per Second)The Bandwidth of this Port
Connected World Wide Node NameThe World Wide Name of the connected node
Connected World Wide Port NameThe World Wide Name of the connected port
Directly Attached CDP IPDirectly Attached CDP IP Addresses of this Port
Directly Attached MAC AddressesDirectly Attached CDP MAC Addresses of this Port
DuplexThe Duplex of this Port
Ethernet TypeThe Ethernet Type of this Port
Inbound Packet DiscardsThe Inbound Packet Discards of this Port
Inbound Packet Errors (Errors)The Inbound Packet Errors of this Port
Inbound Packets (Packets)The Inbound Packets of this Port
Inbound Throughput (Bits)The Inbound Bits of this Port
Inbound Throughput Rate (Bits per Second)The Inbound Bits of this Port
IP AddressThe IP Address of this Port
MAC AddressMAC Address or WWN of this Port
NameThe Port Name of this Port
Outbound Packet DiscardsThe Outbound Packet Discards of this Port
Outbound Packet Errors (Errors)The Outbound Packet Errors of this Port
Outbound Packet Queue LengthThe Outbound Packet Queue Length of this Port
Outbound Packets (Packets)The Outbound Packets of this Port
Outbound Throughput (Bits)The Outbound Bits of this Port
Outbound Throughput Rate (Bits per Second)The Outbound Bits of this Port
Rate ModeThe rate mode of this Port
Speed (Megabits per Second)The Speed of this Port
Status TextThe Status Text of this Port
Switch IDPort Switch ID
User Defined NameThe User Defined name of this Port
VSANThe VSAN parent of this Port

Power Module

NameDescription
Product IDPower Module Product ID
Serial NumberPower Module Serial Number
Status TextStatus Text for this Power Module.
Switch IDPower Module Switch ID

Sensor

NameDescription
ModuleModule this Sensor belongs to
NameName of this Sensor
Status TextStatus Text for this Sensor.
Switch IDSensor Switch ID
ValueValue for this Sensor.

Switch

NameDescription
CPU Utilization (%)CPU Utilization for this Switch
Directly Attached CDP IPDirectly Attached CDP IP Addresses of this Switch
Directly Attached MAC AddressesDirectly Attached CDP MAC Addresses of this Switch
Fan CountFan Count of this Switch
Fans Down (%)Fan Status Down Percentage of this Switch
Fans In Down StateFan Status Down Count of this Switch
Fans In Errors (%)Fan Status In Error Percentage of this Switch
Fans In Error StateFan Status In Error Count of this Switch
Fans In Up StateFan Status Up Count of this Switch
Fans Up (%)Fan Status Up Percentage of this Switch
Free Memory (Kilobytes)Free Memory for this Switch
Management IPManagement IP for this Switch
Memory Utilization (%)Memory Utilization for this Switch
Port CountPort Count of this Switch
Ports Down (%)Port Status Down Percentage of this Switch
Ports In Down StatePort Status Down Count of this Switch
Ports In Error StatePort Status In Error Count of this Switch
Ports In Error (%)Port Status In Error Percentage of this Switch
Ports In Up StatePort Status Up Count of this Switch
Ports Up (%)Port Status Up Percentage of this Switch
Power Module CountPower Module Count of this Switch
Power Supplies Down (%)Power Module Status Down Percentage of this Switch
Power Supplies In Down StatePower Module Status Down Count of this Switch
Power Supplies In Error (%)Power Module Status In Error Percentage of this Switch
Power Supplies In Error StatePower Module Status In Error Count of this Switch
Power Supplies In Up StatePower Module Status Up Count of this Switch
Power Supplies Up (%)Power Module Status Up Percentage of this Switch
Process Board IDProcess Board ID For this Switch.
Sensor CountSensor Count of this Switch
Sensors Down (%)Sensor Status Down Percentage of this Switch
Sensors In Down StateSensor Status Down Count of this Switch
Sensors In Error (%)Sensor Status In Error Percentage of this Switch
Sensors In Error StateSensor Status In Error Count of this Switch
Sensors In Up StateSensor Status Up Count of this Switch
Sensors Up (%)Sensor Status Up Percentage of this Switch
Switch IDID for this Switch
System Uptime (Days)System Uptime for this Switch
Total Memory (Kilobytes)Total Memory for this Switch
Used Memory (Kilobytes)Used Memory for this Switch

VSAN

NameDescription
IDID
Interoperability ModeInteroperability Mode
Load Balancing TypeLoad Balancing Type
NameName
Operational StateIndicates whether traffic can pass through this VSAN. The VSAN is in the operational state if it is active and at least one port is up. This is not configurable.
StateThe administrative state of the VSAN (active/suspended)
Switch IDSwitch ID

Updated 8 months ago

Cisco Nexus


Monitor Cisco Nexus switches

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.