Update nxos show interface #2112

Mikeg2881 · 2025-04-27T20:46:48Z

changes made referencing this issue https://github.com/networktocode/ntc-templates/issues/2108#issuecomment-2833475053

ntc_templates/templates/cisco_nxos_show_interface.textfsm

Some output is formatted differently - Singular vs plural on error(s) - CRC is also seen as CRC/FCS - This caused some values not to be captured

Some lines definitely have leading whitespace so swapping from zero or more to one or more made sense.

mjbear · 2025-04-28T00:19:31Z

@Mikeg2881
I'm working on some improvements (not your fault) since there wasn't an error directive in this nxos template before your changes.

I've already found an instance where values wouldn't be captured since the formatting changed over time. 🤷‍♂️
(Edit: We don't see this unless we diff against your commit and my later commits since the giants/CRCs values weren't captured before this.)

Question: Is RX_STORM_SUPPRESSION_BYTES really in bytes?

Mikeg2881 · 2025-04-28T00:29:45Z

Yes they are in bytes. See below. Is there anything else i need to do on this or the other one i submitted?

Ethernet1/5 is down (Link not connected)
admin state is up, Dedicated Interface
  Hardware: 10/100/1000 Ethernet, address: 9088.555f.3254 (bia 9088.555f.3254)
  MTU 1500 bytes, BW 1000000 Kbit , DLY 10 usec
  reliability 255/255, txload 1/255, rxload 1/255
  Encapsulation ARPA, medium is broadcast
  Port mode is access
  auto-duplex, auto-speed
  Beacon is turned off
  Auto-Negotiation is turned on  FEC mode is Auto
  Input flow-control is off, output flow-control is off
  Auto-mdix is turned on
  Switchport monitor is off 
  EtherType is 0x8100 
  EEE (efficient-ethernet) : Disabled
    admin fec state is auto, oper fec state is off
  Last link flapped never
  Last clearing of "show interface" counters never
  0 interface resets
  Load-Interval #1: 30 seconds
    30 seconds input rate 0 bits/sec, 0 packets/sec
    30 seconds output rate 0 bits/sec, 0 packets/sec
    input rate 0 bps, 0 pps; output rate 0 bps, 0 pps
  Load-Interval #2: 5 minute (300 seconds)
    300 seconds input rate 0 bits/sec, 0 packets/sec
    300 seconds output rate 0 bits/sec, 0 packets/sec
    input rate 0 bps, 0 pps; output rate 0 bps, 0 pps
  RX
    0 unicast packets  0 multicast packets  0 broadcast packets
    0 input packets  0 bytes
    0 jumbo packets  0 storm suppression bytes
    0 runts  0 giants  0 CRC  0 no buffer
    0 input error  0 short frame  0 overrun   0 underrun  0 ignored
    0 watchdog  0 bad etype drop  0 bad proto drop  0 if down drop
    0 input with dribble  0 input discard
    0 Rx pause
    0 Stomped CRC
  TX
    0 unicast packets  0 multicast packets  0 broadcast packets
    0 output packets  0 bytes
    0 jumbo packets
    0 output error  0 collision  0 deferred  0 late collision
    0 lost carrier  0 no carrier  0 babble  0 output discard
    0 Tx pause

mjbear · 2025-04-28T00:45:10Z

Yes they are in bytes. See below.

Ok, some of the older output may not be in bytes, but I'll have to validate that.

Is there anything else i need to do on this

If you locally worked on this, pull the changes that have been made to your branch (git pull).

Please add the Eth1/1 output that had runts/giants/CRC errors in a raw file (ex: tests/cisco_nxos/show_interface/cisco_nxos_show_interface4.raw). Then use the helper scripts to generate the structured data. Commit both of those files to your branch and push the commit(s) to GitHub.

or the other one i submitted?

I have only looked at this one so far.
Once I have had time to look at the other I'll drop feedback there. Thank you for understanding!

mjbear · 2025-04-28T02:14:02Z

Yes they are in bytes. See below.

Ok, some of the older output may not be in bytes, but I'll have to validate that.

Yeah, there are storm suppression packets in the output that follow Jumbo packet output. And adding another rule captures jumbo values that were otherwise not captured.

The bandwidth rates existed before your changes, but I do want to point out (for discussion) that if there are multiple rates, only the second one is captured. If we were to change some of those capture groups to List we could gather them up in one variable but that data type change is a "breaking change". And do we want all that data?

Mikeg2881 · 2025-04-28T11:56:27Z

I am all for adding data as long as it doesn't produce a breaking change.

mjbear · 2025-04-28T12:06:14Z

I am all for adding data as long as it doesn't produce a breaking change.

Sounds good.
I'll have to take a closer look later on.

In the meantime if you would add raw cli text and create the structured output (yaml) as hinted at earlier in this thread that would be greatly appreciated.

Mikeg2881 · 2025-04-28T12:14:35Z

cisco_nxos_show_interface.zip
see attached

mjbear · 2025-04-28T13:06:51Z

cisco_nxos_show_interface.zip see attached

Please add the raw cli text to the changed files on the PR. It will be necessary to either use a local development environment or spin up a GitHub Codespace to be able to run the helper scripts.
On another note, cisco_ios_show_interfaces has used the capture group name OVERRUN so in the spirit of normalization/standardization -- we'll want to discuss what makes sense in terms of capture group names. (That is not unnecessarily introducing a major shift or breaking changes unless it is warranted.)

mjbear · 2025-04-29T18:22:29Z

Lots and lots of formats have been added to this point to support various versions of output and attempt capture the data there's capture groups for.

😅 phew!!!!!!!!!!! 😇

mjbear · 2025-04-30T00:15:08Z

On another note, cisco_ios_show_interfaces has used the capture group name OVERRUN so in the spirit of normalization/standardization -- we'll want to discuss what makes sense in terms of capture group names. (That is not unnecessarily introducing a major shift or breaking changes unless it is warranted.)

We might be at a point to begin discussing the capture group names. (No need to make changes right away.)

I'm of the opinion that we should utilize the existing capture group names to maintain consistency and normalization across multiple vendors (where possible). So this could mean the RX_ and TX_ pieces might be something to remove.

Hopefully we can get a few more voices in here for a wider conversation.

To quote @Mikeg2881 in a conversation outside of this PR, "Also not apposed to ditching RX and TX. Keeping it uniform with other modules seems more logical". Thank you MG!

It may take a moment to investigate each capture group, but the normalization will be beneficial in the long run!

mjbear · 2025-05-04T18:28:49Z

On another note, cisco_ios_show_interfaces has used the capture group name OVERRUN so in the spirit of normalization/standardization -- we'll want to discuss what makes sense in terms of capture group names. (That is not unnecessarily introducing a major shift or breaking changes unless it is warranted.)

We might be at a point to begin discussing the capture group names. (No need to make changes right away.)
I'm of the opinion that we should utilize the existing capture group names to maintain consistency and normalization across multiple vendors (where possible). So this could mean the RX_ and TX_ pieces might be something to remove.
Hopefully we can get a few more voices in here for a wider conversation.

To quote @Mikeg2881 in a conversation outside of this PR, "Also not apposed to ditching RX and TX. Keeping it uniform with other modules seems more logical". Thank you MG!

It may take a moment to investigate each capture group, but the normalization will be beneficial in the long run!

For example when searching for OVERRUN (or similarly GIANTS):

Some templates do not have the RX/TX errors prefixed with RX_ or TX_.

However some templates do.

alcatel_aos_show_interfaces_ethernet
fortinet_fnsysctl_ifconfig
cisco_nxos_show_interface (as of this pull request!)

mjbear · 2025-05-17T03:15:56Z

Some templates do not have the RX/TX errors prefixed with RX_ or TX_.

... snipped ...

However some templates do.

Responding to myself.
Since there are more templates without the prefix (and particularly two other Cisco platform templates), we probably should standardize without RX_ and TX_.

mjbear · 2025-06-09T02:29:37Z

jmcgill298 · 2025-06-09T13:55:19Z

I'm for anything that is not both RX and TX not having the prefix, but where it is a stat for both RX and TX, to add those prefixes

mjbear

I believe these capture groups to be in a good state.

Could I get a second review when there's time @jmcgill298?
Thank you!

nxos show interface changes

43fe419

Mikeg2881 requested review from itdependsnetworks, jmcgill298, jvanderaa and mjbear as code owners April 27, 2025 20:46

mjbear reviewed Apr 27, 2025

View reviewed changes

ntc_templates/templates/cisco_nxos_show_interface.textfsm Show resolved Hide resolved

Drop extra blank line in cisco_nxos_show_interface.textfsm

7ed8bc6

mjbear reviewed Apr 27, 2025

View reviewed changes

ntc_templates/templates/cisco_nxos_show_interface.textfsm Outdated Show resolved Hide resolved

mjbear added 5 commits April 27, 2025 18:58

Swap literal white space for regex

2c76203

Regenerate structured test data with new keys

30fad29

Fix input/output/CRC compatibility

e105d46

Some output is formatted differently - Singular vs plural on error(s) - CRC is also seen as CRC/FCS - This caused some values not to be captured

Change leading whitespace regex

8bc34ef

Some lines definitely have leading whitespace so swapping from zero or more to one or more made sense.

Add regexes for several unmatched lines

11b1ab7

mjbear self-assigned this Apr 28, 2025

mjbear added question WIP Work in Progress labels Apr 28, 2025

mjbear linked an issue Apr 28, 2025 that may be closed by this pull request

cisco_nxos_show_interface.textfsm (Updates) #2108

Open

mjbear added 3 commits April 27, 2025 22:04

Fix jumbo packet matching in older output

abcff61

Add more unmatched lines (ucast,mcast,bcast)

1464311

Add input/output pkt support for older output

9180842

mjbear added 2 commits April 28, 2025 08:52

Fix bandwidth and packet rates for older output

a48b91b

Add unmatched line and finish with Error directive

09e41a6

mjbear and others added 10 commits April 28, 2025 23:16

Add support for mgmt0 attributes

ad746d1

added fail tests 7-10

6ff0f24

Add support for Ha input and vPC status

63a9b6b

updated 9

928ee47

Add support for port-ch with no members

56aa577

Add support for odd "jumbo pa" vendor typo

440e2ca

added more failures to 9

7b7c7df

Add support for loopback stats

f471a46

added more data into file 9

e74e609

Add support for Vlan SVI with in|output: syntax

5d9fc80

mjbear changed the title ~~nxos show interface changes~~ Update nxos show interface Apr 30, 2025

mjbear added 10 commits June 10, 2025 08:53

Rename runts, giants, and collisions

7027c69

Rename late coll, in/out discards, over/underrun

fe777a8

Rename dribble, crc, stomped crc, deferred

c982470

Regenerate test data

37f4886

Rename short frame, bad etype/proto drop

2a27410

Rename interface down drop, storm sup bytes

07b1d33

Rename no buffer, no carrier, lost carrier

06f2c26

Rename babble, watchdog

bc098bb

Replace literal space with regex

88b4e4c

Remove unnecessary parentheses

9d8f2e6

mjbear approved these changes Jun 10, 2025

View reviewed changes

mjbear removed question WIP Work in Progress labels Jun 10, 2025

Update nxos show interface #2112

Are you sure you want to change the base?

Update nxos show interface #2112

Uh oh!

Conversation

Mikeg2881 commented Apr 27, 2025

Uh oh!

Uh oh!

Uh oh!

mjbear commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Mikeg2881 commented Apr 28, 2025

Uh oh!

mjbear commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjbear commented Apr 28, 2025

Uh oh!

Mikeg2881 commented Apr 28, 2025

Uh oh!

mjbear commented Apr 28, 2025

Uh oh!

Mikeg2881 commented Apr 28, 2025

Uh oh!

mjbear commented Apr 28, 2025

Uh oh!

mjbear commented Apr 29, 2025

Uh oh!

mjbear commented Apr 30, 2025

Uh oh!

mjbear commented May 4, 2025

Uh oh!

mjbear commented May 17, 2025

Uh oh!

mjbear commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plural

Singular

No Precedent (Existing Example)

Uh oh!

jmcgill298 commented Jun 9, 2025

Uh oh!

mjbear left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mjbear commented Apr 28, 2025 •

edited

Loading

mjbear commented Apr 28, 2025 •

edited

Loading

mjbear commented Jun 9, 2025 •

edited

Loading