Netzwerkdokumentation

  • Hallo,

    mit der Zeit werden viele Netzwerke immer umfangreicher und komplexer.
    Da wird eine gute Dokumentation zunehmend wichtiger um den Überblick nicht zu verlieren.


    Hat hier jemande gute Vorlagen / Tools zur Dokumentation für Dinge wie

    • Belegung Patchpanel
    • Übersicht IP-Adressen / Subnetze
    • VLAN-Dokumentation
    • Netzwerkstruktur
    • HE-Belegung von Netzwerkschränken
    • etc.

    ?

  • Schwieriges Thema! Bin ich auch seit geraumer Zeit dran aber habe noch lange keine perfekte Lösung gefunden.

    Wer Geld ausgeben mag und es wirklich professionell will: Docusnap! Wer das Tool mal richtig kann will nichts anderes mehr. Damit lässt sich auch viel automatisieren und vereinfachen. Eignet sich aber mittlerweile nur noch, wenn man selbst Admin für eine Firma ist. Sobald man mehrere Betreut ist es leider nicht mehr brauchbar von den Kosten her seit dem die ihr Lizenzmodell geändert haben :(

    Meine 'Tools' zur Erstellung von Dokus?
    -Greenshot - für Screenshots
    -Fotos, Fotos, Fotos!
    -LibreOffice / Word / Excel / Visio
    -Testphase DokuWiki

    Ansonsten gehe ich den Weg über - Was passiert, wenn es defekt ist? Jedes gerät anschauen und dann entscheiden, welche Informationen benötigt werden um die grundlegende Funktion wiederherzustellen bzw. es zu ersetzen.

    Was mir als Leitfaden geholfen hat, sind diese Beiträge:

    Informatik-Aktuell.de - In sechs Schritten zur perfekten IT Dokumentation Part 1
    Informatik-Aktuell.de - In sechs Schritten zur perfekten IT Dokumentation Part 2

    Habe eine Kombination aus Word / Excel Listen und Visio Dateien, wobei das derzeit in Test ist in ein DokuWiki zu übertragen.

    Mein Aufbau grundlegend:

    Spoiler anzeigen
    1. Grundübersicht der vorhandenen Netze / VLANs mit wichtigsten Infos wie - VLAN ID, Netzmaske, DHCP, DNS, IP Bereiche, Geräte mit festen IPs
    2. Lageplan, oft hilft ein Google Earth Foto enorm, je nach Geländegröße halt :)

      1. Gebäude & Hallen auflisten mit Netzwerkraum / Schrank Bezeichnung
      2. Verbindungen untereinander und Abhängigkeiten
      3. ggf. WLAN Ausleuchtung / Positionierung der APs mit Fotos
      4. weitere Geräte wie Maschinen, Lagerregale mit IT Anbindung o.Ä.
    3. Übersicht der Netzwerkschranke / Räume
      1. Aufbau Raum / Netzwerkschrank HE
      2. detail Aufbau - Belegung Patchpanel, Anschlussplan Firewall / Server / ...
      3. Funktionsübersicht der Geräte wie Server, Firewall, USB-Device Server, NAS, ... inkl. Zugriffsabhängigkeiten, Backup, Garantiezeiträume, uvm. je nach Bedarf
      4. ggf. VM Dokumentation - was, wie, wo, warum, womit, wofür, Abhängigkeiten Rechte, Zugriffe usw.

      4. Geräte Dokumentation - Drucker - Modell SN, Verbrauchsmaterial, Standort, IP, Firmware, Funktionen (Scan to SMB, Mail, Drucken nur für bestimme User), Maschinen - Wo befindet sich der PC, Anbindung, benötigte Zugänge intern und extern, ggf. Doku Netzwerkkonfiguration und Änderungsmöglichkeit usw.5. Notfall Doku - was ist zu tun bei einem Ausfall / defekt / Wiederanlaufplan


    Das lässt sich irgendwie unendlich erweitern :pinch: Aber meine Erfahrung zeigt - wenn man es gleich von Anfang so angeht, ist der Aufwand garnicht so groß! Neue Maschine kommt - gleich Vorlage Maschinen Doku nehmen, alle Infos eintragen. Kostet nur wenige Minuten und die Firma die das Gerät liefert und aufbaut freut sich, dass man alle Infos in Papierform hat und können einfach in Ruhe alles aufbauen und in Betrieb nehmen. Hierbei auch gleich wenn möglich die Zugänge dokumentieren sowie ggf. Anleitung zum Konfigurieren der Maschine im Bereich Netzwerk soweit möglich. Ansonsten währenddessen kann man sich um die weitere Doku hierzu kümmern wie Anschluss Switch, Patchfeld usw. :)


    Ich sehe mal zu ein paar Vorlagen vorzubereiten. Denke da kann man sich defintiv etwas austauschen :thumbup:

    das Einzige was am Ende zählt ist
    dass ihr lebt was ihr liebt und liebt wofür ihr lebt


    Kodi HTPC - W11 | AMD Athlon 3000G | Pioneer A 504R Bj. 96
    OMV NAS - NAS | Emby Server | LogitechMediaServer
    3x Logitech SqueezeBox & 3x RasPi PiCorePlayer
    Loxone SmartHome

  • ich nutze DokuWiki (Docker in Synology) mit dem diagrams Plugin (https://www.dokuwiki.org/plugin:diagrams).
    Damit lassen sich Diagramme von https://app.diagrams.net/ einbetten und direkt bearbeiten.

    Kannst du uns hier 2-3 Screenshots zeigen? Ich hab mich am DokuWiki versucht, aber irgendwie ... ich steh da wie vor der Wand und weiß nicht weiter.

    @psychofaktory ich hab da mal angefangen - endlich.
    Letztendlich baue ich es erstmal einzeln auf - jedes Dokument bekommt eine eindeutige Nummer und hat genau EINEN Inahlt (z.B. 1 Netzwerkschrank mit dessen Beschreibung, 1 Patchpanel, usw.)

    mal 2 Beispieldateien

    [xattach=63493]Excel & Word Dokumente[/xattach]

    Dateien

    das Einzige was am Ende zählt ist
    dass ihr lebt was ihr liebt und liebt wofür ihr lebt


    Kodi HTPC - W11 | AMD Athlon 3000G | Pioneer A 504R Bj. 96
    OMV NAS - NAS | Emby Server | LogitechMediaServer
    3x Logitech SqueezeBox & 3x RasPi PiCorePlayer
    Loxone SmartHome

  • @noob_at_pc vielen Dank für die Beispiele.

    So habe ich das aktuell umgesetzt:
    Netzwerkdoku.zip

    Für die Subnetzbereiche habe ich einfach eine Tabelle mit den Spalten:

    • Bereich Name
    • Subnetz / Subnetzmaske
    • Gateway
    • DNS
    • VLAN-ID
    • Interface
    • DHCP-Server
    • DHCP-Bereich
    • Lease-Time
    • SSID
    • Authentifizierung
    • IPv4/IPv6
    • Bemerkung

    Der Rest ist textlich erschlossen.
    Für die Übersicht über die meisten Netzwerk-Parameter ist eigentlich ein Blick in die WebGUI der OPNsense die ich als Firewall einsetze am effektivsten.
    Macht einfach keinen Sinn jede Firewallregel usw jedes Mal manuell irgendwo festzuschreiben. Das würde zu unübersichtlich werden.
    Dafür gibt es bei vielen Firewalls (so auch bei der OPNsense) ja die Möglichkeit einen Read-Only-Benutzer festzulegen mit dem die Konfiguration eingesehen werden kann. Teilweise wird auch die Option angeboten die Konfig einzusehen ohne Zugriff auf eine reale Firewall haben zu müssen.

  • Kannst du uns hier 2-3 Screenshots zeigen? Ich hab mich am DokuWiki versucht, aber irgendwie ... ich steh da wie vor der Wand und weiß nicht weiter.
    @psychofaktory ich hab da mal angefangen - endlich.
    Letztendlich baue ich es erstmal einzeln auf - jedes Dokument bekommt eine eindeutige Nummer und hat genau EINEN Inahlt (z.B. 1 Netzwerkschrank mit dessen Beschreibung, 1 Patchpanel, usw.)

    mal 2 Beispieldateien

    [xattach=63493]Excel & Word Dokumente[/xattach]


    Um ein Diagramm einufügen zuerst auf das Bildsymbol klicken und danach anschließend "Diagramm erstellen". Danach Namen vorgeben und bearbeiten.
    Falls noch Fragen sind einfach nochmal schreiben :)

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!