Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bjornbouetsmith/ROOT.Zfs
.NET Zfs library
https://github.com/bjornbouetsmith/ROOT.Zfs
Last synced: 3 months ago
JSON representation
.NET Zfs library
- Host: GitHub
- URL: https://github.com/bjornbouetsmith/ROOT.Zfs
- Owner: bjornbouetsmith
- License: ms-pl
- Created: 2022-09-28T14:43:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-08T15:09:46.000Z (5 months ago)
- Last Synced: 2024-06-21T12:27:08.809Z (5 months ago)
- Language: C#
- Homepage:
- Size: 640 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - bjornbouetsmith/ROOT.Zfs - .NET Zfs library (others)
README
# Introduction
ZFS .NET library which interfaces with the zfs/zpool binaries to manipulate and query the ZFS file system.
[](https://github.com/bjornbouetsmith/ROOT.Zfs/actions/workflows/dotnet-ci-build.yml)
[](https://github.com/bjornbouetsmith/ROOT.Zfs/actions/workflows/dotnet-ci-integration.yml)
[](https://sonarcloud.io/summary/new_code?id=bjornbouetsmith_ROOT.Zfs)
[](https://sonarcloud.io/summary/new_code?id=bjornbouetsmith_ROOT.Zfs)
[](https://sonarcloud.io/summary/new_code?id=bjornbouetsmith_ROOT.Zfs)
[](https://sonarcloud.io/summary/new_code?id=bjornbouetsmith_ROOT.Zfs)
[](https://sonarcloud.io/summary/new_code?id=bjornbouetsmith_ROOT.Zfs)
[](https://sonarcloud.io/summary/new_code?id=bjornbouetsmith_ROOT.Zfs)
Tested against ZoL
* version 2.1.5-2 on Rocky Linux 8.5
* version 2.1.4 on Ubuntu 22.04
* version 0.86 on Ubuntu 20.04
Will most likely work against different versions, but some of the commands will fail against ZFS on different platforms, since the supporting commands used to load disk/partition information are different - or because the commands are simply not available in that version of zfs.
Commands that do not exist in the version of zfs you are running against, will obviously also fail.
This is something that could be fixed in future versions.
## Example
~~~c#
// First decide if you are connecting to localhost or another machine
// null indicates that you are running on the same machine where the zfs pool is located
// Otherwise you would do: new SSHProcessCall("username","hostname",true);
SSHProcessCall connection = null;
// Create instance of zfs class
var zfs = new Core.Zfs(null);
// Get status of the pool tank
var status = zfs.Pool.GetStatus("tank");
if (status.State == State.Online)
{
return;
}
var pool = status.Pool;
foreach (var vdev in pool.VDevs)
{
if (vdev.State == State.Online)
{
continue;
}
Console.WriteLine("vdev:{0}, State:{1}", vdev.Name, vdev.State);
foreach (var device in vdev.Devices)
{
if (device.State == State.Online)
{
continue;
}
Console.WriteLine("Device:{0}, State:{1}", device.DeviceName, device.State);
}
}
~~~
More examples on the [wiki](https://github.com/bjornbouetsmith/ROOT.Zfs/wiki/Examples)
## Dependencies
Obviously this software requires ZFS to be installed on the target server.
Besides ZFS - some methods also invokes the following binaries:
`smartctl`, `lsblk`, `ls`
`smartctl` is usually found in the package called `smartmontools` the two others should be available in the base installation of the OS.
## Help needed
If you want to help make this library greater either by
* Contributing code
* Writing examples
* Better documentation
* Writing tests and writing expected responses for a given version of zfs - if it differs from version to version
* In any other way, feel free to contact [@bjornbouetsmith](https://github.com/bjornbouetsmith).
## NOTE
Nuget packages found here on github is to be considered development versions and is only meant to enable ci/cd within the ROOT projects.
Packages not found on nuget.org should not be used in production code unless you are ready to change stuff if interfaces or something changes.
Its fine to take packages from here to test out patches etc, but do not expect stable interfaces on new features until its released on nuget.org.
### Documentation
Documentation is based on the openzfs [documentation](https://openzfs.github.io/openzfs-docs) with [license](
https://creativecommons.org/licenses/by-sa/3.0/). If you believe I am in breach of the license, please get in touch.