Skip to content

Commit

Permalink
[doc][DPB] Update DPB related interface breakout command Info (sonic-…
Browse files Browse the repository at this point in the history
…net#1438)

Updated the Command-Reference doc for the below changes.

Added few more info to config interface breakout command for user reference and the CLI section of DPB HLD DOC link has been added for more info.
Same goes for show interface breakout
updated config interface speed info as per version.
All the above-mentioned points have been added for SONiC version >=202006.
  • Loading branch information
Sangita Maity authored Dec 24, 2021
1 parent 1a2a9a3 commit bc8fe7c
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions doc/Command-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3254,9 +3254,9 @@ This show command displays the port auto negotiation status for all interfaces i
Ethernet8 disabled 100G N/A CR4 N/A up up
```

**show interfaces breakout**
**show interfaces breakout (Versions >= 202006)**

This show command displays the port capability for all interfaces i.e. index, lanes, default_brkout_mode, breakout_modes(i.e. all the available breakout modes) and brkout_mode (i.e. current breakout mode). To display current breakout mode, "current-mode" subcommand can be used.For a single interface, provide the interface name with the sub-command.
This show command displays the port capability for all interfaces i.e. index, lanes, default_brkout_mode, breakout_modes(i.e. available breakout modes) and brkout_mode (i.e. current breakout mode). To display current breakout mode, "current-mode" subcommand can be used.For a single interface, provide the interface name with the sub-command.

- Usage:
```
Expand Down Expand Up @@ -3857,12 +3857,20 @@ This command is used for administratively bringing up the Physical interface or
admin@sonic:~$ sudo config interface startup Ethernet8,Ethernet16-20,Ethernet32
```

**config interface <interface_name> speed (Versions >= 202006)**

Dynamic breakout feature is supported in SONiC from 202006 version.
User can configure any speed specified under "breakout_modes" keys for the parent interface in the platform-specific port configuration file (i.e. platform.json).

For example for a breakout mode of 2x50G[25G,10G] the default speed is 50G but the interface also supports 25G and 10G.

Refer [DPB HLD DOC](https://github.com/Azure/SONiC/blob/master/doc/dynamic-port-breakout/sonic-dynamic-port-breakout-HLD.md#cli-design) to know more about this command.

**config interface speed <interface_name> (Versions >= 201904)**

**config interface <interface_name> speed (Versions <= 201811)**

This command is used to configure the speed for the Physical interface. Use the value 40000 for setting it to 40G and 100000 for 100G. Users need to know the device to configure it properly.
Dynamic breakout feature is yet to be supported in SONiC and hence uses cannot configure any values other than 40G and 100G.

- Usage:

Expand Down Expand Up @@ -3955,10 +3963,14 @@ This command is used to configure the TPID for the Physical/PortChannel interfac
admin@sonic:~$ sudo config interface tpid Ethernet64 0x9200
```

**config interface breakout**
**config interface breakout (Versions >= 202006)**

This command is used to set active breakout mode available for user-specified interface based on the platform-specific port configuration file(i.e. platform.json)
and the current mode set for the interface.

This command is used to set breakout mode available for user-specified interface.
kindly use, double tab i.e. <tab><tab> to see the available breakout option customized for each interface provided by the user.
Based on the platform.json and the current mode set in interface, this command acts on setting breakout mode for the interface.

Double tab i.e. <tab><tab> to see the available breakout option customized for each interface provided by the user.

- Usage:
```
Expand All @@ -3981,10 +3993,16 @@ kindly use, double tab i.e. <tab><tab> to see the available breakout option cust
admin@sonic:~$ sudo config interface breakout Ethernet0 <tab><tab>
<tab provides option for breakout mode>
1x100G[40G] 2x50G 4x25G[10G]
```

This command also provides "--force-remove-dependencies/-f" option to CLI, which will automatically determine and remove the configuration dependencies using Yang models.

```
admin@sonic:~$ sudo config interface breakout Ethernet0 4x25G[10G] -f -l -v -y
```

For details please refer [DPB HLD DOC](https://github.com/Azure/SONiC/blob/master/doc/dynamic-port-breakout/sonic-dynamic-port-breakout-HLD.md#cli-design) to know more about this command.

Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)

**config interface autoneg <interface_name> (Versions >= 202106)**
Expand Down

0 comments on commit bc8fe7c

Please sign in to comment.