Corsinvest.ProxmoxVE.Api
1.1.0
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 Corsinvest.ProxmoxVE.Api --version 1.1.0
NuGet\Install-Package Corsinvest.ProxmoxVE.Api -Version 1.1.0
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="Corsinvest.ProxmoxVE.Api" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Corsinvest.ProxmoxVE.Api --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Corsinvest.ProxmoxVE.Api, 1.1.0"
#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 Corsinvest.ProxmoxVE.Api as a Cake Addin #addin nuget:?package=Corsinvest.ProxmoxVE.Api&version=1.1.0 // Install Corsinvest.ProxmoxVE.Api as a Cake Tool #tool nuget:?package=Corsinvest.ProxmoxVE.Api&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Corsinvest.ProxmoxVE.Api
ProxmoVE Client API .Net
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
Corsinvest for Proxmox VE Api Client (Made in Italy)
General
The client is generated from a JSON Api on Proxmox VE.
Main features
- Easy to learn
- Method named
- Method native sufix Rest (prevent)
- GetRest
- CreateRest (Post)
- SetRest (Put)
- DeleteRest
- Set ResponseType json, png
- Full class and method generated from documentation (about client)
- Comment any method and parameters
- Parameters indexed eg [n] is structured in array index and value
- Tree structure
- client.Nodes["pve1"].Qemu[100].Snapshot().snapshotList().Response.data
- Return data Proxmox VE
- Debug Level show to console information REST call
- Return result status
- StatusCode
- ReasonPhrase
- IsSuccessStatusCode
- Task utility
- WaitForTaskToFinish
- TaskIsRunning
- GetExitStatusTask
- Method directry access
- Get
- Create (Post)
- Set (Put)
- Delete
- Login return bool if access
- Return Result class more information
Result
The result is class Result and contain properties:
- Response returned from Proxmox VE (data,errors,...) dynamic ExpandoObject
- ResponseToDictionary return response to dictionary
IDictionary<String, object>
- ResponseInError (bool) : Contains errors from Proxmox VE.
- StatusCode (System.Net.HttpStatusCode): Status code of the HTTP response.
- ReasonPhrase (string): The reason phrase which typically is sent by servers together with the status code.
- IsSuccessStatusCode (bool) : Gets a value that indicates if the HTTP response was successful.
- GetError() (string) : Get error.
Example result:
{
"data": {
"smbios1": "uuid=9246585e-0c8b-4d02-8fe2-f48fd0da3975",
"ide2": "none,media=cdrom",
"onboot": 1,
"boot": "cdn",
"cores": 2,
"agent": 1,
"memory": 4096,
"numa": 0,
"bootdisk": "virtio0",
"sockets": 1,
"net0": "virtio=3A:39:38:30:36:31,bridge=vmbr0",
"parent": "auto4hours170904080002",
"digest": "acafde32daab50bce801fef2e029440c54ebe2f7",
"vga": "qxl",
"virtio0": "local-zfs:vm-100-disk-1,cache=writeback,size=50G",
"ostype": "win8",
"name": "phenometa"
}
}
Usage
var client = new Client("10.92.90.91");
if (client.Login("root", "password"))
{
var vm = client.Nodes["pve1"].Qemu[100];
//config vm
var config = vm.Config.VmConfig();
Console.WriteLine(Client.ObjectToJson(config.Response));
//create snapshot
var response = vm.Snapshot.Snapshot("pippo2311");
//update snapshot description
vm.Snapshot["pippo2311"].Config.UpdateSnapshotConfig("descr");
//delete snapshot
vm.Snapshot["pippo2311"].Delsnapshot();
//list of snapshot
foreach (var snapshot in vm.Snapshot.SnapshotList().Response.data)
{
Console.WriteLine(Client.ObjectToJson(snapshot));
Console.WriteLine(snapshot.name);
}
//change reposnde type from json to png
client.ResponseType = "png";
var dataImg = client.Nodes["pve1"].Rrd.Rrd("cpu", "day").Response;
Console.WriteLine("<img src=\"{dataImg}\" \>");
}
Extension Pack
The extension pack add functionality to Client API.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. |
.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
- Newtonsoft.Json (>= 10.0.3)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Corsinvest.ProxmoxVE.Api:
Package | Downloads |
---|---|
Corsinvest.ProxmoxVE.Api.Extension
Corsinvest for Proxmox VE Api Client Extension |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.3.0 | 130 | 12/19/2024 |
8.2.5 | 901 | 9/19/2024 |
8.2.4 | 451 | 8/13/2024 |
8.2.3 | 370 | 7/15/2024 |
8.2.2 | 6,653 | 6/14/2024 |
8.2.1 | 2,436 | 5/8/2024 |
8.2.0 | 380 | 4/26/2024 |
8.1.7 | 265 | 4/19/2024 |
8.1.6 | 564 | 4/2/2024 |
8.1.5 | 256 | 3/28/2024 |
8.1.4 | 210 | 3/22/2024 |
8.1.3 | 6,225 | 2/29/2024 |
8.1.2 | 195 | 2/13/2024 |
8.1.1 | 154 | 2/12/2024 |
8.1.0 | 6,982 | 12/11/2023 |
8.0.3 | 1,349 | 9/22/2023 |
8.0.2 | 469 | 9/18/2023 |
8.0.1 | 393 | 8/11/2023 |
8.0.0 | 394 | 6/23/2023 |
7.4.6 | 1,869 | 6/16/2023 |
7.4.5 | 297 | 6/8/2023 |
7.4.4 | 863 | 5/29/2023 |
7.4.3 | 404 | 5/10/2023 |
7.4.2 | 262 | 5/5/2023 |
7.4.1 | 650 | 4/14/2023 |
7.4.0 | 555 | 3/23/2023 |
7.3.4 | 12,140 | 11/3/2022 |
7.3.2 | 4,144 | 5/5/2022 |
7.3.1 | 1,724 | 4/26/2022 |
7.3.0 | 961 | 4/5/2022 |
7.2.0 | 1,396 | 1/31/2022 |
7.1.0 | 2,406 | 12/6/2021 |
7.0.1 | 1,722 | 10/30/2021 |
7.0.0 | 465 | 7/6/2021 |
2.8.1 | 450 | 4/28/2021 |
2.8.0 | 1,843 | 4/28/2021 |
2.7.0 | 1,860 | 12/15/2020 |
2.6.9 | 1,261 | 10/19/2020 |
2.6.8 | 862 | 10/15/2020 |
2.6.7 | 436 | 10/15/2020 |
2.6.6 | 4,343 | 9/25/2020 |
2.6.5 | 1,658 | 8/24/2020 |
2.6.1 | 1,696 | 7/30/2020 |
2.6.0 | 2,659 | 7/17/2020 |
2.5.0 | 5,001 | 6/20/2020 |
2.4.1 | 505 | 6/20/2020 |
2.4.0 | 1,942 | 5/12/2020 |
2.3.0 | 3,181 | 4/16/2020 |
2.2.0 | 3,770 | 12/17/2019 |
2.1.0 | 919 | 10/22/2019 |
2.0.0 | 800 | 10/9/2019 |
1.1.3 | 1,049 | 8/26/2019 |
1.1.1 | 1,284 | 7/4/2019 |
1.1.0 | 1,142 | 7/2/2019 |