ntc-templates icon indicating copy to clipboard operation
ntc-templates copied to clipboard

I share the new template for Cisco NXOS command 'show interface breakout'

Open i-m-d opened this issue 5 months ago • 8 comments

I share the new template for Cisco NXOS command 'show interface breakout'

Environment

  • ntc-templates version: 8.0.0

Proposed Functionality

The functionality is to obtain the output of the Cisco NXOS command 'show interface breakout'

Real example command:

# sh int breakout

--------------------------------------------------------------------------------
Parent                     Breakout Map    Breakout Ports
--------------------------------------------------------------------------------
Eth1/2                     10g-4x          Eth1/2/1-4
Eth1/3                     10g-4x          Eth1/3/1-4
Eth1/4                     10g-4x          Eth1/4/1-4
Eth1/5                     10g-4x          Eth1/5/1-4
Eth1/6                     10g-4x          Eth1/6/1-4
Eth1/11                    10g-4x          Eth1/11/1-4
Eth1/13                    10g-4x          Eth1/13/1-4
Eth1/14                    10g-4x          Eth1/14/1-4
Eth1/16                    10g-4x          Eth1/16/1-4
Eth1/19                    10g-4x          Eth1/19/1-4
Eth1/22                    10g-4x          Eth1/22/1-4

Use Case

In show interfaces this kind of interfaces (MPO) are NOT shown, so it is interesting to obtain them.

WORKING Template created for me

Value PARENT (\S+)
Value BREAKOUT_MAP (\S+)
Value BREAKOUT_PORTS (\S+)

Start
  ^${PARENT}\s+${BREAKOUT_MAP}\s+${BREAKOUT_PORTS}\s*$$ -> Record
  ^[Pp]arent\s+[Bb]reakout [Mm]ap\s+[Bb]reakout [Pp]orts\s*$$
  ^-+
  ^\s*$$
  ^. -> Error

i-m-d avatar Aug 28 '25 08:08 i-m-d

# sh int breakout

--------------------------------------------------------------------------------
Parent                     Breakout Map    Breakout Ports
--------------------------------------------------------------------------------
Eth1/2                     10g-4x          Eth1/2/1-4
Eth1/3                     10g-4x          Eth1/3/1-4
... snipped ...

(I've not used MPO breakouts with nxos.) Since there's a third interface identifier added, the child/break-out ports are always contiguous (1-4 with a hyphen), right?

@i-m-d Are you open to creating a pull request (PR) with this template, updated index, and the necessary test data?

mjbear avatar Aug 28 '25 13:08 mjbear

(I've not used MPO breakouts with nxos.) Since there's a third interface identifier added, the child/break-out ports are always contiguous (1-4 with a hyphen), right?

Yes, in this case: This interface: Eth1/2 is divided into 4 (4x) interfaces of 10g ---> 10g-4x And these are the interfaces Eth1/2/1-4 ---> Eth1/2/1, Eth1/2/2, Eth1/2/3, Eth1/2/4

In all my MPO breakouts allways are 1 to 4, and all are 40g breakout into 4 of 10G

@i-m-d Are you open to creating a pull request (PR) with this template, updated index, and the necessary test data?

Send me the DOC to do that, and i will try.

IMPORTANT: this command (sh int breakout) is only in my Cisco Nexus 77xx (version 8.4.10), not in others Cisco Nexus 95xx 93xx 92xx (several versions 9.x, 10.2.x, 10.4.x), for this other Nexus you can use this other solution:

# sh run | i brea
interface breakout module 2 port 1,4,9,15-17,22 map 10g-4x
interface breakout module 3 port 49 map 10g-4x

but this template is no usefull

i-m-d avatar Aug 28 '25 13:08 i-m-d

(I've not used MPO breakouts with nxos.) Since there's a third interface identifier added, the child/break-out ports are always contiguous (1-4 with a hyphen), right?

Yes, in this case: This interface: Eth1/2 is diveded into 4 (4x) interfaces of 10g ---> 10g-4x And these are the interfaces Eth1/2/1-4 ---> Eth1/2/1, Eth1/2/2, Eth1/2/3, Eth1/2/4

In all my MPO breakouts allways are 1 to 4, and all are 40g breakout into 4 of 10G

:+1: Thank you.

@i-m-d Are you open to creating a pull request (PR) with this template, updated index, and the necessary test data?

Send me the DOC to do that, and i will try.

There are more docs I may not have directly linked to, but the major items are in the bullets above. I hope this helps! :tada: :clap:

IMPORTANT: this command (sh int breakout) is only in my Cisco Nexus 77xx (version 8.4.10), not in others Cisco Nexus 95xx 93xx 92xx (several versions 9.x, 10.2.x, 10.4.x), for this other Nexus you can use this other solution: # sh run | i brea

:+1: Thank you.

mjbear avatar Aug 28 '25 14:08 mjbear

@i-m-d Please let us know if there are any questions as you work up a pull request (PR). Thank you!

mjbear avatar Sep 02 '25 17:09 mjbear

@i-m-d Please let us know if there are any questions as you work up a pull request (PR). Thank you!

Thank you, tomorrow i take Juniper certification exam and the long weekend i will go out, so next week i will read docs and ask if any question.

i-m-d avatar Sep 02 '25 17:09 i-m-d

@i-m-d Please let us know if there are any questions as you work up a pull request (PR). Thank you!

Thank you, tomorrow i take Juniper certification exam and the long weekend i will go out, so next week i will read docs and ask if any question.

@i-m-d I hope all went well ... including the long weekend. :laughing:

We appreciate your PR contribution complete with test data when you have time to work it up. Thank you!

mjbear avatar Sep 13 '25 03:09 mjbear

@i-m-d I hope you're doing well. Are you willing to create a PR for this template?

Thank you! :slightly_smiling_face:

mjbear avatar Sep 21 '25 15:09 mjbear

@i-m-d Do you have interest in completing this process with a pull request? Thank you!

mjbear avatar Nov 01 '25 21:11 mjbear

@mjbear i need to create a development environment to create YML and RAW files, but i have very little time.

i-m-d avatar Nov 12 '25 07:11 i-m-d

@mjbear i need to create a development environment to create YML and RAW files,

@i-m-d Right you have a few steps the prepare. (These can go really quick though! :sweat_smile:)

  1. Fork the ntc-templates repo
  2. Create a feature branch to develop on
  3. Create development environment using (Python) poetry
  4. Make commits (template, index file, raw files, yml files)
  5. Run tests locally (or via Docker container) and fix if they don't pass
  6. Create PR against ntc-templates repo
  7. :medal_sports: :beer:

but i have very little time.

Ah, I see.

mjbear avatar Nov 12 '25 13:11 mjbear