Start Neue Main

Dev/sw_fw_scan_CSV/howto.md

@@ -0,0 +1,44 @@
+# How-to: switch_firmware_scan_csv Docker Image
+
+Ez a dokumentum leírja, hogyan kell használni a `switch_firmware_scan_csv` Docker image-et.
+
+## Konfiguráció (config.json)
+
+A szkript a `config.json` fájlból olvassa be a konfigurációs adatokat. Ennek a fájlnak a konténer `WORKDIR` gyökerében (`/app/config.json`) kell elhelyezkednie, és a következő kulcsokat kell tartalmaznia:
+
+- `switch_ips`: Egy lista a switch-ek IP címeiből.
+- `username`: A switch-ekhez való csatlakozáshoz használt felhasználónév.
+- `password`: A switch-ekhez való csatlakozáshoz használt jelszó.
+
+Példa `config.json`:
+```json
+{
+  "switch_ips": [
+    "10.220.1.84",
+    "10.220.1.85"
+  ],
+  "username": "az_on_felhasznaloneve",
+  "password": "az_on_jelszava"
+}
+```
+
+## Futtatás
+
+A konténer futtatásához használja a következő parancsot:
+
+```bash
+docker run -d \
+  --name switch_firmware_scan_csv \
+  -v /eleresi/ut/a/hoston/config.json:/app/config.json \
+  -v /eleresi/ut/a/hoston/results:/app/results \
+  switch_firmware_scan_csv
+```
+
+### Magyarázat:
+
+- `-d`: A konténer háttérben fut.
+- `--name switch_firmware_scan_csv`: A konténer neve.
+- `-v /eleresi/ut/a/hoston/config.json:/app/config.json`: Csatolja a helyi `config.json` fájlt a konténer `/app/config.json` útvonalához.
+- `-v /eleresi/ut/a/hoston/results:/app/results`: Csatol egy kötetet a konténer `/app/results` könyvtárához. A kimeneti CSV fájlok a gazda gép `/eleresi/ut/a/hoston/results` könyvtárában lesznek megtalálhatók.
+
+```