Configuring RESTCONF

Configuration on RESTCONF Server

Step 1      Enable RESTCONF on the server side.

set protocols restconf

Step 2      (Optional) Configure RESTCONF service listening port on the server side.

set protocols restconf port <port-number>

By default, the RESTCONF service port number is 443.

NOTE:

The RESTCONF service listening port in the HTTP request URL sent by RESTCONF Client needs to be consistent with the port configured on the server side.

NOTE:

The RESTCONF service listening port in the HTTP request URL sent by RESTCONF Client needs to be consistent with the port configured on the server side.

Step 3      Commit the configurations.

commit

Configuration Example

Networking Requirements

When users want to manage network devices through a unified management device with high security and scalability, administrators can utilize RESTCONF protocol to remotely configure and manage network devices using HTTP methods, and monitor these devices in real-time.

As shown in Figure 1, RESTCONF Client and RESTCONF Server are connected to each other via an IP network. As an HTTPs client, RESTCONF Client sends HTTP requests to the RESTCONF Server, which is an HTTPs server, using the OPTIONS, HEAD, GET, POST, PATCH, PUT and DELETE methods to create, delete, modify or query one or more data, thus realizing the management of profiles through RESTCONF.

Figure 1.     Application Scenarios for RESTCONF

Deploy and configure RESTCONF through the following approach:

  1. Configure the RESTCONF Client and Server to achieve Layer 3 route reachability between them. This will not be detailed in the following configuration procedure.

2. Enable RESTCONF function and configure RESTCONF service listening port on the RESTCONF Server.

3. After completing the above configuration, the RESTCONF Client can send HTTP requests to the RESTCONF Server to remotely manage the network devices.

Procedure

Step 1      Enable RESTCONF on the server side.

admin@RESTCONF-Server# set protocols restconf

Step 2      (Optional) Configure RESTCONF service listening port on the server side.

admin@RESTCONF-Server# set protocols restconf port 1024

By default, the RESTCONF service listening port number is 443.

NOTE:

The RESTCONF service listening port in the HTTP request URL sent by RESTCONF Client needs to be consistent with the port configured on the server side.

NOTE:

The RESTCONF service listening port in the HTTP request URL sent by RESTCONF Client needs to be consistent with the port configured on the server side.

Step 3      Commit the configurations.

admin@RESTCONF-Server# commit

Copyright © 2024 Pica8 Inc. All Rights Reserved.