EnterpriseVE.ProxmoxVE.Api.Extension
1.0.16
Suggested Alternatives
Corsinvest.ProxmoxVE.Api.Extension
Additional DetailsThis is as new Version
dotnet add package EnterpriseVE.ProxmoxVE.Api.Extension --version 1.0.16
NuGet\Install-Package EnterpriseVE.ProxmoxVE.Api.Extension -Version 1.0.16
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="EnterpriseVE.ProxmoxVE.Api.Extension" Version="1.0.16" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EnterpriseVE.ProxmoxVE.Api.Extension --version 1.0.16
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: EnterpriseVE.ProxmoxVE.Api.Extension, 1.0.16"
#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 EnterpriseVE.ProxmoxVE.Api.Extension as a Cake Addin #addin nuget:?package=EnterpriseVE.ProxmoxVE.Api.Extension&version=1.0.16 // Install EnterpriseVE.ProxmoxVE.Api.Extension as a Cake Tool #tool nuget:?package=EnterpriseVE.ProxmoxVE.Api.Extension&version=1.0.16
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ATTENTION This package is deprecated.
See https://www.nuget.org/packages/Corsinvest.ProxmoxVE.Api.Extension
=================================================================================
EnterpriseVE.ProxmoxVE.Api
ProxmoVE Client API .Net
______ __ _ _ ________
/ ____/___ / /____ _________ _____(_)_______ | | / / ____/
/ __/ / __ \/ __/ _ \/ ___/ __ \/ ___/ / ___/ _ \ | | / / __/
/ /___/ / / / /_/ __/ / / /_/ / / / (__ ) __/ | |/ / /___
/_____/_/ /_/\__/\___/_/ / .___/_/ /_/____/\___/ |___/_____/
/_/
(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 method generated from documentation
- 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
- Return result status
- StatusCode
- ReasonPhrase
- IsSuccessStatusCode
- Wait task finish task
- WaitForTaskToFinish
- 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
- 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);
}
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 API.
See VM.ClientExtension.cs, Storage.ClientExtension.cs, Node.ClientExtension.cs
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
- EnterpriseVE.ProxmoxVE.Api (>= 1.0.15)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
1.0.16 | 1,034 | 11/12/2018 |