This repository has been archived by the owner on Mar 7, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 30
/
eos.py
1645 lines (1432 loc) · 66.1 KB
/
eos.py
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
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2015 Spotify AB. All rights reserved.
#
# The contents of this file are licensed under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with the
# License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""
Napalm driver for Arista EOS.
Read napalm.readthedocs.org for more information.
"""
from __future__ import print_function
from __future__ import unicode_literals
# std libs
import re
import time
from datetime import datetime
from collections import defaultdict
from netaddr import IPAddress
from netaddr import IPNetwork
from netaddr.core import AddrFormatError
# third party libs
import pyeapi
from pyeapi.eapilib import ConnectionError
# NAPALM base
import napalm_base.helpers
from napalm_base.base import NetworkDriver
from napalm_base.utils import string_parsers
from napalm_base.utils import py23_compat
from napalm_base.exceptions import ConnectionException, MergeConfigException, \
ReplaceConfigException, SessionLockedException, CommandErrorException
import napalm_base.constants as c
# local modules
# here add local imports
# e.g. import napalm_eos.helpers etc.
class EOSDriver(NetworkDriver):
"""Napalm driver for Arista EOS."""
SUPPORTED_OC_MODELS = []
_RE_BGP_INFO = re.compile('BGP neighbor is (?P<neighbor>.*?), remote AS (?P<as>.*?), .*') # noqa
_RE_BGP_RID_INFO = re.compile('.*BGP version 4, remote router ID (?P<rid>.*?), VRF (?P<vrf>.*?)$') # noqa
_RE_BGP_DESC = re.compile('\s+Description: (?P<description>.*?)')
_RE_BGP_LOCAL = re.compile('Local AS is (?P<as>.*?),.*')
_RE_BGP_PREFIX = re.compile('(\s*?)(?P<af>IPv[46]) Unicast:\s*(?P<sent>\d+)\s*(?P<received>\d+)') # noqa
_RE_SNMP_COMM = re.compile(r"""^snmp-server\s+community\s+(?P<community>\S+)
(\s+view\s+(?P<view>\S+))?(\s+(?P<access>ro|rw)?)
(\s+ipv6\s+(?P<v6_acl>\S+))?(\s+(?P<v4_acl>\S+))?$""", re.VERBOSE)
def __init__(self, hostname, username, password, timeout=60, optional_args=None):
"""Constructor."""
self.device = None
self.hostname = hostname
self.username = username
self.password = password
self.timeout = timeout
self.config_session = None
if optional_args is None:
optional_args = {}
self.transport = optional_args.get('eos_transport', 'https')
if self.transport == 'https':
self.port = optional_args.get('port', 443)
elif self.transport == 'http':
self.port = optional_args.get('port', 80)
self.enablepwd = optional_args.get('enable_password', '')
def open(self):
"""Implementation of NAPALM method open."""
try:
if self.transport in ('http', 'https'):
connection = pyeapi.client.connect(
transport=self.transport,
host=self.hostname,
username=self.username,
password=self.password,
port=self.port,
timeout=self.timeout
)
elif self.transport == 'socket':
connection = pyeapi.client.connect(transport=self.transport)
else:
raise ConnectionException("Unknown transport: {}".format(self.transport))
if self.device is None:
self.device = pyeapi.client.Node(connection, enablepwd=self.enablepwd)
# does not raise an Exception if unusable
# let's try to run a very simple command
self.device.run_commands(['show clock'], encoding='text')
except ConnectionError as ce:
# and this is raised either if device not avaiable
# either if HTTP(S) agent is not enabled
# show management api http-commands
raise ConnectionException(ce.message)
def close(self):
"""Implementation of NAPALM method close."""
self.discard_config()
def is_alive(self):
return {
'is_alive': True # always true as eAPI is HTTP-based
}
def _load_config(self, filename=None, config=None, replace=True):
if self.config_session is not None:
raise SessionLockedException('Session is already in use by napalm')
else:
self.config_session = 'napalm_{}'.format(datetime.now().microsecond)
commands = []
commands.append('configure session {}'.format(self.config_session))
if replace:
commands.append('rollback clean-config')
if filename is not None:
with open(filename, 'r') as f:
lines = f.readlines()
else:
if isinstance(config, list):
lines = config
else:
lines = config.splitlines()
for line in lines:
line = line.strip()
if line == '':
continue
if line.startswith('!'):
continue
commands.append(line)
try:
self.device.run_commands(commands)
except pyeapi.eapilib.CommandError as e:
self.discard_config()
if replace:
raise ReplaceConfigException(e.message)
else:
raise MergeConfigException(e.message)
def load_replace_candidate(self, filename=None, config=None):
"""Implementation of NAPALM method load_replace_candidate."""
self._load_config(filename, config, True)
def load_merge_candidate(self, filename=None, config=None):
"""Implementation of NAPALM method load_merge_candidate."""
self._load_config(filename, config, False)
def compare_config(self):
"""Implementation of NAPALM method compare_config."""
if self.config_session is None:
return ''
else:
commands = ['show session-config named %s diffs' % self.config_session]
result = self.device.run_commands(commands, encoding='text')[0]['output']
result = '\n'.join(result.splitlines()[2:])
return result.strip()
def commit_config(self):
"""Implementation of NAPALM method commit_config."""
commands = []
commands.append('copy startup-config flash:rollback-0')
commands.append('configure session {}'.format(self.config_session))
commands.append('commit')
commands.append('write memory')
self.device.run_commands(commands)
self.config_session = None
def discard_config(self):
"""Implementation of NAPALM method discard_config."""
if self.config_session is not None:
commands = []
commands.append('configure session {}'.format(self.config_session))
commands.append('abort')
self.device.run_commands(commands)
self.config_session = None
def rollback(self):
"""Implementation of NAPALM method rollback."""
commands = []
commands.append('configure replace flash:rollback-0')
commands.append('write memory')
self.device.run_commands(commands)
def get_facts(self):
"""Implementation of NAPALM method get_facts."""
commands = []
commands.append('show version')
commands.append('show hostname')
commands.append('show interfaces')
result = self.device.run_commands(commands)
version = result[0]
hostname = result[1]
interfaces_dict = result[2]['interfaces']
uptime = time.time() - version['bootupTimestamp']
interfaces = [i for i in interfaces_dict.keys() if '.' not in i]
interfaces = string_parsers.sorted_nicely(interfaces)
return {
'hostname': hostname['hostname'],
'fqdn': hostname['fqdn'],
'vendor': u'Arista',
'model': version['modelName'],
'serial_number': version['serialNumber'],
'os_version': version['internalVersion'],
'uptime': int(uptime),
'interface_list': interfaces,
}
def get_interfaces(self):
commands = []
commands.append('show interfaces')
output = self.device.run_commands(commands)[0]
interfaces = {}
for interface, values in output['interfaces'].items():
interfaces[interface] = {}
if values['lineProtocolStatus'] == 'up':
interfaces[interface]['is_up'] = True
interfaces[interface]['is_enabled'] = True
else:
interfaces[interface]['is_up'] = False
if values['interfaceStatus'] == 'disabled':
interfaces[interface]['is_enabled'] = False
else:
interfaces[interface]['is_enabled'] = True
interfaces[interface]['description'] = values['description']
interfaces[interface]['last_flapped'] = values.pop('lastStatusChangeTimestamp', None)
interfaces[interface]['speed'] = int(values['bandwidth'] * 1e-6)
interfaces[interface]['mac_address'] = napalm_base.helpers.convert(
napalm_base.helpers.mac, values.pop('physicalAddress', u''))
return interfaces
def get_lldp_neighbors(self):
commands = []
commands.append('show lldp neighbors')
output = self.device.run_commands(commands)[0]['lldpNeighbors']
lldp = {}
for n in output:
if n['port'] not in lldp.keys():
lldp[n['port']] = []
lldp[n['port']].append(
{
'hostname': n['neighborDevice'],
'port': n['neighborPort'],
}
)
return lldp
def get_interfaces_counters(self):
commands = ['show interfaces']
output = self.device.run_commands(commands)
interface_counters = defaultdict(dict)
for interface, data in output[0]['interfaces'].items():
if data['hardware'] == 'subinterface':
# Subinterfaces will never have counters so no point in parsing them at all
continue
counters = data.get('interfaceCounters', {})
interface_counters[interface].update(
tx_octets=counters.get('outOctets', -1),
rx_octets=counters.get('inOctets', -1),
tx_unicast_packets=counters.get('outUcastPkts', -1),
rx_unicast_packets=counters.get('inUcastPkts', -1),
tx_multicast_packets=counters.get('outMulticastPkts', -1),
rx_multicast_packets=counters.get('inMulticastPkts', -1),
tx_broadcast_packets=counters.get('outBroadcastPkts', -1),
rx_broadcast_packets=counters.get('inBroadcastPkts', -1),
tx_discards=counters.get('outDiscards', -1),
rx_discards=counters.get('inDiscards', -1),
tx_errors=counters.get('totalOutErrors', -1),
rx_errors=counters.get('totalInErrors', -1)
)
return interface_counters
def get_bgp_neighbors(self):
def get_re_group(res, key, default=None):
""" Small helper to retrive data from re match groups"""
try:
return res.group(key)
except KeyError:
return default
NEIGHBOR_FILTER = 'bgp neighbors vrf all | include remote AS | remote router ID |IPv[46] Unicast:.*[0-9]+|^Local AS|Desc|BGP state' # noqa
output_summary_cmds = self.device.run_commands(
['show ipv6 bgp summary vrf all', 'show ip bgp summary vrf all'],
encoding='json')
output_neighbor_cmds = self.device.run_commands(
['show ip ' + NEIGHBOR_FILTER, 'show ipv6 ' + NEIGHBOR_FILTER],
encoding='text')
bgp_counters = defaultdict(lambda: dict(peers={}))
for summary in output_summary_cmds:
"""
Json output looks as follows
"vrfs": {
"default": {
"routerId": 1,
"asn": 1,
"peers": {
"1.1.1.1": {
"msgSent": 1,
"inMsgQueue": 0,
"prefixReceived": 3926,
"upDownTime": 1449501378.418644,
"version": 4,
"msgReceived": 59616,
"prefixAccepted": 3926,
"peerState": "Established",
"outMsgQueue": 0,
"underMaintenance": false,
"asn": 1
}
}
}
}
"""
for vrf, vrf_data in summary['vrfs'].items():
bgp_counters[vrf]['router_id'] = vrf_data['routerId']
for peer, peer_data in vrf_data['peers'].items():
if peer_data['peerState'] == 'Idle':
is_enabled = True if peer_data['peerStateIdleReason'] != 'Admin' else False
else:
is_enabled = True
peer_info = {
'is_up': peer_data['peerState'] == 'Established',
'is_enabled': is_enabled,
'uptime': int(time.time() - peer_data['upDownTime'])
}
bgp_counters[vrf]['peers'][napalm_base.helpers.ip(peer)] = peer_info
lines = []
[lines.extend(x['output'].splitlines()) for x in output_neighbor_cmds]
while lines:
"""
Raw output from the command looks like the following:
BGP neighbor is 1.1.1.1, remote AS 1, external link
Description: Very info such descriptive
BGP version 4, remote router ID 1.1.1.1, VRF my_vrf
BGP state is Idle, Administratively shut down
IPv4 Unicast: 683 78
IPv6 Unicast: 0 0
Local AS is 2, local router ID 2.2.2.2
"""
neighbor_info = re.match(self._RE_BGP_INFO, lines.pop(0))
# this line can be either description or rid info
next_line = lines.pop(0)
desc = re.match(self._RE_BGP_DESC, next_line)
if desc is None:
rid_info = re.match(self._RE_BGP_RID_INFO, next_line)
desc = ''
else:
rid_info = re.match(self._RE_BGP_RID_INFO, lines.pop(0))
desc = desc.group('description')
lines.pop(0)
v4_stats = re.match(self._RE_BGP_PREFIX, lines.pop(0))
v6_stats = re.match(self._RE_BGP_PREFIX, lines.pop(0))
local_as = re.match(self._RE_BGP_LOCAL, lines.pop(0))
data = {
'remote_as': int(neighbor_info.group('as')),
'remote_id': napalm_base.helpers.ip(get_re_group(rid_info, 'rid', '0.0.0.0')),
'local_as': int(local_as.group('as')),
'description': py23_compat.text_type(desc),
'address_family': {
'ipv4': {
'sent_prefixes': int(get_re_group(v4_stats, 'sent', -1)),
'received_prefixes': int(get_re_group(v4_stats, 'received', -1)),
'accepted_prefixes': -1
},
'ipv6': {
'sent_prefixes': int(get_re_group(v6_stats, 'sent', -1)),
'received_prefixes': int(get_re_group(v6_stats, 'received', -1)),
'accepted_prefixes': -1
}
}
}
peer_addr = napalm_base.helpers.ip(neighbor_info.group('neighbor'))
vrf = rid_info.group('vrf')
if peer_addr not in bgp_counters[vrf]['peers']:
bgp_counters[vrf]['peers'][peer_addr] = {
'is_up': False, # if not found, means it was not found in the oper stats
# i.e. neighbor down,
'uptime': 0,
'is_enabled': True
}
bgp_counters[vrf]['peers'][peer_addr].update(data)
if 'default' in bgp_counters:
bgp_counters['global'] = bgp_counters.pop('default')
return dict(bgp_counters)
def get_environment(self):
def extract_temperature_data(data):
for s in data:
temp = s['currentTemperature'] if 'currentTemperature' in s else 0.0
name = s['name']
values = {
'temperature': temp,
'is_alert': temp > s['overheatThreshold'],
'is_critical': temp > s['criticalThreshold']
}
yield name, values
sh_version_out = self.device.run_commands(['show version'])
is_veos = sh_version_out[0]['modelName'].lower() == 'veos'
commands = [
'show environment cooling',
'show environment temperature'
]
if not is_veos:
commands.append('show environment power')
fans_output, temp_output, power_output = self.device.run_commands(commands)
else:
fans_output, temp_output = self.device.run_commands(commands)
environment_counters = {
'fans': {},
'temperature': {},
'power': {},
'cpu': {}
}
cpu_output = self.device.run_commands(['show processes top once'],
encoding='text')[0]['output']
for slot in fans_output['fanTraySlots']:
environment_counters['fans'][slot['label']] = {'status': slot['status'] == 'ok'}
# First check FRU's
for fru_type in ['cardSlots', 'powerSupplySlots']:
for fru in temp_output[fru_type]:
t = {name: value for name, value in extract_temperature_data(fru['tempSensors'])}
environment_counters['temperature'].update(t)
# On board sensors
parsed = {n: v for n, v in extract_temperature_data(temp_output['tempSensors'])}
environment_counters['temperature'].update(parsed)
if not is_veos:
for psu, data in power_output['powerSupplies'].items():
environment_counters['power'][psu] = {
'status': data['state'] == 'ok',
'capacity': data['capacity'],
'output': data['outputPower']
}
cpu_lines = cpu_output.splitlines()
# Matches either of
# Cpu(s): 5.2%us, 1.4%sy, 0.0%ni, 92.2%id, 0.6%wa, 0.3%hi, 0.4%si, 0.0%st ( 4.16 > )
# %Cpu(s): 4.2 us, 0.9 sy, 0.0 ni, 94.6 id, 0.0 wa, 0.1 hi, 0.2 si, 0.0 st ( 4.16 < )
m = re.match('.*ni, (?P<idle>.*).id.*', cpu_lines[2])
environment_counters['cpu'][0] = {
'%usage': round(100 - float(m.group('idle')), 1)
}
# Matches either of
# Mem: 3844356k total, 3763184k used, 81172k free, 16732k buffers ( 4.16 > )
# KiB Mem: 32472080 total, 5697604 used, 26774476 free, 372052 buffers ( 4.16 < )
mem_regex = '.*total,\s+(?P<used>\d+)[k\s]+used,\s+(?P<free>\d+)[k\s]+free,.*'
m = re.match(mem_regex, cpu_lines[3])
environment_counters['memory'] = {
'available_ram': int(m.group('free')),
'used_ram': int(m.group('used'))
}
return environment_counters
def get_lldp_neighbors_detail(self, interface=''):
lldp_neighbors_out = {}
filters = []
if interface:
filters.append(interface)
commands = []
commands.append(
'show lldp neighbors {filters} detail'.format(
filters=' '.join(filters)
)
)
lldp_neighbors_in = {}
lldp_neighbors_in = self.device.run_commands(commands)[0].get('lldpNeighbors', {})
for interface in lldp_neighbors_in:
interface_neighbors = lldp_neighbors_in.get(interface).get('lldpNeighborInfo', {})
if not interface_neighbors:
# in case of empty infos
continue
# it is provided a list of neighbors per interface
for neighbor in interface_neighbors:
if interface not in lldp_neighbors_out.keys():
lldp_neighbors_out[interface] = []
capabilities = neighbor.get('systemCapabilities')
capabilities_list = list(capabilities.keys())
capabilities_list.sort()
lldp_neighbors_out[interface].append(
{
'parent_interface': interface, # no parent interfaces
'remote_port':
neighbor.get('neighborInterfaceInfo', {}).get('interfaceId', u''),
'remote_port_description': u'',
'remote_system_name': neighbor.get('systemName', u''),
'remote_system_description': neighbor.get('systemDescription', u''),
'remote_chassis_id': napalm_base.helpers.mac(
neighbor.get('chassisId', u'')),
'remote_system_capab': py23_compat.text_type(', '.join(capabilities_list)),
'remote_system_enable_capab': py23_compat.text_type(', '.join(
[capability for capability in capabilities_list
if capabilities[capability]]))
}
)
return lldp_neighbors_out
def cli(self, commands):
cli_output = {}
if type(commands) is not list:
raise TypeError('Please enter a valid list of commands!')
for command in commands:
try:
cli_output[py23_compat.text_type(command)] = self.device.run_commands(
[command], encoding='text')[0].get('output')
# not quite fair to not exploit rum_commands
# but at least can have better control to point to wrong command in case of failure
except pyeapi.eapilib.CommandError:
# for sure this command failed
cli_output[py23_compat.text_type(command)] = 'Invalid command: "{cmd}"'.format(
cmd=command
)
raise CommandErrorException(str(cli_output))
except Exception as e:
# something bad happened
msg = 'Unable to execute command "{cmd}": {err}'.format(cmd=command, err=e)
cli_output[py23_compat.text_type(command)] = msg
raise CommandErrorException(str(cli_output))
return cli_output
def get_bgp_config(self, group='', neighbor=''):
"""Implementation of NAPALM method get_bgp_config."""
_GROUP_FIELD_MAP_ = {
'type': 'type',
'multipath': 'multipath',
'apply-groups': 'apply_groups',
'remove-private-as': 'remove_private_as',
'ebgp-multihop': 'multihop_ttl',
'remote-as': 'remote_as',
'local-v4-addr': 'local_address',
'local-v6-addr': 'local_address',
'local-as': 'local_as',
'description': 'description',
'import-policy': 'import_policy',
'export-policy': 'export_policy'
}
_PEER_FIELD_MAP_ = {
'description': 'description',
'remote-as': 'remote_as',
'local-v4-addr': 'local_address',
'local-v6-addr': 'local_address',
'local-as': 'local_as',
'next-hop-self': 'nhs',
'route-reflector-client': 'route_reflector_client',
'description': 'description',
'import-policy': 'import_policy',
'export-policy': 'export_policy',
'passwd': 'authentication_key'
}
_PROPERTY_FIELD_MAP_ = _GROUP_FIELD_MAP_.copy()
_PROPERTY_FIELD_MAP_.update(_PEER_FIELD_MAP_)
_PROPERTY_TYPE_MAP_ = {
# used to determine the default value
# and cast the values
'remote-as': int,
'ebgp-multihop': int,
'local-v4-addr': py23_compat.text_type,
'local-v6-addr': py23_compat.text_type,
'local-as': int,
'remove-private-as': bool,
'next-hop-self': bool,
'description': py23_compat.text_type,
'route-reflector-client': bool,
'password': py23_compat.text_type,
'route-map': py23_compat.text_type,
'apply-groups': list,
'type': py23_compat.text_type,
'import-policy': py23_compat.text_type,
'export-policy': py23_compat.text_type,
'multipath': bool
}
_DATATYPE_DEFAULT_ = {
py23_compat.text_type: '',
int: 0,
bool: False,
list: []
}
def default_group_dict(local_as):
group_dict = {}
group_dict.update({
key: _DATATYPE_DEFAULT_.get(_PROPERTY_TYPE_MAP_.get(prop))
for prop, key in _GROUP_FIELD_MAP_.items()
})
group_dict.update({
'prefix_limit': {},
'neighbors': {},
'local_as': local_as
}) # few more default values
return group_dict
def default_neighbor_dict(local_as):
neighbor_dict = {}
neighbor_dict.update({
key: _DATATYPE_DEFAULT_.get(_PROPERTY_TYPE_MAP_.get(prop))
for prop, key in _PEER_FIELD_MAP_.items()
}) # populating with default values
neighbor_dict.update({
'prefix_limit': {},
'local_as': local_as,
'authentication_key': u''
}) # few more default values
return neighbor_dict
def parse_options(options, default_value=False):
if not options:
return {}
config_property = options[0]
field_name = _PROPERTY_FIELD_MAP_.get(config_property)
field_type = _PROPERTY_TYPE_MAP_.get(config_property)
field_value = _DATATYPE_DEFAULT_.get(field_type) # to get the default value
if not field_type:
# no type specified at all => return empty dictionary
return {}
if not default_value:
if len(options) > 1:
field_value = napalm_base.helpers.convert(field_type,
options[1],
_DATATYPE_DEFAULT_.get(field_type))
else:
if field_type is bool:
field_value = True
if field_name is not None:
return {field_name: field_value}
elif config_property in ['route-map', 'password']:
# do not respect the pattern neighbor [IP_ADDRESS] [PROPERTY] [VALUE]
# or need special output (e.g.: maximum-routes)
if config_property == 'password':
return {'authentication_key': py23_compat.text_type(options[2])}
# returns the MD5 password
if config_property == 'route-map':
direction = None
if len(options) == 3:
direction = options[2]
field_value = field_type(options[1]) # the name of the policy
elif len(options) == 2:
direction = options[1]
if direction == 'in':
field_name = 'import_policy'
else:
field_name = 'export_policy'
return {field_name: field_value}
return {}
bgp_config = {}
commands = []
commands.append('show running-config | section router bgp')
bgp_conf = self.device.run_commands(commands, encoding='text')[0].get('output', '\n\n')
bgp_conf_lines = bgp_conf.splitlines()
bgp_neighbors = {}
if not group:
neighbor = '' # noqa
local_as = 0
bgp_neighbors = {}
for bgp_conf_line in bgp_conf_lines:
default_value = False
bgp_conf_line = bgp_conf_line.strip()
if bgp_conf_line.startswith('router bgp'):
local_as = int(bgp_conf_line.replace('router bgp', '').strip())
continue
if not (bgp_conf_line.startswith('neighbor') or
bgp_conf_line.startswith('no neighbor')):
continue
if bgp_conf_line.startswith('no'):
default_value = True
bgp_conf_line = bgp_conf_line.replace('no neighbor ', '').replace('neighbor ', '')
bgp_conf_line_details = bgp_conf_line.split()
group_or_neighbor = py23_compat.text_type(bgp_conf_line_details[0])
options = bgp_conf_line_details[1:]
try:
# will try to parse the neighbor name
# which sometimes is the IP Address of the neigbor
# or the name of the BGP group
IPAddress(group_or_neighbor)
# if passes the test => it is an IP Address, thus a Neighbor!
peer_address = group_or_neighbor
if peer_address not in bgp_neighbors:
bgp_neighbors[peer_address] = default_neighbor_dict(local_as)
if options[0] == 'peer-group':
bgp_neighbors[peer_address]['__group'] = options[1]
# in the config, neighbor details are lister after
# the group is specified for the neighbor:
#
# neighbor 192.168.172.36 peer-group 4-public-anycast-peers
# neighbor 192.168.172.36 remote-as 12392
# neighbor 192.168.172.36 maximum-routes 200
#
# because the lines are parsed sequentially
# can use the last group detected
# that way we avoid one more loop to
# match the neighbors with the group they belong to
# directly will apend the neighbor in the neighbor list of the group at the end
bgp_neighbors[peer_address].update(
parse_options(options, default_value)
)
except AddrFormatError:
# exception trying to parse group name
# group_or_neighbor represents the name of the group
group_name = group_or_neighbor
if group and group_name != group:
continue
if group_name not in bgp_config.keys():
bgp_config[group_name] = default_group_dict(local_as)
bgp_config[group_name].update(
parse_options(options, default_value)
)
for peer, peer_details in bgp_neighbors.items():
peer_group = peer_details.pop('__group', None)
if not peer_group:
peer_group = '_'
if peer_group not in bgp_config:
bgp_config[peer_group] = default_group_dict(local_as)
bgp_config[peer_group]['neighbors'][peer] = peer_details
return bgp_config
def get_arp_table(self):
arp_table = []
commands = ['show arp']
ipv4_neighbors = []
try:
ipv4_neighbors = self.device.run_commands(commands)[0].get('ipV4Neighbors', [])
except pyeapi.eapilib.CommandError:
return []
for neighbor in ipv4_neighbors:
interface = py23_compat.text_type(neighbor.get('interface'))
mac_raw = neighbor.get('hwAddress')
ip = py23_compat.text_type(neighbor.get('address'))
age = float(neighbor.get('age'))
arp_table.append(
{
'interface': interface,
'mac': napalm_base.helpers.mac(mac_raw),
'ip': napalm_base.helpers.ip(ip),
'age': age
}
)
return arp_table
def get_ntp_servers(self):
commands = ['show running-config | section ntp']
raw_ntp_config = self.device.run_commands(commands, encoding='text')[0].get('output', '')
ntp_config = napalm_base.helpers.textfsm_extractor(self, 'ntp_peers', raw_ntp_config)
return {py23_compat.text_type(ntp_peer.get('ntppeer')): {}
for ntp_peer in ntp_config if ntp_peer.get('ntppeer', '')}
def get_ntp_stats(self):
ntp_stats = []
REGEX = (
'^\s?(\+|\*|x|-)?([a-zA-Z0-9\.+-:]+)'
'\s+([a-zA-Z0-9\.]+)\s+([0-9]{1,2})'
'\s+(-|u)\s+([0-9h-]+)\s+([0-9]+)'
'\s+([0-9]+)\s+([0-9\.]+)\s+([0-9\.-]+)'
'\s+([0-9\.]+)\s?$'
)
commands = []
commands.append('show ntp associations')
# output = self.device.run_commands(commands)
# pyeapi.eapilib.CommandError: CLI command 2 of 2 'show ntp associations'
# failed: unconverted command
# JSON output not yet implemented...
ntp_assoc = self.device.run_commands(commands, encoding='text')[0].get('output', '\n\n')
ntp_assoc_lines = ntp_assoc.splitlines()[2:]
for ntp_assoc in ntp_assoc_lines:
line_search = re.search(REGEX, ntp_assoc, re.I)
if not line_search:
continue # pattern not found
line_groups = line_search.groups()
try:
ntp_stats.append({
'remote': py23_compat.text_type(line_groups[1]),
'synchronized': (line_groups[0] == '*'),
'referenceid': py23_compat.text_type(line_groups[2]),
'stratum': int(line_groups[3]),
'type': py23_compat.text_type(line_groups[4]),
'when': py23_compat.text_type(line_groups[5]),
'hostpoll': int(line_groups[6]),
'reachability': int(line_groups[7]),
'delay': float(line_groups[8]),
'offset': float(line_groups[9]),
'jitter': float(line_groups[10])
})
except Exception:
continue # jump to next line
return ntp_stats
def get_interfaces_ip(self):
interfaces_ip = {}
interfaces_ipv4_out = self.device.run_commands(['show ip interface'])[0]['interfaces']
try:
interfaces_ipv6_out = self.device.run_commands(['show ipv6 interface'])[0]['interfaces']
except pyeapi.eapilib.CommandError as e:
if 'No IPv6 configured interfaces' in e.message:
interfaces_ipv6_out = {}
else:
raise
for interface_name, interface_details in interfaces_ipv4_out.items():
ipv4_list = []
if interface_name not in interfaces_ip.keys():
interfaces_ip[interface_name] = {}
if u'ipv4' not in interfaces_ip.get(interface_name):
interfaces_ip[interface_name][u'ipv4'] = {}
if u'ipv6' not in interfaces_ip.get(interface_name):
interfaces_ip[interface_name][u'ipv6'] = {}
iface_details = interface_details.get('interfaceAddress', {})
if iface_details.get('primaryIp', {}).get('address') != '0.0.0.0':
ipv4_list.append(
{
'address': napalm_base.helpers.ip(iface_details.get(
'primaryIp', {}).get('address')),
'masklen': iface_details.get('primaryIp', {}).get('maskLen')
}
)
for secondary_ip in iface_details.get('secondaryIpsOrderedList', []):
ipv4_list.append(
{
'address': napalm_base.helpers.ip(secondary_ip.get('address')),
'masklen': secondary_ip.get('maskLen')
}
)
for ip in ipv4_list:
if not ip.get('address'):
continue
if ip.get('address') not in interfaces_ip.get(interface_name).get(u'ipv4'):
interfaces_ip[interface_name][u'ipv4'][ip.get('address')] = {
u'prefix_length': ip.get('masklen')
}
for interface_name, interface_details in interfaces_ipv6_out.items():
ipv6_list = []
if interface_name not in interfaces_ip.keys():
interfaces_ip[interface_name] = {}
if u'ipv4' not in interfaces_ip.get(interface_name):
interfaces_ip[interface_name][u'ipv4'] = {}
if u'ipv6' not in interfaces_ip.get(interface_name):
interfaces_ip[interface_name][u'ipv6'] = {}
ipv6_list.append(
{
'address': napalm_base.helpers.convert(
napalm_base.helpers.ip, interface_details.get('linkLocal', {})
.get('address')),
'masklen': int(
interface_details.get('linkLocal', {}).get('subnet', '::/0').split('/')[-1])
# when no link-local set, address will be None and maslken 0
}
)
for address in interface_details.get('addresses'):
ipv6_list.append(
{
'address': napalm_base.helpers.ip(address.get('address')),
'masklen': int(address.get('subnet').split('/')[-1])
}
)
for ip in ipv6_list:
if not ip.get('address'):
continue
if ip.get('address') not in interfaces_ip.get(interface_name).get(u'ipv6'):
interfaces_ip[interface_name][u'ipv6'][ip.get('address')] = {
u'prefix_length': ip.get('masklen')
}
return interfaces_ip
def get_mac_address_table(self):
mac_table = []
commands = ['show mac address-table']
mac_entries = []
try:
mac_entries = self.device.run_commands(commands)[0].get(
'unicastTable', {}).get('tableEntries', [])
except Exception:
return {}
for mac_entry in mac_entries:
vlan = mac_entry.get('vlanId')
interface = mac_entry.get('interface')
mac_raw = mac_entry.get('macAddress')
static = (mac_entry.get('entryType') == 'static')
last_move = mac_entry.get('lastMove', 0.0)
moves = mac_entry.get('moves', 0)
mac_table.append(
{
'mac': napalm_base.helpers.mac(mac_raw),
'interface': interface,
'vlan': vlan,
'active': True,
'static': static,
'moves': moves,
'last_move': last_move
}
)
return mac_table
def get_route_to(self, destination='', protocol=''):
routes = {}
if protocol.lower() == 'direct':
protocol = 'connected'
try:
ipv = ''
if IPNetwork(destination).version == 6:
ipv = 'v6'
except AddrFormatError:
return 'Please specify a valid destination!'