einarnn
commented
6 years ago Jean-Christophe,
Apologies for the long delay in getting back to you. Unfortunately, I was on vacation when this query arrived, so getting back to it now.
The general form for a URL for a query against the openconfig-interfaces model for config content should look like:
https://ip_address/restconf/data/openconfig-interfaces:interfaces?content=configThe YANG module name is used to scope the top-level node interfaces in the openconfig-interfaces model.
I can confirm that the two examples you show above would, indeed, generate 400: Bad request.
With respect to host discovery, we try to support what you see defined in Section 3.1 of RFC 8040. For example, on a CSR1Kv running IOS-XE 16.6.1, I can do a query like:
GET /.well-known/host-meta?depth=unbounded HTTP/1.1
Authorization: Basic dmFncmFudDp2YWdyYW50
Host: **********
Connection: close
User-Agent: Paw/3.1.5 (Macintosh; OS X/10.12.6) GCDHTTPRequest...and get back:
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Jul 2017 23:13:49 GMT
Content-Type: application/xrd+xml
Content-Length: 107
Connection: close
Vary: Accept-Encoding
<XRD xmlns='http://docs.oasis-open.org/ns/xri/xrd-1.0'>
<Link rel='restconf' href='/restconf'/>
</XRD>I can then dispatch a query such as:
GET /restconf?depth=unbounded HTTP/1.1
Authorization: Basic dmFncmFudDp2YWdyYW50
Accept: application/yang-data+json
Host: **********
Connection: close
User-Agent: Paw/3.1.5 (Macintosh; OS X/10.12.6) GCDHTTPRequestAnd see:
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Jul 2017 23:14:48 GMT
Content-Type: application/yang-data+json
Transfer-Encoding: chunked
Connection: close
Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
Vary: Accept-Encoding
Pragma: no-cache
{"restconf":{"data":{},"operations":{},"yang-library-version":"2016-06-21"}}This tells me that the device, under /restconf, supports the data and operations subtrees, along with supporting the IETF YANG Library model. To discover more details of model support, I then need to use the IETF YANG Library together data. For example, if I wanted to get a list of the modules the device claims to support, I might use the query:
GET /restconf/data/ietf-yang-library:modules-state/module?content=nonconfig&fields=name HTTP/1.1
Authorization: Basic dmFncmFudDp2YWdyYW50
Accept: application/yang-data+json
Host: **********
Connection: close
User-Agent: Paw/3.1.5 (Macintosh; OS X/10.12.6) GCDHTTPRequest...which would give me a response something like (again, from a CSR1Kv as I don't have a NX-OS device to hand):
(PS partial response only)
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/yang-data+json
Pragma: no-cache
Transfer-Encoding: Identity
Date: Wed, 12 Jul 2017 23:24:05 GMT
Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
Connection: close
{
"ietf-yang-library:module": [
{
"name": "ATM-FORUM-TC-MIB"
},
{
"name": "ATM-MIB"
},
{
"name": "ATM-TC-MIB"
},
{
"name": "BGP4-MIB"
},
[...elided...]Hope this helps. Please feel free to get back to me with any further queries.
Cheers,
Einar
jean-christophe-manciot
NX-OS 9kv 7.0(3)I6(1)
Hello @einarnn I'm having a hard time figuring out the URI(s) which must be used to attain the openconfig resources supported by this device. Using yang-explorer, I can confirm that it does support openconfig:
I can also GET all vendor specific data returned by
http://ip_address/restconf/data/Cisco-NX-OS-device:System?content=config: Cisco-NX-OS-device:System.ymlBut what URI should I use to GET the openconfig data? I tried all sorts of URIs, including
http://ip_address/restconf/data/Cisco-NX-OS-device:Openconfig?content=confighttp://ip_address/restconf/data/Openconfig?content=configEach time, I receive a
400: Bad Request.Generally speaking, is there a method to automatically discover the URI of any Yang resource on any Cisco platform?