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
|
# Copyright (c) 2016 Hochikong
from pxssh import pxssh
from vyroute.basic_function import Modifylo
from vyroute.basic_function import StaticRoute
from vyroute.basic_function import RIPRoute
from vyroute.basic_function import OSPFRoute
from vyroute.basic_function import DeleteRoute
from vyroute.basic_function import BGPRoute
class Router(object):
pass
class BasicRouter(Router):
def __init__(self, address, cred):
"""Initial a router object
:param address: Router address,example:'192.168.10.10'
:param cred: Router user and password,example:'vyos:vyos'
"""
self.__address = address
self.__cred = list(cred)
self.__divi = self.__cred.index(":")
self.__username = ''.join(self.__cred[:self.__divi])
self.__passwd = ''.join(self.__cred[self.__divi+1:])
self.__conn = pxssh()
self.__status = {"status": None, "commit": None, "save": None, "configure": None}
def status(self):
"""Check the router object inner status
:return: A python dictionary include the status of the router object
"""
return self.__status
def login(self):
"""Login the router
:return: A message or an error
"""
try:
if self.__conn.login(self.__address, self.__username, self.__passwd) is True:
self.__status["status"] = "login"
return "Result : Login successfully."
else:
return "Error : Connect Failed."
except Exception as e:
return e
def logout(self):
"""Logout the router
:return: A message or an error
"""
try:
self.__conn.close()
self.__status["status"] = "logout"
self.__status["configure"] = None
self.__conn = pxssh()
return "Result : Logout successfully."
except Exception as e:
return e
def configure(self):
"""Enter the VyOS configure mode
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] is not "Yes":
self.__conn.sendline("configure")
self.__conn.prompt(0)
self.__conn.set_unique_prompt()
self.__status["configure"] = "Yes"
return "Result : Active configure mode successfully."
else:
return "Error : In configure mode now!"
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def commit(self):
"""Commit the configuration changes
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
if self.__status["commit"] is None:
return "Error : You don't need to commit."
if self.__status["commit"] == "No":
self.__conn.sendline("commit")
self.__conn.prompt()
self.__status["commit"] = "Yes"
return "Result : Commit successfully."
else:
return "Error : You have committed!"
else:
return "Error : Router not in configure mode!"
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def save(self):
"""Save the configuration after commit
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
if self.__status["commit"] == "Yes":
if self.__status["save"] is None:
return "Error : You don't need to save."
if self.__status["save"] == "No":
self.__conn.sendline("save")
self.__conn.prompt(0)
self.__status["save"] = "Yes"
return "Result : Save successfully."
else:
return "Error : You have saved!"
elif self.__status["commit"] is None:
return "Error : You don't need to save."
else:
return "Error : You need to commit first!"
else:
return "Error : Router not in configure mode!"
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def exit(self, force=False):
"""Exit VyOS configure mode
:param force: True or False
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
if force is True:
self.__conn.sendline("exit discard")
self.__conn.prompt()
self.__status["configure"] = "No"
self.__status["save"] = None
self.__status["commit"] = None
return "Result : Exit configure mode successfully."
else:
if self.__status["commit"] == "Yes":
if self.__status["save"] == "Yes":
self.__conn.sendline("exit")
self.__conn.prompt()
self.__status["configure"] = "No"
self.__status["save"] = None
self.__status["commit"] = None
return "Result : Exit configure mode successfully."
else:
return "Error : You should save first."
elif self.__status["commit"] is None:
self.__conn.sendline("exit")
self.__conn.prompt()
self.__status['configure'] = "No"
return "Result : Exit configure mode successfully."
else:
return "Error : You should commit first."
else:
return "Error : You are not in configure mode,need not exit."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def lo(self, lo_address):
"""Add a router loopback address
Parameter example:
'1.1.1.1/32'
:param lo_address: The target address you want.Don't forget the netmask
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = Modifylo.modifylo(self.__conn, lo_address)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def delete_route(self, route_type):
"""Delete router configurations
Parameter example:
'rip'/'static'/'ospf'/'bgp'/'all'
WARNING!
When you use this function,please don't forget this func will delete all same type
router configuration,when your 'config' in data is 'rip',it will delete all rip router setting.
If you do not want your setting disappear,you can delete router configuration manually or rewrite
this func.
:param route_type: Route type
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = DeleteRoute.deleteroute(self.__conn, route_type)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def static_route(self, network_range, next_hop, distance):
"""This method provide a basic static router configuration function
Parameter example:
'network_range':'10.20.10.0/24'
'next-hop':'10.20.10.1'
'distance':'1'
:param network_range: The target network,don't forget the netmask
:param next_hop: The next hop
:param distance: The distance
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = StaticRoute.staticroute(self.__conn, network_range, next_hop, distance)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def rip_network(self, network_range):
"""RIP router network setting
Parameter example:
'10.20.10.0/24'
:param network_range: The target network,don't forget the netmask
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = RIPRoute.rip_network(self.__conn, network_range)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def rip_redistribute(self):
"""Execute 'set protocols rip redistribute connected' command
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = RIPRoute.rip_redistribute(self.__conn)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def ospf_area(self, area, network_range):
"""This method provide a OSPF area configuration function
Parameter example:
'area':'0'
'network_range':'192.168.10.0/24'
:param area: The ospf area number
:param network_range: The target network,don't forget the netmask
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = OSPFRoute.ospfarea(self.__conn, area, network_range)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def ospf_router_id(self, router_id):
"""This method provide a router id configuration function
Parameter example:
'1.1.1.1'
:param router_id: The router id
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = OSPFRoute.ospf_router_id(self.__conn, router_id)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def ospf_redistribute(self, metric_type):
"""OSPF redistribute setting
Parameter example:
'2'
:param metric_type: The metric-type
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = OSPFRoute.ospf_redistribute(self.__conn, metric_type)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def ospf_adjacency(self):
"""Execute 'Set protocols ospf log-adjacency-changes' command
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = OSPFRoute.ospf_adjacency(self.__conn)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def ospf_default_route(self, metric, metric_type):
"""This method execute the commands to configure default route
Parameter example:
'metric':'10'
'metric-type':'2'
:param metric: The metric,a number
:param metric_type: The metric-type
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = OSPFRoute.ospf_default_route(self.__conn, metric, metric_type)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def ospf_route_map(self, rule, interface):
"""VyOS route-map setting when you configure a OSPF router
Parameter example:
'rule':'10'
'interface':'lo'
:param rule: The route-map rule number
:param interface: The interface name
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = OSPFRoute.ospf_route_map(self.__conn, rule, interface)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def bgp_route(self, self_as, neighbor, multihop, remote_as, update_source):
"""VyOS BGP router basic setting
Parameter example:
'self_as':'65538'
'neighbor':'192.168.10.5'
'multihop':'2'
'remote_as':'65537'
'update_source':'192.168.10.6'
:param self_as: The AS number of the router you login
:param neighbor: The neighbor router address
:param multihop: The amount of hops
:param remote_as: The remote AS number
:param update_source: The update source
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = BGPRoute.bgp_as(self.__conn, self_as, neighbor, multihop, remote_as, update_source)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def bgp_network(self, self_as, network_range):
"""Add a network to BGP router
Parameter example:
'self_as':'65538'
'network_range':'10.20.10.0/24'
:param self_as: The AS number of the router you login
:param network_range: The target network,don't forget the netmask
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = BGPRoute.bgp_network(self.__conn, self_as, network_range)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def bgp_router_id(self, self_as, router_id):
"""Set a router id for the router you login
Parameter example:
'self_as':'65538'
'router_id':'10.20.10.0'
:param self_as: The AS number of the router you login
:param router_id: The router id,or you can use the router address as router id
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = BGPRoute.bgp_router_id(self.__conn, self_as, router_id)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
def bgp_blackhole_route(self, network_range):
"""Set a blackhole route
Parameter example:
'10.20.10.0/24'
:param network_range: The target network,don't forget the netmask
:return: A message or an error
"""
try:
if self.__status["status"] == "login":
if self.__status["configure"] == "Yes":
res = BGPRoute.bgp_blackhole_route(self.__conn, network_range)
if "Result" in res:
if self.__status["commit"] == "No":
pass
else:
self.__status["commit"] = "No"
if self.__status["save"] == "No":
pass
else:
self.__status["save"] = "No"
return res
else:
return res
else:
return "Error : You are not in configure mode."
else:
return "Error : Router object not connect to a router."
except Exception as e:
return e
|
