Skip to content

Commit bc8fe7c

Browse files
author
Sangita Maity
authored
[doc][DPB] Update DPB related interface breakout command Info (sonic-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.
1 parent 1a2a9a3 commit bc8fe7c

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

doc/Command-Reference.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -3254,9 +3254,9 @@ This show command displays the port auto negotiation status for all interfaces i
32543254
Ethernet8 disabled 100G N/A CR4 N/A up up
32553255
```
32563256
3257-
**show interfaces breakout**
3257+
**show interfaces breakout (Versions >= 202006)**
32583258
3259-
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.
3259+
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.
32603260
32613261
- Usage:
32623262
```
@@ -3857,12 +3857,20 @@ This command is used for administratively bringing up the Physical interface or
38573857
admin@sonic:~$ sudo config interface startup Ethernet8,Ethernet16-20,Ethernet32
38583858
```
38593859
3860+
**config interface <interface_name> speed (Versions >= 202006)**
3861+
3862+
Dynamic breakout feature is supported in SONiC from 202006 version.
3863+
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).
3864+
3865+
For example for a breakout mode of 2x50G[25G,10G] the default speed is 50G but the interface also supports 25G and 10G.
3866+
3867+
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.
3868+
38603869
**config interface speed <interface_name> (Versions >= 201904)**
38613870
38623871
**config interface <interface_name> speed (Versions <= 201811)**
38633872
38643873
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.
3865-
Dynamic breakout feature is yet to be supported in SONiC and hence uses cannot configure any values other than 40G and 100G.
38663874
38673875
- Usage:
38683876
@@ -3955,10 +3963,14 @@ This command is used to configure the TPID for the Physical/PortChannel interfac
39553963
admin@sonic:~$ sudo config interface tpid Ethernet64 0x9200
39563964
```
39573965
3958-
**config interface breakout**
3966+
**config interface breakout (Versions >= 202006)**
3967+
3968+
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)
3969+
and the current mode set for the interface.
39593970
3960-
This command is used to set breakout mode available for user-specified interface.
3961-
kindly use, double tab i.e. <tab><tab> to see the available breakout option customized for each interface provided by the user.
3971+
Based on the platform.json and the current mode set in interface, this command acts on setting breakout mode for the interface.
3972+
3973+
Double tab i.e. <tab><tab> to see the available breakout option customized for each interface provided by the user.
39623974
39633975
- Usage:
39643976
```
@@ -3981,10 +3993,16 @@ kindly use, double tab i.e. <tab><tab> to see the available breakout option cust
39813993
admin@sonic:~$ sudo config interface breakout Ethernet0 <tab><tab>
39823994
<tab provides option for breakout mode>
39833995
1x100G[40G] 2x50G 4x25G[10G]
3996+
```
3997+
3998+
This command also provides "--force-remove-dependencies/-f" option to CLI, which will automatically determine and remove the configuration dependencies using Yang models.
39843999
4000+
```
39854001
admin@sonic:~$ sudo config interface breakout Ethernet0 4x25G[10G] -f -l -v -y
39864002
```
39874003
4004+
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.
4005+
39884006
Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)
39894007
39904008
**config interface autoneg <interface_name> (Versions >= 202106)**

0 commit comments

Comments
 (0)