Commit 7c9bf5b3 authored by Jennifer Graul's avatar Jennifer Graul
Browse files

added readme

parent 444fb842
# Proxmox Doku Generator
Dieses Python-Script erzeugt mit Hilfe der Proxmox-API eine Dokuwiki-Tabelle für alle VMs eines angegebenen Nodes mit deren Eigenschaften.
## Benutzung
Die möglichen Parameter und ihre Bedeutung können mittels
```
python3 genproxmoxdoku.py --help
```
abgerufen werden.
Einige Beispiele für die Benutzung des Scripts:
- Anmeldung an der API mit Passwort in der Datei **apipass.txt**
- ```python3 genproxmoxdoku.py -u api@pve --passfile apipass.txt -n ritalin --host ritalin.fem.tu-ilmenau.de```
- Anmeldung an der API und das Passwort soll abgefragt werden:
- ```python3 genproxmoxdoku.py -u api@pve --askpass -n ritalin --host ritalin.fem.tu-ilmenau.de```
## Benötigte minimale Berechtigungen für einen API-Nutzer
Wenn ein API-Nutzer mit möglichst wenigen Rechten benutzt werden soll um diese Doku zu generieren, muss er mindestens folgende Berechtigungen haben:
| Path | Role |
|:-------:|:--------------------:|
| /access | PVEAuditor (Builtin) |
| /nodes | PVEAuditor (Builtin) |
| /vms | PVEAuditor (Builtin) |
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment