Updated CMIS VDM CLI commands - #2458
Open
nkanchi-nexthop wants to merge 2 commits into
Open
Conversation
Collaborator
|
/azp run |
|
No pipelines are associated with this pull request. |
Signed-off-by: Nikhil Kanchi <nkanchi@nexthop.ai>
nkanchi-nexthop
force-pushed
the
nkanchi.cmis-monitoring-hld-vdm-updates
branch
from
July 10, 2026 17:38
b41d9c3 to
b2cc332
Compare
Collaborator
|
/azp run |
|
No pipelines are associated with this pull request. |
Contributor
Author
|
@prgeor @mihirpat1 Please help reviewing this |
There was a problem hiding this comment.
Pull request overview
Updates the SONiC CMIS diagnostic monitoring documentation to reflect new table-style output for VDM-related CLI commands, including per-port sections and additional columns for current/min/avg/max and thresholds.
Changes:
- Reformats
show interfaces transceiver vdm PORTdocumented output into a per-port table layout, including thresholds and basic/statistic values in the same row. - Reformats
show interfaces transceiver vdm flag PORTdocumented output into a simplified per-port table layout and updates the--detailexample output format.
Comments suppressed due to low confidence (2)
doc/platform_api/CMIS_Diagnostic_Monitoring_Overview_in_SONiC.md:1969
- The
show interfaces transceiver vdm flagsection no longer explains the (apparently changed) filtering behavior. The example shows rows even when all flags areFalse, but the text doesn't state that output includes such rows (and the--detaildescription is now separated). Adding a brief behavior description here will prevent confusion about why output isn't empty when no flags are asserted.
This CLI shows the transceiver VDM flags for a given port.
doc/platform_api/CMIS_Diagnostic_Monitoring_Overview_in_SONiC.md:2021
- The
--detailexample uses a different argument ordering (vdm flag --detail Ethernet1) than the non-detail example and the section heading (vdm flag PORT). Unless the CLI explicitly requires this ordering, it’s clearer to keep the port in the same position and show the option as an optional trailing flag.
admin@sonic# show interfaces transceiver vdm flag --detail Ethernet1
prgeor
reviewed
Jul 28, 2026
| ##### 4.2.2.1 VDM flags dump using the `--detail` option | ||
|
|
||
| With the `--detail` option, the VDM data for all types of observables will be displayed. With this option, the CLI will show data for all lanes and supported observables (irrespective of the flag status). For unsupported observables, the CLI will show `N/A` for the data. | ||
| The `--detail` option can be used to show the flag, Change Count, Last Set Time and Last Clear Time for all observables supported by the module. |
Contributor
There was a problem hiding this comment.
@aditya-nexthop @nkanchi-nexthop is there a specific reason to not show N/A?
Contributor
There was a problem hiding this comment.
I don't think we need to show N/A anywhere in this command output, right, @nkanchi-nexthop ?
Author
There was a problem hiding this comment.
Yes, the command output for both flag and flag --detail will never have N/A displayed. @aditya-nexthop @prgeor
prgeor
previously approved these changes
Jul 29, 2026
Contributor
|
@nkanchi-nexthop @aditya-nexthop any code PR? |
Contributor
Collaborator
|
/azp run |
|
No pipelines are associated with this pull request. |
Collaborator
|
/azp run |
|
No pipelines are associated with this pull request. |
nkanchi-nexthop
force-pushed
the
nkanchi.cmis-monitoring-hld-vdm-updates
branch
from
July 31, 2026 08:22
fbf38ad to
b6bda1e
Compare
Collaborator
|
/azp run |
|
No pipelines are associated with this pull request. |
Signed-off-by: Nikhil Kanchi <nkanchi@nexthop.ai>
nkanchi-nexthop
force-pushed
the
nkanchi.cmis-monitoring-hld-vdm-updates
branch
from
July 31, 2026 08:23
b6bda1e to
95ba024
Compare
Collaborator
|
/azp run |
|
No pipelines are associated with this pull request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR reformats the
show interfaces transceiver vdmoutput into a new table layout. It changes the VDM CLI to show data under a per-port section with columns for parameter, unit, lane, current/min/avg/max values, and the four threshold types, while keeping basic and statistic observables together in the same row when applicable.It also updates the behavior for unsupported observables so they display -- instead of being omitted, and applies a similar cleaner table format to the
show interfaces transceiver vdm flagcommand as well.Implemented in this upstream PR: sonic-net/sonic-utilities#4636