Fetch capability of mirror before configuring it by stephenxs · Pull Request #4089 · sonic-net/sonic-utilities

stephenxs · 2025-10-11T09:50:12Z

What I did

Fetch capability of ingress/egress mirror before configuring it and avoid configuring ingress/egress mirror on a platform that does not support it.

How I did it

Check the capability in PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE in STATE_DB table SWITCH_CAPABILITY.
The capability of ingress/egress mirror is inserted to STATE_DB by orchagent during initialization.

How to verify it

Manual test and unit test

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-10-11T09:50:20Z

/azp run

azure-pipelines · 2025-10-11T09:50:30Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-10-11T10:10:52Z

/azp run

azure-pipelines · 2025-10-11T10:11:02Z

Azure Pipelines successfully started running 1 pipeline(s).

stephenxs · 2025-10-13T03:57:58Z

Failure is caused by rebasing the commit to the latest master. Investigating.

stephenxs · 2025-10-13T07:11:25Z

Failure is caused by rebasing the commit to the latest master. Investigating.

Depends on sonic-net/sonic-swss#3934

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-10-20T04:53:23Z

/azp run

azure-pipelines · 2025-10-20T04:53:33Z

Azure Pipelines successfully started running 1 pipeline(s).

config/main.py

bingwang-ms · 2025-11-04T00:49:40Z

Depends on sonic-net/sonic-swss#3934

bingwang-ms · 2025-11-04T00:49:57Z

@qiluo-msft Can you help review this change? Thanks

qiluo-msft · 2025-11-04T01:07:19Z

config/main.py

+def is_port_mirror_capability_supported(direction, namespace=None):
+    """ Check if port mirror capability is supported for the given direction """
+    try:
+        state_db = SonicV2Connector(host='127.0.0.1')


Could you use unix socket which has better performance? #Closed

qiluo-msft · 2025-11-04T01:08:20Z

config/main.py

+                return False
+
+        return True
+    except Exception:


Could you use more specific exception type? #Closed

Removed as we do not expect any exception here.

Copilot

Pull Request Overview

This PR adds ASIC capability checking for port mirror direction support before allowing mirror session configuration. The change prevents users from configuring mirror sessions with directions (rx/tx/both) that are not supported by the underlying ASIC hardware.

Added is_port_mirror_capability_supported() function to query STATE_DB for ASIC capabilities
Integrated capability validation into validate_mirror_session_config()
Added comprehensive test coverage for capability checking functionality

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
config/main.py	Added capability checking function and validation logic to prevent unsupported mirror directions
tests/config_mirror_session_test.py	Added test cases for capability checking and removed trailing whitespace

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

config/main.py

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-11-04T07:20:03Z

/azp run

azure-pipelines · 2025-11-04T07:20:13Z

Azure Pipelines successfully started running 1 pipeline(s).

stephenxs · 2025-11-04T07:25:02Z

It's weird that pretest passed locally but failed in the github

stephens@675ff3c81f2e:/sonic/src/sonic-utilities/config$ git commit -s
[INFO] Initializing environment for https://github.com/PyCQA/flake8.
[INFO] Installing environment for https://github.com/PyCQA/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
flake8...................................................................Passed
[detached HEAD 8bf2b0d7] Fix community review comments
 1 file changed, 19 insertions(+), 23 deletions(-)
stephens@675ff3c81f2e:/sonic/src/sonic-utilities/config$ git log

What I did Fetch capability of ingress/egress mirror before configuring it and avoid configuring ingress/egress mirror on a platform that does not support it. How I did it Check the capability in PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE in STATE_DB table SWITCH_CAPABILITY. The capability of ingress/egress mirror is inserted to STATE_DB by orchagent during initialization. How to verify it Manual test and unit test

)" This reverts commit ad0a3d3.

This reverts commit ad0a3d3.

yxieca · 2025-12-14T01:02:12Z

@stephenxs this change causes test failure when advancing sonic-utilities submodule. We need to revert to move forward.

yxieca · 2025-12-14T01:09:01Z

@stephenxs this change is causing show_techsupport/test_techsupport.py to fail at multi-asic deployment. But this is a good change to have. I will see if that is the only failure. if it is, then I am leaning towards file an issue to xfail it and let you work on a fix. Please stay tuned.

stephenxs · 2025-12-14T07:10:43Z

@stephenxs this change is causing show_techsupport/test_techsupport.py to fail at multi-asic deployment. But this is a good change to have. I will see if that is the only failure. if it is, then I am leaning towards file an issue to xfail it and let you work on a fix. Please stay tuned.

Could you please share the test link? Thanks

yxieca · 2025-12-14T18:07:13Z

Issue: sonic-net/sonic-mgmt#21690

Test failure: https://elastictest.org/scheduler/testplan/693d87a8be086527515c111d

stephenxs · 2025-12-15T04:06:45Z

Issue: sonic-net/sonic-mgmt#21690

Test failure: https://elastictest.org/scheduler/testplan/693d87a8be086527515c111d

Draft a PR to fix it: #4159

What I did Fetch capability of ingress/egress mirror before configuring it and avoid configuring ingress/egress mirror on a platform that does not support it. How I did it Check the capability in PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE in STATE_DB table SWITCH_CAPABILITY. The capability of ingress/egress mirror is inserted to STATE_DB by orchagent during initialization. How to verify it Manual test and unit test

mssonicbld · 2026-01-15T18:33:11Z

Cherry-pick PR to 202511: #4204

The legacy 'config mirror_session add' command calls add_erspan() with direction=None and src_port=None. After PR sonic-net#4089 added port mirror capability checking, validate_mirror_session_config() checks PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE in STATE_DB when direction is None. On platforms where orchagent does not populate these keys, this causes the legacy command to fail with 'Port mirror direction both is not supported by the ASIC'. The fix skips the capability check when src_port is not specified, since legacy ERSPAN sessions don't use port-based mirroring and should not be subject to the port mirror capability check. Fixes: sonic-net#4318 Signed-off-by: Ying Xie <[email protected]>

…sessions ## What I did Fixed is_port_mirror_capability_supported() so that ERSPAN sessions (direction=None) are not blocked by the PORT_INGRESS_MIRROR_CAPABLE / PORT_EGRESS_MIRROR_CAPABLE capability check. ## Root cause PR sonic-net#4089 added a capability check that reads PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE from STATE_DB SWITCH_CAPABILITY|switch. For ERSPAN sessions, direction=None was treated as 'check both', but: 1. These capability flags only apply to SPAN (port mirror) sessions, not ERSPAN (which uses source/destination IPs, not ports) 2. Platforms that don't populate these STATE_DB keys return None, which != 'true', so the function incorrectly returns False (unsupported) PR sonic-net#4159 partially addressed the multi-ASIC namespace issue but did not fix the fundamental problem for ERSPAN sessions with no src/dst port specified. ## How I fixed it - **For ERSPAN (direction=None)**: Return True immediately. PORT_INGRESS/EGRESS_MIRROR_CAPABLE does not apply to ERSPAN sessions. - **For SPAN (direction != None)**: Treat absent STATE_DB key (None value) as 'supported' for backward compatibility with platforms that don't populate SWITCH_CAPABILITY table entries. ## How to verify it Unit tests updated in ests/config_mirror_session_test.py: - Added Test 4 to verify behavior when STATE_DB keys are absent (all return True) - Updated Test 2 and Test 3 assertions for direction=None to expect True Fixes: sonic-net/sonic-mgmt#21690 Signed-off-by: Sonic Build Admin <[email protected]>

…sessions (#4368) ## What I did Fixed is_port_mirror_capability_supported() so that ERSPAN sessions (direction=None) are not blocked by the PORT_INGRESS_MIRROR_CAPABLE / PORT_EGRESS_MIRROR_CAPABLE capability check. ## Root cause PR #4089 added a capability check that reads PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE from STATE_DB SWITCH_CAPABILITY|switch. For ERSPAN sessions, direction=None was treated as 'check both', but: 1. These capability flags only apply to SPAN (port mirror) sessions, not ERSPAN (which uses source/destination IPs, not ports) 2. Platforms that don't populate these STATE_DB keys return None, which != 'true', so the function incorrectly returns False (unsupported) PR #4159 partially addressed the multi-ASIC namespace issue but did not fix the fundamental problem for ERSPAN sessions with no src/dst port specified. ## How I fixed it - **For ERSPAN (direction=None)**: Return True immediately. PORT_INGRESS/EGRESS_MIRROR_CAPABLE does not apply to ERSPAN sessions. - **For SPAN (direction != None)**: Treat absent STATE_DB key (None value) as 'supported' for backward compatibility with platforms that don't populate SWITCH_CAPABILITY table entries. ## How to verify it Unit tests updated in ests/config_mirror_session_test.py: - Added Test 4 to verify behavior when STATE_DB keys are absent (all return True) - Updated Test 2 and Test 3 assertions for direction=None to expect True Fixes: sonic-net/sonic-mgmt#21690 Signed-off-by: Sonic Build Admin <[email protected]>

Fetch capability of mirror before configuring it.

9b5a365

Signed-off-by: Stephen Sun <[email protected]>

Fix pre-commit issues

8b63e49

Signed-off-by: Stephen Sun <[email protected]>

Remove problematic test

d232447

Signed-off-by: Stephen Sun <[email protected]>

stephenxs changed the title ~~Fetch capability of mirror before configuring it.~~ Fetch capability of mirror before configuring it Oct 20, 2025

stephenxs mentioned this pull request Oct 20, 2025

Check mirror ingress/egress capability before configuring it or setting it to SAI sonic-net/SONiC#2088

Merged

stephenxs marked this pull request as ready for review October 23, 2025 06:03

keboliu approved these changes Oct 23, 2025

View reviewed changes

stephenxs requested a review from bingwang-ms October 24, 2025 06:07

bingwang-ms reviewed Oct 30, 2025

View reviewed changes

config/main.py Outdated Show resolved Hide resolved

bingwang-ms previously approved these changes Nov 4, 2025

View reviewed changes

qiluo-msft reviewed Nov 4, 2025

View reviewed changes

qiluo-msft requested a review from Copilot November 4, 2025 01:08

Copilot AI reviewed Nov 4, 2025

View reviewed changes

config/main.py Outdated Show resolved Hide resolved

config/main.py Outdated Show resolved Hide resolved

Fix community review comments

207af46

Signed-off-by: Stephen Sun <[email protected]>

stephenxs dismissed bingwang-ms’s stale review via 207af46 November 4, 2025 07:19

stephenxs requested a review from qiluo-msft November 4, 2025 07:20

qiluo-msft merged commit ad0a3d3 into sonic-net:master Nov 17, 2025
7 checks passed

stephenxs deleted the mirror_capability_check branch November 18, 2025 01:08

yxieca added a commit to yxieca/sonic-utilities that referenced this pull request Dec 13, 2025

Revert "Fetch capability of mirror before configuring it (sonic-net#4089

46057ca

)" This reverts commit ad0a3d3.

yxieca added a commit that referenced this pull request Dec 14, 2025

Revert "Fetch capability of mirror before configuring it (#4089)"

d719238

This reverts commit ad0a3d3.

yxieca mentioned this pull request Dec 14, 2025

Revert "Fetch capability of mirror before configuring it" #4158

Closed

volodymyrsamotiy added the Request for 202511 Branch label Jan 14, 2026

vmittal-msft added the Approved for 202511 Branch label Jan 15, 2026

mssonicbld mentioned this pull request Jan 15, 2026

[action] [PR:4089] Fetch capability of mirror before configuring it #4204

Merged

mssonicbld added the Created PR to 202511 Branch label Jan 15, 2026

mannytaheri mentioned this pull request Jan 22, 2026

Bug:[Chassis] Port mirror direction 'both' is not supported by the ASIC sonic-net/sonic-buildimage#25162

Closed

saksarav-nokia mentioned this pull request Jan 23, 2026

Add multi-asic support for mirror capability check #4218

Closed

venu-nexthop mentioned this pull request Feb 9, 2026

Bug:ERSPAN mirror config CLI is failing sonic-net/sonic-buildimage#25399

Open

This was referenced Feb 28, 2026

Legacy 'config mirror_session add' missing direction parameter after PR #4089 #4318

Closed

Bug: everflow test fails with 'Port mirror direction both is not supported by the ASIC' sonic-net/sonic-mgmt#22661

Closed

yxieca mentioned this pull request Feb 28, 2026

Fix legacy mirror_session add failing capability check #4319

Closed

bingwang-ms mentioned this pull request Mar 2, 2026

fix: skip PORT_INGRESS/EGRESS_MIRROR_CAPABLE check for ERSPAN mirror sessions #4323

Merged

mssonicbld added Included in 202511 Branch and removed Created PR to 202511 Branch labels Mar 9, 2026

mssonicbld mentioned this pull request Mar 18, 2026

[action] [PR:4323] fix: skip PORT_INGRESS/EGRESS_MIRROR_CAPABLE check for ERSPAN mirror sessions #4368

Merged

Conversation

stephenxs commented Oct 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

How I did it

How to verify it

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Uh oh!

mssonicbld commented Oct 11, 2025

Uh oh!

azure-pipelines bot commented Oct 11, 2025

Uh oh!

mssonicbld commented Oct 11, 2025

Uh oh!

azure-pipelines bot commented Oct 11, 2025

Uh oh!

stephenxs commented Oct 13, 2025

Uh oh!

stephenxs commented Oct 13, 2025

Uh oh!

mssonicbld commented Oct 20, 2025

Uh oh!

azure-pipelines bot commented Oct 20, 2025

Uh oh!

Uh oh!

bingwang-ms commented Nov 4, 2025

Uh oh!

bingwang-ms commented Nov 4, 2025

Uh oh!

qiluo-msft Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephenxs Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephenxs Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

stephenxs commented Nov 4, 2025

Uh oh!

Uh oh!

yxieca commented Dec 14, 2025

Uh oh!

yxieca commented Dec 14, 2025

Uh oh!

stephenxs commented Dec 14, 2025

Uh oh!

yxieca commented Dec 14, 2025

Uh oh!

stephenxs commented Dec 15, 2025

Uh oh!

mssonicbld commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

stephenxs commented Oct 11, 2025 •

edited

Loading

qiluo-msft Nov 4, 2025 •

edited

Loading

qiluo-msft Nov 4, 2025 •

edited

Loading