Sonic Netconf Server Proposal by aseaudi · Pull Request #1466 · sonic-net/SONiC

aseaudi · 2023-09-09T06:38:41Z

This PR is for an update in the Sonic Management Framework to add an RFC Compliant Netconf Server, which reuses the Translib and the yang models that are already part of the management framework.

The updated management framework HLD that includes the Netconf Server is under /doc/mgmt/Management Framework.md

a-barboza · 2023-09-14T01:07:04Z

I believe there is another proposal going on for NetCONF server support in SONiC:

#1428

ebiken-ntt · 2023-09-14T02:54:10Z

I believe there is another proposal going on for NetCONF server support in SONiC:
#1428

Yes. We have discussed our (NTT's) NETCONF HLD #1428 in today's SONiC UMF working group meeting.
You can find the recording here: https://github.com/sonic-net/SONiC/wiki/Working-Group-and-Weekly-Meeting-Recordings-Links

We would also like @aseaudi to share this #1466 proposal to the UMF WG community. (Ritu or someone from the WG should contact you to join the WG meeting)

zhangyanzhao · 2023-09-28T17:38:02Z

BRCM registered as reviewer.
SONiC community review recording https://zoom.us/rec/share/aweG3ImuMEJXmjU3m4d5DjE3mRGV_cWzLFJtzGvfq_ZxsMAJ9KNqVPgRw45GZDgE.17WdOQVPU5MnopRz

jeff-yin · 2023-09-28T17:51:31Z

@zhangyanzhao please add @prvattem, @rathnasabapathyv, @mhampasagar, @joyas-joseph as reviewers from Dell.

adyeung · 2023-09-28T21:18:40Z

Adding @anand-kumar-subramanian @a-barboza @mbalachandar @sachinholla @faraazbrcm to review and share comments

zhangyanzhao · 2023-10-06T23:20:23Z

@zhangyanzhao please add @prvattem, @rathnasabapathyv, @mhampasagar, @joyas-joseph as reviewers from Dell.

added except mhampassagar who needs to accept the invitation to become a reviewer.

zhangyanzhao · 2023-10-06T23:23:02Z

sachinholla

invitation is sent out, will add them after accepting the invitation

kwangsuk · 2023-10-11T20:01:10Z

Can you please add the NETCONF server capabilities supported by the proposal?

anand-kumar-subramanian

Need more information on the Netconf server similar to the sections 3.2.2.5 gNMI server and 4.4 gNMI flow.

anand-kumar-subramanian · 2023-10-11T19:56:55Z

doc/mgmt/Management Framework.md

    3. Industry-standard CLI / Cisco like CLI
-
-* Must provide support for [OpenAPI spec](http://spec.openapis.org/oas/v3.0.3) to generate REST server side code
+* Must provide support for [OpenAPI spec](http://spec.openapis.org/oas/v3.0.3) to generate REST server side code and NETCONF server side code


Is OpenAPI spec going to be used to generate NETCONF server side code?

it should be REST only, we removed NETCONF part

zhangyanzhao · 2023-10-13T00:06:08Z

@aseaudi can you please help to add the code PRs to this HLD by referring to #806 ? Thanks.

aseaudi · 2023-10-13T07:44:16Z

@kwangsuk

Can you please add the NETCONF server capabilities supported by the proposal?

Done

aseaudi · 2023-10-13T08:17:22Z

resolves #1498

zhangyanzhao · 2024-02-05T09:10:16Z

@aseaudi can you please help to add the code PRs by referring to #806 ? Thanks.

zhangyanzhao · 2024-05-06T02:38:34Z

code PR is not ready, move to backlog for future release

hussamsh · 2025-06-11T17:43:03Z

Hello @zhangyanzhao ,

The code PR is ready here, can you please move forward with this HLD PR and the code PR for 202511 release ?

I also sent an email to Anil regarding the same request.

chenkelly · 2025-06-19T08:37:06Z

doc/mgmt/Management Framework.md

+
+###### 3.2.2.11.14 API Documentation
+
+NETCONF server will provide all schemas, check section 3.2.2.11.8.3.


We couldn’t find this section 3.2.2.11.8.3. Could you kindly confirm if it’s missing or located elsewhere?

@chenkelly corrected the section number

chenkelly · 2025-06-19T08:57:52Z

doc/mgmt/Management Framework.md

 25. Write lock acquired in Step 3 is released.
 26. Final response is returned from the Translib infra to REST/GNMI.

+### 4.3 NETCONF <get> flow


The section should be 4.6. A flow diagram might also be helpful to illustrate these steps more clearly.

@chenkelly section updated to 4.6

mssonicbld · 2025-06-19T09:41:44Z

/azp run

azure-pipelines · 2025-06-19T09:41:50Z

No pipelines are associated with this pull request.

mssonicbld · 2025-06-19T09:52:49Z

/azp run

azure-pipelines · 2025-06-19T09:52:55Z

No pipelines are associated with this pull request.

sugisono-omw · 2025-07-02T07:31:38Z

doc/mgmt/Management Framework.md

+
+###### 3.2.2.11.5 Concurrency
+
+REST server will accept concurrent requests. Translib provides appropriate locking mechanism - parallel reads and sequential writes.


"REST Server" looks like a typo for "NETCONF server".

it is corrected now

sugisono-omw · 2025-07-02T07:38:49Z

doc/mgmt/Management Framework.md

+* TACACS authenticaation.
+* No authentication
+
+Details are in [SONiC RBAC HLD](https://github.com/project-arlo/SONiC/blob/master/doc/aaa/SONiC%20RBAC%20HLD.md).


The link for the reference document on "SONiC RBAC HLD" appears to be obsolete.
I assume the following document is the one the link points to.
Is my guess correct?
https://github.com/project-arlo/SONiC/blob/dell_sonic_share/doc/mgmt/SONiC_HAMD_RBAC_HLD.md

it is now updated , thanks

mssonicbld · 2025-07-02T21:31:05Z

/azp run

azure-pipelines · 2025-07-02T21:31:12Z

No pipelines are associated with this pull request.

sugisono-omw · 2025-07-07T00:57:08Z

doc/mgmt/Management Framework.md

+
+NETCONF server will Support Netconf 1.1.
+
+###### 3.2.2.11.8 NETCONF Discovery


If no sections were skipped, the section number is 3.2.2.11.7 instead of 3.2.2.11.8.

@sugisono-omw it is corrected now, thanks

sugisono-omw · 2025-07-07T00:58:47Z

doc/mgmt/Management Framework.md

+
+The NETCONF server will reply back with error in several situations, to be defined ...
+
+###### 3.2.2.4.13 DB Schema


"3.2.2.4.13" seems to be a typo for "3.2.2.11.13".

@sugisono-omw it is corrected now, thanks

mssonicbld · 2025-09-05T19:39:10Z

/azp run

azure-pipelines · 2025-09-05T19:39:16Z

No pipelines are associated with this pull request.

aseaudi added 2 commits August 3, 2023 13:46

netconf changes

ee257c6

Merge branch 'sonic-net:master' into netconf

7ecbedb

zhangyanzhao requested a review from adyeung September 28, 2023 17:36

zhangyanzhao requested a review from jeff-yin September 28, 2023 17:45

jeff-yin requested a review from kwangsuk September 28, 2023 17:46

zhangyanzhao requested review from kwangsuk and removed request for kwangsuk September 28, 2023 17:49

adyeung requested a review from anand-kumar-subramanian September 28, 2023 21:19

zhangyanzhao requested review from joyas-joseph, prvattem and rathnasabapathyv October 6, 2023 23:17

aseaudi added 2 commits October 11, 2023 22:01

update picture

e5c3d8a

correction

c50945b

anand-kumar-subramanian reviewed Oct 11, 2023

View reviewed changes

corrections

c0487aa

aseaudi added 2 commits October 13, 2023 10:35

updates

7a2cbba

updates

874c710

hussamsh mentioned this pull request Apr 29, 2024

Initial NETCONF server sonic-net/sonic-netconf-server#2

Merged

hussamsh mentioned this pull request Jul 5, 2024

Add netconf docker to build-image sonic-net/sonic-buildimage#19492

Open

chenkelly reviewed Jun 19, 2025

View reviewed changes

Update Management Framework.md

ebff015

Update Management Framework.md

d071255

sugisono-omw reviewed Jul 2, 2025

View reviewed changes

Update Management Framework.md

ee1afef

sugisono-omw reviewed Jul 7, 2025

View reviewed changes

Update Management Framework.md

6b5a7e3


		###### 3.2.2.11.14 API Documentation

		NETCONF server will provide all schemas, check section 3.2.2.11.8.3.


		###### 3.2.2.11.5 Concurrency

		REST server will accept concurrent requests. Translib provides appropriate locking mechanism - parallel reads and sequential writes.


		NETCONF server will Support Netconf 1.1.

		###### 3.2.2.11.8 NETCONF Discovery


		The NETCONF server will reply back with error in several situations, to be defined ...

		###### 3.2.2.4.13 DB Schema

Conversation

aseaudi commented Sep 9, 2023

Uh oh!

a-barboza commented Sep 14, 2023

Uh oh!

ebiken-ntt commented Sep 14, 2023

Uh oh!

zhangyanzhao commented Sep 28, 2023

Uh oh!

jeff-yin commented Sep 28, 2023

Uh oh!

adyeung commented Sep 28, 2023

Uh oh!

zhangyanzhao commented Oct 6, 2023

Uh oh!

zhangyanzhao commented Oct 6, 2023

Uh oh!

kwangsuk commented Oct 11, 2023

Uh oh!

anand-kumar-subramanian left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhangyanzhao commented Oct 13, 2023

Uh oh!

aseaudi commented Oct 13, 2023

Uh oh!

aseaudi commented Oct 13, 2023

Uh oh!

zhangyanzhao commented Feb 5, 2024

Uh oh!

zhangyanzhao commented May 6, 2024

Uh oh!

hussamsh commented Jun 11, 2025

Uh oh!

chenkelly Jun 19, 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!

Choose a reason for hiding this comment

Uh oh!

chenkelly Jun 19, 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!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Jun 19, 2025

Uh oh!

azure-pipelines bot commented Jun 19, 2025

Uh oh!

mssonicbld commented Jun 19, 2025

Uh oh!

azure-pipelines bot commented Jun 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Jul 2, 2025

Uh oh!

azure-pipelines bot commented Jul 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Sep 5, 2025

Uh oh!

chenkelly Jun 19, 2025 •

edited

Loading

chenkelly Jun 19, 2025 •

edited

Loading