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 2019 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
import os
import subprocess
import jinja2
from vyos.validate import *
from ipaddress import IPv4Network, IPv6Address
from netifaces import ifaddresses, AF_INET, AF_INET6
from time import sleep
dhcp_cfg = """
# generated by ifconfig.py
option rfc3442-classless-static-routes code 121 = array of unsigned integer 8;
interface "{{ intf }}" {
send host-name "{{ hostname }}";
request subnet-mask, broadcast-address, routers, domain-name-servers, rfc3442-classless-static-routes, domain-name, interface-mtu;
}
"""
dhcpv6_cfg = """
# generated by ifconfig.py
interface "{{ intf }}" {
request routers, domain-name-servers, domain-name;
}
"""
dhclient_base = r'/var/lib/dhcp/dhclient_'
class Interface:
def __init__(self, ifname, type=None):
"""
This is the base interface class which supports basic IP/MAC address
operations as well as DHCP(v6). Other interface which represent e.g.
and ethernet bridge are implemented as derived classes adding all
additional functionality.
DEBUG:
This class has embedded debugging (print) which can be enabled by
creating the following file:
vyos@vyos# touch /tmp/vyos.ifconfig.debug
Example:
>>> from vyos.ifconfig import Interface
>>> i = Interface('eth0')
"""
if not os.path.exists('/sys/class/net/{}'.format(ifname)) and not type:
raise Exception('interface "{}" not found'.format(str(ifname)))
self._ifname = str(ifname)
self._debug = False
if os.path.isfile('/tmp/vyos.ifconfig.debug'):
self._debug = True
if not os.path.exists('/sys/class/net/{}'.format(ifname)):
cmd = 'ip link add dev "{}" type "{}"'.format(ifname, type)
self._cmd(cmd)
# per interface DHCP config files
self._dhcp_cfg_file = dhclient_base + self._ifname + '.conf'
self._dhcp_pid_file = dhclient_base + self._ifname + '.pid'
self._dhcp_lease_file = dhclient_base + self._ifname + '.leases'
# per interface DHCPv6 config files
self._dhcpv6_cfg_file = dhclient_base + self._ifname + '.v6conf'
self._dhcpv6_pid_file = dhclient_base + self._ifname + '.v6pid'
self._dhcpv6_lease_file = dhclient_base + self._ifname + '.v6leases'
def _debug_msg(self, msg):
if self._debug:
print('"DEBUG/{}: {}'.format(self._ifname, msg))
def remove(self):
"""
Remove system interface
Example:
>>> from vyos.ifconfig import Interface
>>> i = Interface('eth0')
>>> i.remove()
"""
# stop DHCP(v6) if running
self.del_dhcp()
self.del_dhcpv6()
# NOTE (Improvement):
# after interface removal no other commands should be allowed
# to be called and instead should raise an Exception:
cmd = 'ip link del dev "{}"'.format(self._ifname)
self._cmd(cmd)
def _cmd(self, command):
self._debug_msg(command)
process = subprocess.Popen(command,stdout=subprocess.PIPE, shell=True)
proc_stdout = process.communicate()[0].strip()
# add exception handling code
pass
def _read_sysfs(self, filename):
"""
Provide a single primitive w/ error checking for reading from sysfs.
"""
var = None
with open(filename, 'r') as f:
var = f.read().rstrip('\n')
self._debug_msg('read "{}" <- "{}"'.format(value, filename))
return var
def _write_sysfs(self, filename, value):
"""
Provide a single primitive w/ error checking for writing to sysfs.
"""
self._debug_msg('write "{}" -> "{}"'.format(value, filename))
with open(filename, 'w') as f:
f.write(str(value))
return None
@property
def mtu(self):
"""
Get/set interface mtu in bytes.
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').mtu
'1500'
"""
return self._read_sysfs('/sys/class/net/{0}/mtu'
.format(self._ifname))
@mtu.setter
def mtu(self, mtu):
"""
Get/set interface mtu in bytes.
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').mtu = 1400
>>> Interface('eth0').mtu
'1400'
"""
if mtu < 68 or mtu > 9000:
raise ValueError('Invalid MTU size: "{}"'.format(mru))
return self._write_sysfs('/sys/class/net/{0}/mtu'
.format(self._ifname), mtu)
@property
def mac(self):
"""
Get/set interface mac address
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').mac
'00:0c:29:11:aa:cc'
"""
return self._read_sysfs('/sys/class/net/{0}/address'
.format(self._ifname))
@mac.setter
def mac(self, mac):
"""
Get/set interface mac address
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').mac = '00:90:43:fe:fe:1b'
>>> Interface('eth0').mac
'00:90:43:fe:fe:1b'
"""
# a mac address consits out of 6 octets
octets = len(mac.split(':'))
if octets != 6:
raise ValueError('wrong number of MAC octets: {} '.format(octets))
# validate against the first mac address byte if it's a multicast address
if int(mac.split(':')[0]) & 1:
raise ValueError('{} is a multicast MAC address'.format(mac))
# overall mac address is not allowed to be 00:00:00:00:00:00
if sum(int(i, 16) for i in mac.split(':')) == 0:
raise ValueError('00:00:00:00:00:00 is not a valid MAC address')
# check for VRRP mac address
if mac.split(':')[0] == '0' and addr.split(':')[1] == '0' and mac.split(':')[2] == '94' and mac.split(':')[3] == '0' and mac.split(':')[4] == '1':
raise ValueError('{} is a VRRP MAC address'.format(mac))
# Assemble command executed on system. Unfortunately there is no way
# of altering the MAC address via sysfs
cmd = 'ip link set dev "{}" address "{}"'.format(self._ifname, mac)
self._cmd(cmd)
@property
def arp_cache_tmo(self):
"""
Get configured ARP cache timeout value from interface in seconds.
Internal Kernel representation is in milliseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').arp_cache_tmo
'30'
"""
return (self._read_sysfs('/proc/sys/net/ipv4/neigh/{0}/base_reachable_time_ms'
.format(self._ifname)) / 1000)
@arp_cache_tmo.setter
def arp_cache_tmo(self, tmo):
"""
Set ARP cache timeout value in seconds. Internal Kernel representation
is in milliseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').arp_cache_tmo = '40'
"""
return self._write_sysfs('/proc/sys/net/ipv4/neigh/{0}/base_reachable_time_ms'
.format(self._ifname), (int(tmo) * 1000))
@property
def link_detect(self):
"""
How does the kernel act when receiving packets on 'down' interfaces
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').link_detect
'0'
"""
return self._read_sysfs('/proc/sys/net/ipv4/conf/{0}/link_filter'
.format(self._ifname))
@link_detect.setter
def link_detect(self, link_filter):
"""
Konfigure kernel response in packets received on interfaces that are 'down'
0 - Allow packets to be received for the address on this interface
even if interface is disabled or no carrier.
1 - Ignore packets received if interface associated with the incoming
address is down.
2 - Ignore packets received if interface associated with the incoming
address is down or has no carrier.
Default value is 0. Note that some distributions enable it in startup
scripts.
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').link_detect = '1'
"""
if link_filter >= 0 and link_filter <= 2:
return self._write_sysfs('/proc/sys/net/ipv4/conf/{0}/link_filter'
.format(self._ifname), link_filter)
else:
raise ValueError()
@property
def ifalias(self):
"""
Get/set interface alias name
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').ifalias
''
"""
return self._read_sysfs('/sys/class/net/{0}/ifalias'
.format(self._ifname))
@ifalias.setter
def ifalias(self, ifalias=None):
"""
Get/set interface alias name
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').ifalias = 'VyOS upstream interface'
>>> Interface('eth0').ifalias
'VyOS upstream interface'
to clear interface alias e.g. delete it use:
>>> Interface('eth0').ifalias = ''
>>> Interface('eth0').ifalias
''
"""
if not ifalias:
# clear interface alias
ifalias = '\0'
self._write_sysfs('/sys/class/net/{0}/ifalias'
.format(self._ifname), ifalias)
@property
def state(self):
"""
Enable (up) / Disable (down) an interface
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').state
'up'
"""
return self._read_sysfs('/sys/class/net/{0}/operstate'
.format(self._ifname))
@state.setter
def state(self, state):
"""
Enable (up) / Disable (down) an interface
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').state = 'down'
>>> Interface('eth0').state
'down'
"""
if state not in ['up', 'down']:
raise ValueError('state must be "up" or "down"')
# Assemble command executed on system. Unfortunately there is no way
# to up/down an interface via sysfs
cmd = 'ip link set dev "{}" "{}"'.format(self._ifname, state)
self._cmd(cmd)
@property
def proxy_arp(self):
"""
Get current proxy ARP configuration from sysfs. Default: 0
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').proxy_arp
'0'
"""
return self._read_sysfs('/proc/sys/net/ipv4/conf/{}/proxy_arp'
.format(self._ifname))
@proxy_arp.setter
def proxy_arp(self, enable):
"""
Set per interface proxy ARP configuration
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').proxy_arp = 1
>>> Interface('eth0').proxy_arp
'1'
"""
if int(enable) >= 0 and int(enable) <= 1:
return self._write_sysfs('/proc/sys/net/ipv4/conf/{}/proxy_arp'
.format(self._ifname), enable)
else:
raise ValueError("Value out of range")
@property
def proxy_arp_pvlan(self):
"""
Private VLAN proxy arp.
Basically allow proxy arp replies back to the same interface
(from which the ARP request/solicitation was received).
This is done to support (ethernet) switch features, like RFC
3069, where the individual ports are NOT allowed to
communicate with each other, but they are allowed to talk to
the upstream router. As described in RFC 3069, it is possible
to allow these hosts to communicate through the upstream
router by proxy_arp'ing. Don't need to be used together with
proxy_arp.
This technology is known by different names:
In RFC 3069 it is called VLAN Aggregation.
Cisco and Allied Telesyn call it Private VLAN.
Hewlett-Packard call it Source-Port filtering or port-isolation.
Ericsson call it MAC-Forced Forwarding (RFC Draft).
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').proxy_arp_pvlan
'0'
"""
return self._read_sysfs('/proc/sys/net/ipv4/conf/{}/proxy_arp_pvlan'
.format(self._ifname))
@proxy_arp_pvlan.setter
def proxy_arp_pvlan(self, enable):
"""
Private VLAN proxy arp.
Basically allow proxy arp replies back to the same interface
(from which the ARP request/solicitation was received).
This is done to support (ethernet) switch features, like RFC
3069, where the individual ports are NOT allowed to
communicate with each other, but they are allowed to talk to
the upstream router. As described in RFC 3069, it is possible
to allow these hosts to communicate through the upstream
router by proxy_arp'ing. Don't need to be used together with
proxy_arp.
This technology is known by different names:
In RFC 3069 it is called VLAN Aggregation.
Cisco and Allied Telesyn call it Private VLAN.
Hewlett-Packard call it Source-Port filtering or port-isolation.
Ericsson call it MAC-Forced Forwarding (RFC Draft).
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').proxy_arp_pvlan = 1
>>> Interface('eth0').proxy_arp_pvlan
'1'
"""
if int(enable) >= 0 and int(enable) <= 1:
return self._write_sysfs('/proc/sys/net/ipv4/conf/{}/proxy_arp_pvlan'
.format(self._ifname), enable)
else:
raise ValueError("Value out of range")
def get_addr(self):
"""
Retrieve assigned IPv4 and IPv6 addresses from given interface.
This is done using the netifaces and ipaddress python modules.
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').get_addrs()
['172.16.33.30/24', 'fe80::20c:29ff:fe11:a174/64']
"""
ipv4 = []
ipv6 = []
if AF_INET in ifaddresses(self._ifname).keys():
for v4_addr in ifaddresses(self._ifname)[AF_INET]:
# we need to manually assemble a list of IPv4 address/prefix
prefix = '/' + str(IPv4Network('0.0.0.0/' + v4_addr['netmask']).prefixlen)
ipv4.append( v4_addr['addr'] + prefix )
if AF_INET6 in ifaddresses(self._ifname).keys():
for v6_addr in ifaddresses(self._ifname)[AF_INET6]:
# Note that currently expanded netmasks are not supported. That means
# 2001:db00::0/24 is a valid argument while 2001:db00::0/ffff:ff00:: not.
# see https://docs.python.org/3/library/ipaddress.html
bits = bin( int(v6_addr['netmask'].replace(':',''), 16) ).count('1')
prefix = '/' + str(bits)
# we alsoneed to remove the interface suffix on link local addresses
v6_addr['addr'] = v6_addr['addr'].split('%')[0]
ipv6.append( v6_addr['addr'] + prefix )
return ipv4 + ipv6
def add_addr(self, addr):
"""
Add IP address to interface. Address is only added if it yet not added
to that interface.
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.add_addr('192.0.2.1/24')
>>> j.add_addr('2001:db8::ffff/64')
>>> j.get_addr()
['192.0.2.1/24', '2001:db8::ffff/64']
"""
if not is_intf_addr_assigned(self._ifname, addr):
cmd = 'sudo ip addr add "{}" dev "{}"'.format(addr, self._ifname)
self._cmd(cmd)
def del_addr(self, addr):
"""
Remove IP address from interface.
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.add_addr('2001:db8::ffff/64')
>>> j.add_addr('192.0.2.1/24')
>>> j.get_addr()
['192.0.2.1/24', '2001:db8::ffff/64']
>>> j.del_addr('192.0.2.1/24')
>>> j.get_addr()
['2001:db8::ffff/64']
"""
if is_intf_addr_assigned(self._ifname, addr):
cmd = 'ip addr del "{}" dev "{}"'.format(addr, self._ifname)
self._cmd(cmd)
# replace dhcpv4/v6 with systemd.networkd?
def set_dhcp(self):
"""
Configure interface as DHCP client. The dhclient binary is automatically
started in background!
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.set_dhcp()
"""
dhcp = {
'hostname': 'vyos',
'intf': self._ifname
}
# read configured system hostname.
# maybe change to vyos hostd client ???
with open('/etc/hostname', 'r') as f:
dhcp['hostname'] = f.read().rstrip('\n')
# render DHCP configuration
tmpl = jinja2.Template(dhcp_cfg)
dhcp_text = tmpl.render(dhcp)
with open(self._dhcp_cfg_file, 'w') as f:
f.write(dhcp_text)
cmd = 'start-stop-daemon --start --quiet --pidfile ' + self._dhcp_pid_file
cmd += ' --exec /sbin/dhclient --'
# now pass arguments to dhclient binary
cmd += ' -4 -nw -cf {} -pf {} -lf {} {}'.format(self._dhcp_cfg_file, self._dhcp_pid_file, self._dhcp_lease_file, self._ifname)
self._cmd(cmd)
def del_dhcp(self):
"""
De-configure interface as DHCP clinet. All auto generated files like
pid, config and lease will be removed.
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.del_dhcp()
"""
pid = 0
if os.path.isfile(self._dhcp_pid_file):
with open(self._dhcp_pid_file, 'r') as f:
pid = int(f.read())
else:
self._debug_msg('No DHCP client PID found')
return None
# stop dhclient
cmd = 'start-stop-daemon --stop --quiet --pidfile {}'.format(self._dhcp_pid_file)
self._cmd(cmd)
# cleanup old config file
if os.path.isfile(self._dhcp_cfg_file):
os.remove(self._dhcp_cfg_file)
# cleanup old pid file
if os.path.isfile(self._dhcp_pid_file):
os.remove(self._dhcp_pid_file)
# cleanup old lease file
if os.path.isfile(self._dhcp_lease_file):
os.remove(self._dhcp_lease_file)
def set_dhcpv6(self):
"""
Configure interface as DHCPv6 client. The dhclient binary is automatically
started in background!
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.set_dhcpv6()
"""
dhcpv6 = {
'intf': self._ifname
}
# render DHCP configuration
tmpl = jinja2.Template(dhcpv6_cfg)
dhcpv6_text = tmpl.render(dhcpv6)
with open(self._dhcpv6_cfg_file, 'w') as f:
f.write(dhcpv6_text)
# https://bugs.launchpad.net/ubuntu/+source/ifupdown/+bug/1447715
#
# wee need to wait for IPv6 DAD to finish once and interface is added
# this suxx :-(
sleep(5)
# no longer accept router announcements on this interface
cmd = 'sysctl -q -w net.ipv6.conf.{}.accept_ra=0'.format(self._ifname)
self._cmd(cmd)
cmd = 'start-stop-daemon --start --quiet --pidfile ' + self._dhcpv6_pid_file
cmd += ' --exec /sbin/dhclient --'
# now pass arguments to dhclient binary
cmd += ' -6 -nw -cf {} -pf {} -lf {} {}'.format(self._dhcpv6_cfg_file, self._dhcpv6_pid_file, self._dhcpv6_lease_file, self._ifname)
self._cmd(cmd)
def del_dhcpv6(self):
"""
De-configure interface as DHCPv6 clinet. All auto generated files like
pid, config and lease will be removed.
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.del_dhcpv6()
"""
pid = 0
if os.path.isfile(self._dhcpv6_pid_file):
with open(self._dhcpv6_pid_file, 'r') as f:
pid = int(f.read())
else:
self._debug_msg('No DHCPv6 client PID found')
return None
# stop dhclient
cmd = 'start-stop-daemon --stop --quiet --pidfile {}'.format(self._dhcpv6_pid_file)
self._cmd(cmd)
# accept router announcements on this interface
cmd = 'sysctl -q -w net.ipv6.conf.{}.accept_ra=1'.format(self._ifname)
self._cmd(cmd)
# cleanup old config file
if os.path.isfile(self._dhcpv6_cfg_file):
os.remove(self._dhcpv6_cfg_file)
# cleanup old pid file
if os.path.isfile(self._dhcpv6_pid_file):
os.remove(self._dhcpv6_pid_file)
# cleanup old lease file
if os.path.isfile(self._dhcpv6_lease_file):
os.remove(self._dhcpv6_lease_file)
class LoopbackIf(Interface):
def __init__(self, ifname):
super().__init__(ifname, type='loopback')
class DummyIf(Interface):
def __init__(self, ifname):
super().__init__(ifname, type='dummy')
class BridgeIf(Interface):
def __init__(self, ifname):
super().__init__(ifname, type='bridge')
@property
def ageing_time(self):
"""
Return configured bridge interface MAC address aging time in seconds.
Internal kernel representation is in centiseconds, thus its converted
in the end. Kernel default is 300 seconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').aging_time
'300'
"""
return (self._read_sysfs('/sys/class/net/{0}/bridge/ageing_time'
.format(self._ifname)) / 100)
@ageing_time.setter
def ageing_time(self, time):
"""
Set bridge interface MAC address aging time in seconds. Internal kernel
representation is in centiseconds. Kernel default is 300 seconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').ageing_time = 2
"""
time = int(time) * 100
return self._write_sysfs('/sys/class/net/{0}/bridge/ageing_time'
.format(self._ifname), time)
@property
def forward_delay(self):
"""
Get bridge forwarding delay in seconds. Internal Kernel representation
is in centiseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').ageing_time
'3'
"""
return (self._read_sysfs('/sys/class/net/{0}/bridge/forward_delay'
.format(self._ifname)) / 100)
@forward_delay.setter
def forward_delay(self, time):
"""
Set bridge forwarding delay in seconds. Internal Kernel representation
is in centiseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').forward_delay = 15
"""
return self._write_sysfs('/sys/class/net/{0}/bridge/forward_delay'
.format(self._ifname), (int(time) * 100))
@property
def hello_time(self):
"""
Get bridge hello time in seconds. Internal Kernel representation
is in centiseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').hello_time
'2'
"""
return (self._read_sysfs('/sys/class/net/{0}/bridge/hello_time'
.format(self._ifname)) / 100)
@hello_time.setter
def hello_time(self, time):
"""
Set bridge hello time in seconds. Internal Kernel representation
is in centiseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').hello_time = 2
"""
return self._write_sysfs('/sys/class/net/{0}/bridge/hello_time'
.format(self._ifname), (int(time) * 100))
@property
def max_age(self):
"""
Get bridge max max message age in seconds. Internal Kernel representation
is in centiseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').max_age
'20'
"""
return (self._read_sysfs('/sys/class/net/{0}/bridge/max_age'
.format(self._ifname)) / 100)
@max_age.setter
def max_age(self, time):
"""
Set bridge max message age in seconds. Internal Kernel representation
is in centiseconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').max_age = 30
"""
return self._write_sysfs('/sys/class/net/{0}/bridge/max_age'
.format(self._ifname), (int(time) * 100))
@property
def priority(self):
"""
Get bridge max aging time in seconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').priority
'32768'
"""
return self._read_sysfs('/sys/class/net/{0}/bridge/priority'
.format(self._ifname))
@priority.setter
def priority(self, priority):
"""
Set bridge max aging time in seconds.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').priority = 8192
"""
return self._write_sysfs('/sys/class/net/{0}/bridge/priority'
.format(self._ifname), priority)
@property
def stp_state(self):
"""
Get current bridge STP (Spanning Tree) state.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').stp_state
'0'
"""
state = 0
with open('/sys/class/net/{0}/bridge/stp_state'.format(self._ifname), 'r') as f:
state = int(f.read().rstrip('\n'))
return state
@stp_state.setter
def stp_state(self, state):
"""
Set bridge STP (Spannign Tree) state. 0 -> STP disabled, 1 -> STP enabled
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').stp_state = 1
"""
if int(state) >= 0 and int(state) <= 1:
return self._write_sysfs('/sys/class/net/{0}/bridge/stp_state'
.format(self._ifname), state)
else:
raise ValueError("Value out of range")
@property
def multicast_querier(self):
"""
Get bridge multicast querier membership state.
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').multicast_querier
'0'
"""
return self._read_sysfs('/sys/class/net/{0}/bridge/multicast_querier'
.format(self._ifname))
@multicast_querier.setter
def multicast_querier(self, enable):
"""
Sets whether the bridge actively runs a multicast querier or not. When a
bridge receives a 'multicast host membership' query from another network
host, that host is tracked based on the time that the query was received
plus the multicast query interval time.
Use enable=1 to enable or enable=0 to disable
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').multicast_querier = 1
"""
if int(enable) >= 0 and int(enable) <= 1:
return self._write_sysfs('/sys/class/net/{0}/bridge/multicast_querier'
.format(self._ifname), enable)
else:
raise ValueError("Value out of range")
def add_port(self, interface):
"""
Add physical interface to bridge (member port)
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').add_port('eth0')
>>> BridgeIf('br0').add_port('eth1')
"""
if not interface:
raise ValueError('No interface address specified')
cmd = 'ip link set dev "{}" master "{}"'.format(interface, self._ifname)
self._cmd(cmd)
def del_port(self, interface):
"""
Add bridge member port
Example:
>>> from vyos.ifconfig import Interface
>>> BridgeIf('br0').del_port('eth1')
"""
if not interface:
raise ValueError('No interface address specified')
cmd = 'ip link set dev "{}" nomaster'.format(interface)
self._cmd(cmd)
def set_cost(self, interface, cost):
"""
Set interface path cost, only relevant for STP enabled interfaces
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').path_cost(4)
"""
return self._write_sysfs('/sys/class/net/{}/brif/{}/path_cost'
.format(self._ifname, interface), cost)
def set_priority(self, interface, priority):
"""
Set interface path priority, only relevant for STP enabled interfaces
Example:
>>> from vyos.ifconfig import Interface
>>> Interface('eth0').priority(4)
"""
return self._write_sysfs('/sys/class/net/{}/brif/{}/priority'
.format(self._ifname, interface), priority)
class BondIf(Interface):
def __init__(self, ifname):
super().__init__(ifname, type='bond')
@property
def xmit_hash_policy(self):
"""
Selects the transmit hash policy to use for slave selection in
balance-xor, 802.3ad, and tlb modes. Possible values are: layer2,
layer2+3, layer3+4, encap2+3, encap3+4.
The default value is layer2
Example:
>>> from vyos.ifconfig import BondIf
>>> BondIf('bond0').xmit_hash_policy
'layer3+4'
"""
# Linux Kernel appends has policy value to string, e.g. 'layer3+4 1',
# so remove the later part and only return the mode as string.
return self._read_sysfs('/sys/class/net/{}/bonding/xmit_hash_policy'
.format(self._ifname)).split(' ')[0]
@xmit_hash_policy.setter
def xmit_hash_policy(self, mode):
"""
Selects the transmit hash policy to use for slave selection in
balance-xor, 802.3ad, and tlb modes. Possible values are: layer2,
layer2+3, layer3+4, encap2+3, encap3+4.
The default value is layer2
Example:
>>> from vyos.ifconfig import Interface
>>> BondIf('bond0').xmit_hash_policy = 'layer2+3'
>>> BondIf('bond0').proxy_arp
'1'
"""
if not mode in ['layer2', 'layer2+3', 'layer3+4', 'encap2+3', 'encap3+4']:
raise ValueError()
return self._write_sysfs('/sys/class/net/{}/bonding/xmit_hash_policy'
.format(self._ifname), mode)
|