Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Corsinvest/cv4pve-diag
Diagnostic tool for Proxmox VE
https://github.com/Corsinvest/cv4pve-diag
diagnostic kvm lxc proxmox proxmox-cluster proxmox-ve qemu
Last synced: 3 days ago
JSON representation
Diagnostic tool for Proxmox VE
- Host: GitHub
- URL: https://github.com/Corsinvest/cv4pve-diag
- Owner: Corsinvest
- License: gpl-3.0
- Created: 2019-10-30T17:30:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T14:52:12.000Z (about 2 months ago)
- Last Synced: 2024-09-19T15:09:18.324Z (about 2 months ago)
- Topics: diagnostic, kvm, lxc, proxmox, proxmox-cluster, proxmox-ve, qemu
- Language: C#
- Homepage: https://www.corsinvest.it/cv4pve
- Size: 143 KB
- Stars: 23
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-proxmox-ve - cv4pve-diag
README
# cv4pve-diag
[](LICENSE.md) 
```text
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
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 format 'USER@REALM!TOKENID=UUID'. Require Proxmox VE 6.2 or later
--username User name @
--password The password. Specify 'file:path_file' to store password in file.
--validate-certificate Validate SSL Certificate Proxmox VE node.
--host (REQUIRED) The host name host[:port],host1[:port],host2[:port]
--settings-file File settings (generated from create-settings)
--ignored-issues-file File ignored issues (generated from create-ignored-issues)
--ignored-issues-show Show second table with ignored issue
-o, --output 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 and License
Copyright: Corsinvest Srl
For licensing details please visit [LICENSE.md](LICENSE.md)
## 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)
## Tutorial
[](https://www.youtube.com/watch?v=hn1nw9KXlsg&feature=youtu.be "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
* Validate certificate SSL, default not validate
## Web GUI Version in cv4pve-admin
[](https://github.com/Corsinvest/cv4pve-admin)
## 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.
## Configuration
Supports Linux, Windows, OSX and ARM
Install on Linux x64
Step 1 - Download the Lastest Zip File cv4pve-diag-linux-x64.zip to a Directory of your Choice:
wget https://github.com/Corsinvest/cv4pve-diag/releases/download/x.x.x/cv4pve-diag-linux-x64.zip
NOTE: x.x.x is the Version Number
Example for v1.4.8:
root@debian:/# wget https://github.com/Corsinvest/cv4pve-diag/releases/download/v1.4.8/cv4pve-diag-linux-x64.zip
```sh
Step 2 - Unzip cv4pve-diag-linux-x64.zip to a Directory of your Choice:
root@debian:/# unzip cv4pve-diag-linux-x64.zip
Step 3 - Chmod cv4pve-diag to Add Persmissions to Execute cv4pve-diag:
root@debian:/# chmod +x cv4pve-diag
NOTE: This Allows Owner\Group\Others to Execute cv4pve-diag
```
Step 4 - Run the Diagnostic Tool:
NOTE: Use ./ in front of the the Command cv4pve-diag if you are in the same Directory as cv4pve-diag.
If you are at the Root Directory, use the Directory Path to cv4pve-diag
```sh
Example Running Tool within its Directory:
root@debian:/cv4pvediag# ./cv4pve-diag --output=Text --host=192.168.0.100:8006 --username=root@pam --password=password execute
NOTE: Use ./ in front of the the Command cv4pve-diag if you are in the same Directory as cv4pve-diag.
Example Running from the Root Directory:
root@debian:/# /cv4pvediag/cv4pve-diag --output=Text --host=192.168.0.100:8006 --username=root@pam --password=password execute
NOTE: If you are at the Root Directory, use the Directory Path to Run cv4pve-diag
Attention: There is a Slight Delay when using the Tool due to Processing the Information. Please wait for Data to Display.
```
Install on Windows x86 and x64
```sh
Step 1 - Download the Lastest Zip File cv4pve-diag.exe-win-x64.zip or
cv4pve-diag.exe-win-x86.zip to a Directory of your Choice:
x86 Version:
Option A - Click On File to Download: https://github.com/Corsinvest/cv4pve-diag/releases
NOTE: Select under Assets and Choose Lastest Version
Option B - Direct Downlod: https://github.com/Corsinvest/cv4pve-diag/releases/download/x.x.x/cv4pve-diag.exe-win-x86.zip
NOTE: x.x.x is the Version Number
Example Option B for v1.4.8:
https://github.com/Corsinvest/cv4pve-diag/releases/download/v1.4.8/cv4pve-diag.exe-win-x86.zip
x64 Version:
Option A - Click On File to Download: https://github.com/Corsinvest/cv4pve-diag/releases
NOTE: Select under Assets and Choose Lastest Version
Option B - Direct Downlod: https://github.com/Corsinvest/cv4pve-diag/releases/download/x.x.x/cv4pve-diag.exe-win-x64.zip
NOTE: x.x.x is the Version Number
Example Option B for v1.4.8:
https://github.com/Corsinvest/cv4pve-diag/releases/download/v1.4.8/cv4pve-diag.exe-win-x64.zip
Step 2 - Run the Diagnostic Tool:
Example for x86 Version Running in PowerShell:
C:\cv4pve-diag.exe-win-x86> .\cv4pve-diag --output=Text --host=192.168.0.100:8006 --username=root@pam --password=password execute
NOTE: The .\ in front of the Command cv4pve-diag is needed.
It is Recommened to Run the Tool in PowerShell
when Outputing in Text Mode for proper Displaying of the Data.
You can use CMD(DOS Terminal) however there is a Limatation of Displaying correctly.
Example for x86 Version Running in CMD(DOS Terminal):
C:\cv4pve-diag.exe-win-x86> cv4pve-diag --output=Text --host=192.168.0.100:8006 --username=root@pam --password=password execute
NOTE: .\ in front of the Command cv4pve-diag is not needed.
Attention: There is a Slight Delay when using the Tool due to Processing the Information. Please wait for Data to Display.
```
```txt
OUTPUT OF CV4PVE-DIAG DATA
-------------------------------------------------------------------------------------------------------------------------------------
| 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.
```json
[
{
"Id": "105",
"Context": "Qemu",
"SubContext": "Protection",
"Description": null,
"Gravity": "Critical"
}
]
```
## Execution with file parameter
Is possible execute with file parameter
```sh
root@debian:~# cv4pve-diag @FileParameter.parm
```
File **FileParameter.parm**
```txt
--host=192.168.0.100:8006
--username=root@pam
--password=password
```