Corsinvest.ProxmoxVE.Api.Extension 1.1.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package Corsinvest.ProxmoxVE.Api.Extension --version 1.1.2
NuGet\Install-Package Corsinvest.ProxmoxVE.Api.Extension -Version 1.1.2
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.Extension" Version="1.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Corsinvest.ProxmoxVE.Api.Extension --version 1.1.2
#r "nuget: Corsinvest.ProxmoxVE.Api.Extension, 1.1.2"
#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.Extension as a Cake Addin
#addin nuget:?package=Corsinvest.ProxmoxVE.Api.Extension&version=1.1.2

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

Corsinvest.ProxmoxVE.Api

License GitHub release AppVeyor branch

ProxmoVE Client API .Net

ProxmoxVE Api

Nuget Api

Nuget Extension

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

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 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.

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

Package Description

Corsinvest.ProxmoxVE.Diagnostic.Api

Corsinvest for Proxmox VE Diagnostic Api

Corsinvest.ProxmoxVE.Metrics.Exporter.Api

Corsinvest for Proxmox VE Metrics Exporter Api

Corsinvest.ProxmoxVE.NodeProtect.Api

Corsinvest for Proxmox VE Node Protrect

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
8.1.5 33 3/28/2024
8.1.4 90 3/22/2024
8.1.3 1,173 2/29/2024
8.1.2 79 2/13/2024
8.1.1 68 2/12/2024
8.1.0 2,954 12/11/2023
8.0.3 877 9/22/2023
8.0.2 262 9/18/2023
8.0.1 272 8/11/2023
8.0.0 263 6/23/2023
7.4.6 1,063 6/16/2023
7.4.5 208 6/8/2023
7.4.4 621 5/29/2023
7.4.3 291 5/10/2023
7.4.2 185 5/5/2023
7.4.1 460 4/14/2023
7.4.0 290 3/23/2023
7.3.8 600 11/3/2022
7.3.7 1,078 9/7/2022
7.3.6 1,256 6/16/2022
7.3.5 600 6/14/2022
7.3.4 3,104 5/27/2022
7.3.2 941 5/3/2022
7.3.1 751 4/26/2022
7.3.0 711 4/5/2022
3.2.0 845 1/31/2022
3.1.3 1,172 1/4/2022
3.1.2 477 12/16/2021
3.1.1 479 12/16/2021
3.1.0 821 12/6/2021
3.0.0 1,121 10/31/2021
2.8.0 1,532 4/28/2021
2.7.0 1,401 12/15/2020
2.6.11 985 10/19/2020
2.6.10 683 10/15/2020
2.6.9 1,587 10/12/2020
2.6.8 696 9/28/2020
2.6.7 1,860 9/28/2020
2.6.6 667 9/25/2020
2.6.5 1,359 8/24/2020
2.6.2 1,399 7/30/2020
2.6.1 1,301 7/20/2020
2.6.0 1,369 7/17/2020
2.5.7 1,170 7/14/2020
2.5.6 720 7/13/2020
2.5.4 679 6/22/2020
2.5.3 1,898 6/20/2020
2.5.2 734 6/20/2020
2.5.1 764 6/20/2020
2.5.0 753 6/20/2020
2.4.0 1,583 5/12/2020
2.3.3 745 5/10/2020
2.3.1 755 5/8/2020
2.3.0 1,880 4/16/2020
2.2.3 1,398 2/21/2020
2.2.2 1,233 1/30/2020
2.2.1 932 12/27/2019
2.2.0 966 12/17/2019
2.1.0 582 10/22/2019
2.0.0 575 10/9/2019
1.2.0 605 9/5/2019
1.1.3 615 8/26/2019
1.1.2 805 7/4/2019
1.1.1 620 7/4/2019
1.1.0 910 7/2/2019