Reference Guide

● -k specifies a text file to read curl arguments from. The command line arguments found in the text file will be used as if they
were provided on the command line. Use the IP address or URL of the OS10 switch when you access the OS10 RESTCONF
API from a remote orchestration system.
● -H specifies an extra header to include in the request when sending HTTPS to a server. You can enter multiple extra
headers.
● -d sends the specified data in an HTTPS request.
In curl commands, use %2F to represent a backslash (/); for example, enter ethernet1/2/3 as ethernet1%2F1%2F3.
View XML structure of CLI commands
To use the RESTCONF API to configure and monitor an OS10 switch, create an HTTPS request with data parameters in JSON
format. The JSON data parameters correspond to the same parameters in the XML structure of an OS10 command.
To display the parameter values in the XML code of an OS10 command as reference, enter the debug cli netconf
command in EXEC mode. In CONFIGURATION mode, enter the do debug cli netconf command.
This command enables a CLI-to-XML display. At the prompt, enter the OS10 command for which you want to display the XML
request and reply. To exit the CLI-to-XML display, enter the no debug cli netconf command.
Locate the XML parameters values for the same JSON data arguments. For example, to configure VLAN 20 on an OS10 switch,
you would enter the RESTCONF endpoint and JSON contents in the curl command. Note how the JSON type and name
parameters are displayed in the XML structure of the interface vlan command.
●
RESTCONF endpoint: /restconf/data/interfaces
● JSON data content:
{
"interface": [{
"type": "iana-if-type:l2vlan",
"enabled": true,
“description”: “vlan20”,
"name": "vlan20"
}]
}
● curl command:
curl -X POST –u admin:admin –k "https://10.11.86.113/restconf/data/interfaces"
-H "accept: application/json" -H "Content-Type: application/json"
-d '{ "interface": [{ "type": "iana-if-type:l2vlan", "enabled": true,
“description”:“vlan20”, "name":"vlan20"}]}'
To display the values for the type and name parameters in the curl command, display the XML structure of the interface
vlan 20 configuration command:
OS10(config)# do debug cli netconf
OS10(config)# interface vlan 10
Request:
<?xml version="1.0" encoding="UTF-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<candidate/>
</target>
<default-operation>merge</default-operation>
<error-option>stop-on-error</error-option>
<test-option>set</test-option>
<config>
<interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-
interfaces" xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type" xmlns:dell-
if="http://www.dellemc.com/networking/os10/dell-interface" xmlns:dell-eth="http://
www.dellemc.com/networking/os10/dell-ethernet" xmlns:dell-lag="http://www.dellemc.com/
networking/os10/dell-lag">
<interface>
<type>ianaift:l2vlan</type>
<name>vlan10</name>
</interface>
RESTCONF API
751