Add interface link-training command into the CLI doc (#2257)

* LT Admin/Oper: Use 'N/A' when the data is unavailable Signed-off-by: Dante Su <[email protected]> * fix test failure Signed-off-by: Dante Su <[email protected]> * fix coverage failure Signed-off-by: Dante Su <[email protected]> * [doc]: Update Command-Reference.md (#2257) Add interface link-training command into the CLI doc Use 'N/A' if link-training attribute is not supported in the SAI. Signed-off-by: Dante Su <[email protected]> Signed-off-by: Dante Su <[email protected]>
sonic-net · Jan 25, 2023 · 22757b1 · 22757b1
1 parent f4f857e
commit 22757b1
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 18 deletions.
diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md
@@ -441,14 +441,15 @@ The same syntax applies to all subgroups of `show` which themselves contain subc
     -?, -h, --help  Show this message and exit.
 
   Commands:
-    counters     Show interface counters
-    description  Show interface status, protocol and...
-    naming_mode  Show interface naming_mode status
-    neighbor     Show neighbor related information
-    portchannel  Show PortChannel information
-    status       Show Interface status information
-    tpid         Show Interface tpid information
-    transceiver  Show SFP Transceiver information
+    counters       Show interface counters
+    description    Show interface status, protocol and...
+    link-training  Show interface link-training information
+    naming_mode    Show interface naming_mode status
+    neighbor       Show neighbor related information
+    portchannel    Show PortChannel information
+    status         Show Interface status information
+    tpid           Show Interface tpid information
+    transceiver    Show SFP Transceiver information
   ```
 
 Go Back To [Beginning of the document](#) or [Beginning of this section](#getting-help)
@@ -3643,6 +3644,35 @@ This command displays the key fields of the interfaces such as Operational Statu
   Ethernet4    down       up  hundredGigE1/2  T0-2:hundredGigE1/30
   ```
 
+**show interfaces link-training (Versions >= 202211)**
+
+This command is to display the link-training status of the selected interfaces. If **interface_name** is not specicied, this command shows the link-training status of all interfaces.
+
+- Usage:
+  ```
+  show interfaces link-training status [<interface_name>]
+  ```
+
+- Example:
+  ```
+  admin@sonic:~$ show interfaces link-training status
+    Interface      LT Oper    LT Admin    Oper    Admin
+  -----------  -----------  ----------  ------  -------
+    Ethernet0      trained          on      up       up
+    Ethernet8      trained          on      up       up
+   Ethernet16          off         off    down       up
+   Ethernet24  not trained          on    down       up
+   Ethernet32          off         off    down       up
+  ```
+
+- Example (to only display the link-training status of interface Ethernet8):
+  ```
+  admin@sonic:~$ show interfaces link-training status Ethernet8
+    Interface      LT Oper    LT Admin    Oper    Admin
+  -----------  -----------  ----------  ------  -------
+    Ethernet8      trained          on      up       up
+  ```
+
 **show interfaces mpls**
 
 This command is used to display the configured MPLS state for the list of configured interfaces.
@@ -3841,6 +3871,7 @@ This sub-section explains the following list of configuration on the interfaces.
 10) type - to set interface type
 11) mpls - To add or remove MPLS operation for the interface
 12) loopback-action - to set action for packet that ingress and gets routed on the same IP interface
+13) link-training - to set interface link-training mode
 
 From 201904 release onwards, the “config interface” command syntax is changed and the format is as follows:
 
@@ -4411,6 +4442,29 @@ Loopback action can be drop or forward.
   admin@sonic:~$ config interface ip loopback-action Ethernet0 forward
 
   ```
+
+**config interface link-training <interface_name> (Versions >= 202211)**
+
+This command is used for setting link-training mode of a interface.
+
+- Usage:
+  ```
+  sudo config interface link-training --help
+  Usage: config interface link-training [OPTIONS] <interface_name> <mode>
+
+    Set interface link-training mode
+
+  Options:
+    -v, --verbose   Enable verbose output
+    -h, -?, --help  Show this message and exit.
+  ```
+
+- Example:
+  ```
+  admin@sonic:~$ sudo config interface link-training Ethernet0 on
+  admin@sonic:~$ sudo config interface link-training Ethernet0 off
+  ```
+
 Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)
 
 ## Interface Naming Mode

diff --git a/scripts/intfutil b/scripts/intfutil
@@ -797,10 +797,8 @@ class IntfLinkTrainingStatus(object):
                     continue
                 lt_admin = appl_db_port_status_get(self.db, key, PORT_LINK_TRAINING)
                 if lt_admin not in ['on', 'off']:
-                    lt_admin = '-'
+                    lt_admin = 'N/A'
                 lt_status = state_db_port_status_get(self.db, key, PORT_LINK_TRAINING_STATUS)
-                if lt_status in ['N/A', '', None]:
-                    lt_status = 'off'
                 table.append((key,
                               lt_status.replace('_', ' '),
                               lt_admin,

diff --git a/tests/intfutil_test.py b/tests/intfutil_test.py
@@ -101,15 +101,15 @@
   Interface      LT Oper    LT Admin    Oper    Admin
 -----------  -----------  ----------  ------  -------
   Ethernet0  not trained          on    down       up
- Ethernet16          off           -      up       up
- Ethernet24          off           -      up       up
- Ethernet28          off           -      up       up
+ Ethernet16          N/A         N/A      up       up
+ Ethernet24          N/A         N/A      up       up
+ Ethernet28          N/A         N/A      up       up
  Ethernet32      trained          on      up       up
- Ethernet36          off           -      up       up
+ Ethernet36          N/A         N/A      up       up
 Ethernet112          off         off      up       up
-Ethernet116          off           -      up       up
-Ethernet120          off           -      up       up
-Ethernet124          off           -      up       up
+Ethernet116          N/A         N/A      up       up
+Ethernet120          N/A         N/A      up       up
+Ethernet124          N/A         N/A      up       up
 """
 
 class TestIntfutil(TestCase):