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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright (C) 2017-2018 Red Hat, Inc.
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Author: Gris Ge <fge@redhat.com>
//! # `LibStorageMgmt`
//!
//! `LibStorageMgmt` provides a set of API for programmatically manage their
//! storage hardware in a vendor neutral way supporting these actions:
//!
//! * List storage pools, volumes, access groups, or file systems.
//!
//! * Create and delete volumes, access groups, file systems, or NFS exports.
//!
//! * Grant and remove access to volumes, access groups, or initiators.
//!
//! * Replicate volumes with snapshots, clones, and copies.
//!
//! * Create and delete access groups and edit members of a group.
//!
//! * List Linux local SCSI/ATA/NVMe disks.
//!
//! * Control IDENT/FAULT LED of local disks via SES(SCSI Enclosure Service), NPEM, VMD (utilizes ledmon library)
//!
//! To use `LibStorageMgmt` rust binding, you need:
//!
//! * Start the libstoragemgmt daemon(`lsmd`)
//!
//! * Choose a URI after reading [`LibStorageMgmt` user guide][1]
//!
//! * Make a connection to plugin via [`lsm::Client`][2].
//!
//! * Check required [`lsm::Capabilities`][3] for supported functionality.
//!
//! * Invoke required method of [`lsm::Client`][2].
//!
//! # Example code using simulator plugin
//!
//! ```rust
//! extern crate lsm;
//! use lsm::{Client, LsmError};
//!
//! let mut c: Client = match Client::new("sim://", None, None) {
//! Ok(i) => i,
//! Err(e) => {
//! match e {
//! // Error handling goes here
//! LsmError::DaemonNotRunning(_) =>
//! panic!("Please start the libstoragemgmt daemon"),
//! _ => panic!("{}", e)
//! };
//! },
//! };
//! let syss = match c.systems() {
//! Ok(i) => i,
//! Err(e) => panic!("{}", e) // Please use error handling as above.
//! };
//! for s in syss {
//! let cap = match c.capabilities(&s) {
//! Ok(i) => i,
//! Err(e) => panic!("{}", e) // Please use error handling as above.
//! };
//! if cap.is_supported(lsm::Capability::Volumes) {
//! let vols = match c.volumes() {
//! Ok(i) => i,
//! Err(e) => panic!("{}", e) // Please use error handling as above.
//! };
//! for vol in vols {
//! println!("Got volume: {} {}", vol.name, vol.id);
//! }
//! }
//! }
//!
//! ```
//!
//! [1]: https://libstorage.github.io/libstoragemgmt-doc/doc/user_guide.html
//! [2]: struct.Client.html
//! [3]: struct.Capabilities.html
extern crate serde;
extern crate serde_derive;
extern crate regex;
extern crate serde_json;
extern crate url;
pub use ;
pub use *;
pub use LsmError;
pub use ;