Index

Introduction

This lab provides a hands-on approach to configuring network devices using the NETCONF protocol and YANG data models.

Prerequisites

containerlab
uv (if you want to create the virtual environment manually, use Python 3.12)

To get started, clone the repository containing scripts and examples from:

ssh://git@git.rnp.br:2022/redes-abertas/schema-driven-cfg.git

Building the Test Environment with `containerlab`

In this section, we will use containerlab to deploy a simple network topology defined in the simple-lab.yaml file.

Image Generation (if needed): The virtual router images (vSRX for Juniper and NE40E for Huawei) need to be available locally. Use vrnetlab to build these images. Refer to the vrnetlab documentation for detailed instructions on how to generate the VSRX 20.1R1.13 and Huawei NE40E V800R011C00SPC607B607 images. The Cisco XRd image does not need to be generated in this way, as it is already a container, just follow the instructions on the containerlab website.
Topology Deployment: With the images ready, execute the following command to start the lab:
```
sudo containerlab deploy -t simple-lab.yaml
```
containerlab will provision the containers and display a table with the IP addresses for each device. Note these IPs, as they will be used in the subsequent steps.

Installing Python Dependencies

The Python scripts used in this lab have external dependencies. Follow one of the methods below to install them:

Using `uv` (Recommended)

If you have uv installed, run the command below in the root of the cloned repository to create a virtual environment and install the dependencies:

uv sync

Then, activate the virtual environment:

source .venv/bin/activate

Using `pip` with a Manual Virtual Environment

If you prefer to manage the virtual environment manually with Python 3.12+ and pip:

Create a virtual environment:
```
python3 -m venv .venv
```
Activate the virtual environment:
```
source .venv/bin/activate
```
Install the dependencies:
```
pip install -r requirements.txt
```

Testing NETCONF Operations

With the environment configured, we can test NETCONF operations using the netconf_test.py script. This script uses YAML configuration files to define the device connection parameters and XML payloads for the NETCONF operations.

Update the Device Configuration Files: Modify the huawei_device_config.yaml, junos_device_config.yaml, and cisco_device_config.yaml files with the correct IP addresses of your devices (provided by containerlab) and the corresponding credentials.

Example (huawei_device_config.yaml):
```
# filepath: huawei_device_config.yaml
device:
hostname: "172.20.20.5"
username: "admin"
password: "admin"
port: 830
type: "huaweiyang"
```
Run the netconf_test.py Script:

Script Usage:
```
python netconf_test.py -c <config_yaml_file> -p <payload_xml_file>
```
Arguments: - -c CONFIG, --config CONFIG: Path to the device YAML configuration file (e.g., huawei_device_config.yaml). - -p PAYLOAD, --payload PAYLOAD: Path to the XML file containing the NETCONF payload (e.g., xml/huawei-native-interface-ip.xml).

Example of Applying Interface Configuration on a Huawei Device:
```
python netconf_test.py -c huawei_device_config.yaml -p xml/huawei-native-interface-ip.xml
```
Access the device and verify that the IP 10.1.1.2/24 has been configured on the Ethernet1/0/1 interface.

To remove the configuration, use the deletion payload:
```
python netconf_test.py -c huawei_device_config.yaml -p xml/huawei-native-interface-ip-delete.xml
```
Example of Applying Interface Configuration on a Juniper Device:
```
python netconf_test.py -c junos_device_config.yaml -p xml/junos-native-interface-ip.xml
```
Access the device and verify that the IP 10.1.1.2/24 has been configured on the ge-0/0/0 interface.

To remove the configuration, use the deletion payload:
```
python netconf_test.py -c junos_device_config.yaml -p xml/junos-native-interface-ip-delete.xml
```
Example of Applying Interface Configuration on a Cisco Device:
```
python netconf_test.py -c cisco_device_config.yaml -p xml/cisco-native-interface-ip.xml
```
Access the device and verify that the IP 192.168.1.12 has been configured on the GigabitEthernet0/0/0/0 interface.

To remove the configuration, use the deletion payload:
```
python netconf_test.py -c cisco_device_config.yaml -p xml/cisco-native-interface-ip-delete.xml
```
Example using OpenConfig models:

Now try performing the same operation using OpenConfig model payloads:
```
#Huawei
python netconf_test.py -c huawei_device_config.yaml -p xml/openconfig-huawei-interface-ip.xml
#Juniper
python netconf_test.py -c junos_device_config.yaml -p xml/openconfig-junos-interface-ip.xml
```

Obtaining YANG Models from Devices

YANG models define the structure of configuration and state data for network devices, serving as the foundation for automation and interoperability via NETCONF. Understanding and exploring these models is essential for creating correct NETCONF payloads.

The following sections present methods for obtaining YANG models from the Huawei, Juniper, and Cisco devices in this example.

Obtaining YANG Models from Huawei Devices

For Huawei devices, we can obtain the YANG models via NETCONF without needing to alter the initial device configuration performed by containerlab. Use the huawei_get_schema.py script to download the models to a local folder.

Script Usage:

python huawei_get_schema.py <host> <username> <password> [output_dir]

Arguments:

host: IP address or hostname of the Huawei device (obtained from containerlab).
username: Username for NETCONF authentication.
password: Password for NETCONF authentication.
output_dir (Optional): Directory to save the YANG files. Default: huawei-schema.

Obtaining YANG Models from Juniper Devices

For Juniper devices (Junos OS), it is recommended to obtain the YANG models directly through the equipment's CLI and transfer them to your local machine.

Refer to the official Juniper documentation for detailed guidance.

Obtaining YANG models from Cisco devices

To obtain the YANG model from a Cisco device, execute the cisco_get_schema.py script as follows:

usage: cisco_get_schema.py [-h] [--port PORT] host username password [output_dir]
arguments:
  host          IP address or hostname of the Cisco device
  username      Username for authentication on the device
  password      Password for authentication on the device
  output_dir    (Optional) Path to the directory where the YANG files will be saved - default=cisco-schema
  --port        (Optional) NETCONF port - default=830
ex:
python cisco_get_schema.py 192.168.1.2 admin 'password' cisco-schema --port 830

The YANG files will be downloaded and saved in the specified directory (when available, the name will follow the pattern <module>@<revision>.yang).