Simple.Mox
0.6.3
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Simple.Mox --version 0.6.3
NuGet\Install-Package Simple.Mox -Version 0.6.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Simple.Mox" Version="0.6.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Simple.Mox --version 0.6.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Simple.Mox, 0.6.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Simple.Mox as a Cake Addin #addin nuget:?package=Simple.Mox&version=0.6.3 // Install Simple.Mox as a Cake Tool #tool nuget:?package=Simple.Mox&version=0.6.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Simple.Mox
A simple Proxmox C# API
How to use
Create an API-Key
Follow proxmox API guide to genarate an API-Token https://pve.proxmox.com/wiki/Proxmox_VE_API
Then either:
// Manually fill your token
Instance c = new Instance("https://proxmox.local:8006/", "PVEAPIToken=a@b!a=123");
Or:
// Manually fill your token
Instance c = new Instance("https://proxmox.local:8006/", new AuthParams
{
User = "username",
Realm = "pam", // default
TokenName = "monitoring",
TokenSecret = "aaaaaaaaa-bbb-cccc-dddd-ef0123456789",
});
Start using
The program.cs file have a demo with all calls
Get Proxmox instance info
// Get Proxmox instance info
var info = await c.GetInfoAsync();
var firstNodeInfo = info.Nodes[0];
// get node by info, index or name
var node = await c.GetNodeAsync(firstNodeInfo); // await c.GetNodeAsync("pve");
Get Node info
var nodeStatus = await node.GetStatusAsync();
var nodeReport = await node.GenerateReportAsync();
var nodeStatistcs = await node.GetStatisticsAsync(Simple.Mox.Models.NodeRRD.TimeFrame.day);
var pngBytes = await node.GetStatisticsImageAsync(Simple.Mox.Models.NodeRRD.TimeFrame.day, Simple.Mox.Models.NodeRRD.DataSet.loadavg);
Get Node LXCs and VMs
var nodeAllLxcs = await node.GetLXCsAsync();
var lxc100 = await node.GetLXCAsync(100);
// Get node VMs
var nodeAllVMs = await node.GetVMsAsync();
var vm300 = await node.GetVMAsync(300);
Enumerate all VMs e LXCs
var items = await c.GetItemsAsync();
// get VM 123
var vm123 = await items[123].AsVMAsync();
// get LXC 123
var ct321 = await items[321].AsVMAsync();
Get VM information
var vm_status = await vm300.GetStatusAsync();
var vm_cfg = await vm300.GetConfigAsync();
var vm_stats = await vm300.GetStatisticsAsync(Simple.Mox.Models.NodeRRD.TimeFrame.day);
var vm_bytes = await vm300.GetStatisticsImageAsync(Simple.Mox.Models.NodeRRD.TimeFrame.day, Simple.Mox.Models.VMRRD.DataSet.cpu);
System.IO.File.WriteAllBytes("vm300.png", vm_bytes);
Get LXC information
var lxc_status = await lxc100.GetStatusAsync();
var lxc_cfg = await lxc100.GetConfigAsync();
var lxc_stats = await lxc100.GetStatisticsAsync(Simple.Mox.Models.NodeRRD.TimeFrame.day);
var lxc_bytes = await lxc100.GetStatisticsImageAsync(Simple.Mox.Models.NodeRRD.TimeFrame.day, Simple.Mox.Models.LXCRRD.DataSet.cpu);
System.IO.File.WriteAllBytes("lxc100.png", lxc_bytes);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Simple.API (>= 1.7.1.3)
-
net6.0
- Simple.API (>= 1.7.1.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
See examples and documentation on the GitHub page https://github.com/RafaelEstevamReis/Simple.Mox