ugos-client 0.14.2

Rust client library for the UGREEN NAS (UGOS) API: authentication, KVM virtual machine management, snapshots, networks, storage, and images
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! UGOS NAS API client library.
//!
//! Provides typed access to the UGREEN NAS (UGOS) REST API,
//! including authentication (RSA + session tokens) and all
//! service modules (KVM, storage, network, etc.).
//!
//! # Quick start
//!
//! ```rust,no_run
//! use ugos_client::{UgosClient, Credentials};
//! use ugos_client::api::kvm::KvmApi;
//!
//! # async fn example() -> ugos_client::error::Result<()> {
//! let creds = Credentials {
//!     username: "admin".into(),
//!     password: "secret".into(),
//! };
//! let tls = ugos_client::TlsPolicy::Pinned(
//!     ugos_client::tls::probe_fingerprint("192.168.1.10", 9443).await?,
//! );
//! let client = UgosClient::connect("192.168.1.10", 9443, creds, &tls).await?;
//! let vms = client.vm_list().await?;
//! # Ok(())
//! # }
//! ```

pub mod api;
pub mod auth;
pub mod client;
pub mod crypto;
pub mod error;
pub mod tls;
pub mod types;

// Re-export the most commonly used items at the crate root.
pub use auth::{Credentials, Session};
pub use client::UgosClient;
pub use tls::{CertFingerprint, TlsPolicy};

#[cfg(test)]
mod tests;