Repository navigation
Expand file tree
/
Copy pathsnmp_bulk_core.py
More file actions
960 lines (789 loc) · 34.4 KB
/
Copy pathsnmp_bulk_core.py
File metadata and controls
960 lines (789 loc) · 34.4 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
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
#!/usr/bin/env python3
"""Cœur métier (sans GTK) du déploiement SNMP pour GCM.
Core simple et synchrone pour le plugin Push SNMP, adapté du style
``netmiko_bulk_core.py``. Utilise **EzSnmp** (bindings natifs libnetsnmp)
pour de meilleures performances sur volumes.
Structure : profils SNMP → inventaire CSV → gabarit → push par lot.
Dépendances::
apt install libsnmp-dev snmp-mibs-downloader
pip install ezsnmp --break-system-packages
"""
from __future__ import annotations
import configparser
import re
import threading
import time
from collections.abc import Callable
from concurrent.futures import ThreadPoolExecutor, as_completed
from dataclasses import dataclass, field
from pathlib import Path
from loguru import logger
# Convention bibliothèque (#130) : muet à l'import, réactivé par
# logging_config.configure_logging() (CORE_MODULES).
logger.disable(__name__)
try:
from ezsnmp import Session
from ezsnmp.exceptions import (
EasySNMPError,
EasySNMPNoSuchInstanceError,
EasySNMPNoSuchObjectError,
EasySNMPTimeoutError,
)
except ImportError:
from easysnmp import Session
from easysnmp.exceptions import (
EasySNMPError,
EasySNMPNoSuchInstanceError,
EasySNMPNoSuchObjectError,
EasySNMPTimeoutError,
)
__all__ = [
"SNMP_VENDORS",
"SnmpAuth",
"SnmpProfile",
"SnmpProfileStore",
"InventoryRow",
"PushResult",
"load_inventory",
"render_template",
"find_missing_variables",
"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_]+)#")
# Statuts
STATUS_OK = "ok"
STATUS_REJECTED = "rejected"
STATUS_FAILED = "failed"
STATUS_SKIPPED = "skipped"
# Vendeurs disponibles
SNMP_VENDORS = {
"h3c_comware": "H3C / HPE Comware",
"cisco_ios": "Cisco IOS / IOS-XE",
"huawei_vrp": "Huawei VRP",
}
# ────────────────────────────────────────────────────────────────────────
# Authentification et Profils SNMP
# ────────────────────────────────────────────────────────────────────────
@dataclass
class SnmpAuth:
"""Authentification SNMP (v2c ou v3)."""
version: str = "v2c"
community: str = "private"
username: str | None = None
auth_password: str | None = None
auth_protocol: str = "SHA"
priv_password: str | None = None
priv_protocol: str = "AES"
security_level: str = "auth_with_privacy"
def session_kwargs(
self, host: str, port: int = 161, timeout: int = 5, retries: int = 2
) -> dict:
"""Paramètres pour ezsnmp.Session(...).
Args:
host: IP/hôte de l'équipement cible.
port: Port SNMP de l'équipement.
timeout: Délai d'attente par requête, en secondes.
retries: Nombre de nouvelles tentatives en cas de timeout.
Returns:
Dictionnaire de kwargs prêt à passer à ``ezsnmp.Session(...)``.
"""
logger.debug(f"SnmpAuth.session_kwargs | host={host} port={port} version={self.version}")
base = {
"hostname": host,
"port": port,
"timeout": timeout,
"retries": retries,
}
if self.version == "v2c":
base["version"] = 2
base["community"] = self.community
else: # v3
base["version"] = 3
base["security_username"] = self.username or ""
base["auth_protocol"] = self.auth_protocol
base["auth_password"] = self.auth_password or ""
base["privacy_protocol"] = self.priv_protocol
base["privacy_password"] = self.priv_password or ""
base["security_level"] = self.security_level
return base
@dataclass
class SnmpProfile:
"""Profil de connexion SNMP."""
name: str
vendor: str
auth: SnmpAuth
port: int = 161
timeout: int = 5
retries: int = 2
poll_interval: float = 2.0
poll_timeout: float = 120.0
class SnmpProfileStore:
"""Magasin des profils SNMP (sur disque en .ini)."""
def __init__(self, path: str | Path = "snmp_profiles.ini"):
"""Initialise le magasin.
Args:
path: Chemin du fichier ``.ini`` de profils SNMP.
"""
logger.debug(f"SnmpProfileStore.__init__ | path={path}")
self.path = Path(path)
self._profiles: dict[str, SnmpProfile] = {}
if self.path.exists():
self.load()
def load(self) -> None:
"""Charge les profils depuis le fichier."""
logger.debug(f"SnmpProfileStore.load | path={self.path}")
config = configparser.ConfigParser()
config.read(self.path)
for section in config.sections():
if section.startswith("profile:"):
name = section[8:]
profile = SnmpProfile(
name=name,
vendor=config.get(section, "vendor"),
auth=SnmpAuth(
version=config.get(section, "snmp_version", fallback="v2c"),
community=config.get(section, "community", fallback="private"),
username=config.get(section, "username", fallback=None),
auth_password=config.get(section, "auth_password", fallback=None),
auth_protocol=config.get(section, "auth_protocol", fallback="SHA"),
priv_password=config.get(section, "priv_password", fallback=None),
priv_protocol=config.get(section, "priv_protocol", fallback="AES"),
security_level=config.get(
section, "security_level", fallback="auth_with_privacy"
),
),
port=config.getint(section, "port", fallback=161),
timeout=config.getint(section, "timeout", fallback=5),
retries=config.getint(section, "retries", fallback=2),
poll_interval=config.getfloat(section, "poll_interval", fallback=2.0),
poll_timeout=config.getfloat(section, "poll_timeout", fallback=120.0),
)
self._profiles[name] = profile
def save(self) -> None:
"""Sauvegarde les profils sur disque."""
logger.debug(f"SnmpProfileStore.save | path={self.path} n={len(self._profiles)}")
config = configparser.ConfigParser()
for name, p in self._profiles.items():
section = f"profile:{name}"
config[section] = {
"vendor": p.vendor,
"snmp_version": p.auth.version,
"community": p.auth.community,
"username": p.auth.username or "",
"auth_password": p.auth.auth_password or "",
"auth_protocol": p.auth.auth_protocol,
"priv_password": p.auth.priv_password or "",
"priv_protocol": p.auth.priv_protocol,
"security_level": p.auth.security_level,
"port": str(p.port),
"timeout": str(p.timeout),
"retries": str(p.retries),
"poll_interval": str(p.poll_interval),
"poll_timeout": str(p.poll_timeout),
}
self.path.parent.mkdir(parents=True, exist_ok=True)
with open(self.path, "w") as f:
config.write(f)
def get(self, name: str) -> SnmpProfile | None:
"""Récupère un profil par nom.
Args:
name: Nom du profil recherché.
"""
logger.debug(f"SnmpProfileStore.get | name={name}")
return self._profiles.get(name)
def all(self) -> list[SnmpProfile]:
"""Retourne tous les profils."""
logger.debug("SnmpProfileStore.all")
return list(self._profiles.values())
def set(self, name: str, profile: SnmpProfile) -> None:
"""Ajoute ou met à jour un profil.
Args:
name: Nom du profil.
profile: Instance ``SnmpProfile`` à enregistrer.
"""
logger.debug(f"SnmpProfileStore.set | name={name} vendor={profile.vendor}")
self._profiles[name] = profile
self.save()
def delete(self, name: str) -> None:
"""Supprime un profil.
Args:
name: Nom du profil à supprimer.
"""
logger.debug(f"SnmpProfileStore.delete | name={name}")
self._profiles.pop(name, None)
self.save()
# ────────────────────────────────────────────────────────────────────────
# Inventaire CSV
# ────────────────────────────────────────────────────────────────────────
@dataclass
class InventoryRow:
"""Ligne de l'inventaire CSV."""
line_no: int
ip: str
profile_name: str
variables: dict[str, str] = field(default_factory=dict)
def load_inventory(csv_path: str | Path) -> list[InventoryRow]:
"""Charge l'inventaire CSV.
Args:
csv_path: Chemin du fichier CSV d'inventaire.
Returns:
Liste des lignes d'inventaire parsées.
"""
logger.debug(f"load_inventory | csv_path={csv_path}")
rows = []
import csv
with open(csv_path, encoding="utf-8") as f:
reader = csv.DictReader(f, skipinitialspace=True)
for line_no, row in enumerate(reader, start=2):
ip = row.get("ip") or row.get("host") or ""
profile_name = row.get("type") or row.get("profile") or ""
if ip and profile_name:
vars_dict = {
k: v for k, v in row.items() if k not in ("ip", "host", "type", "profile")
}
rows.append(
InventoryRow(
line_no=line_no, ip=ip, profile_name=profile_name, variables=vars_dict
)
)
return rows
# ────────────────────────────────────────────────────────────────────────
# Gabarit
# ────────────────────────────────────────────────────────────────────────
def find_missing_variables(template: str, available: set[str]) -> set[str]:
"""Variables #...# du gabarit non trouvées dans le CSV.
Args:
template: Contenu du gabarit de configuration.
available: Ensemble des noms de variables disponibles (colonnes CSV).
Returns:
Ensemble des noms de variables référencées par le gabarit mais absentes.
"""
logger.debug(f"find_missing_variables | available={available}")
template_vars = set(_VAR_RE.findall(template))
return template_vars - available
def render_template(template: str, variables: dict[str, str]) -> str:
"""Remplace les variables #col# par leurs valeurs.
Args:
template: Contenu du gabarit de configuration.
variables: Valeurs à substituer, indexées par nom de colonne.
Returns:
Le gabarit avec les variables remplacées.
"""
logger.debug(f"render_template | n_variables={len(variables)}")
def replace(match):
"""Substitue une occurrence ``#var#`` par sa valeur.
Args:
match: Correspondance regex sur ``#nom_variable#``.
"""
var_name = match.group(1)
return variables.get(var_name, f"#{var_name}#")
return _VAR_RE.sub(replace, template)
# ────────────────────────────────────────────────────────────────────────
# Résultat
# ────────────────────────────────────────────────────────────────────────
@dataclass
class PushResult:
"""Résultat du push sur un équipement."""
row: InventoryRow
status: str
error: str = ""
log_path: str = ""
duration_s: float = 0.0
# ────────────────────────────────────────────────────────────────────────
# Drivers SNMP (par constructeur)
# ────────────────────────────────────────────────────────────────────────
class SnmpDriver:
"""Interface pour un driver SNMP (constructeur)."""
vendor_id: str = ""
display_name: str = ""
def __init__(
self,
auth: SnmpAuth,
port: int = 161,
timeout: int = 5,
retries: int = 2,
poll_interval: float = 2.0,
poll_timeout: float = 120.0,
):
"""Initialise le driver.
Args:
auth: Authentification SNMP (v2c ou v3).
port: Port SNMP de l'équipement.
timeout: Délai d'attente par requête, en secondes.
retries: Nombre de nouvelles tentatives en cas de timeout.
poll_interval: Intervalle entre deux sondages de statut, en secondes.
poll_timeout: Délai maximal d'attente du résultat, en secondes.
"""
logger.debug(f"SnmpDriver.__init__ | vendor={self.vendor_id} port={port}")
self.auth = auth
self.port = port
self.timeout = timeout
self.retries = retries
self.poll_interval = poll_interval
self.poll_timeout = poll_timeout
def _session(self, host: str) -> Session:
"""Crée une session EzSnmp.
Args:
host: IP/hôte de l'équipement cible.
"""
logger.debug(f"SnmpDriver._session | host={host}")
return Session(**self.auth.session_kwargs(host, self.port, self.timeout, self.retries))
def _set_multiple(self, host: str, oid_values: list[tuple[str, str, str]]) -> tuple[bool, str]:
"""Effectue un SET multi-varbind.
Args:
host: IP/hôte de l'équipement cible.
oid_values: Liste de tuples ``(oid, valeur, type)`` à écrire.
Returns:
Tuple ``(ok, detail)``.
"""
logger.debug(f"SnmpDriver._set_multiple | host={host} n_oid={len(oid_values)}")
try:
self._session(host).set_multiple(oid_values)
return True, "OK"
except (EasySNMPTimeoutError, EasySNMPError) as exc:
return False, str(exc)
def _get(self, host: str, oid: str) -> tuple[bool, str]:
"""Effectue un GET.
Args:
host: IP/hôte de l'équipement cible.
oid: OID SNMP à lire.
Returns:
Tuple ``(ok, valeur_ou_detail)``.
"""
logger.debug(f"SnmpDriver._get | host={host} oid={oid}")
try:
var = self._session(host).get(oid)
return True, var.value
except (
EasySNMPTimeoutError,
EasySNMPNoSuchObjectError,
EasySNMPNoSuchInstanceError,
EasySNMPError,
) as exc:
return False, str(exc)
def push(
self, host: str, server_ip: str, filename: str, username: str = "", password: str = ""
) -> tuple[bool, str]:
"""À implémenter : effectue le push de config.
Args:
host: IP/hôte de l'équipement cible.
server_ip: IP du serveur de dépôt (TFTP/FTP/SFTP).
filename: Nom du fichier de configuration à récupérer.
username: Identifiant optionnel pour le serveur de dépôt.
password: Mot de passe optionnel pour le serveur de dépôt.
Raises:
NotImplementedError: Toujours, cette méthode doit être surchargée.
"""
logger.debug(f"SnmpDriver.push | host={host} vendor={self.vendor_id}")
raise NotImplementedError
class H3cComwareDriver(SnmpDriver):
"""Driver H3C / HPE Comware (HH3C-CONFIG-MAN-MIB)."""
vendor_id = "h3c_comware"
display_name = "H3C / HPE Comware"
BASE = "1.3.6.1.4.1.25506.2.4.1.2.4.1"
RESULT_BASE = "1.3.6.1.4.1.25506.2.4.1.2.5.1"
FAIL_REASON_COL = 7
_STATE_IN_PROGRESS = 1
_STATE_SUCCESS = 2
def push(
self, host: str, server_ip: str, filename: str, username: str = "", password: str = ""
) -> tuple[bool, str]:
"""Push config sur H3C/Comware.
Args:
host: IP/hôte de l'équipement cible.
server_ip: IP du serveur de dépôt (TFTP/FTP).
filename: Nom du fichier de configuration à récupérer.
username: Identifiant optionnel pour le serveur de dépôt.
password: Mot de passe optionnel pour le serveur de dépôt.
Returns:
Tuple ``(ok, detail)``.
"""
logger.debug(
f"H3cComwareDriver.push | host={host} server_ip={server_ip} filename={filename}"
)
t0 = time.time()
idx = int(t0) % 2147483647 or 1
oid_values = [
(f"{self.BASE}.2.{idx}", "4", "i"),
(f"{self.BASE}.3.{idx}", "2", "i"),
(f"{self.BASE}.4.{idx}", filename, "s"),
(f"{self.BASE}.5.{idx}", server_ip, "a"),
]
if username:
oid_values.append((f"{self.BASE}.6.{idx}", username, "s"))
if password:
oid_values.append((f"{self.BASE}.7.{idx}", password, "s"))
oid_values.append((f"{self.BASE}.9.{idx}", "4", "i"))
ok, detail = self._set_multiple(host, oid_values)
if not ok:
return False, f"SET initial échoué: {detail}"
return self._poll_result_table(host, idx)
def _poll_result_table(self, host: str, op_idx: int) -> tuple[bool, str]:
"""Sonde la table de résultat jusqu'à succès/échec/timeout.
Args:
host: IP/hôte de l'équipement cible.
op_idx: Index de l'opération à surveiller dans la table de résultat.
Returns:
Tuple ``(ok, detail)``.
"""
logger.debug(f"H3cComwareDriver._poll_result_table | host={host} op_idx={op_idx}")
session = self._session(host)
deadline = time.time() + self.poll_timeout
while time.time() < deadline:
try:
rows = session.walk(f"{self.RESULT_BASE}.2")
except (EasySNMPTimeoutError, EasySNMPError) as exc:
return False, f"walk OperateResultTable échoué: {exc}"
match_row = None
for row in rows:
try:
if int(row.value) == op_idx:
match_row = row.oid_index
break
except (ValueError, TypeError):
continue
if match_row is not None:
try:
state_var = session.get(f"{self.RESULT_BASE}.4.{match_row}")
state = int(state_var.value)
if state != self._STATE_IN_PROGRESS:
if state == self._STATE_SUCCESS:
return True, "succès"
detail = f"état terminal non-succès (code={state})"
try:
reason = session.get(
f"{self.RESULT_BASE}.{self.FAIL_REASON_COL}.{match_row}"
)
detail += f" — raison: {reason.value}"
except (
EasySNMPError,
EasySNMPNoSuchObjectError,
EasySNMPNoSuchInstanceError,
):
pass
return False, detail
except (EasySNMPError, ValueError) as exc:
return False, f"erreur lecture State: {exc}"
time.sleep(self.poll_interval)
return False, "timeout en attente du résultat"
class CiscoConfigCopyDriver(SnmpDriver):
"""Driver Cisco IOS / IOS-XE (CISCO-CONFIG-COPY-MIB)."""
vendor_id = "cisco_ios"
display_name = "Cisco IOS / IOS-XE"
BASE = "1.3.6.1.4.1.9.9.96.1.1.1.1"
STATE_OID = f"{BASE}.10"
_STATE_WAITING = 1
_STATE_RUNNING = 2
_STATE_SUCCESSFUL = 3
_STATE_FAILED = 4
def push(
self, host: str, server_ip: str, filename: str, username: str = "", password: str = ""
) -> tuple[bool, str]:
"""Push config sur Cisco IOS/IOS-XE.
Args:
host: IP/hôte de l'équipement cible.
server_ip: IP du serveur de dépôt (TFTP/FTP).
filename: Nom du fichier de configuration à récupérer.
username: Identifiant optionnel pour le serveur de dépôt.
password: Mot de passe optionnel pour le serveur de dépôt.
Returns:
Tuple ``(ok, detail)``.
"""
logger.debug(
f"CiscoConfigCopyDriver.push | host={host} server_ip={server_ip} filename={filename}"
)
t0 = time.time()
idx = int(t0) % 2147483647 or 1
oid_values = [
(f"{self.BASE}.2.{idx}", "1", "i"),
(f"{self.BASE}.3.{idx}", "1", "i"),
(f"{self.BASE}.4.{idx}", "4", "i"),
(f"{self.BASE}.5.{idx}", server_ip, "a"),
(f"{self.BASE}.6.{idx}", filename, "s"),
]
if username:
oid_values.append((f"{self.BASE}.7.{idx}", username, "s"))
if password:
oid_values.append((f"{self.BASE}.8.{idx}", password, "s"))
oid_values.append((f"{self.BASE}.14.{idx}", "4", "i"))
ok, detail = self._set_multiple(host, oid_values)
if not ok:
return False, f"SET initial échoué: {detail}"
deadline = time.time() + self.poll_timeout
while time.time() < deadline:
ok, state_str = self._get(host, f"{self.STATE_OID}.{idx}")
if not ok:
time.sleep(self.poll_interval)
continue
try:
state = int(state_str)
except ValueError:
return False, f"state invalide: {state_str}"
if state == self._STATE_SUCCESSFUL:
return True, "succès"
elif state == self._STATE_FAILED:
return False, "la copie a échoué côté équipement"
elif state in (self._STATE_WAITING, self._STATE_RUNNING):
time.sleep(self.poll_interval)
continue
else:
return False, f"état inconnu: {state}"
return False, "timeout en attente de ccCopyState"
class HuaweiVrpDriver(SnmpDriver):
"""Driver Huawei VRP (HUAWEI-CONFIG-MAN-MIB).
Portage de ``HuaweiConfigMan`` (ancienne variante EasySNMP autonome,
``snmp_bulk_core_easysnmp.py``) vers l'architecture ``SnmpDriver``
partagée par ce module. Résout l'écart où ``SNMP_VENDORS`` proposait déjà
``huawei_vrp`` dans l'UI (`plugin_snmp_push.py`) sans qu'aucun driver ne
soit enregistré dans ``DRIVERS`` — un push Huawei échouait donc
systématiquement avec « Constructeur inconnu: huawei_vrp ».
⚠️ Codes ``hwCfgOperateState`` (colonne 4 de la table de résultat) :
vérifiés sur le texte officiel de HUAWEI-CONFIG-MAN-MIB V2.36, mais la
documentation constructeur elle-même signale que la plage de valeurs a
été révisée plusieurs fois selon les versions ; à confirmer par un
``snmpwalk -Ov`` sur le firmware VRP exact avant mise en prod (au
minimum ``opInProgress`` = 1 est stable, le code de succès l'est moins).
"""
vendor_id = "huawei_vrp"
display_name = "Huawei VRP"
# hwConfig(1.3.6.1.4.1.2011.6.10).hwConfigManObjects(1)
BASE = "1.3.6.1.4.1.2011.6.10.1.2.4.1" # hwCfgOperateEntry (requête)
RESULT_BASE = "1.3.6.1.4.1.2011.6.10.1.2.5.1" # hwCfgOperateResultEntry (résultat)
FAIL_REASON_COL = 8 # hwCfgOperateErrorReason
_STATE_IN_PROGRESS = 1
_STATE_SUCCESS = 2
def push(
self, host: str, server_ip: str, filename: str, username: str = "", password: str = ""
) -> tuple[bool, str]:
"""Push config sur Huawei VRP.
Args:
host: IP/hôte de l'équipement cible.
server_ip: IP du serveur de dépôt (TFTP/FTP).
filename: Nom du fichier de configuration à récupérer.
username: Identifiant optionnel pour le serveur de dépôt.
password: Mot de passe optionnel pour le serveur de dépôt.
Returns:
Tuple ``(ok, detail)``.
"""
logger.debug(
f"HuaweiVrpDriver.push | host={host} server_ip={server_ip} filename={filename}"
)
t0 = time.time()
idx = int(t0) % 2147483647 or 1
oid_values = [
(f"{self.BASE}.2.{idx}", "4", "i"), # hwCfgOperateType = net2Running
(f"{self.BASE}.3.{idx}", "2", "i"), # hwCfgOperateProtocol = tftp
(f"{self.BASE}.4.{idx}", filename, "s"), # hwCfgOperateFileName
# hwCfgOperateServerAddress — PAS .11 (hwCfgOperateSourceAddress,
# adresse source optionnelle du client, pas le serveur cible)
(f"{self.BASE}.5.{idx}", server_ip, "a"),
]
if username:
oid_values.append((f"{self.BASE}.6.{idx}", username, "s"))
if password:
oid_values.append((f"{self.BASE}.7.{idx}", password, "s"))
oid_values.append(
(f"{self.BASE}.9.{idx}", "4", "i")
) # hwCfgOperateRowStatus = createAndGo
ok, detail = self._set_multiple(host, oid_values)
if not ok:
return False, f"SET initial échoué: {detail}"
return self._poll_result_table(host, idx)
def _poll_result_table(self, host: str, op_idx: int) -> tuple[bool, str]:
"""Sonde la table de résultat jusqu'à succès/échec/timeout.
Args:
host: IP/hôte de l'équipement cible.
op_idx: Index de l'opération à surveiller dans la table de résultat.
Returns:
Tuple ``(ok, detail)``.
"""
logger.debug(f"HuaweiVrpDriver._poll_result_table | host={host} op_idx={op_idx}")
session = self._session(host)
deadline = time.time() + self.poll_timeout
while time.time() < deadline:
try:
rows = session.walk(f"{self.RESULT_BASE}.2") # colonne OptIndex
except (EasySNMPTimeoutError, EasySNMPError) as exc:
return False, f"walk OperateResultTable échoué: {exc}"
match_row = None
for row in rows:
try:
if int(row.value) == op_idx:
match_row = row.oid_index
break
except (ValueError, TypeError):
continue
if match_row is not None:
try:
state_var = session.get(f"{self.RESULT_BASE}.4.{match_row}")
state = int(state_var.value)
if state != self._STATE_IN_PROGRESS:
if state == self._STATE_SUCCESS:
return True, "succès"
detail = f"état terminal non-succès (code brut={state})"
try:
reason = session.get(
f"{self.RESULT_BASE}.{self.FAIL_REASON_COL}.{match_row}"
)
detail += f" — raison: {reason.value}"
except (
EasySNMPError,
EasySNMPNoSuchObjectError,
EasySNMPNoSuchInstanceError,
):
pass
return False, detail
except (EasySNMPError, ValueError) as exc:
return False, f"erreur lecture State: {exc}"
time.sleep(self.poll_interval)
return False, "timeout en attente du résultat"
# Registry des drivers
DRIVERS = {
"h3c_comware": H3cComwareDriver,
"cisco_ios": CiscoConfigCopyDriver,
"huawei_vrp": HuaweiVrpDriver,
}
# ────────────────────────────────────────────────────────────────────────
# Push et exécution par lot
# ────────────────────────────────────────────────────────────────────────
def push_to_device(
row: InventoryRow,
profile: SnmpProfile,
rendered_config: str,
log_dir: Path,
server_ip: str = "192.168.1.1",
) -> PushResult:
"""Push la config vers un équipement.
Args:
row: Ligne d'inventaire de l'équipement cible.
profile: Profil SNMP (constructeur + identifiants) à utiliser.
rendered_config: Configuration déjà rendue (variables substituées).
log_dir: Dossier où écrire le journal de cet envoi.
server_ip: IP du serveur de dépôt (TFTP/FTP/SFTP).
Returns:
Le ``PushResult`` de l'envoi.
"""
logger.debug(f"push_to_device | ip={row.ip} vendor={profile.vendor} server_ip={server_ip}")
t0 = time.time()
driver_class = DRIVERS.get(profile.vendor)
if not driver_class:
return PushResult(
row=row,
status=STATUS_REJECTED,
error=f"Constructeur inconnu: {profile.vendor}",
duration_s=time.time() - t0,
)
try:
driver = driver_class(
auth=profile.auth,
port=profile.port,
timeout=profile.timeout,
retries=profile.retries,
poll_interval=profile.poll_interval,
poll_timeout=profile.poll_timeout,
)
filename = f"config_{row.ip}.txt"
ok, detail = driver.push(row.ip, server_ip, filename)
status = STATUS_OK if ok else STATUS_FAILED
except Exception as exc:
status = STATUS_FAILED
detail = str(exc)
logger.exception(f"Exception durant push vers {row.ip}: {exc}")
log_path = log_dir / f"{row.line_no}_{row.ip}.log"
try:
log_path.write_text(f"{status}: {detail}\n", encoding="utf-8")
except OSError:
pass
return PushResult(
row=row,
status=status,
error=detail if status != STATUS_OK else "",
log_path=str(log_path),
duration_s=time.time() - t0,
)
def run_bulk_push(
rows: list[InventoryRow],
profiles: SnmpProfileStore,
template_text: str,
log_dir: str | Path,
max_workers: int = 10,
on_row_start: Callable[[InventoryRow], None] | None = None,
on_row_done: Callable[[PushResult], None] | None = None,
cancel_event: threading.Event | None = None,
server_ip: str = "192.168.1.1",
) -> list[PushResult]:
"""Pousse la config sur tous les équipements en parallèle.
Args:
rows: Lignes d'inventaire à traiter.
profiles: Magasin de profils SNMP.
template_text: Contenu du gabarit de configuration.
log_dir: Dossier où écrire les journaux d'envoi.
max_workers: Nombre d'envois parallèles.
on_row_start: Callback appelé avant l'envoi d'une ligne.
on_row_done: Callback appelé après l'envoi d'une ligne.
cancel_event: Événement permettant d'annuler l'exécution en cours.
server_ip: IP du serveur de dépôt (TFTP/FTP/SFTP).
Returns:
Liste des ``PushResult`` de tous les envois effectués.
"""
logger.debug(
f"run_bulk_push | n_rows={len(rows)} max_workers={max_workers} server_ip={server_ip}"
)
if cancel_event is None:
cancel_event = threading.Event()
log_path = Path(log_dir)
log_path.mkdir(parents=True, exist_ok=True)
results = []
with ThreadPoolExecutor(max_workers=max_workers) as executor:
futures = {}
for row in rows:
profile = profiles.get(row.profile_name)
if not profile:
result = PushResult(
row=row,
status=STATUS_REJECTED,
error=f"Profil '{row.profile_name}' inexistant",
duration_s=0.0,
)
results.append(result)
if on_row_done:
on_row_done(result)
continue
if on_row_start:
on_row_start(row)
rendered = render_template(template_text, row.variables)
future = executor.submit(push_to_device, row, profile, rendered, log_path, server_ip)
futures[future] = row
for future in as_completed(futures):
if cancel_event.is_set():
executor.shutdown(wait=False, cancel_futures=True)
break
result = future.result()
results.append(result)
if on_row_done:
on_row_done(result)
return results
# ────────────────────────────────────────────────────────────────────────
# Résumé
# ────────────────────────────────────────────────────────────────────────
def summarize_results(results: list[PushResult]) -> dict[str, int]:
"""Résumé des résultats.
Args:
results: Liste des ``PushResult`` à résumer.
Returns:
Dictionnaire des compteurs (total/ok/rejected/failed/skipped).
"""
logger.debug(f"summarize_results | n={len(results)}")
return {
"total": len(results),
"ok": sum(1 for r in results if r.status == STATUS_OK),
"rejected": sum(1 for r in results if r.status == STATUS_REJECTED),
"failed": sum(1 for r in results if r.status == STATUS_FAILED),
"skipped": sum(1 for r in results if r.status == STATUS_SKIPPED),
}