https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/NETCONF-28 netconf <p>When connecting a to a Juniper EX-2200 device using the netconf connector, it reports a non RFC compliant candidate capability in the hello message:</p> <p>&lt;hello&gt;<br/> &lt;capabilities&gt;<br/> &lt;capability&gt;urn:ietf:params:xml:ns:netconf:base:1.0&lt;/capability&gt;<br/> &lt;capability&gt;urn:ietf:params:xml:ns:netconf:capability:candidate:1.0&lt;/capability&gt; <br/> &lt;capability&gt;urn:ietf:params:xml:ns:netconf:capability:confirmed-commit:1.0&lt;/capability&gt; <br/> &lt;capability&gt;urn:ietf:params:xml:ns:netconf:capability:validate:1.0&lt;/capability&gt; <br/> &lt;capability&gt;urn:ietf:params:xml:ns:netconf:capability:url:1.0?protocol=http,ftp,file&lt;/capability&gt; <br/> &lt;capability&gt;<a href="http://xml.juniper.net/netconf/junos/1.0" class="external-link" target="_blank" rel="nofollow noopener">http://xml.juniper.net/netconf/junos/1.0</a>&lt;/capability&gt;<br/> &lt;capability&gt;<a href="http://xml.juniper.net/dmi/system/1.0" class="external-link" target="_blank" rel="nofollow noopener">http://xml.juniper.net/dmi/system/1.0</a>&lt;/capability&gt;<br/> &lt;/capabilities&gt;<br/> &lt;session-id&gt;63940&lt;/session-id&gt;<br/> &lt;/hello&gt;</p> <p>The Juniper reports: urn:ietf:params:xml:ns:netconf:capability:candidate:1.0 </p> <p>While it should be: urn:ietf:params:netconf:capability:candidate:1.0</p> <p>When executing a change using a restconf call, ODL tries to change using the writable-runnning approach, because it does not detect the candidate capability. This is not supported by Juniper, and the request fails.</p> <p>Attached is a log file, which shows the request, starting from line 2657.</p> <p>It would be very helpful if ODL has a feature which allows more flexible checking for the candidate capability, or a fallback method for accepting the specific 'Juniper-style' candidate capability.</p> <p>The same issue might apply for the confirmed-commit capability, but I am unable to check this yet.</p> <p>Operating System: All<br/> Platform: All</p> NETCONF-28

Netconf candidate capability non RFC compliant fallback

Improvement Resolved Won't Do Ivan Hrasko Erik Ruiter pt Mon, 8 Jun 2015 14:06:28 +0000 Wed, 18 Jan 2023 15:03:38 +0000 Wed, 18 Jan 2023 15:02:35 +0000 4.0.6 5.0.1 netconf 0 5 <p>Attachment karaf.log has been added with description: karaf log having netconf connect trace enabled</p> <p>Hi Erik,</p> <p>Continuing our discussion here:</p> <p>Yes, the Juniper capability is in different format than expected in ODL or stated in RFC. </p> <p>We could introduce a fallback into netconf connector to check for the juniper version of candidate capability string, or make it less strict when looking for candidate capability (maybe checking only for substring "netconf:capability:candidate:1.0").</p> <p>The fix is pretty easy, we just need to modify class:<br/> controller/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/listener/NetconfSessionPreferences.java ... there's a method called isCandidateSupported().</p> <p>If you feel like modifying the class yourself, feel free to take this bug and submit a patch. It would be great if you could do that, since you can also test the fix against the Juniper device.</p> <p>If not, let us know and we will take care of this.</p> <p>Maros</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/22265/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/22265/</a></p> <p>This works, the candidate config is now locked instead of the running config.<br/> And various other netconf requests are performed.<br/> However the restconf call still does not work. Shall I create a new bug report?</p> <p>Hi Erik, thanks for the commit. </p> <p>We can discuss the failure here and maybe open another bug later.<br/> So whats the failure now ? Can you provide more information ?</p> <p>Attachment karaf_after_applied_patch.log has been added with description: karaf log after applied patch</p> <p>I am trying to excute a restconf call to cahnge the host-name of the device.<br/> The call is:</p> <p>curl -X POST --data "&lt;system xmlns='http://xml.juniper.net/xnm/1.1/xnm'&gt;&lt;host-name&gt;newswitch&lt;/host-name&gt;&lt;/system&gt;" <a href="http://admin:admin@localhost:8181/restconf/config/opendaylight-inventory:nodes/node/sw-opennaas-1/yang-ext:mount/configuration:configuration" class="external-link" target="_blank" rel="nofollow noopener">http://admin:admin@localhost:8181/restconf/config/opendaylight-inventory:nodes/node/sw-opennaas-1/yang-ext:mount/configuration:configuration</a> -H "Accept: application/xml" -H "Content-Type: application/xml" -v</p> <p>When viewing the logs, I see that ODL successfully locks the candidate config and performs some &lt;get-config&gt; actions on the 'system' tree of the configuration.<br/> However after this the lock is released, and the config wasn't adjusted.<br/> Please find the log attached, the call starts at line 3151.</p> <p>the REST call produces the following body:</p> <p>&lt;errors xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf"&gt;<br/> &lt;error&gt;<br/> &lt;error-type&gt;protocol&lt;/error-type&gt;<br/> &lt;error-tag&gt;data-exists&lt;/error-tag&gt;<br/> &lt;error-message&gt;Data already exists for path: /(<a href="http://xml.juniper.net/xnm/1.1/xnm?revision=1970-01-01)configuration/system" class="external-link" target="_blank" rel="nofollow noopener">http://xml.juniper.net/xnm/1.1/xnm?revision=1970-01-01)configuration/system</a>&lt;/error-message&gt;<br/> &lt;/error&gt;<br/> &lt;/errors&gt;</p> <p>Does this mean that I am using a wrong URL for accesing the system subtree?</p> <p>I also tried to delete the host-name from the configuration, so that I am sure there was not host-name element in the configuration, but this did not help.</p> <p>Hi Erik, </p> <p>So its just restconf telling you the data exists and cannot be created again. POST method was recently changed from performing merge operation to create operation, whch fails when data is already present. The error is expected now. You can try using PUT (replace) instead with the same data, but dont forget to update the URL by adding the system element to it. The URL for PUT should probably look like this:</p> <p><a href="http://admin:admin@localhost:8181/restconf/config/opendaylight-inventory:nodes/node/sw-opennaas-1/yang-ext:mount/configuration:configuration/configuration:system" class="external-link" target="_blank" rel="nofollow noopener">http://admin:admin@localhost:8181/restconf/config/opendaylight-inventory:nodes/node/sw-opennaas-1/yang-ext:mount/configuration:configuration/configuration:system</a></p> <p>Maros</p> <p>Attachment karaf_put_log.txt has been added with description: karaf put log</p> <p>Hi Maros,</p> <p>I tried the PUT, using:</p> <p>curl -X PUT --data "&lt;system xmlns='http://xml.juniper.net/xnm/1.1/xnm'&gt;&lt;host-name&gt;newswitch&lt;/host-name&gt;&lt;/system&gt;" <a href="http://admin:admin@localhost:8181/restconf/config/opendaylight-inventory:nodes/node/sw-opennaas-1/yang-ext:mount/configuration:configuration/configuration:system" class="external-link" target="_blank" rel="nofollow noopener">http://admin:admin@localhost:8181/restconf/config/opendaylight-inventory:nodes/node/sw-opennaas-1/yang-ext:mount/configuration:configuration/configuration:system</a> -H "Accept: application/xml" -H "Content-Type: application/xml" -v</p> <p>As a response I get a error 500.</p> <p>In the logs I do see a edit-config request, but it does not list the host-name element, for some reason it is not added.</p> <p>&lt;edit-config&gt;<br/> &lt;target&gt;<br/> &lt;candidate/&gt;<br/> &lt;/target&gt;<br/> &lt;config&gt;<br/> &lt;configuration xmlns="http://xml.juniper.net/xnm/1.1/xnm"/&gt;<br/> &lt;/config&gt;<br/> &lt;/edit-config&gt;</p> <p>Please find the output attached in the karaf_put_log file</p> <p>Hi Erik,</p> <p>The request with empty configuration is expected, it is RESTCONF trying to ensure parent structure performing a "merge edit-config rpc" with empty configuration container. After that a real edit should follow. But your device has a problem with the empty configuration container:</p> <p>&lt;error-message&gt;syntax error, expecting &lt;configuration&gt;&lt;/error-message&gt;</p> <p>I believe this is the same issue that you faced some time ago(&lt;configuration/&gt; vs &lt;configuration&gt;&lt;/configuration&gt;) and moving to Lithium should have helped with that (With Helium this was failing when get-config requests were invoked trying to find out if the parent structure exists). Now the get-configs + optional edits are replaced with a single edit (the one that fails for you now). But it looks like we were not successful in avoiding the issue and right now we have 3 options:</p> <ul class="alternate" type="square"> <li>Make Restconf ensure parents optional</li> <li>Make Restconf ignore (with warning) the error when ensuring parents and try to edit the real data anyway</li> <li>Make Netconf serialize empty elements this way: &lt;configuration&gt;&lt;/configuration&gt; instead of this &lt;configuration/&gt; (possibly optional setting)</li> <li>Fix your device - highly unlikely</li> </ul> <p>I ll try to discuss the best option here with other ODL devs and make it into Lithium asap.</p> <p>Maros</p> <p>Property to change the output to html(no self-closing tags) is<br/> ThreadLocalTransformers.getPrettyTransformer().setOutputProperty(OutputKeys.METHOD, "html");<br/> Tested, and output was: <br/> &lt;hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"&gt;&lt;/hello&gt;<br/> instead of <br/> &lt;hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"/&gt;</p> <p>In RFC specifications are used self-closing tags when possible, <br/> so this seems be default but some option should be introduced.</p> <p>Part of code where html property we set in netconf(netconf-subsystem) in NetconfMessageToXMLEncoder.java (line 56) to test it:<br/> StreamResult result = new StreamResult(new org.opendaylight.controller.netconf.nettyutil.handler.BufferedWriter(new OutputStreamWriter(os)));<br/> DOMSource source = new DOMSource(msg.getDocument());<br/> ThreadLocalTransformers.getPrettyTransformer().setOutputProperty(OutputKeys.METHOD, "html");<br/> ThreadLocalTransformers.getPrettyTransformer().transform(source, result);</p> <p>So it's possible to compile netconf with this change without tests and check if this doesn't cause any other error.</p> <p>Hi Erik,</p> <p>Could you test the html output method with your device ? It removes the self closing tags but also removes the xml declaration and formatting from the output so we are not sure if that wont break something else.</p> <p>Hi,</p> <p>I tried the parsing option, and it gave some mixed results.</p> <p>For reading configurations, for the &lt;source&gt; tag the Juniper device only accepts the short form:<br/> &lt;candidate/&gt; or &lt;running/&gt;<br/> If you send &lt;candidate&gt;&lt;/candidate&gt; or &lt;running&gt;&lt;/running&gt;<br/> It will fail.<br/> So the proposed fix will break this.</p> <p>For &lt;edit-config&gt;, apparently the Juniper then does not care about the formatting of the candidate/running tag.<br/> The change does help, and the logs show that indeed the candidate config is adjusted and committed.<br/> But the result is not reflected on the switch, the hostname stays the same. This might be due to some other issue, since I have the same problem, when manually sending RPC's through 'ssh -s netconf'. </p> <p>Anyway, before I provide any details, I just found out that Juniper announced a new Junos release, which introduces RFC-compliant NETCONF as a new feature.<br/> Also see: <a href="http://pathfinder.juniper.net/feature-explorer/feature-info.html?fKey=6855&amp;fn=Enforcing+RFC-compliant+behavior+in+NETCONF+sessions" class="external-link" target="_blank" rel="nofollow noopener">http://pathfinder.juniper.net/feature-explorer/feature-info.html?fKey=6855&amp;fn=Enforcing+RFC-compliant+behavior+in+NETCONF+sessions</a></p> <p>So I am trying to obtain this version, and will let you know if this solves the problems.</p> <p>Move to NETCONFI project.</p> <p>We will need to port the fix for less strict candidate capability checking to Netconf repo.</p> <p>As for the other issue, please open a new bug if new Junos doesnt fix your issues.</p> <p>I consider accepting:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>urn:ietf:params:xml:ns:netconf:capability:candidate:1.0 </pre> </div></div> <p>as a valid capability be a breakage of the <a href="https://www.rfc-editor.org/rfc/rfc6241#section-8" class="external-link" target="_blank" rel="nofollow noopener">protocol</a> because:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>The shorthand form MUST NOT be used inside the protocol.</pre> </div></div> <p> </p> <p>In addition, Junos device now supports correct namespaces: <a href="https://www.juniper.net/documentation/us/en/software/junos/netconf/topics/concept/netconf-session-rfc-compliant.html" class="external-link" target="_blank" rel="nofollow noopener">https://www.juniper.net/documentation/us/en/software/junos/netconf/topics/concept/netconf-session-rfc-compliant.html</a>.</p> <p>We have successfully tested <a href="https://github.com/Juniper/yang/tree/master/22.3/22.3R1" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/Juniper/yang/tree/master/22.3/22.3R1</a> models with netconf testool and device is connected.</p> <p>Finally, the requirement to shorthand namespace is invalid according to RFC, Junos models are valid and is has been proven they can be used with ODL, and Junos device has recently added settings to operate in compatible manner.</p> <p>Thus, closing this issue.</p> Development External issue ID 3626 External issue URL Issue Type ODL SR Target Milestone Rank 0|i01w0f: