Skip to content

Using RESTCONF

Coming later

This chapter, and the RESTCONF sections of the feature pages, are not written yet.

The switch serves a RESTCONF API (RFC 8040) at https://<switch-ip>/restconf. It works on the same data models and the same configuration as the CLI, so the CLI sections of the feature pages apply: a CLI path like

interfaces interface lan3 ethernet switched-vlan config access-vlan

is the RESTCONF resource

/restconf/data/openconfig-interfaces:interfaces/interface=lan3/openconfig-if-ethernet:ethernet/openconfig-vlan:switched-vlan/config/access-vlan

Differences from the CLI:

  • RESTCONF changes are applied to the running configuration at once. There is no candidate and no separate commit.

  • Like CLI commits, they are not saved. Save with save in the CLI, or with a copy-config from running to startup:

    curl -k -u ops -X POST -H 'Content-Type: application/yang-data+json' \
    -d '{"ietf-netconf:input":{"target":{"startup":[null]},"source":{"running":[null]}}}' \
    https://192.168.1.1/restconf/operations/ietf-netconf:copy-config

  • Every request needs the admin login, as HTTP basic auth (curl -u ops asks for the password of the admin ops; the examples use that name). -k accepts the switch's self-signed certificate.

  • The admin account and the factory reset are RPCs of the module clixon-switch, see Password and factory reset.

Until this chapter is written, the clixon-switch-rs README has RESTCONF examples for DHCP, spanning tree and SNMP, and the LLDP page has its own.