API Guide

curl Commands
curl command options include:
● -X specifies the HTTPS request type; for example, POST , PATCH, or GET.
● -u specifies the user name and password to use for server authentication.
● -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.
For more information, see the curl Man page.
Usage Information
Consider the following when accessing OS10 RESTCONF API using curl commands:
● Dell EMC recommends using a specific URI of the target resource for GET queries in a scaled system. For example, curl -
X GET -k -u admin:admin -H "accept:application/json" https://$TARGET/restconf/data/
interfaces/interface/port-channel10
OS10 does not support REST queries on the root resource of the RESTCONF datastore. For example, the GET query, curl
-X GET -k -u admin:admin https://$TARGET/restconf/data returns an error.
● When a RESTCONF query is in progress, you cannot configure any CLI commands until a RESTCONF query is complete.
● It is recommended to use POST request instead of PUT, to replace the target data resources.
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, use the debug cli netconf command
in EXEC mode. In CONFIGURATION mode, use the do debug cli netconf command.
This command enables a CLI-to-XML display. At the prompt, enter the OS10 command of the XML request and the reply you
need. To exit the CLI-to-XML display, use 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,
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"}]}'
RESTCONF API
1389