Repository navigation
Expand file tree
/
Copy pathnetmiko_bulk_core.py
More file actions
812 lines (710 loc) · 30.6 KB
/
Copy pathnetmiko_bulk_core.py
File metadata and controls
812 lines (710 loc) · 30.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
"""Cœur métier (sans GTK) du plugin de déploiement de configuration en masse
via Netmiko pour GCM.
Ce module ne dépend ni de GTK ni de netmiko au niveau du import top-level
(netmiko est importé paresseusement dans ``push_to_device``) afin de rester
testable facilement en dehors de l'environnement graphique.
Notions, à l'image de rancid/.cloginrc :
- **Profils** (``profiles.ini``) : couples user/password/port/secret/
device_type, un profil par type de matériel. ``VENDOR_DEVICE_TYPES``
fournit le catalogue des ``device_type`` netmiko groupés par
constructeur, pour peupler un sélecteur dans l'éditeur de profil.
- **Inventaire** (CSV) : une ligne par équipement. Colonnes minimales
``ip`` et ``type``/``profile``. Toute colonne supplémentaire devient une
variable ``#nom#`` utilisable dans le gabarit.
- **Gabarits** (fichiers texte) : configuration à pousser, variables
``#colonne#`` remplacées par les valeurs de la ligne CSV.
- **Journaux** : chaque exécution écrit un fichier de log par hôte sur
disque (indépendamment de toute UI), plus un manifeste JSON agrégeant
statuts et statistiques, consultables après coup.
"""
from __future__ import annotations
import configparser
import csv
import json
import re
import threading
import time
from collections.abc import Callable, Sequence
from concurrent.futures import ThreadPoolExecutor, as_completed
from dataclasses import dataclass, field
from pathlib import Path
from typing import Protocol
__all__ = [
"VENDOR_DEVICE_TYPES",
"iter_all_device_types",
"DeviceProfile",
"InventoryRow",
"PushResult",
"ProfileStore",
"load_inventory",
"render_template",
"find_missing_variables",
"scan_output_for_errors",
"push_to_device",
"run_bulk_push",
"summarize_results",
"STATUS_OK",
"STATUS_REJECTED",
"STATUS_FAILED",
"STATUS_SKIPPED",
]
_VAR_RE = re.compile(r"#([A-Za-z0-9_]+)#")
# ──────────────────────────────────────────────────────────────────────────
# Catalogue constructeurs → device_type netmiko
# ──────────────────────────────────────────────────────────────────────────
# Groupé par constructeur pour peupler un sélecteur en cascade (constructeur
# puis device_type) dans l'éditeur de profil. Basé sur les drivers netmiko
# au moment de l'écriture ; une nouvelle version de netmiko peut en ajouter
# d'autres (cf. ``netmiko.ssh_dispatcher.CLASS_MAPPER.keys()`` pour la liste
# exhaustive à jour de l'installation locale).
VENDOR_DEVICE_TYPES: dict[str, list[tuple[str, str]]] = {
"Cisco": [
("cisco_ios", "IOS / IOS-XE (switch, routeur)"),
("cisco_xe", "IOS-XE (explicite)"),
("cisco_xr", "IOS-XR"),
("cisco_nxos", "NX-OS (Nexus)"),
("cisco_asa", "ASA (pare-feu)"),
("cisco_ftd", "Firepower Threat Defense"),
("cisco_wlc", "Wireless LAN Controller"),
("cisco_s300", "Small Business SG/SF 300"),
("cisco_tp", "TelePresence"),
],
"Huawei": [
("huawei", "VRP (générique)"),
("huawei_vrpv8", "VRP V8 (NE/CE/ARG)"),
("huawei_smartax", "SmartAX (accès/MSAN)"),
],
"HPE / Aruba": [
("hp_comware", "Comware (H3C/HPE FlexNetwork)"),
("hp_procurve", "ProCurve / Aruba OS Switch (ancien)"),
("aruba_os", "ArubaOS (WLAN, contrôleurs)"),
("aruba_osswitch", "Aruba OS-Switch"),
],
"Juniper": [
("juniper_junos", "Junos (recommandé)"),
("juniper", "Junos (générique, historique)"),
("juniper_screenos", "ScreenOS (NetScreen)"),
],
"Arista": [
("arista_eos", "EOS"),
],
"Fortinet": [
("fortinet", "FortiOS"),
],
"Palo Alto": [
("paloalto_panos", "PAN-OS"),
],
"Check Point": [
("checkpoint_gaia", "Gaia"),
],
"Mikrotik": [
("mikrotik_routeros", "RouterOS"),
("mikrotik_switchos", "SwitchOS"),
],
"Dell": [
("dell_force10", "FTOS (Force10 / S-series)"),
("dell_os10", "OS10"),
("dell_os9", "OS9 (PowerConnect N/Z)"),
("dell_os6", "OS6 (PowerConnect)"),
("dell_powerconnect", "PowerConnect (générique)"),
("dell_isilon", "Isilon OneFS"),
("dell_sonic", "SONiC"),
],
"Extreme Networks": [
("extreme", "ExtremeWare (générique)"),
("extreme_exos", "EXOS"),
("extreme_ers", "Ethernet Routing Switch (ex-Avaya/Nortel)"),
("extreme_slx", "SLX (ex-Brocade)"),
("extreme_vdx", "VDX (ex-Brocade)"),
("extreme_wing", "WiNG (WLAN, ex-Motorola/Zebra)"),
("extreme_netiron", "NetIron (ex-Brocade/Foundry)"),
],
"F5": [
("f5_ltm", "BIG-IP LTM (tmsh)"),
("f5_tmsh", "BIG-IP (tmsh générique)"),
("f5_linux", "BIG-IP (shell Linux sous-jacent)"),
],
"Nokia / Alcatel": [
("nokia_sros", "SR OS"),
("alcatel_sros", "SR OS (marque Alcatel-Lucent)"),
("alcatel_aos", "AOS (switchs OmniSwitch)"),
],
"Ubiquiti": [
("ubiquiti_edge", "EdgeSwitch / EdgeMax (ancien driver)"),
("ubiquiti_edgeswitch", "EdgeSwitch"),
("ubiquiti_unifiswitch", "UniFi Switch"),
],
"Ruckus / Ruijie": [
("ruckus_fastiron", "FastIron (ICX, ex-Brocade/Foundry)"),
("ruijie_os", "Ruijie OS"),
],
"Autres constructeurs réseau": [
("a10", "A10 Networks ACOS"),
("adtran_os", "Adtran AOS"),
("allied_telesis_awplus", "Allied Telesis AlliedWare Plus"),
("apresia_aeos", "Apresia AEOS"),
("broadcom_icos", "Broadcom ICOS"),
("calix_b6", "Calix B6"),
("casa_cbr", "Casa Systems CBR"),
("centec_os", "Centec OS"),
("ciena_saos", "Ciena SAOS"),
("cloudgenix_ion", "CloudGenix ION"),
("coriant", "Coriant"),
("digi_transport", "Digi TransPort"),
("eltex", "Eltex (générique)"),
("eltex_esr", "Eltex ESR"),
("endace", "Endace"),
("flexvnf", "Flexiwan/FlexVNF"),
("ipinfusion_ocnos", "IP Infusion OcNOS"),
("keymile", "Keymile (générique)"),
("keymile_nos", "Keymile NOS"),
("mrv_lx", "MRV LX"),
("mrv_optiswitch", "MRV OptiSwitch"),
("netgear_prosafe", "Netgear ProSafe"),
("netscaler", "Citrix NetScaler"),
("oneaccess_oneos", "OneAccess OneOS"),
("pluribus", "Pluribus Netvisor"),
("quanta_mesh", "Quanta Mesh"),
("rad_etx", "RAD ETX"),
("raisecom_ros", "Raisecom ROS"),
("sixwind_os", "6WIND 6WINDGate"),
("sophos_sfos", "Sophos SFOS (pare-feu)"),
("supermicro_smis", "Supermicro SMIS"),
("teldat_cit", "Teldat CIT"),
("tplink_jetstream", "TP-Link JetStream"),
("vyos", "VyOS"),
("vyatta_vyos", "Vyatta / VyOS (ancien driver)"),
("watchguard_fireware", "WatchGuard Fireware"),
("yamaha", "Yamaha (routeurs RTX)"),
("zte_zxros", "ZTE ZXROS"),
("zyxel_os", "Zyxel OS"),
],
"Serveurs / générique": [
("linux", "Linux (shell générique via SSH)"),
("generic", "Générique (protocole SSH basique)"),
("generic_termserver", "Serveur de terminaux générique"),
("ovs_linux", "Open vSwitch sur Linux"),
("netapp_cdot", "NetApp cDOT"),
],
}
def iter_all_device_types() -> list[tuple[str, str, str]]:
"""Aplati ``VENDOR_DEVICE_TYPES`` en tuples ``(constructeur, device_type,
libellé)``, pratique pour peupler une simple liste de recherche.
"""
out = []
for vendor, entries in VENDOR_DEVICE_TYPES.items():
for device_type, label in entries:
out.append((vendor, device_type, label))
return out
# ──────────────────────────────────────────────────────────────────────────
# Profils (équivalent .cloginrc)
# ──────────────────────────────────────────────────────────────────────────
@dataclass
class DeviceProfile:
"""Un profil de connexion, référencé par nom depuis la colonne ``type``
(ou ``profile``) de l'inventaire CSV.
"""
name: str
device_type: str # valeur netmiko, ex. "cisco_ios", "hp_comware"
vendor: str = "" # étiquette constructeur (cf. VENDOR_DEVICE_TYPES), informative
username: str = ""
password: str = ""
secret: str = "" # mot de passe "enable", si applicable
port: int = 22
timeout: int = 10
save_command: str = "" # ex. "save force" (comware) ; vide -> conn.save_config() natif
def to_netmiko_kwargs(self, host: str) -> dict:
"""Construit le dictionnaire de connexion attendu par ``netmiko.ConnectHandler``.
Args:
host (str): Adresse IP/nom d'hôte de l'équipement cible (issue
de la ligne d'inventaire, distincte du profil lui-même).
Returns:
dict: Paramètres ``device_type``/``host``/``username``/
``password``/``port``/``timeout``, plus ``secret`` si défini
sur le profil.
"""
kwargs = {
"device_type": self.device_type,
"host": host,
"username": self.username,
"password": self.password,
"port": self.port,
"timeout": self.timeout,
}
if self.secret:
kwargs["secret"] = self.secret
return kwargs
class ProfileStore:
"""Charge, modifie et sauvegarde les profils définis dans un ``.ini``.
Format (une section par profil) ::
[comware]
vendor = HPE / Aruba
device_type = hp_comware
username = admin
password = secret
port = 22
"""
def __init__(self, path: str | Path):
"""Initialise le magasin de profils sur un fichier ``.ini``.
Args:
path (str | Path): Chemin du fichier de profils. Chargé
immédiatement via :meth:`reload` s'il existe déjà, sinon
le magasin démarre vide (fichier créé au premier
:meth:`save`).
"""
self.path = Path(path)
self._profiles: dict[str, DeviceProfile] = {}
if self.path.exists():
self.reload()
def reload(self) -> None:
"""Recharge tous les profils depuis ``self.path``, en mémoire.
Écrase l'état en mémoire courant (``self._profiles``) ; les
profils modifiés via :meth:`set` mais non sauvegardés
(:meth:`save`) sont donc perdus.
"""
cp = configparser.ConfigParser()
cp.read(self.path, encoding="utf-8")
profiles: dict[str, DeviceProfile] = {}
for section in cp.sections():
s = cp[section]
profiles[section] = DeviceProfile(
name=section,
device_type=s.get("device_type", fallback=""),
vendor=s.get("vendor", fallback=""),
username=s.get("username", fallback=""),
password=s.get("password", fallback=""),
secret=s.get("secret", fallback=""),
port=s.getint("port", fallback=22),
timeout=s.getint("timeout", fallback=10),
save_command=s.get("save_command", fallback=""),
)
self._profiles = profiles
def get(self, name: str) -> DeviceProfile | None:
"""Retourne le profil nommé *name*, ou ``None`` s'il n'existe pas.
Args:
name (str): Nom du profil recherché (clé exacte, sensible à la
casse).
Returns:
DeviceProfile | None: Le profil correspondant, ou ``None``.
"""
return self._profiles.get(name)
def names(self) -> list[str]:
"""Retourne les noms de profils connus, triés alphabétiquement.
Returns:
list[str]: Noms de profils en ordre alphabétique.
"""
return sorted(self._profiles.keys())
def all(self) -> list[DeviceProfile]:
"""Retourne tous les profils, triés par nom.
Returns:
list[DeviceProfile]: Profils dans l'ordre de :meth:`names`.
"""
return [self._profiles[n] for n in self.names()]
def set(self, profile: DeviceProfile) -> None:
"""Ajoute ou remplace un profil (par ``profile.name``), en mémoire."""
self._profiles[profile.name] = profile
def delete(self, name: str) -> None:
"""Supprime un profil par son nom, en mémoire.
Args:
name (str): Nom du profil à supprimer. Aucune erreur n'est
levée si ce profil n'existe pas déjà (``pop(..., None)``).
"""
self._profiles.pop(name, None)
def save(self) -> None:
"""Écrit l'ensemble des profils courants dans ``self.path``
(permissions restreintes, comme le ``.cloginrc`` de rancid).
"""
cp = configparser.ConfigParser()
for name in self.names():
p = self._profiles[name]
cp[name] = {
"vendor": p.vendor,
"device_type": p.device_type,
"username": p.username,
"password": p.password,
"secret": p.secret,
"port": str(p.port),
"timeout": str(p.timeout),
"save_command": p.save_command,
}
with open(self.path, "w", encoding="utf-8") as fh:
cp.write(fh)
try:
self.path.chmod(0o600)
except OSError:
pass
@staticmethod
def write_template(path: str | Path) -> None:
"""Écrit un fichier ``profiles.ini`` d'exemple si *path* n'existe pas."""
path = Path(path)
if path.exists():
return
store = ProfileStore.__new__(ProfileStore)
store.path = path
store._profiles = {
"comware": DeviceProfile(
name="comware",
vendor="HPE / Aruba",
device_type="hp_comware",
username="admin",
password="change_me",
port=22,
),
"cisco": DeviceProfile(
name="cisco",
vendor="Cisco",
device_type="cisco_ios",
username="admin",
password="change_me",
secret="change_me_enable",
port=22,
),
}
store.save()
# ──────────────────────────────────────────────────────────────────────────
# Inventaire CSV
# ──────────────────────────────────────────────────────────────────────────
@dataclass
class InventoryRow:
"""Une ligne d'inventaire = un équipement + ses variables de gabarit."""
ip: str
profile_name: str
variables: dict[str, str] = field(default_factory=dict)
line_no: int = 0
def render_context(self) -> dict[str, str]:
"""Construit le dictionnaire de variables utilisable par :func:`render_template`.
Returns:
dict[str, str]: Copie de ``self.variables`` complétée par
``ip``/``host`` (défauts à ``self.ip`` s'ils ne sont pas déjà
fournis par une colonne CSV du même nom).
"""
ctx = dict(self.variables)
ctx.setdefault("ip", self.ip)
ctx.setdefault("host", self.ip)
return ctx
def _sniff_delimiter(sample: str) -> str:
for candidate in (";", ",", "\t"):
if candidate in sample.splitlines()[0]:
return candidate
return ";"
def load_inventory(path: str | Path) -> list[InventoryRow]:
"""Charge un inventaire CSV.
Colonnes reconnues (insensibles à la casse) :
- ``ip`` ou ``host`` (obligatoire).
- ``type`` ou ``profile`` (obligatoire) : nom du profil à utiliser.
- toute autre colonne devient une variable ``#nom_colonne#``.
"""
path = Path(path)
text = path.read_text(encoding="utf-8-sig")
if not text.strip():
raise ValueError("Fichier d'inventaire vide.")
delimiter = _sniff_delimiter(text)
reader = csv.DictReader(text.splitlines(), delimiter=delimiter)
if not reader.fieldnames:
raise ValueError("Impossible de lire l'en-tête du CSV.")
fieldmap = {f.strip().lower(): f for f in reader.fieldnames}
ip_col = fieldmap.get("ip") or fieldmap.get("host")
profile_col = fieldmap.get("type") or fieldmap.get("profile")
if not ip_col:
raise ValueError("Le CSV doit contenir une colonne 'ip' (ou 'host').")
if not profile_col:
raise ValueError("Le CSV doit contenir une colonne 'type' (ou 'profile').")
rows: list[InventoryRow] = []
for i, raw in enumerate(reader, start=2): # ligne 1 = en-tête
ip = (raw.get(ip_col) or "").strip()
profile_name = (raw.get(profile_col) or "").strip()
if not ip:
continue
variables = {
k.strip(): (v or "").strip()
for k, v in raw.items()
if k not in (ip_col, profile_col) and k is not None
}
rows.append(InventoryRow(ip=ip, profile_name=profile_name, variables=variables, line_no=i))
return rows
# ──────────────────────────────────────────────────────────────────────────
# Gabarits
# ──────────────────────────────────────────────────────────────────────────
def find_missing_variables(template_text: str, context: dict[str, str]) -> list[str]:
"""Liste les variables ``#nom#`` référencées par le gabarit mais absentes du contexte.
Args:
template_text (str): Texte du gabarit de commandes à envoyer,
contenant d'éventuels placeholders ``#nom_variable#``.
context (dict[str, str]): Variables disponibles pour la
substitution (typiquement :meth:`InventoryRow.render_context`).
Returns:
list[str]: Noms de variables référencées par *template_text* mais
absentes de *context*, triés alphabétiquement (liste vide si tout
est résolvable).
"""
needed = set(_VAR_RE.findall(template_text))
return sorted(v for v in needed if v not in context)
def render_template(template_text: str, context: dict[str, str]) -> str:
"""Substitue chaque placeholder ``#nom#`` de *template_text* par sa valeur dans *context*.
Args:
template_text (str): Texte du gabarit de commandes à envoyer.
context (dict[str, str]): Variables disponibles pour la
substitution. Un placeholder sans correspondance dans
*context* est laissé tel quel (non substitué) — voir
:func:`find_missing_variables` pour les détecter en amont.
Returns:
str: Texte du gabarit avec les placeholders résolus substitués.
"""
def _sub(m: re.Match) -> str:
key = m.group(1)
return context.get(key, m.group(0))
return _VAR_RE.sub(_sub, template_text)
# ──────────────────────────────────────────────────────────────────────────
# Détection d'erreurs dans les logs (indépendante du constructeur)
# ──────────────────────────────────────────────────────────────────────────
# Marqueurs d'erreur couramment renvoyés par les CLI réseau lorsqu'une
# commande est rejetée (syntaxe invalide, commande inconnue, droits
# insuffisants...). Volontairement générique et multi-constructeurs plutôt
# qu'une liste par OS : netmiko ne lève pas d'exception dans ce cas, le
# rejet n'apparaît que dans le texte renvoyé par l'équipement.
_ERROR_PATTERNS = [
re.compile(r"%\s*invalid", re.IGNORECASE),
re.compile(r"%\s*unknown command", re.IGNORECASE),
re.compile(r"%\s*ambiguous command", re.IGNORECASE),
re.compile(r"%\s*incomplete command", re.IGNORECASE),
re.compile(r"%\s*bad command", re.IGNORECASE),
re.compile(r"unrecognized command", re.IGNORECASE),
re.compile(r"invalid input", re.IGNORECASE),
re.compile(r"syntax error", re.IGNORECASE),
re.compile(r"command rejected", re.IGNORECASE),
re.compile(r"permission denied", re.IGNORECASE),
re.compile(r"authorization failed", re.IGNORECASE),
re.compile(r"too many parameters", re.IGNORECASE),
re.compile(r"error:\s", re.IGNORECASE),
]
def scan_output_for_errors(output_text: str) -> list[str]:
"""Retourne les lignes de *output_text* qui ressemblent à un rejet de
commande par l'équipement (indépendamment du constructeur).
"""
hits = []
for line in output_text.splitlines():
for pat in _ERROR_PATTERNS:
if pat.search(line):
hits.append(line.strip())
break
return hits
# ──────────────────────────────────────────────────────────────────────────
# Exécution
# ──────────────────────────────────────────────────────────────────────────
# Statuts possibles d'un PushResult
STATUS_OK = "ok" # connecté, config envoyée, aucun marqueur d'erreur détecté
STATUS_REJECTED = "rejected" # connecté, mais l'équipement a signalé une erreur dans sa sortie
STATUS_FAILED = "failed" # échec de connexion/authentification/exécution
STATUS_SKIPPED = "skipped" # non tenté (annulé, profil/variable manquants)
@dataclass
class PushResult:
"""Résultat d'une tentative de push de configuration sur un équipement.
Un statut ``STATUS_*`` (``ok``/``rejected``/``failed``/``skipped``) ;
voir :attr:`ok` pour la vue booléenne compat utilisée par l'UI.
"""
row: InventoryRow
status: str # STATUS_*
output: str = ""
error: str = ""
config_errors: list[str] = field(default_factory=list)
log_path: str = ""
duration_s: float = 0.0
@property
def ok(self) -> bool:
"""Compat : True seulement si aucune erreur, ni de connexion ni de
configuration.
"""
return self.status == STATUS_OK
class PushResultLike(Protocol):
"""Forme commune de ``PushResult`` et ``snmp_push_core.SnmpPushResult``
(journal, manifeste et synthèse sont partagés par les deux transports).
"""
row: InventoryRow
status: str
output: str
error: str
config_errors: list[str]
log_path: str
duration_s: float
def _write_log(log_dir: Path, row: InventoryRow, result: PushResultLike) -> str:
log_dir.mkdir(parents=True, exist_ok=True)
safe_ip = re.sub(r"[^A-Za-z0-9_.-]", "_", row.ip)
log_file = log_dir / f"{row.line_no:04d}_{safe_ip}.log"
lines = [
f"# Hôte : {row.ip} (profil : {row.profile_name}, ligne CSV : {row.line_no})",
f"# Statut : {result.status}",
]
if result.error:
lines.append(f"# Erreur de connexion : {result.error}")
if result.config_errors:
lines.append("# Lignes rejetées détectées :")
lines.extend(f"# {e}" for e in result.config_errors)
lines.append("# ── Sortie brute de l'équipement ──")
lines.append(result.output or "(aucune sortie)")
log_file.write_text("\n".join(lines), encoding="utf-8")
return str(log_file)
def push_to_device(
row: InventoryRow,
profile: DeviceProfile,
rendered_config: str,
save: bool = False,
) -> PushResult:
"""Se connecte à un équipement et envoie la configuration rendue.
Ne journalise pas sur disque elle-même (cf. ``run_bulk_push``) : cette
fonction peut donc être appelée isolément (ex. tests, aperçu réel) sans
effet de bord fichier.
"""
try:
from netmiko import ConnectHandler
from netmiko.exceptions import NetmikoAuthenticationException, NetmikoTimeoutException
except ImportError as exc: # pragma: no cover - dépendance externe
return PushResult(row=row, status=STATUS_FAILED, error=f"netmiko non installé : {exc}")
lines = [line for line in rendered_config.splitlines() if line.strip() != ""]
if not lines:
return PushResult(
row=row, status=STATUS_FAILED, error="Gabarit rendu vide, rien à envoyer."
)
started = time.monotonic()
conn = None
try:
conn = ConnectHandler(**profile.to_netmiko_kwargs(row.ip))
if profile.secret:
conn.enable()
output = conn.send_config_set(lines)
if save:
if profile.save_command:
output += "\n" + conn.send_command_timing(profile.save_command)
else:
output += "\n" + conn.save_config()
errors = scan_output_for_errors(output)
status = STATUS_REJECTED if errors else STATUS_OK
return PushResult(
row=row,
status=status,
output=output,
config_errors=errors,
duration_s=time.monotonic() - started,
)
except NetmikoAuthenticationException as exc:
return PushResult(
row=row,
status=STATUS_FAILED,
error=f"Authentification refusée : {exc}",
duration_s=time.monotonic() - started,
)
except NetmikoTimeoutException as exc:
return PushResult(
row=row,
status=STATUS_FAILED,
error=f"Délai dépassé / injoignable : {exc}",
duration_s=time.monotonic() - started,
)
except Exception as exc: # noqa: BLE001 - on veut consigner toute erreur par hôte
return PushResult(
row=row, status=STATUS_FAILED, error=str(exc), duration_s=time.monotonic() - started
)
finally:
if conn is not None:
try:
conn.disconnect()
except Exception:
pass
def run_bulk_push(
rows: list[InventoryRow],
profiles: ProfileStore,
template_text: str,
*,
log_dir: str | Path,
save: bool = False,
max_workers: int = 5,
on_row_start: Callable[[InventoryRow], None] | None = None,
on_row_done: Callable[[PushResult], None] | None = None,
cancel_event: threading.Event | None = None,
) -> list[PushResult]:
"""Pousse la configuration sur tous les *rows* en parallèle (borné par
*max_workers*), en journalisant chaque hôte sur disque dans *log_dir*
et en écrivant un manifeste JSON agrégé à la fin.
``on_row_start``/``on_row_done`` sont appelés depuis les threads
ouvriers — si utilisés pour mettre à jour une UI GTK, l'appelant doit
les faire rebondir sur le thread principal (ex. ``GLib.idle_add``).
"""
log_dir = Path(log_dir)
results: list[PushResult] = []
def _work(row: InventoryRow) -> PushResult:
if cancel_event is not None and cancel_event.is_set():
result = PushResult(row=row, status=STATUS_SKIPPED, error="Annulé avant envoi.")
result.log_path = _write_log(log_dir, row, result)
return result
profile = profiles.get(row.profile_name)
if profile is None:
result = PushResult(
row=row, status=STATUS_FAILED, error=f"Profil inconnu : '{row.profile_name}'"
)
result.log_path = _write_log(log_dir, row, result)
return result
context = row.render_context()
missing = find_missing_variables(template_text, context)
if missing:
result = PushResult(
row=row,
status=STATUS_FAILED,
error=f"Variables manquantes dans le CSV : {', '.join(missing)}",
)
result.log_path = _write_log(log_dir, row, result)
return result
if on_row_start:
on_row_start(row)
rendered = render_template(template_text, context)
result = push_to_device(row, profile, rendered, save=save)
result.log_path = _write_log(log_dir, row, result)
return result
with ThreadPoolExecutor(max_workers=max(1, max_workers)) as pool:
futures = {pool.submit(_work, row): row for row in rows}
for fut in as_completed(futures):
result = fut.result()
results.append(result)
if on_row_done:
on_row_done(result)
_write_manifest(log_dir, results)
return results
def _write_manifest(log_dir: Path, results: Sequence[PushResultLike]) -> None:
manifest = {
"generated_at": time.strftime("%Y-%m-%d %H:%M:%S"),
"summary": summarize_results(results),
"hosts": [
{
"ip": r.row.ip,
"profile": r.row.profile_name,
"line_no": r.row.line_no,
"status": r.status,
"error": r.error,
"config_errors": r.config_errors,
"log_path": r.log_path,
"duration_s": round(r.duration_s, 2),
}
for r in results
],
}
log_dir.mkdir(parents=True, exist_ok=True)
(log_dir / "manifest.json").write_text(
json.dumps(manifest, ensure_ascii=False, indent=2), encoding="utf-8"
)
def summarize_results(results: Sequence[PushResultLike]) -> dict:
"""Statistiques d'une exécution, pour affichage dans la phase Résultats."""
total = len(results)
by_status = {STATUS_OK: 0, STATUS_REJECTED: 0, STATUS_FAILED: 0, STATUS_SKIPPED: 0}
for r in results:
by_status[r.status] = by_status.get(r.status, 0) + 1
error_kinds: dict[str, int] = {}
for r in results:
if r.status == STATUS_FAILED and r.error:
key = r.error.split(":")[0].strip()
error_kinds[key] = error_kinds.get(key, 0) + 1
return {
"total": total,
"ok": by_status[STATUS_OK],
"rejected": by_status[STATUS_REJECTED],
"failed": by_status[STATUS_FAILED],
"skipped": by_status[STATUS_SKIPPED],
"error_kinds": error_kinds,
}