NX-API v1.0+ is the data collection method. The metrics are collected directly from the Nexus Switches.
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.
TCP 80 (HTTP) or 443 (HTTPS) to the Nexus Switch
A least privileged user (LPU) of Network Operator (read-only) for NX-API.
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+
Host
Required
Port
Protocol
Validate Certificate Against Truststore
Username
Required
Password
Required
Max Threads
Model
Fan Model
Name
Fan Name
Status Text
Status Text for this Fan.
Switch ID
Fan Switch ID
Active Router ID
Active Router ID of the HSRP Group
Group Address
Group Address of the HSRP Group
HSRP Group Number
Group Number of the HSRP Group
Standby Router ID
Standby Router ID of the HSRP Group
Virtual MAC Address
Virtual MAC Address of the HSRP Group
Active Router ID
Active Router ID of the HSRP Group
Group Address
HSRP Group Member group address
Hello Time
HSRP Group Member hello time
Hold Time
HSRP Group Member hold time
HSRP Group Number
HSRP Group Number
Preemption Delay
HSRP Group Member preemption delay
Priority
HSRP Group Member priority
State Text
HSRP Group Member State Text
Switch ID
HSRP Group Member Switch ID
Broadcast Packets Received (Packets)
L3 Interface Broadcast Packets Received
Broadcast Packets Sent (Packets)
L3 Interface Broadcast Packets Sent
IOD
If-Ordinal of Interface of this L3 Interface
IP Prefix
IP Prefix of this L3 Interface
IP Subnet
L3 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 ID
L3 Interface Switch ID
Admin Status Text
The Admin Status Text of this Port
Bandwidth (Kilobits per Second)
The Bandwidth of this Port
Connected World Wide Node Name
The World Wide Name of the connected node
Connected World Wide Port Name
The World Wide Name of the connected port
Directly Attached CDP IP
Directly Attached CDP IP Addresses of this Port
Directly Attached MAC Addresses
Directly Attached CDP MAC Addresses of this Port
Duplex
The Duplex of this Port
Ethernet Type
The Ethernet Type of this Port
Inbound Packet Discards
The 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 Address
The IP Address of this Port
MAC Address
MAC Address or WWN of this Port
Name
The Port Name of this Port
Outbound Packet Discards
The Outbound Packet Discards of this Port
Outbound Packet Errors (Errors)
The Outbound Packet Errors of this Port
Outbound Packet Queue Length
The 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 Mode
The rate mode of this Port
Speed (Megabits per Second)
The Speed of this Port
Status Text
The Status Text of this Port
Switch ID
Port Switch ID
User Defined Name
The User Defined name of this Port
VSAN
The VSAN parent of this Port
Product ID
Power Module Product ID
Serial Number
Power Module Serial Number
Status Text
Status Text for this Power Module.
Switch ID
Power Module Switch ID
Module
Module this Sensor belongs to
Name
Name of this Sensor
Status Text
Status Text for this Sensor.
Switch ID
Sensor Switch ID
Value
Value for this Sensor.
CPU Utilization (%)
CPU Utilization for this Switch
Directly Attached CDP IP
Directly Attached CDP IP Addresses of this Switch
Directly Attached MAC Addresses
Directly Attached CDP MAC Addresses of this Switch
Fan Count
Fan Count of this Switch
Fans Down (%)
Fan Status Down Percentage of this Switch
Fans In Down State
Fan Status Down Count of this Switch
Fans In Errors (%)
Fan Status In Error Percentage of this Switch
Fans In Error State
Fan Status In Error Count of this Switch
Fans In Up State
Fan Status Up Count of this Switch
Fans Up (%)
Fan Status Up Percentage of this Switch
Free Memory (Kilobytes)
Free Memory for this Switch
Management IP
Management IP for this Switch
Memory Utilization (%)
Memory Utilization for this Switch
Port Count
Port Count of this Switch
Ports Down (%)
Port Status Down Percentage of this Switch
Ports In Down State
Port Status Down Count of this Switch
Ports In Error State
Port Status In Error Count of this Switch
Ports In Error (%)
Port Status In Error Percentage of this Switch
Ports In Up State
Port Status Up Count of this Switch
Ports Up (%)
Port Status Up Percentage of this Switch
Power Module Count
Power Module Count of this Switch
Power Supplies Down (%)
Power Module Status Down Percentage of this Switch
Power Supplies In Down State
Power Module Status Down Count of this Switch
Power Supplies In Error (%)
Power Module Status In Error Percentage of this Switch
Power Supplies In Error State
Power Module Status In Error Count of this Switch
Power Supplies In Up State
Power Module Status Up Count of this Switch
Power Supplies Up (%)
Power Module Status Up Percentage of this Switch
Process Board ID
Process Board ID For this Switch.
Sensor Count
Sensor Count of this Switch
Sensors Down (%)
Sensor Status Down Percentage of this Switch
Sensors In Down State
Sensor Status Down Count of this Switch
Sensors In Error (%)
Sensor Status In Error Percentage of this Switch
Sensors In Error State
Sensor Status In Error Count of this Switch
Sensors In Up State
Sensor Status Up Count of this Switch
Sensors Up (%)
Sensor Status Up Percentage of this Switch
Switch ID
ID 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
ID
ID
Interoperability Mode
Interoperability Mode
Load Balancing Type
Load Balancing Type
Name
Name
Operational State
Indicates 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.
State
The administrative state of the VSAN (active/suspended)
Switch ID
Switch ID