Files
dockernet-inspector/docs/usage.md

60 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Verwendung
Das Script kann auf zwei Arten verwendet werden.
## Interaktiver Modus (Menü)
```bash
bash ./dockernet-inspector.v1.sh
```
Das Script startet ein interaktives Menü mit folgenden Optionen:
- **1** Alle Netzwerke auflisten
- **2** Detaillierte Infos zu einem Netzwerk (mit Netzwerk-Auswahl)
- **3** IPs eines Netzwerks anzeigen (mit Netzwerk-Auswahl)
- **4** Alle belegten IPs anzeigen
- **5** Ungenutzte Netzwerke anzeigen
- **6** Netzwerke löschen
- **7** Alle ungenutzten, löschbaren Netzwerke löschen
- **0** Beenden
Bei den Optionen **2** und **3** wird eine Netzwerkliste angezeigt, aus der per Nummer ausgewählt werden kann.
## Kommandozeilen-Modus (CLI)
```bash
bash ./dockernet-inspector.v1.sh [BEFEHL] [OPTIONEN]
```
### Verfügbare Befehle
| Befehl | Beschreibung |
|--------|--------------|
| *(keine)* | Startet den interaktiven Modus |
| `networks` | Listet alle verfügbaren Docker-Netzwerke auf |
| `inspect <netzwerk>` | Zeigt detaillierte Informationen zu einem Netzwerk |
| `ips <netzwerk>` | Zeigt alle belegten IPv4-Adressen im angegebenen Netzwerk |
| `ips-all` | Zeigt alle belegten IPv4-Adressen in allen Docker-Netzwerken (aufsteigend sortiert) |
| `unused-networks` | Zeigt alle Docker-Netzwerke ohne verbundene Container |
| `delete-networks` | Löscht ein interaktiv ausgewähltes Netzwerk |
| `delete-unused-networks` | Löscht alle ungenutzten, löschbaren Docker-Netzwerke nach Bestätigung |
| `<netzwerk>` | Alias für `inspect <netzwerk>` (Rückwärtskompatibilität) |
| `help`, `-h`, `--help` | Zeigt die Hilfe an |
### Kurzbeispiele
```bash
bash ./dockernet-inspector.v1.sh networks
bash ./dockernet-inspector.v1.sh inspect bridge
bash ./dockernet-inspector.v1.sh my-custom-network
bash ./dockernet-inspector.v1.sh ips dockernet
bash ./dockernet-inspector.v1.sh ips-all
bash ./dockernet-inspector.v1.sh unused-networks
bash ./dockernet-inspector.v1.sh delete-networks
bash ./dockernet-inspector.v1.sh delete-unused-networks
bash ./dockernet-inspector.v1.sh help
```
Ausführliche Ausgabe-Beispiele sind in [examples.md](examples.md) zu finden.