Feture Requests #18

Closed
opened 2026-10-28 07:21:29 +00:00 by Sebi · 0 comments
Owner

netssh – Feature Requests

Die folgenden Requests sind beim Neuinstallieren und im täglichen Einsatz von netssh entstanden (Cache mit ~4300 Hosts, zsh mit oh-my-zsh). Jeder Abschnitt ist als eigenes Issue gedacht. Domains, IPs und Hostnamen sind durch neutrale Beispiele ersetzt (example.com, 203.0.113.x).


1. zsh-Completion ist bei vielen Hosts unbenutzbar langsam

Problem
Bei einem Cache mit ~4300 Hosts hängt netssh <Tab> in zsh über 20 Sekunden, praktisch also endlos. Das Binary selbst ist schnell: netssh __complete '' braucht ~0,01 s. Die Zeit geht komplett im Skript verloren, das netssh completion zsh erzeugt (der Cobra-Standard).

Ursache

  • Die Einleseschleife startet für jede Zeile eine Subshell (local tab="$(printf '\t')"). Bei ~4300 Einträgen dauert das allein ~2,2 s.
  • Danach gehen alle Einträge durch _describe. Das skaliert bei Tausenden Einträgen sehr schlecht.

Reproduktion

  1. Einen Cache mit mehreren Tausend Hosts anlegen.
  2. netssh completion zsh > "$fpath[1]/_netssh" ausführen, dann exec zsh.
  3. netssh <Tab> drücken: Die Shell hängt.

Vorschlag

  • Ein eigenes, schlankes zsh-Completion-Skript mitliefern statt des Cobra-Standards: Unterbefehle mit Beschreibung über _describe, Hosts ohne Beschreibung direkt über compadd.

  • Workaround, der funktioniert (Antwort in ~0,2 s statt >20 s):

    _netssh_fast() {
      local -a lines cmds hosts
      local directive
      lines=(${(f)"$(netssh __complete "${(@)words[2,CURRENT]}" 2>/dev/null)"})
      directive=${${(M)lines:#:*}[-1]#:}
      lines=(${lines:#:*})
      cmds=(${(M)lines:#*$'\t'*})
      hosts=(${lines:#*$'\t'*})
      cmds=(${cmds//:/\\:}); cmds=(${cmds//$'\t'/:})
      (( $#cmds )) && _describe -t commands 'netssh command' cmds
      (( $#hosts )) && compadd -J hosts -X '%Bhosts%b' -- $hosts
      (( $#lines )) || (( ${directive:-0} & 4 )) || _files
    }
    compdef _netssh_fast netssh
    
  • Optional: Host-Vorschläge erst ab einem Präfix liefern oder ihre Anzahl begrenzen (z. B. completion.max_results).

Akzeptanzkriterium: netssh <Tab> antwortet bei 5000 Hosts in unter 0,5 s.


2. Installer richtet unter zsh keine Completion ein

Problem
Der Installer legt nur eine Bash-Completion an (~/.local/share/bash-completion/completions/netssh). zsh lädt diese Datei nicht. Deshalb zeigt Tab nur Dateien an statt Hosts. Den Block in ~/.zshrc schreibt der Installer aber, er erkennt zsh also.

Vorschlag

  • Die Shell erkennen und für zsh die Completion aus Punkt 1 in ein Verzeichnis aus fpath legen, z. B. ~/.zfunc oder $ZSH_CACHE_DIR/completions bei oh-my-zsh. Alternativ im zshrc-Block per compdef registrieren.
  • Am Ende ausgeben, welche Completion für welche Shell eingerichtet wurde.
  • Hinweis ausgeben, dass ~/.zcompdump gelöscht oder compinit neu ausgeführt werden muss.

3. Kein uninstall / sauberes Neuinstallieren

Problem
Nach mehreren Versionen lagen Reste an vielen Stellen verteilt. Einige stammten aus älteren Versionen und hatten ein anderes Format:

  • Binary in /usr/local/bin/netssh
  • Zeilen in ~/.bashrc und ~/.zshrc, ältere Versionen ohne Markierung, neuere mit # >>> netssh >>>
  • ~/.config/netssh.yaml
  • ~/.cache/netssh/ mit wechselnder Struktur (hosts.json direkt bzw. instances-<hash>/hosts.json)
  • Completion-Dateien für bash und zsh

Das musste alles von Hand gesucht und entfernt werden.

Vorschlag

  • netssh uninstall [--keep-config] einführen. Der Befehl entfernt alle oben genannten Teile, auch Zeilen alter Versionen ohne Markierung. Das Regex dafür steckt schon im Binary.
  • Rc-Einträge in jeder Version mit # >>> netssh >>> / # <<< netssh <<< markieren und bei Updates alte Einträge ersetzen statt neue anzuhängen.
  • Vor dem Entfernen ein Backup der Config anlegen (sie enthält den API-Token).

4. Jumphost / ProxyJump-Unterstützung

Problem
In vielen Umgebungen sind Server nur über einen Jumphost erreichbar. netssh verbindet sich immer direkt. Da netssh die IP-Adresse an ssh übergibt (siehe Punkt 6), greifen auch vorhandene Host *.example.com-Regeln mit ProxyJump in ~/.ssh/config nicht. Andere Tools mit fest eingebautem -o ProxyJump=… funktionieren, netssh schlägt beim selben Host fehl.

Workaround
Alle IP-Bereiche aus dem Cache als Muster in ~/.ssh/config eintragen (Host 203.* 198.* … + ProxyJump). Das ist fehleranfällig und muss bei neuen Netzen von Hand ergänzt werden.

Vorschlag

ssh:
  proxy_jump: "jumphost.example.com"     # global
netboxes:
  - name: "prod"
    url: "https://netbox.example.com"
    ssh:
      proxy_jump: "jumphost.example.com" # pro Instanz überschreibbar
  • Zusätzlich das Flag --jump/-J <host> und --no-jump für einzelne Aufrufe.
  • Optional Regeln nach NetBox-Attributen (Site, Tag, Rolle, Tenant), z. B. rules: [{match: {tag: "dmz"}, proxy_jump: "…"}].

5. Host-Key-Prüfung konfigurierbar machen

Problem
Server werden häufig neu installiert, und IPs werden wiederverwendet. Fingerprints ändern sich deshalb ständig, und ssh bricht mit „REMOTE HOST IDENTIFICATION HAS CHANGED“ ab. netssh bietet keine Einstellung dafür. Die einzige Lösung ist eine globale Änderung in ~/.ssh/config, die dann auch für alle anderen ssh-Verbindungen gilt (Git usw.).

Vorschlag

ssh:
  host_key_checking: strict | accept-new | off   # Standard: strict
  • off setzt -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=ERROR, aber nur für netssh-Verbindungen.
  • Auch pro NetBox-Instanz einstellbar, z. B. off für Staging und strict für Produktion.
  • Bei off beim Verbinden einen kurzen Hinweis ausgeben.

6. Verbindungsziel: IP vs. Hostname / HostKeyAlias

Problem
netssh übergibt ssh <user>@<primary_ip>. Das hat Nebenwirkungen:

  • Host-Regeln in ~/.ssh/config mit Hostnamen-Mustern greifen nicht (siehe Punkt 4).
  • known_hosts-Einträge laufen über die IP. Wird die IP einem anderen Server zugewiesen, kommt es zu Fingerprint-Konflikten.

Vorschlag

  • Option ssh.target: ip | hostname (Standard: ip).
  • Bei ip zusätzlich -o HostKeyAlias=<netbox-name> und -o HostName=<ip> setzen, ssh mit dem Hostnamen als Ziel aufrufen. So funktionieren Hostnamen-Regeln in ~/.ssh/config und known_hosts-Einträge pro Gerät.
  • Optional ssh.address_family: any | inet | inet6 für Umgebungen, in denen IPv6 nicht erreichbar ist (-4 / -6).

7. Freie ssh-Optionen in der Config

Problem
Unbekannte Flags reicht netssh zwar an ssh weiter. Es gibt aber keinen Weg, Optionen dauerhaft pro netssh oder pro Instanz zu setzen, ohne ~/.ssh/config global zu ändern.

Vorschlag

ssh:
  extra_args: ["-4"]
  options:
    ServerAliveInterval: 60
    ServerAliveCountMax: 5

Das wäre auch die allgemeine Grundlage für die Punkte 4 und 5.


8. Kleinigkeiten

  • netssh --version fehlt. Der Aufruf wird an ssh durchgereicht, und es kommt die ssh-Fehlermeldung unknown option -- -. Gerade beim Neuinstallieren nach mehreren Versionen ist es wichtig zu sehen, welche Version installiert ist. Vorschlag: netssh version bzw. --version abfangen.
  • Kein Dry-Run. Ein netssh --dry-run <host> sollte den fertigen ssh-Befehl ausgeben. Das hilft bei Fehlern wie in Punkt 4. Bisher geht das nur über den Umweg netssh -G <host>.
# netssh – Feature Requests Die folgenden Requests sind beim Neuinstallieren und im täglichen Einsatz von netssh entstanden (Cache mit ~4300 Hosts, zsh mit oh-my-zsh). Jeder Abschnitt ist als eigenes Issue gedacht. Domains, IPs und Hostnamen sind durch neutrale Beispiele ersetzt (`example.com`, `203.0.113.x`). --- ## 1. zsh-Completion ist bei vielen Hosts unbenutzbar langsam **Problem** Bei einem Cache mit ~4300 Hosts hängt `netssh <Tab>` in zsh über 20 Sekunden, praktisch also endlos. Das Binary selbst ist schnell: `netssh __complete ''` braucht ~0,01 s. Die Zeit geht komplett im Skript verloren, das `netssh completion zsh` erzeugt (der Cobra-Standard). **Ursache** - Die Einleseschleife startet für jede Zeile eine Subshell (`local tab="$(printf '\t')"`). Bei ~4300 Einträgen dauert das allein ~2,2 s. - Danach gehen alle Einträge durch `_describe`. Das skaliert bei Tausenden Einträgen sehr schlecht. **Reproduktion** 1. Einen Cache mit mehreren Tausend Hosts anlegen. 2. `netssh completion zsh > "$fpath[1]/_netssh"` ausführen, dann `exec zsh`. 3. `netssh <Tab>` drücken: Die Shell hängt. **Vorschlag** - Ein eigenes, schlankes zsh-Completion-Skript mitliefern statt des Cobra-Standards: Unterbefehle mit Beschreibung über `_describe`, Hosts ohne Beschreibung direkt über `compadd`. - Workaround, der funktioniert (Antwort in ~0,2 s statt >20 s): ```zsh _netssh_fast() { local -a lines cmds hosts local directive lines=(${(f)"$(netssh __complete "${(@)words[2,CURRENT]}" 2>/dev/null)"}) directive=${${(M)lines:#:*}[-1]#:} lines=(${lines:#:*}) cmds=(${(M)lines:#*$'\t'*}) hosts=(${lines:#*$'\t'*}) cmds=(${cmds//:/\\:}); cmds=(${cmds//$'\t'/:}) (( $#cmds )) && _describe -t commands 'netssh command' cmds (( $#hosts )) && compadd -J hosts -X '%Bhosts%b' -- $hosts (( $#lines )) || (( ${directive:-0} & 4 )) || _files } compdef _netssh_fast netssh ``` - Optional: Host-Vorschläge erst ab einem Präfix liefern oder ihre Anzahl begrenzen (z. B. `completion.max_results`). **Akzeptanzkriterium:** `netssh <Tab>` antwortet bei 5000 Hosts in unter 0,5 s. --- ## 2. Installer richtet unter zsh keine Completion ein **Problem** Der Installer legt nur eine Bash-Completion an (`~/.local/share/bash-completion/completions/netssh`). zsh lädt diese Datei nicht. Deshalb zeigt Tab nur Dateien an statt Hosts. Den Block in `~/.zshrc` schreibt der Installer aber, er erkennt zsh also. **Vorschlag** - Die Shell erkennen und für zsh die Completion aus Punkt 1 in ein Verzeichnis aus `fpath` legen, z. B. `~/.zfunc` oder `$ZSH_CACHE_DIR/completions` bei oh-my-zsh. Alternativ im zshrc-Block per `compdef` registrieren. - Am Ende ausgeben, welche Completion für welche Shell eingerichtet wurde. - Hinweis ausgeben, dass `~/.zcompdump` gelöscht oder `compinit` neu ausgeführt werden muss. --- ## 3. Kein `uninstall` / sauberes Neuinstallieren **Problem** Nach mehreren Versionen lagen Reste an vielen Stellen verteilt. Einige stammten aus älteren Versionen und hatten ein anderes Format: - Binary in `/usr/local/bin/netssh` - Zeilen in `~/.bashrc` **und** `~/.zshrc`, ältere Versionen ohne Markierung, neuere mit `# >>> netssh >>>` - `~/.config/netssh.yaml` - `~/.cache/netssh/` mit wechselnder Struktur (`hosts.json` direkt bzw. `instances-<hash>/hosts.json`) - Completion-Dateien für bash und zsh Das musste alles von Hand gesucht und entfernt werden. **Vorschlag** - `netssh uninstall [--keep-config]` einführen. Der Befehl entfernt alle oben genannten Teile, auch Zeilen alter Versionen ohne Markierung. Das Regex dafür steckt schon im Binary. - Rc-Einträge in jeder Version mit `# >>> netssh >>>` / `# <<< netssh <<<` markieren und bei Updates alte Einträge ersetzen statt neue anzuhängen. - Vor dem Entfernen ein Backup der Config anlegen (sie enthält den API-Token). --- ## 4. Jumphost / ProxyJump-Unterstützung **Problem** In vielen Umgebungen sind Server nur über einen Jumphost erreichbar. netssh verbindet sich immer direkt. Da netssh die **IP-Adresse** an ssh übergibt (siehe Punkt 6), greifen auch vorhandene `Host *.example.com`-Regeln mit `ProxyJump` in `~/.ssh/config` nicht. Andere Tools mit fest eingebautem `-o ProxyJump=…` funktionieren, netssh schlägt beim selben Host fehl. **Workaround** Alle IP-Bereiche aus dem Cache als Muster in `~/.ssh/config` eintragen (`Host 203.* 198.* …` + `ProxyJump`). Das ist fehleranfällig und muss bei neuen Netzen von Hand ergänzt werden. **Vorschlag** ```yaml ssh: proxy_jump: "jumphost.example.com" # global netboxes: - name: "prod" url: "https://netbox.example.com" ssh: proxy_jump: "jumphost.example.com" # pro Instanz überschreibbar ``` - Zusätzlich das Flag `--jump/-J <host>` und `--no-jump` für einzelne Aufrufe. - Optional Regeln nach NetBox-Attributen (Site, Tag, Rolle, Tenant), z. B. `rules: [{match: {tag: "dmz"}, proxy_jump: "…"}]`. --- ## 5. Host-Key-Prüfung konfigurierbar machen **Problem** Server werden häufig neu installiert, und IPs werden wiederverwendet. Fingerprints ändern sich deshalb ständig, und ssh bricht mit „REMOTE HOST IDENTIFICATION HAS CHANGED“ ab. netssh bietet keine Einstellung dafür. Die einzige Lösung ist eine globale Änderung in `~/.ssh/config`, die dann auch für alle anderen ssh-Verbindungen gilt (Git usw.). **Vorschlag** ```yaml ssh: host_key_checking: strict | accept-new | off # Standard: strict ``` - `off` setzt `-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=ERROR`, aber **nur** für netssh-Verbindungen. - Auch pro NetBox-Instanz einstellbar, z. B. `off` für Staging und `strict` für Produktion. - Bei `off` beim Verbinden einen kurzen Hinweis ausgeben. --- ## 6. Verbindungsziel: IP vs. Hostname / `HostKeyAlias` **Problem** netssh übergibt `ssh <user>@<primary_ip>`. Das hat Nebenwirkungen: - `Host`-Regeln in `~/.ssh/config` mit Hostnamen-Mustern greifen nicht (siehe Punkt 4). - known_hosts-Einträge laufen über die IP. Wird die IP einem anderen Server zugewiesen, kommt es zu Fingerprint-Konflikten. **Vorschlag** - Option `ssh.target: ip | hostname` (Standard: `ip`). - Bei `ip` zusätzlich `-o HostKeyAlias=<netbox-name>` und `-o HostName=<ip>` setzen, ssh mit dem Hostnamen als Ziel aufrufen. So funktionieren Hostnamen-Regeln in `~/.ssh/config` und known_hosts-Einträge pro Gerät. - Optional `ssh.address_family: any | inet | inet6` für Umgebungen, in denen IPv6 nicht erreichbar ist (`-4` / `-6`). --- ## 7. Freie ssh-Optionen in der Config **Problem** Unbekannte Flags reicht netssh zwar an ssh weiter. Es gibt aber keinen Weg, Optionen dauerhaft pro netssh oder pro Instanz zu setzen, ohne `~/.ssh/config` global zu ändern. **Vorschlag** ```yaml ssh: extra_args: ["-4"] options: ServerAliveInterval: 60 ServerAliveCountMax: 5 ``` Das wäre auch die allgemeine Grundlage für die Punkte 4 und 5. --- ## 8. Kleinigkeiten - **`netssh --version` fehlt.** Der Aufruf wird an ssh durchgereicht, und es kommt die ssh-Fehlermeldung `unknown option -- -`. Gerade beim Neuinstallieren nach mehreren Versionen ist es wichtig zu sehen, welche Version installiert ist. Vorschlag: `netssh version` bzw. `--version` abfangen. - **Kein Dry-Run.** Ein `netssh --dry-run <host>` sollte den fertigen ssh-Befehl ausgeben. Das hilft bei Fehlern wie in Punkt 4. Bisher geht das nur über den Umweg `netssh -G <host>`.
Sebi closed this issue 2026-11-16 20:18:56 +00:00
Sign in to join this conversation.
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Sebi/ssh-netbox-wrapper#18