Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Corsinvest/cv4pve-api-dotnet
Proxmox VE Client API .Net C#
https://github.com/Corsinvest/cv4pve-api-dotnet
api api-client api-gateway api-rest dotnet dotnet-core dotnet-standard enterprise lxc nuget proxmox proxmox-apis proxmox-cluster proxmox-ve proxmoxve pve qemu web-api
Last synced: 3 days ago
JSON representation
Proxmox VE Client API .Net C#
- Host: GitHub
- URL: https://github.com/Corsinvest/cv4pve-api-dotnet
- Owner: Corsinvest
- License: gpl-3.0
- Created: 2017-09-02T23:22:50.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T14:34:22.000Z (about 2 months ago)
- Last Synced: 2024-10-31T15:53:31.715Z (5 days ago)
- Topics: api, api-client, api-gateway, api-rest, dotnet, dotnet-core, dotnet-standard, enterprise, lxc, nuget, proxmox, proxmox-apis, proxmox-cluster, proxmox-ve, proxmoxve, pve, qemu, web-api
- Language: C#
- Homepage: https://www.corsinvest.it/cv4pve
- Size: 1.07 MB
- Stars: 61
- Watchers: 5
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-proxmox-ve - cv4pve-api-dotnet
README
# Corsinvest.ProxmoxVE.Api
[](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.Api) [](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.Api.Extension) [](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.Api.Metadata) [](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.Api.Shell) [](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.Api.Shared)
Proxmox VE Client API .Net
[Proxmox VE Api](https://pve.proxmox.com/pve-docs/api-viewer/)
```text
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
Corsinvest for Proxmox VE Api Client (Made in Italy)
```
## Copyright and License
Copyright: Corsinvest Srl
For licensing details please visit [LICENSE](LICENSE)
## Commercial Support
This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the [site](https://www.corsinvest.it/cv4pve)
## General
The client is generated from a JSON Api on Proxmox VE.
## Main features
* Easy to learn
* Method named
* Implementation respect the [Api structure of Proxmox VE](https://pve.proxmox.com/pve-docs/api-viewer/)
* 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
* Login with One-time password for Two-factor authentication
* Set Timeout for the Connection.
* Validate certificate SSL, default not validate
## Api token
From version 6.2 of Proxmox VE is possible to use [Api token](https://pve.proxmox.com/pve-docs/pveum-plain.html).
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](https://msdn.microsoft.com/en-US/library/system.dynamic.expandoobject(v=vs.110).aspx)
* **ResponseToDictionary** return response to dictionary ```IDictionary```
* **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:
```json
{
"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
```C#
//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("
");
}
//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**
## 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.