Showing results for 
Search instead for 
Did you mean: 
Cisco Employee

YANG Suite and IOS XE - enabling NETCONF

Now that YANG Suite is installed and running, lets understand a bit more about what is required on the device side. In this case the device is Catalyst 9300 but could be any of the switching, routing, or wireless devices running IOS XE that support NETCONF-YANG. Since version 16.6 of IOS XE the NETCONF-YANG API is supported, and this support continues with the 17.x releases.


The CLI's required to enable the NETCONF-YANG API are below. If you already have a local user created, like in most cases, you will not need to crate a dedicated "netconf" user like below and instead use your existing user or admin login account.


aaa new-model
aaa authentication login default local
aaa authorization exec default local
username netconf privilege 15 password 0 netconf

Screen Shot 2021-02-11 at 4.31.17 PM.png


There are several ways to validate that the API is operational. Show commands 

C9300-24UX#show netconf-yang status
netconf-yang: enabled
netconf-yang ssh port: 830
netconf-yang candidate-datastore: disabled

Screen Shot 2021-02-11 at 4.29.40 PM.png


Another simple way to validate the API is by connecting to the NETCONF interface with a SSH client, using the NETCONF session type. Once connected you will see the capabilities exchange - a list of all supported YANG modules.

ssh -p 830 netconf@<IOS XE IP address> -s netconf

Screen Shot 2021-02-11 at 4.29.10 PM.png


The XE device is now ready for use with YANG Suite. Full details of the NETCONF interface can be found in the Programmability Configuration Guide



Content for Community-Ad