Corsinvest.ProxmoxVE.Api.Extension 7.3.7

.NET Standard 2.0
NuGet\Install-Package Corsinvest.ProxmoxVE.Api.Extension -Version 7.3.7
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.
dotnet add package Corsinvest.ProxmoxVE.Api.Extension --version 7.3.7
<PackageReference Include="Corsinvest.ProxmoxVE.Api.Extension" Version="7.3.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Corsinvest.ProxmoxVE.Api.Extension --version 7.3.7
#r "nuget: Corsinvest.ProxmoxVE.Api.Extension, 7.3.7"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Corsinvest.ProxmoxVE.Api.Extension as a Cake Addin
#addin nuget:?package=Corsinvest.ProxmoxVE.Api.Extension&version=7.3.7

// Install Corsinvest.ProxmoxVE.Api.Extension as a Cake Tool
#tool nuget:?package=Corsinvest.ProxmoxVE.Api.Extension&version=7.3.7

Corsinvest.ProxmoxVE.Api

License

Nuget

Nuget

Nuget

Nuget

Nuget

Proxmox VE Client API .Net

Proxmox VE Api

   ______                _                      __
  / ____/___  __________(_)___ _   _____  _____/ /_
 / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
\____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Copyright: Corsinvest Srl For licensing details please visit LICENSE.md

Commercial Support

This software is part of a suite of tools called cv4pve. If you want commercial support send mail support@corsinvest.it

General

The client is generated from a JSON Api on Proxmox VE.

Main features

  • Easy to learn
  • Method named
  • 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
  • Logger with MicrosMicrosoft.Extensions.Logging
  • Return result
    • Request
    • Response
    • Status
  • Last result action
  • Task utility
    • WaitForTaskToFinish
    • TaskIsRunning
    • GetExitStatusTask
  • Method direct access
    • Get
    • Create (Post)
    • Set (Put)
    • Delete
  • Login return bool if access
  • Return Result class more information
  • ClientBase lite function
  • Form Proxmox VE 6.2 support Api Token for user
  • Async / Await
  • Add model in Shared library for decode json
  • Add Extension method Get to decode in json from result in Extension library

Api token

From version 6.2 of Proxmox VE is possible to use Api token. This feature permit execute Api without using user and password. If using Privilege Separation when create api token remember specify in permission. Format USER@REALM!TOKENID=UUID

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

//if you want use lite version only get/set/create/delete use PveClientBase

var client = new PveClient("10.92.90.91");
if (await client.Login("root", "password"))
{
    var vm = await client.Nodes["pve1"].Qemu[100];

    //config vm
    var config = await vm.Config.VmConfig();
    Console.WriteLine(JsonConvert.SerializeObject(config.Response,Formatting.Indented));

    //create snapshot
    var response = await vm.Snapshot.Snapshot("pippo2311");

    //update snapshot description
    await vm.Snapshot["pippo2311"].Config.UpdateSnapshotConfig("description");

    //delete snapshot
    await vm.Snapshot["pippo2311"].Delsnapshot();

    //list of snapshot
    foreach (var snapshot in (await vm.Snapshot.SnapshotList()).Response.data)
    {
        Console.WriteLine(JsonConvert.SerializeObject(snapshot,Formatting.Indented));
        Console.WriteLine(snapshot.name);
    }

    //change response type from json to png
    client.ResponseType = "png";
    var dataImg = client.Nodes["pve1"].Rrd.Rrd("cpu", "day").Response;
    Console.WriteLine("<img src=\"{dataImg}\" \>");
}

//using Api Token
var client = new PveClient("10.92.100.33");
client.ApiToken = "root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f";
var version = await client.Version.Version();
Console.WriteLine(JsonConvert.SerializeObject(version.Response.data, Formatting.Indented));

Corsinvest.ProxmoxVE.Extension

Extension add functionality on Api.

  • ApiExplorer
  • Retrive VM/CT data from name or id
  • Simplify management of VM/CT e.g snapshot
  • Extension method Get to decode json from result e.g Client.Cluster.Status.Get() return IEnumerable<IClusterStatus>

Corsinvest.ProxmoxVE.Shared

Contain model for Json conversion and utility.

Corsinvest.ProxmoxVE.Metadata

Read documentation ProxmoxVE API and extract structure.

Corsinvest.ProxmoxVE.Shell

Utility for console application.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on Corsinvest.ProxmoxVE.Api.Extension:

Package Downloads
Corsinvest.ProxmoxVE.Api.Shell

Corsinvest for Proxmox VE Api Shell

Corsinvest.ProxmoxVE.AutoSnap.Api

Corsinvest for Proxmox VE AutpSnap Api

Corsinvest.ProxmoxVE.Diagnostic.Api

Corsinvest for Proxmox VE Diagnostic Api

Corsinvest.ProxmoxVE.Metrics.Exporter.Api

Corsinvest for Proxmox VE Metrics Exporter Api

Corsinvest.ProxmoxVE.TelegramBot.Api

Corsinvest for Proxmox VE Botgram Api

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Corsinvest.ProxmoxVE.Api.Extension:

Repository Stars
Corsinvest/cv4pve-autosnap
Automatic snapshot tool for Proxmox VE
Version Downloads Last updated
7.3.7 93 9/7/2022
7.3.6 198 6/16/2022
7.3.5 109 6/14/2022
7.3.4 204 5/27/2022
7.3.2 239 5/3/2022
7.3.1 137 4/26/2022
7.3.0 181 4/5/2022
3.2.0 231 1/31/2022
3.1.3 294 1/4/2022
3.1.2 176 12/16/2021
3.1.1 172 12/16/2021
3.1.0 490 12/6/2021
3.0.0 517 10/31/2021
2.8.0 793 4/28/2021
2.7.0 636 12/15/2020
2.6.11 541 10/19/2020
2.6.10 329 10/15/2020
2.6.9 758 10/12/2020
2.6.8 342 9/28/2020
2.6.7 908 9/28/2020
2.6.6 342 9/25/2020
2.6.5 715 8/24/2020
2.6.2 750 7/30/2020
2.6.1 616 7/20/2020
2.6.0 725 7/17/2020
2.5.7 577 7/14/2020
2.5.6 367 7/13/2020
2.5.4 396 6/22/2020
2.5.3 1,026 6/20/2020
2.5.2 403 6/20/2020
2.5.1 425 6/20/2020
2.5.0 423 6/20/2020
2.4.0 817 5/12/2020
2.3.3 396 5/10/2020
2.3.1 428 5/8/2020
2.3.0 1,011 4/16/2020
2.2.3 724 2/21/2020
2.2.2 732 1/30/2020
2.2.1 490 12/27/2019
2.2.0 544 12/17/2019
2.1.0 377 10/22/2019
2.0.0 357 10/9/2019
1.2.0 371 9/5/2019
1.1.3 395 8/26/2019
1.1.2 479 7/4/2019
1.1.1 376 7/4/2019
1.1.0 510 7/2/2019