Implementation details for NSO interfaces and APIs.
Loading...
Loading...
Loading...
Loading...
Implementation details for XPath.
The NSO XPath documentation covers implementation details and extension to or deviation from the XPath 1.0 documentation and YANG RFC 7950 XPath extensions respectively. The XPath 1.0 documentation and YANG RFCs are the main reference guides for the NSO XPath implementation, while the NSO documentation complements them.
Implementation details for RESTCONF.
The NSO RESTCONF documentation covers implementation details and extension to or deviation from the RESTCONF RFC 8040 and YANG RFC 7950 respectively. The IETF RESTCONF and YANG RFCs are the main reference guides for the NSO RESTCONF interface, while the NSO documentation complements the RFCs.
Sample NSO RESTCONF APIs.
These sample requests are Read-Only by design to work with the Always-on DevNet Sandbox.
For Read/Write requests see the Postman Collection.
Newer NSO releases (starting with 5.3) also include a | display restconf
option to more easily get API paths: show running-config devices | display restconf
.
Implementation details for NETCONF.
The NSO NETCONF documentation covers implementation details and extension to or deviation from the NETCONF RFC 6241 and YANG RFC 7950 respectively. The IETF NETCONF and YANG RFCs are the main reference guides for the NSO NETCONF interface, while the NSO documentation complements the RFCs.
The CLI equivalent of: show running-config devices device dist-rtr01 config interface
"application/yang-data+json"
The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.
"application/yang-data+json"
The CLI equivalent of show devices device dist-rtr01 platform.
"application/yang-data+json"
The CLI equivalent of: show running-config devices device dist-rtr01 config interface GigabitEthernet 1
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-rtr01 config ip domain name.
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-rtr01 config ip route.
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-rtr01 config router ospf.
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-rtr01 config line
"application/yang-data+json"
The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.
"application/yang-data+json"
The CLI equivalent of show devices device dist-sw01 platform.
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-sw01 config vlan.
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-sw01 config interface
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-sw01 config vpc
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-sw01 config boot
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-sw01 config router ospf
"application/yang-data+json"
The CLI equivalent of show running-config devices device dist-sw01 config line
"application/yang-data+json"
The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.
"application/yang-data+json"
The CLI equivalent of show devices device core-rtr01 platform
"application/yang-data+json"
The CLI equivalent of show running-config devices device core-rtr01 config vrf
"application/yang-data+json"
The CLI equivalent of show running-config devices device core-rtr01 config interface
"application/yang-data+json"
The CLI equivalent of show running-config devices device core-rtr01 config interface GigabitEthernet 0/0/0/0 ip address
"application/yang-data+json"
The CLI equivalent of show running-config devices device core-rtr01 config router static
"application/yang-data+json"
The CLI equivalent of show running-config devices device core-rtr01 config router ospf
"application/yang-data+json"
The CLI equivalent of show running-config devices device core-rtr01 config line
"application/yang-data+json"
The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.
"application/yang-data+json"
The CLI equivalent of show devices device edge-firewall01 platform
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config interface
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config interface GigabitEthernet 0/1 ip address
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config dns
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config access-list
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config object
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config policy-map
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config router ospf
"application/yang-data+json"
The CLI equivalent of show running-config devices device edge-firewall01 config object-group
"application/yang-data+json"
Shows all service instances. In this case we have just one. CLI equivalent is show running-config svi_verify_example
"application/yang-data+xml"
"application/yang-data+json"
Show the service instance inputs for a single service instance called "first-instance." The CLI equivalent is show running-config svi_verify_example first-instance
"application/yang-data+xml"
"application/yang-data+json"
Shows logs for when services have errors. CLI equivalent is show svi_verify_example log
"application/yang-data+xml"
"application/yang-data+json"
shows the list of services that a device is participating in. CLI equivalent is show devices device service-list for a full list or show devices device dist-sw01 service-list for a single device
"application/yang-data+xml"
"application/yang-data+json"
Device Groups can be nested, in this case the ALL group includes the other groups and was manually created. CLI equivalent show running-config devices device-group
"application/yang-data+json"
"application/yang-data+json"
You can view the contents of a single device group. CLI equivalent show running-config devices device-group IOS-DEVICES
"application/yang-data+json"
"application/yang-data+json"
Credentials are stored in AES encrypted strings, but can be accessed over the API. CLI equivalent show running-config devices authgroups
"application/yang-data+json"
"application/yang-data+json"
NSO keeps track of alarms such as failing to connect to a device. CLI equivalent show alarms
"application/yang-data+json"
"application/yang-data+json"