Corsinvest.ProxmoxVE.Diagnostic.Api 1.5.9

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

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

cv4pve-diag

License

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


  Diagnostic for Proxmox VE                      (Made in Italy)

  cv4pve-diag is a part of suite cv4pve.
  For more information visit https://www.corsinvest.it/cv4pve

Usage:
  cv4pve-diag [command] [options]

Options:
  --api-token <api-token>                            Api token format 'USER@REALM!TOKENID=UUID'. Require Proxmox VE 6.2 or later
  --username <username>                              User name <username>@<realm>
  --password <password>                              The password. Specify 'file:path_file' to store password in file.
  --host <host> (REQUIRED)                           The host name host[:port],host1[:port],host2[:port]
  --settings-file <settings-file>                    File settings (generated from create-settings)
  --ignored-issues-file <ignored-issues-file>        File ignored issues (generated from create-ignored-issues)
  --ignored-issues-show                              Show second table with ignored issue
  -o, --output <Html|Json|JsonPretty|Markdown|Text>  Type output [default: Text]
  --version                                          Show version information
  -?, -h, --help                                     Show help and usage information

Commands:
  create-settings        Create file settings (settings.json)
  create-ignored-issues  Create File ignored issues (ignored-issues.json)
  export-collect         Export collect data collect to data.json
  execute                Execute diagnostic and print result to console

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

Commercial Support

This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the site

Tutorial

Tutorial

Introduction

Diagnostic for Proxmox VE.

this software collect data from Proxmox VE and output list of Warning/Critical/Info message.

Main features

  • Completely written in C#
  • Use native api REST Proxmox VE (library C#)
  • Independent os (Windows, Linux, Macosx)
  • Installation unzip file extract binary
  • Not require installation in Proxmox VE
  • Execute out side Proxmox VE
  • Custom settings from file --settings-file
  • Ignore issue from file --ignored-issues-file
  • Use Api token --api-token parameter
  • Execution with file parameter e.g. @FileParameter.parm

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.

Configuration

E.g. install on linux 64

Download last package e.g. Debian cv4pve-diag-linux-x64.zip, on your os and install:

root@debian:~# unzip cv4pve-diag-linux-x64.zip

This tool need basically no configuration.

root@debian:~# cv4pve-diag --host=192.168.0.100 --username=root@pam --password=fagiano
-------------------------------------------------------------------------------------------------------------------------------------
| Id                             | Description                                                  | Context | SubContext   | Gravity  |
-------------------------------------------------------------------------------------------------------------------------------------
| pve2                           | 1 Replication has errors                                     | Node    | Replication  | Critical |
| pve2                           | Zfs 'rpool' health problem                                   | Node    | Zfs          | Critical |
| 312                            | Unknown resource qemu                                        | Qemu    | Status       | Critical |
| pve3                           | Node not online                                              | Node    | Status       | Warning  |
| local-zfs:vm-117-disk-1        | Image Orphaned                                               | Storage | Image        | Warning  |
| local-zfs:vm-105-disk-3        | Image Orphaned                                               | Storage | Image        | Warning  |
| 121                            | Qemu Agent not enabled                                       | Qemu    | Agent        | Warning  |
| 101                            | OS 'XP/2003' not mantained from vendor!                      | Qemu    | Agent        | Warning  |
| 101                            | Qemu Agent not enabled                                       | Qemu    | Agent        | Warning  |
| 103                            | cv4pve-autosnap not configured                               | Qemu    | AutoSnapshot | Warning  |
| 115                            | vzdump backup not configured                                 | Qemu    | Backup       | Warning  |
| 205                            | vzdump backup not configured                                 | Qemu    | Backup       | Warning  |
| 103                            | vzdump backup not configured                                 | Qemu    | Backup       | Warning  |
| 313                            | vzdump backup not configured                                 | Qemu    | Backup       | Warning  |
| 117                            | Unused disk0                                                 | Qemu    | Hardware     | Warning  |
| 115                            | Cdrom mounted                                                | Qemu    | Hardware     | Warning  |
| 121                            | 10 snapshots older than 1 month                              | Qemu    | Snapshot     | Warning  |
| 313                            | 10 snapshots older than 1 month                              | Qemu    | Snapshot     | Warning  |
| 500                            | Start on boot not enabled                                    | Qemu    | StartOnBoot  | Warning  |
| 117                            | Start on boot not enabled                                    | Qemu    | StartOnBoot  | Warning  |
| 114                            | 10 snapshots older than 1 month                              | Lxc     | Snapshot     | Warning  |
| pve1                           | 3 Update availble                                            | Node    | Update       | Info     |
| pve2                           | 6 Update availble                                            | Node    | Update       | Info     |
| 109                            | For more performance switch 'scsi0' hdd to VirtIO            | Qemu    | VirtIO       | Info     |
-------------------------------------------------------------------------------------------------------------------------------------

Settings

For change default settings can create file using create-settings command. Edit settings.json file and execute new settings using parameter --settings-file.

Ignore Issue

For ignore issues create file using create-ignored-issues command. Edit ignored-issues.json file and execute using parameter --ignored-issues-file. The regex rule is used for match in Id,SubContext,Description.

[
  {
    "Id": "105",
    "Context": "Qemu",
    "SubContext": "Protection",
    "Description": null,
    "Gravity": "Critical"
  }
]

Execution with file parameter

Is possible execute with file parameter

root@debian:~# cv4pve-diag @FileParameter.parm

File FileParameter.parm

--host=192.168.0.100
--username=root@pam
--password=fagiano
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

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

Repository Stars
Corsinvest/cv4pve-admin
Corsinvest for Proxmox VE Web Admin Clusters - vCenter but for Proxmoxm VE
Version Downloads Last updated
1.6.2 137 9/19/2024
1.6.1 177 4/30/2024
1.6.0 133 2/29/2024
1.5.11 404 6/19/2023
1.5.10 183 6/16/2023
1.5.9 221 5/10/2023
1.5.8 184 5/5/2023
1.5.6 543 6/16/2022
1.5.5 470 6/16/2022
1.5.4 486 6/14/2022
1.5.3 470 5/27/2022
1.5.2 457 5/27/2022
1.5.1 362 12/16/2021
1.5.0 388 4/29/2021
1.4.11 418 1/15/2021
1.4.10 447 1/15/2021
1.4.9 464 12/18/2020
1.4.8 518 11/29/2020
1.4.7 459 11/24/2020
1.4.6 540 10/12/2020
1.4.5 480 9/28/2020
1.4.4 515 8/24/2020
1.4.3 506 7/30/2020
1.4.2 527 7/20/2020
1.4.1 504 7/20/2020
1.4.0 496 7/17/2020
1.3.2 486 7/14/2020
1.3.1 485 7/13/2020
1.3.0 512 6/20/2020
1.2.0 574 5/20/2020
1.1.0 529 5/12/2020
1.0.2 546 5/7/2020
1.0.1 496 5/5/2020
1.0.0 504 4/24/2020