Skip to main content

netconf_async/
lib.rs

1#![doc = include_str!("../README.md")]
2#![warn(missing_docs)]
3#![cfg_attr(docsrs, feature(doc_cfg))]
4
5pub mod connection;
6pub mod error;
7pub mod framer;
8pub mod message;
9pub mod transport;
10
11pub use connection::Connection;
12pub use error::{NetconfClientError, NetconfClientResult};
13pub use message::{Datastore, Filter, RpcReply};
14pub use transport::Transport;
15
16#[cfg(feature = "ssh")]
17pub use transport::ssh::{
18    HostKeyPolicy, JumpPool, JumpSession, SshAuth, SshConfig, SshJump, SshSessionOpts, SshTransport,
19};
20
21/// XML namespace for NETCONF 1.0 messages ([RFC6241](https://www.rfc-editor.org/rfc/rfc6241.html)).
22pub const NETCONF_URN: &str = "urn:ietf:params:xml:ns:netconf:base:1.0";
23/// `:base:1.0` capability ([RFC6241](https://www.rfc-editor.org/rfc/rfc6241.html)).
24pub const NETCONF_BASE_10_CAP: &str = "urn:ietf:params:netconf:base:1.0";
25/// `:base:1.1` capability; advertised by the server when chunked framing is supported ([RFC6242](https://www.rfc-editor.org/rfc/rfc6242.html)).
26pub const NETCONF_BASE_11_CAP: &str = "urn:ietf:params:netconf:base:1.1";
27/// `:writable-running:1.0` capability ([RFC6241 8.2](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.2)).
28pub const WRITABLE_RUNNING_CAP: &str = "urn:ietf:params:netconf:capability:writable-running:1.0";
29/// `:candidate:1.0` capability ([RFC6241 8.3](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.3)).
30pub const CANDIDATE_CAP: &str = "urn:ietf:params:netconf:capability:candidate:1.0";
31/// `:startup:1.0` capability ([RFC6241 8.7](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.7)).
32pub const STARTUP_CAP: &str = "urn:ietf:params:netconf:capability:startup:1.0";
33/// `:rollback-on-error:1.0` capability ([RFC6241 8.5](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.5)).
34pub const ROLLBACK_ON_ERROR_CAP: &str = "urn:ietf:params:netconf:capability:rollback-on-error:1.0";
35/// `:url:1.0` capability ([RFC6241 8.8](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.8)).
36pub const URL_CAP: &str = "urn:ietf:params:netconf:capability:url:1.0";
37/// `:confirmed-commit:1.0` capability ([RFC6241 8.4](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.4)).
38pub const CONFIRMED_COMMIT_10_CAP: &str = "urn:ietf:params:netconf:capability:confirmed-commit:1.0";
39/// `:confirmed-commit:1.1` capability ([RFC6241 8.4](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.4)).
40pub const CONFIRMED_COMMIT_CAP: &str = "urn:ietf:params:netconf:capability:confirmed-commit:1.1";
41/// `:validate:1.0` capability ([RFC6241 8.6](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.6)).
42pub const VALIDATE_10_CAP: &str = "urn:ietf:params:netconf:capability:validate:1.0";
43/// `:validate:1.1` capability ([RFC6241 8.6](https://www.rfc-editor.org/rfc/rfc6241.html#section-8.6)).
44pub const VALIDATE_CAP: &str = "urn:ietf:params:netconf:capability:validate:1.1";
45/// `:with-defaults:1.0` capability ([RFC6243](https://www.rfc-editor.org/rfc/rfc6243.html)).
46pub const WITH_DEFAULTS_CAP: &str = "urn:ietf:params:netconf:capability:with-defaults:1.0";
47/// `:notification:1.0` capability ([RFC5277](https://www.rfc-editor.org/rfc/rfc5277.html)).
48pub const NOTIFICATION_CAP: &str = "urn:ietf:params:netconf:capability:notification:1.0";
49/// `:interleave:1.0` capability — RPCs on a session with an active subscription ([RFC5277](https://www.rfc-editor.org/rfc/rfc5277.html#section-6)).
50pub const INTERLEAVE_CAP: &str = "urn:ietf:params:netconf:capability:interleave:1.0";
51/// Default NETCONF-over-SSH port ([RFC6242](https://www.rfc-editor.org/rfc/rfc6242.html)).
52pub const DEFAULT_NETCONF_SSH_PORT: u16 = 830;