r-sitko/netconf-client

Rust NETCONF client

netconf-client

Table of contents

• Table of contents
• About The Project
• Features
• Getting Started
  • Prerequisites
    • Use library in project
    • Run integration tests from netconf-client library
  • Setup
  • Examples
  • Error handling
• Running integration tests
• API documentation

About The Project

Rust NETCONF RFC6241 client with SSH secure connection support.

Features

• SSH connection
• Supported NETCONF messages:
  • <hello>
  • <get-config>
  • <edit-config>
  • <copy-config>
  • <delete-config>
  • <lock>
  • <unlock>
  • <get>
  • <close-session>
  • <kill-session>
  • <discard-changes>
  • <commit>
• Supported datastores:
  • <running>
  • <candidate>
  • <startup>

Getting Started

Prerequisites

Use library in project

• Rust
• Cargo

Run integration tests from netconf-client library

• Rust
• Cargo
• Docker

Setup

Add netconf-client git package to Cargo.toml dependencies section. This library is not available in crates.io.

Basing on latest commit from main branch:

[dependencies]
netconf-client = { git = "https://github.com/rsitko92/netconf-client.git" }

Basing on concrete commit:

[dependencies]
netconf-client = { git = "https://github.com/rsitko92/netconf-client.git", rev = "3f63491" }

Examples

All netconf-client API methods returns std::Result type. If client get successful response, std::Result with Ok(T) variant is returned, where T is a apriopriate NETCONF response type defined in replies module.

let mut client = NetconfClient::new(
    "127.0.0.1",
    830,
    "root",
    "root",
);
client.connect().unwrap();
client.send_hello().unwrap();
let rsp = client.get(None).unwrap();
println!("get response: {:?}", rsp.data);

More useful examples can be found in tests folder.

Error handling

When error is encountered (for example: io error, SSH error, NETCONF response error) API methods return std::Result with Err(NetconfClientError) variant. NetconfClientError is an enum defined in errors module. User should check if methods return Err and react accordingly.

Running integration tests

cargo test --test '*'

API documentation

https://rsitko92.github.io/netconf-client/netconf_client/

netconf-client's Issues

inspired by this library - new rust playground project

Hello,

i wanted to let you know that I read your crate/library codebase, and used some of its patterns as an inspiration for implementation of my Rust NETCONF client playground sub-crate located at https://github.com/RustyJoeM/netconf-client-playground
I added a reference to this repository in the main readme file.

best regards,
Jozef