[SNMP]: SONiC SNMP Changes to support IPv6 #1457

SuvarnaMeenakshi · 2023-09-01T22:39:29Z

Document captures the changes required to support SNMP over IPv6 for single asic platforms.

[SNMP][IPv6]: Fix SNMP IPv6 reachability issue in certain scenarios [SNMP][IPv6]: Fix SNMP IPv6 reachability issue in certain scenarios sonic-buildimage#15487
[SNMP][IPv6]: Fix to use link local IPv6 address as snmp agentAddress [SNMP][IPv6]: Fix to use link local IPv6 address as snmp agentAddress sonic-buildimage#16013
[SNMP]: Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG [SNMP]: Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG sonic-buildimage#17045

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

doc/snmp/snmp-changes-to-support-ipv6.md

venkatmahalingam · 2023-09-11T17:40:02Z

doc/snmp/snmp-changes-to-support-ipv6.md

+
+
+### Effects of this change ###
+1. By default, SNMP will listen on Management and Loopback0 IPs configured via config_db.


This new change may not work for all SONiC users, can introduce backward compatibility issues as we dont have any issue with IPv4 case.

modified to be backward compatible

venkatmahalingam · 2023-09-11T17:41:21Z

doc/snmp/snmp-changes-to-support-ipv6.md

+
+**Possible solution**
+
+Update STATE_DB with DHCP configured management IP address.


Hope you are fixing this as part of the initial pull request itself, otherwise we're breaking the working feature when the DHCP is desired for the mgmt interface.

Not required with current suggested change

zhangyanzhao · 2023-09-12T15:39:41Z

community review recording https://zoom.us/rec/share/IhwpNF2czHBDY1OeZwnKdTmnPr4gc2AmItBcRYc1HgFUJG539cPaeIsvdDMaeli3.AqXFYTMBt18iU1XQ

doc/snmp/snmp-changes-to-support-ipv6.md

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

venkatmahalingam

We should make sure that the backward compatibility issues are addressed properly before merging this HLD.

What is the motivation for this PR? Skip SNMP IPv6 related test cases in 202211,202205 and 202305 branches until the approach to fix IPv6 issue is fixed. PR contains details of the issue and approach sonic-net/SONiC#1457 How did you do it? Skip single asic IPv6 SNMP loopback test case and link local test case in branches with the testcase added. How did you verify/test it? Tested on 202205 single asic VS image

…#10097) What is the motivation for this PR? Skip SNMP IPv6 related test cases in 202211,202205 and 202305 branches until the approach to fix IPv6 issue is fixed. PR contains details of the issue and approach sonic-net/SONiC#1457 How did you do it? Skip single asic IPv6 SNMP loopback test case and link local test case in branches with the testcase added. How did you verify/test it? Tested on 202205 single asic VS image (cherry picked from commit a72a4db)

…t#10097) What is the motivation for this PR? Skip SNMP IPv6 related test cases in 202211,202205 and 202305 branches until the approach to fix IPv6 issue is fixed. PR contains details of the issue and approach sonic-net/SONiC#1457 How did you do it? Skip single asic IPv6 SNMP loopback test case and link local test case in branches with the testcase added. How did you verify/test it? Tested on 202205 single asic VS image (cherry picked from commit a72a4db)

…10238) What is the motivation for this PR? cherry pick of #10097 Skip SNMP IPv6 related test cases in 202211,202205 and 202305 branches until the approach to fix IPv6 issue is fixed. PR contains details of the issue and approach sonic-net/SONiC#1457 How did you do it? Skip single asic IPv6 SNMP loopback test case and link local test case in branches with the testcase added. How did you verify/test it? Tested on 202205 single asic VS image (cherry picked from commit a72a4db)

SuvarnaMeenakshi · 2023-10-10T20:44:13Z

@venkatmahalingam , @dgsudharsan , @qiluo-msft , thank you for reviewing.
Based on the feedback, one approach that I would like your input for is instead of modifying snmpd.conf.j2 default behavior to get the MGMT and Loopback IP, if we keep the snmpd.conf.j2 as it was and modify the minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG config table with MGMT and LOOPBACK IP in config_db.
This way, if we load a minigraph with Management and Looopback IP, that will get used and snmpd will listen on those IPs.
If we use config_db, then snmpd will listen on IPs in SNMP_AGENT_ADDRESS_CONFIG if that table is present, if not it will listen on any IP. This was the initial behavior.
Here is a diff for the proposal SuvarnaMeenakshi/sonic-buildimage@d1a9fa3

…10244) (cherry picked from commit a72a4db) What is the motivation for this PR? Skip SNMP IPv6 related test cases in 202211,202205 and 202305 branches until the approach to fix IPv6 issue is fixed. PR contains details of the issue and approach sonic-net/SONiC#1457 How did you do it? Skip single asic IPv6 SNMP loopback test case and link local test case in branches with the testcase added. How did you verify/test it? Tested on 202205 single asic VS image (cherry picked from commit a72a4db)

zhangyanzhao · 2023-10-12T04:45:01Z

@SuvarnaMeenakshi can you please add the code PRs to this HLD? Thanks.

dgsudharsan · 2023-10-25T04:46:48Z

@venkatmahalingam , @dgsudharsan , @qiluo-msft , thank you for reviewing. Based on the feedback, one approach that I would like your input for is instead of modifying snmpd.conf.j2 default behavior to get the MGMT and Loopback IP, if we keep the snmpd.conf.j2 as it was and modify the minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG config table with MGMT and LOOPBACK IP in config_db. This way, if we load a minigraph with Management and Looopback IP, that will get used and snmpd will listen on those IPs. If we use config_db, then snmpd will listen on IPs in SNMP_AGENT_ADDRESS_CONFIG if that table is present, if not it will listen on any IP. This was the initial behavior. Here is a diff for the proposal SuvarnaMeenakshi/sonic-buildimage@d1a9fa3

Hi @SuvarnaMeenakshi
If I understand, this flow will get executed only when someone calls config load minigraph. If there is an upgrade flow, this will not get executed, so backward compatibility is maintained. Similarly if someone creates config_db.json directly and performs reboot, this flow will not get triggered. Can you confirm this?

SuvarnaMeenakshi · 2023-10-25T17:59:24Z

rly if someone creates config_db.json directly and perf

@venkatmahalingam , @dgsudharsan , @qiluo-msft , thank you for reviewing. Based on the feedback, one approach that I would like your input for is instead of modifying snmpd.conf.j2 default behavior to get the MGMT and Loopback IP, if we keep the snmpd.conf.j2 as it was and modify the minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG config table with MGMT and LOOPBACK IP in config_db. This way, if we load a minigraph with Management and Looopback IP, that will get used and snmpd will listen on those IPs. If we use config_db, then snmpd will listen on IPs in SNMP_AGENT_ADDRESS_CONFIG if that table is present, if not it will listen on any IP. This was the initial behavior. Here is a diff for the proposal SuvarnaMeenakshi/sonic-buildimage@d1a9fa3

Hi @SuvarnaMeenakshi If I understand, this flow will get executed only when someone calls config load minigraph. If there is an upgrade flow, this will not get executed, so backward compatibility is maintained. Similarly if someone creates config_db.json directly and performs reboot, this flow will not get triggered. Can you confirm this?

During upgrade_flow, if the config_db.json file is present, then backward compatibility will be maintained.
Yes, if someone is using config_db.json directly and performing a reboot then this will not be triggered and snmp will listen on any IP.
Only when load_minigraph is issued this flow will be triggered and snmp will listen on loopback and mgmt IPs configured in the minigraph.xml.

venkatmahalingam · 2023-10-26T16:14:00Z

modify the minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG config table with MGMT and LOOPBACK IP in config_db.

Thanks @SuvarnaMeenakshi, this looks good.

SuvarnaMeenakshi · 2023-10-31T22:34:39Z

modify the minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG config table with MGMT and LOOPBACK IP in config_db.

Thanks @SuvarnaMeenakshi, this looks good.

@dgsudharsan @venkatmahalingam thank you, I have code PR here sonic-net/sonic-buildimage#17045

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

SuvarnaMeenakshi · 2023-11-16T23:02:33Z

@SuvarnaMeenakshi can you please add the code PRs to this HLD? Thanks.

Updated PR in the document.

modify the minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG config table with MGMT and LOOPBACK IP in config_db.

Thanks @SuvarnaMeenakshi, this looks good.

@dgsudharsan @venkatmahalingam thank you, I have code PR here sonic-net/sonic-buildimage#17045

@dgsudharsan @venkatmahalingam Please help review this document PR

SuvarnaMeenakshi · 2023-11-22T00:46:57Z

@qiluo-msft please help review and merge this.

qiluo-msft · 2023-11-28T23:45:58Z

doc/snmp/snmp-changes-to-support-ipv6.md

+## Motivation ##
+
+SNMP query over IPv6 address fails in certain scenarios on single asic platforms.
+Ideally, SNMP over IPv6 should be successful over both IPv4 and IPv6.


Could you rephase "SNMP over IPv6 should be successful over both IPv4 and IPv6"? #Closed

qiluo-msft · 2023-11-28T23:47:26Z

doc/snmp/snmp-changes-to-support-ipv6.md

+
+1. [SNMP][IPv6]: Fix SNMP IPv6 reachability issue in certain scenarios https://github.com/sonic-net/sonic-buildimage/pull/15487
+2. [SNMP][IPv6]: Fix to use link local IPv6 address as snmp agentAddress https://github.com/sonic-net/sonic-buildimage/pull/16013
+3. [SNMP]: Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG https://github.com/sonic-net/sonic-buildimage/pull/17045


Since this issue is only on single asic, why fixing multi asic in this PR? #Closed

Yes, only on single-asic, not fixing for multi-asic in this PR.

Rephrase incorrect statement in motivation section. Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

qiluo-msft

LGTM, please also check with other reviewers.

SuvarnaMeenakshi · 2023-12-05T00:49:52Z

@qiluo-msft can you help merge this PR?
We have approval from Dell team.

…able (#17045) #### Why I did it SNMP query over IPv6 does not work due to issue in net-snmp where IPv6 query does not work on multi-nic environment. To get around this, if snmpd listens on specific ipv4 or ipv6 address, then the issue is not seen. We plan to configure Management IP and Loopback IP configured in minigraph.xml as SNMP_AGENT_ADDRESS in config_db., based on changes discussed in sonic-net/SONiC#1457. ##### Work item tracking - Microsoft ADO **(number only)**:26091228 #### How I did it Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG with management and Loopback0 IP addresses. Modify snmpd.conf.j2 to use SNMP_AGENT_ADDRESS_CONFIG table if it is present in config_db, if not listen on any IP. Main change: 1. if minigraph.xml is used to configure the device, then snmpd will listen on mgmt and loopback IP addresses, 2. if config_db is used to configure the device, snmpd will listen IP present in SNMP_AGENT_ADDRESS_CONFIG if that table is present, if table is not present snmpd will listen on any IP. #### How to verify it config_db.json created from minigraph.xml for single asic VS image with mgmt and Loopback IP addresses. ``` "SNMP_AGENT_ADDRESS_CONFIG": { "10.1.0.32|161|": {}, "10.250.0.101|161|": {}, "FC00:1::32|161|": {}, "fec0::ffff:afa:1|161|": {} }, ..... snmpd listening on the above IP addresses: admin@vlab-01:~$ sudo netstat -tulnp | grep 161 tcp 0 0 127.0.0.1:3161 0.0.0.0:* LISTEN 71522/snmpd udp 0 0 10.250.0.101:161 0.0.0.0:* 71522/snmpd udp 0 0 10.1.0.32:161 0.0.0.0:* 71522/snmpd udp6 0 0 fec0::ffff:afa:1:161 :::* 71522/snmpd udp6 0 0 fc00:1::32:161 :::* 71522/snmpd ```

SuvarnaMeenakshi · 2023-12-06T21:30:23Z

@dgsudharsan can you approve the doc PR

SuvarnaMeenakshi · 2023-12-07T17:32:21Z

@dgsudharsan can you approve the doc PR

Merging the PR based on discussion in the PR, thanks.

…able (sonic-net#17045) #### Why I did it SNMP query over IPv6 does not work due to issue in net-snmp where IPv6 query does not work on multi-nic environment. To get around this, if snmpd listens on specific ipv4 or ipv6 address, then the issue is not seen. We plan to configure Management IP and Loopback IP configured in minigraph.xml as SNMP_AGENT_ADDRESS in config_db., based on changes discussed in sonic-net/SONiC#1457. ##### Work item tracking - Microsoft ADO **(number only)**:26091228 #### How I did it Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG with management and Loopback0 IP addresses. Modify snmpd.conf.j2 to use SNMP_AGENT_ADDRESS_CONFIG table if it is present in config_db, if not listen on any IP. Main change: 1. if minigraph.xml is used to configure the device, then snmpd will listen on mgmt and loopback IP addresses, 2. if config_db is used to configure the device, snmpd will listen IP present in SNMP_AGENT_ADDRESS_CONFIG if that table is present, if table is not present snmpd will listen on any IP. #### How to verify it config_db.json created from minigraph.xml for single asic VS image with mgmt and Loopback IP addresses. ``` "SNMP_AGENT_ADDRESS_CONFIG": { "10.1.0.32|161|": {}, "10.250.0.101|161|": {}, "FC00:1::32|161|": {}, "fec0::ffff:afa:1|161|": {} }, ..... snmpd listening on the above IP addresses: admin@vlab-01:~$ sudo netstat -tulnp | grep 161 tcp 0 0 127.0.0.1:3161 0.0.0.0:* LISTEN 71522/snmpd udp 0 0 10.250.0.101:161 0.0.0.0:* 71522/snmpd udp 0 0 10.1.0.32:161 0.0.0.0:* 71522/snmpd udp6 0 0 fec0::ffff:afa:1:161 :::* 71522/snmpd udp6 0 0 fc00:1::32:161 :::* 71522/snmpd ```

…able (#17045) #### Why I did it SNMP query over IPv6 does not work due to issue in net-snmp where IPv6 query does not work on multi-nic environment. To get around this, if snmpd listens on specific ipv4 or ipv6 address, then the issue is not seen. We plan to configure Management IP and Loopback IP configured in minigraph.xml as SNMP_AGENT_ADDRESS in config_db., based on changes discussed in sonic-net/SONiC#1457. ##### Work item tracking - Microsoft ADO **(number only)**:26091228 #### How I did it Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG with management and Loopback0 IP addresses. Modify snmpd.conf.j2 to use SNMP_AGENT_ADDRESS_CONFIG table if it is present in config_db, if not listen on any IP. Main change: 1. if minigraph.xml is used to configure the device, then snmpd will listen on mgmt and loopback IP addresses, 2. if config_db is used to configure the device, snmpd will listen IP present in SNMP_AGENT_ADDRESS_CONFIG if that table is present, if table is not present snmpd will listen on any IP. #### How to verify it config_db.json created from minigraph.xml for single asic VS image with mgmt and Loopback IP addresses. ``` "SNMP_AGENT_ADDRESS_CONFIG": { "10.1.0.32|161|": {}, "10.250.0.101|161|": {}, "FC00:1::32|161|": {}, "fec0::ffff:afa:1|161|": {} }, ..... snmpd listening on the above IP addresses: admin@vlab-01:~$ sudo netstat -tulnp | grep 161 tcp 0 0 127.0.0.1:3161 0.0.0.0:* LISTEN 71522/snmpd udp 0 0 10.250.0.101:161 0.0.0.0:* 71522/snmpd udp 0 0 10.1.0.32:161 0.0.0.0:* 71522/snmpd udp6 0 0 fec0::ffff:afa:1:161 :::* 71522/snmpd udp6 0 0 fc00:1::32:161 :::* 71522/snmpd ```

zhangyanzhao · 2024-02-05T09:02:29Z

back ported to previous releases as well

skg-net · 2024-02-06T00:38:25Z

@SuvarnaMeenakshi Can you please update the Quality Metric (Alpha/Beta/GA) for the feature either in this PR comments or in HLD itself based on https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20feature%20quality%20definition.md
Thanks

SuvarnaMeenakshi · 2024-02-07T18:03:00Z

@SuvarnaMeenakshi Can you please update the Quality Metric (Alpha/Beta/GA) for the feature either in this PR comments or in HLD itself based on https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20feature%20quality%20definition.md Thanks

Sure, will check the quality metric and add the required details. Is this a new additional requirement for new features or changes?

[SNMP]: SONiC SNMP Changes to support IPv6

7d05687

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

SuvarnaMeenakshi requested review from qiluo-msft and dgsudharsan September 1, 2023 22:39

venkatmahalingam reviewed Sep 11, 2023

View reviewed changes

doc/snmp/snmp-changes-to-support-ipv6.md Outdated Show resolved Hide resolved

venkatmahalingam reviewed Sep 11, 2023

View reviewed changes

doc/snmp/snmp-changes-to-support-ipv6.md Outdated Show resolved Hide resolved

venkatmahalingam reviewed Sep 11, 2023

View reviewed changes

doc/snmp/snmp-changes-to-support-ipv6.md Show resolved Hide resolved

venkatmahalingam reviewed Sep 11, 2023

View reviewed changes

lguohan reviewed Sep 12, 2023

View reviewed changes

doc/snmp/snmp-changes-to-support-ipv6.md Outdated Show resolved Hide resolved

Minor typo fix.

4570e84

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

venkatmahalingam suggested changes Sep 13, 2023

View reviewed changes

This was referenced Sep 21, 2023

Skip SNMP IPv6 testcases in 2022xx 2023xx branches sonic-net/sonic-mgmt#10097

Merged

SNMP query over IPv6 does not work sonic-net/sonic-buildimage#6108

Open

SuvarnaMeenakshi mentioned this pull request Oct 6, 2023

[202305] Skip SNMP IPv6 testcases in 2022xx 2023xx branches sonic-net/sonic-mgmt#10238

Merged

6 tasks

SuvarnaMeenakshi mentioned this pull request Oct 6, 2023

[202205] Skip SNMP IPv6 testcases in 2022xx 2023xx branches (#10097) sonic-net/sonic-mgmt#10244

Merged

6 tasks

SuvarnaMeenakshi mentioned this pull request Oct 31, 2023

[SNMP]: Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG sonic-net/sonic-buildimage#17045

Merged

11 tasks

Update document based on latest accepted code changes.

e591dbb

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

venkatmahalingam approved these changes Nov 20, 2023

View reviewed changes

qiluo-msft reviewed Nov 28, 2023

View reviewed changes

Fix as per review comment.

f2c8755

Rephrase incorrect statement in motivation section. Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>

qiluo-msft approved these changes Dec 2, 2023

View reviewed changes

SuvarnaMeenakshi merged commit fb78b2a into sonic-net:master Dec 7, 2023
1 check passed

mssonicbld mentioned this pull request Feb 2, 2024

[action] [PR:17045] [SNMP]: Modify minigraph parser to update SNMP_AGENT_ADDRESS_CONFIG table (#17045) sonic-net/sonic-buildimage#17986

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SNMP]: SONiC SNMP Changes to support IPv6 #1457

[SNMP]: SONiC SNMP Changes to support IPv6 #1457

SuvarnaMeenakshi commented Sep 1, 2023 •

edited

Loading

venkatmahalingam Sep 11, 2023

SuvarnaMeenakshi Nov 16, 2023

venkatmahalingam Sep 11, 2023

SuvarnaMeenakshi Nov 16, 2023

zhangyanzhao commented Sep 12, 2023

venkatmahalingam left a comment

SuvarnaMeenakshi commented Oct 10, 2023 •

edited

Loading

zhangyanzhao commented Oct 12, 2023

dgsudharsan commented Oct 25, 2023

SuvarnaMeenakshi commented Oct 25, 2023

venkatmahalingam commented Oct 26, 2023

SuvarnaMeenakshi commented Oct 31, 2023

SuvarnaMeenakshi commented Nov 16, 2023

SuvarnaMeenakshi commented Nov 22, 2023

qiluo-msft Nov 28, 2023 •

edited

Loading

qiluo-msft Nov 28, 2023 •

edited

Loading

SuvarnaMeenakshi Nov 29, 2023

qiluo-msft left a comment

SuvarnaMeenakshi commented Dec 5, 2023

SuvarnaMeenakshi commented Dec 6, 2023

SuvarnaMeenakshi commented Dec 7, 2023

zhangyanzhao commented Feb 5, 2024

skg-net commented Feb 6, 2024

SuvarnaMeenakshi commented Feb 7, 2024



		### Effects of this change ###
		1. By default, SNMP will listen on Management and Loopback0 IPs configured via config_db.


		Possible solution

		Update STATE_DB with DHCP configured management IP address.

[SNMP]: SONiC SNMP Changes to support IPv6 #1457

[SNMP]: SONiC SNMP Changes to support IPv6 #1457

Conversation

SuvarnaMeenakshi commented Sep 1, 2023 • edited Loading

venkatmahalingam Sep 11, 2023

Choose a reason for hiding this comment

SuvarnaMeenakshi Nov 16, 2023

Choose a reason for hiding this comment

venkatmahalingam Sep 11, 2023

Choose a reason for hiding this comment

SuvarnaMeenakshi Nov 16, 2023

Choose a reason for hiding this comment

zhangyanzhao commented Sep 12, 2023

venkatmahalingam left a comment

Choose a reason for hiding this comment

SuvarnaMeenakshi commented Oct 10, 2023 • edited Loading

zhangyanzhao commented Oct 12, 2023

dgsudharsan commented Oct 25, 2023

SuvarnaMeenakshi commented Oct 25, 2023

venkatmahalingam commented Oct 26, 2023

SuvarnaMeenakshi commented Oct 31, 2023

SuvarnaMeenakshi commented Nov 16, 2023

SuvarnaMeenakshi commented Nov 22, 2023

qiluo-msft Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

qiluo-msft Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

SuvarnaMeenakshi Nov 29, 2023

Choose a reason for hiding this comment

qiluo-msft left a comment

Choose a reason for hiding this comment

SuvarnaMeenakshi commented Dec 5, 2023

SuvarnaMeenakshi commented Dec 6, 2023

SuvarnaMeenakshi commented Dec 7, 2023

zhangyanzhao commented Feb 5, 2024

skg-net commented Feb 6, 2024

SuvarnaMeenakshi commented Feb 7, 2024

SuvarnaMeenakshi commented Sep 1, 2023 •

edited

Loading

SuvarnaMeenakshi commented Oct 10, 2023 •

edited

Loading

qiluo-msft Nov 28, 2023 •

edited

Loading

qiluo-msft Nov 28, 2023 •

edited

Loading