cisco_nxos_show_interface.textfsm (Updates)

[Mikeg2881]

I see this note "Feature request for adding data captured to existing templates will be closed.", hopefully it is not closed.
I wanted more data from show interfaces on Cisco NXOS devices. I think my revised TEXTFSM file is good as I tested on old and new Nexus devices. and it appears to work as expected. I wanted all the items under TX and RX so i added them in there. For consistency I renamed INPUT_ERRRORS to RX_INPUT_ERRORS and the same for OUTPUT_ERRORS to TX_OUTPUT_ERRORS. I realize that may mess other people up so that can be changed back. The textFSM does appear to capture all the data i want. Now sure if someone can check/validate this/tweak it?

Value Required INTERFACE (\S+)
Value LINK_STATUS (.+?)
Value ADMIN_STATE (.+?)
Value HARDWARE_TYPE (.*)
Value MAC_ADDRESS ([a-zA-Z0-9]+.[a-zA-Z0-9]+.[a-zA-Z0-9]+)
Value BIA ([a-zA-Z0-9]+.[a-zA-Z0-9]+.[a-zA-Z0-9]+)
Value DESCRIPTION (\S+((\s+\S+)+)?)
Value IP_ADDRESS (\d+\.\d+\.\d+\.\d+)
Value PREFIX_LENGTH (\d+)
Value MTU (\d+)
Value MODE (\S+)
Value DUPLEX (.+duplex?)
Value SPEED (.+?)
Value INPUT_PACKETS (\d+)
Value OUTPUT_PACKETS (\d+)
# OLD-----Value INPUT_ERRORS (\d+)
# OLD-----Value OUTPUT_ERRORS (\d+)
Value BANDWIDTH (\d+\s+\w+)
Value DELAY (\d+\s+\w+)
Value ENCAPSULATION ([\w\.]+)
Value LAST_LINK_FLAPPED (.+?)
Value VLAN_ID (\d+)
Value PACKET_INPUT_RATE (.+?)
Value PACKET_OUTPUT_RATE (.+?)
Value BANDWIDTH_INPUT_RATE (.+?)
Value BANDWIDTH_OUTPUT_RATE (.+?)
Value MEDIA_TYPE (.+?)
# RX
Value RX_INPUT_ERRORS (\d+)
Value RX_SHORT_FRAME (\d+)
Value RX_OVERRUN (\d+)
Value RX_UNDERRUN (\d+)
Value RX_IGNORED (\d+)
Value RX_WATCHDOG (\d+)
Value RX_BAD_ETYPE_DROP (\d+)
Value RX_BAD_PROTO_DROP (\d+)
Value RX_IF_DOWN_DROP (\d+)
Value RX_DRIBBLE (\d+)
Value RX_INPUT_DISCARD (\d+)
Value RX_PAUSE (\d+)
Value RX_STOMPED_CRC (\d+)
Value RX_JUMBO_PACKETS (\d+)
Value RX_STORM_SUPPRESSION_BYTES (\d+)
Value RX_RUNTS (\d+)
Value RX_GIANTS (\d+)
Value RX_CRC (\d+)
Value RX_NO_BUFFER (\d+)
# TX
Value TX_JUMBO_PACKETS (\d+)
Value TX_OUTPUT_ERRORS (\d+)
Value TX_COLLISIONS (\d+)
Value TX_DEFERRED (\d+)
Value TX_LATE_COLLISIONS (\d+)
Value TX_LOST_CARRIER (\d+)
Value TX_NO_CARRIER (\d+)
Value TX_BABBLE (\d+)
Value TX_OUTPUT_DISCARD (\d+)
Value TX_PAUSE (\d+)


Start
  ^\S+\s+is.+ -> Continue.Record
  ^${INTERFACE}\s+is\s+${LINK_STATUS},\sline\sprotocol\sis\s${ADMIN_STATE}$$
  ^${INTERFACE}\s+is\s+${LINK_STATUS}$$
  ^admin\s+state\s+is\s+${ADMIN_STATE},
  ^\s+Hardware(:|\s+is)\s+${HARDWARE_TYPE},\s+address(:|\s+is)\s+${MAC_ADDRESS}(.*bia\s+${BIA})*
  ^\s+Description:\s+${DESCRIPTION}\s*$$
  ^\s+Internet\s+Address\s+is\s+${IP_ADDRESS}\/${PREFIX_LENGTH}
  ^\s+Port\s+mode\s+is\s+${MODE}
  ^\s+${DUPLEX}, ${SPEED}(,\s+media\s+type\s+is\s+${MEDIA_TYPE})?\s*$$
  ^\s+MTU\s+${MTU}.*BW\s+${BANDWIDTH}.*DLY\s+${DELAY}
  ^\s+Encapsulation\s+${ENCAPSULATION}(,)?(\s+Virtual\s+LAN,\s+Vlan\s+ID\s+${VLAN_ID},)?
  ^\s+${INPUT_PACKETS}\s+input\s+packets\s+\d+\s+bytes\s*$$
  # RX
  ^\s+${RX_INPUT_ERRORS}\s+input\s+error\s+${RX_SHORT_FRAME}\s+short\s+frame\s+${RX_OVERRUN}\s+overrun\s+${RX_UNDERRUN}\s+underrun\s+${RX_IGNORED}\s+ignored\s*$$
  ^ *${RX_WATCHDOG} +watchdog +${RX_BAD_ETYPE_DROP} +bad +etype +drop +${RX_BAD_PROTO_DROP} +bad +proto +drop +${RX_IF_DOWN_DROP} +if +down +drop *$$
  ^ *${RX_DRIBBLE} +input +with +dribble +${RX_INPUT_DISCARD} +input +discard *$$
  ^ *${RX_PAUSE} +Rx +pause *$$
  ^ *${RX_STOMPED_CRC} +Stomped +CRC *$$
  ^ *${RX_JUMBO_PACKETS} +jumbo +packets +${RX_STORM_SUPPRESSION_BYTES} +storm +suppression +bytes *$$
  ^ *${RX_RUNTS} +runts +${RX_GIANTS} +giants +${RX_CRC} +CRC +${RX_NO_BUFFER} +no +buffer *$$
  # TX
  ^ *${TX_JUMBO_PACKETS} +jumbo +packets *$$
  ^ *${TX_OUTPUT_ERRORS} +output +error +${TX_COLLISIONS} +collision +${TX_DEFERRED} +deferred +${TX_LATE_COLLISIONS} +late +collision *$$
  ^ *${TX_LOST_CARRIER} +lost +carrier +${TX_NO_CARRIER} +no +carrier +${TX_BABBLE} +babble +${TX_OUTPUT_DISCARD} +output +discard *$$
  ^ *${TX_PAUSE} +Tx +pause *$$
  ^\s+${OUTPUT_PACKETS}\s+output\s+packets\s+\d+\s+bytes\s*$$
  ^\s+Last\s+link\s+flapped\s+${LAST_LINK_FLAPPED}\s*$$
  ^\s+\d+\s+seconds\s+input\s+rate\s+${BANDWIDTH_INPUT_RATE}\s+bits/sec,\s+${PACKET_INPUT_RATE}\s+packets/sec
  ^\s+\d+\s+seconds\s+output\s+rate\s+${BANDWIDTH_OUTPUT_RATE}\s+bits/sec,\s+${PACKET_OUTPUT_RATE}\s+packets/sec

Sample Interface

Ethernet1/1 is up
admin state is up, Dedicated Interface
  Hardware: 10/100/1000 Ethernet, address: 9088.555f.3250 (bia 9088.555f.3250)
  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
  full-duplex, 1000 Mb/s
  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 40week(s) 5day(s)
  Last clearing of "show interface" counters never
  1 interface resets
  Load-Interval #1: 30 seconds
    30 seconds input rate 200 bits/sec, 0 packets/sec
    30 seconds output rate 5320 bits/sec, 1 packets/sec
    input rate 200 bps, 0 pps; output rate 5.32 Kbps, 1 pps
  Load-Interval #2: 5 minute (300 seconds)
    300 seconds input rate 160 bits/sec, 0 packets/sec
    300 seconds output rate 4576 bits/sec, 1 packets/sec
    input rate 160 bps, 0 pps; output rate 4.58 Kbps, 1 pps
  RX
    5432519 unicast packets  960110 multicast packets  6 broadcast packets
    6392635 input packets  827345973 bytes
    22 jumbo packets  333 storm suppression bytes
    132 runts  12313 giants  2211122 CRC  4431412 no buffer
    10 input error  20 short frame  30 overrun   40 underrun  50 ignored
    60 watchdog  70 bad etype drop  80 bad proto drop  90 if down drop
    100 input with dribble  111 input discard
    122 Rx pause
    133 Stomped CRC
  TX
    4257792 unicast packets  115660636 multicast packets  18381328 broadcast packets
    138299756 output packets  16581146467 bytes
    69 jumbo packets
    555 output error  555444 collision  13132131 deferred  12312312 late collision
    132123 lost carrier  11 no carrier  22 babble  33 output discard
    69 Tx pause

[mjbear]

I see this note "Feature request for adding data captured to existing templates will be closed.", hopefully it is not closed.

I believe that message is mostly meant to deter random people expecting others to build them templates.

Based on your post here you're putting effort into it.

I wanted more data from show interfaces on Cisco NXOS devices. I think my revised TEXTFSM file is good as I tested on old and new Nexus devices. and it appears to work as expected. I wanted all the items under TX and RX so i added them in there. For consistency I renamed INPUT_ERRRORS to RX_INPUT_ERRORS and the same for OUTPUT_ERRORS to TX_OUTPUT_ERRORS. I realize that may mess other people up so that can be changed back. The textFSM does appear to capture all the data i want. Now sure if someone can check/validate this/tweak it?

Unless there's a huge reason to change the INPUT_ERRORS/OUTPUT_ERRORS capture group names we shouldn't since that constitutes a breaking change. (More on that in a bit.)

Value Required INTERFACE (\S+)
Value LINK_STATUS (.+?)
Value ADMIN_STATE (.+?)
Value HARDWARE_TYPE (.*)
Value MAC_ADDRESS ([a-zA-Z0-9]+.[a-zA-Z0-9]+.[a-zA-Z0-9]+)
Value BIA ([a-zA-Z0-9]+.[a-zA-Z0-9]+.[a-zA-Z0-9]+)
Value DESCRIPTION (\S+((\s+\S+)+)?)
Value IP_ADDRESS (\d+\.\d+\.\d+\.\d+)
Value PREFIX_LENGTH (\d+)
Value MTU (\d+)
Value MODE (\S+)
Value DUPLEX (.+duplex?)
Value SPEED (.+?)
Value INPUT_PACKETS (\d+)
Value OUTPUT_PACKETS (\d+)
# OLD-----Value INPUT_ERRORS (\d+)
# OLD-----Value OUTPUT_ERRORS (\d+)
Value BANDWIDTH (\d+\s+\w+)
Value DELAY (\d+\s+\w+)
Value ENCAPSULATION ([\w\.]+)
Value LAST_LINK_FLAPPED (.+?)
Value VLAN_ID (\d+)
Value PACKET_INPUT_RATE (.+?)
Value PACKET_OUTPUT_RATE (.+?)
Value BANDWIDTH_INPUT_RATE (.+?)
Value BANDWIDTH_OUTPUT_RATE (.+?)
Value MEDIA_TYPE (.+?)
# RX
Value RX_INPUT_ERRORS (\d+)
Value RX_SHORT_FRAME (\d+)
Value RX_OVERRUN (\d+)
Value RX_UNDERRUN (\d+)
Value RX_IGNORED (\d+)
Value RX_WATCHDOG (\d+)
Value RX_BAD_ETYPE_DROP (\d+)
Value RX_BAD_PROTO_DROP (\d+)
Value RX_IF_DOWN_DROP (\d+)
Value RX_DRIBBLE (\d+)
Value RX_INPUT_DISCARD (\d+)
Value RX_PAUSE (\d+)
Value RX_STOMPED_CRC (\d+)
Value RX_JUMBO_PACKETS (\d+)
Value RX_STORM_SUPPRESSION_BYTES (\d+)
Value RX_RUNTS (\d+)
Value RX_GIANTS (\d+)
Value RX_CRC (\d+)
Value RX_NO_BUFFER (\d+)

Do we need to prefix these with RX?
Or just simply have overruns be in OVERRUN?

# TX
Value TX_JUMBO_PACKETS (\d+)
Value TX_OUTPUT_ERRORS (\d+)
Value TX_COLLISIONS (\d+)
Value TX_DEFERRED (\d+)
Value TX_LATE_COLLISIONS (\d+)
Value TX_LOST_CARRIER (\d+)
Value TX_NO_CARRIER (\d+)
Value TX_BABBLE (\d+)
Value TX_OUTPUT_DISCARD (\d+)
Value TX_PAUSE (\d+)

... snipped ...

Similarly for those prefixed with TX, do we need that part?
I'm not dismissing it -- simply bringing it up for discussion. Thank you. 🙂

And maybe a group decision will occur here justifying the breaking changes to prefix the INPUT_ERRORS/OUTPUT_ERRORS capture group names with RX and TX respectively. 😀

Do you want to open up a pull request (PR) for these changes?
This will allow for any edits to happen right there at the PR.

Thank you.

[Mikeg2881]

If i was starting from scratch i would argue to change INPUT_ERRORS/OUTPUT_ERRORS. But i wouldn't want to change them so keeping them is best. I like the idea of the TX and RX because it lines up perfectly to the real show command.
What is a pull request? I tested this on maybe 10 switches and it seemed to work. Is there more testing that is done?

[mjbear]

If i was starting from scratch i would argue to change INPUT_ERRORS/OUTPUT_ERRORS.

I see your point.

But i wouldn't want to change them so keeping them is best.

The following templates currently use INPUT_ERRORS and OUTPUT_ERRORS. If we were to change it for one, we should change it to unify/normalize all.

ntc_templates/templates/cisco_ios_show_interfaces.textfsm
ntc_templates/templates/cisco_nxos_show_interface.textfsm
ntc_templates/templates/cisco_xr_show_interfaces.textfsm
ntc_templates/templates/oneaccess_oneos_show_interfaces.textfsm

I like the idea of the TX and RX because it lines up perfectly to the real show command.

👍

What is a pull request?

Essentially a pull request (PR) is how a person can submit code changes for review (and eventually have them pulled and merged in).

Details on ntc-templates PR and development guidelines.

I tested this on maybe 10 switches and it seemed to work. Is there more testing that is done?

I'd have to check the existing test data to see if we have coverage for those values. For now we're probably good on tests against physical hardware.

[Mikeg2881]

I have made a branch and now try to push it and it doen't look like i have access.

C:\Code\ntc branch\ntc-templates>git push origin cisco_nxos_show_interface(Update)
remote: Permission to networktocode/ntc-templates.git denied to Mikeg2881.
fatal: unable to access 'https://github.com/networktocode/ntc-templates/': The requested URL returned error: 403

[mjbear]

I have made a branch and now try to push it and it doen't look like i have access.

It is necessary to fork the ntc-templates repo so there's an area where you'll have the ability to modify it.

[Mikeg2881]

I think i did it correctly?
https://github.com/networktocode/ntc-templates/pull/2112

[mjbear]

I think i did it correctly? https://github.com/networktocode/ntc-templates/pull/2112

I see the PR.
There are several pieces to the PR, but you have the basics covered. Great start!