Handleiding

Documenteren en overdragen

Wat er in de klantmap hoort en wat de volgende persoon nodig heeft om jouw werk over te nemen.

Een installatie is klaar als iemand anders hem kan overnemen. Dat is een hogere lat dan "het netwerk werkt", en het is de enige lat die ertoe doet op de dag dat jij er niet bent. De configurator levert het meeste materiaal daarvoor kant en klaar op; het enige wat jij doet is het op één plek bewaren.

Wat er in de klantmap hoort

  • Het script per apparaat, met de naam van het apparaat als bestandsnaam. In een site kun je ook alles in één bestand downloaden, met per script een kop die zegt op welk apparaat het hoort.
  • Het terugdraai-script naast elk script. Je wilt de weg terug hebben voordat je hem nodig hebt.
  • Het sitebestand, het .json-bestand dat je met "site opslaan als bestand" bewaart. Dit is het belangrijkste bestand in de map: daarmee opent de volgende persoon je hele configuratie opnieuw in de tool, past iets aan en genereert nieuwe scripts, in plaats van uit een script terug te redeneren wat de bedoeling was.
  • Het afgedrukte overdrachtsblad voor wie niet in de tool gaat kijken.
  • De gegevens die de tool niet kan weten: het klantnummer bij de provider, het abonnement, de contactpersoon, de serienummers en waar de apparatuur hangt.

Het sitebestand bevat wachtwoorden en sleutels in leesbare tekst. Bewaar het bij de klantgegevens, niet in een gedeelde map waar het hele kantoor bij kan.

Het overdrachtsblad

Bij de scripts staat de knop voor het overdrachtsblad: afdrukken of als PDF bewaren. Het is opgebouwd uit dezelfde gegevens als het script, dus de twee kunnen niet uit elkaar lopen. Per apparaat staat erop:

  • Apparaat: naam, model, rol, site, tijdzone en update-kanaal, met lege regels voor het serienummer en de locatie om met pen in te vullen.
  • Beheer: het beheeradres, de beheer-VLAN, een eventuele noodpoort, de beheerdersnaam en welke diensten vanaf welke adressen bereikbaar zijn.
  • Internet, LAN met vaste toewijzingen, de VLAN-tabel met subnet, routeradres, DHCP, internet en isolatie, en zo nodig wie welk netwerk mag benaderen.
  • De poortentabel: per poort wat eraan hangt, welk VLAN en jouw opmerking.
  • Wifi met de SSIDs, VPN, de firewall met poortdoorverwijzingen, en de notitie die je bij het systeem hebt gezet.

Onderaan staan regels voor "geïnstalleerd door", de datum en een handtekening van de klant. Bij een site komt er een voorblad voor: de site met naam en tijdzone, alle apparaten met rol en beheeradres, de bekabeling van en naar welke poort, en de VLANs en SSIDs van de site. Dat voorblad is vaak het enige wat iemand een jaar later nog leest.

Wachtwoorden

Standaard staan er geen wachtwoorden op het overdrachtsblad. Er is een vinkje "wachtwoorden afdrukken" als het blad in een kluis terechtkomt; zet je dat aan, dan zegt de voettekst van het blad dat het wachtwoorden bevat. De rest van de tijd laat je het uit, want een afgedrukt blad ligt uiteindelijk op een bureau of staat op een foto.

Wachtwoorden horen in een wachtwoordbeheerder van de klant of van jouw bedrijf, met één regel per apparaat of per site. De configurator is daar geen plek voor: hij draait volledig in je browser en stuurt niets naar een server, maar wat er in de browser is opgeslagen staat alleen op die ene computer en verdwijnt met de browsergegevens. De wachtwoordknop in de tool genereert er een van zestien tekens; korter dan twaalf levert een waarschuwing op. Gebruik je tijdens de installatie iets tijdelijks, wissel het dan voor de overdracht en niet erna.

Het terugdraai-script

Naast elk script kun je een terugdraai-script downloaden. Dat verwijdert elk object dat het eerste script aanmaakt, gevonden op de naam of de opmerking die het script zelf heeft meegegeven, in omgekeerde volgorde. Wat je verbinding in leven houdt gaat als laatste: adressen, de bridge, interfacelijsten en de DHCP-client. Zo blijf je zo lang mogelijk binnen.

Wees eerlijk over wat het niet doet. Regels die een bestaande instelling wijzigen kunnen niet worden teruggezet: de oude waarde staat op het apparaat en niet in het script. Die staan onderaan het bestand als commentaar, alleen met menu en doel, zodat er nooit een wachtwoord in het terugdraai-bestand belandt. Hetzelfde geldt voor geschreven regels die pas tijdens het uitvoeren bepalen wat ze raken. De exacte weg terug is daarom de backup die je vóór het plakken maakt; de kop van het bestand zegt dat ook, met /system backup load name=before-configurator erbij. Draai het script vanuit Safe Mode, en het liefst via MAC-WinBox of een console.

Wat de volgende persoon nodig heeft

Geef iemand het sitebestand, het overdrachtsblad en de afspraak hoe er genoemd wordt, en hij kan verder. Handig om er standaard bij te zetten: welke poorten trunks zijn, waar de noodpoort zit, en in het notitieveld van het systeem een regel over wie het beheert en hoe wijzigingen lopen. Die notitie verschijnt bij het inloggen en op het blad. Moet er later iets veranderen, dan pas je het in de tool aan en vergelijk je het nieuwe script met een export van het draaiende apparaat, zodat je alleen het verschil plakt. Zie het script gebruiken en bewaren en delen, en namen kiezen voor de afspraken die dit leesbaar houden.

Meteen proberen? Open de configurator