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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>IPRoute module — pyroute2 0.5.2 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="IPDB module" href="ipdb.html" />
<link rel="prev" title="Quickstart" href="usage.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ipdb.html" title="IPDB module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="usage.html" title="Quickstart"
accesskey="P">previous</a> |</li>
<li class="nav-item"><a href="http://pyroute2.org">Project home</a> »</li>
<li class="nav-item nav-item-0"><a href="index.html">pyroute2 0.5.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pyroute2.iproute">
<span id="iproute-module"></span><h1>IPRoute module<a class="headerlink" href="#module-pyroute2.iproute" title="Permalink to this headline">¶</a></h1>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<p>The RTNL API is provided by the class <cite>RTNL_API</cite>. It is a
mixin class that works on top of any RTNL-compatible socket,
so several classes with almost the same API are available:</p>
<blockquote>
<div><ul class="simple">
<li><cite>IPRoute</cite> – simple RTNL API</li>
<li><cite>NetNS</cite> – RTNL API in a network namespace</li>
<li><cite>IPBatch</cite> – RTNL packet compiler</li>
<li><cite>ShellIPR</cite> – run RTNL in a (remote) shell</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="responses-as-lists">
<h2>Responses as lists<a class="headerlink" href="#responses-as-lists" title="Permalink to this headline">¶</a></h2>
<p>The netlink socket implementation in the pyroute2 is
agnostic to particular netlink protocols, and always returns
a list of messages as the response to a request sent to the
kernel:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">IPRoute</span><span class="p">()</span> <span class="k">as</span> <span class="n">ipr</span><span class="p">:</span>
<span class="c1"># this request returns one match</span>
<span class="n">eth0</span> <span class="o">=</span> <span class="n">ipr</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'eth0'</span><span class="p">)</span>
<span class="nb">len</span><span class="p">(</span><span class="n">eth0</span><span class="p">)</span> <span class="c1"># -> 1, if exists, else 0</span>
<span class="c1"># but that one returns a set of</span>
<span class="n">up</span> <span class="o">=</span> <span class="n">ipr</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">operstate</span><span class="o">=</span><span class="s1">'UP'</span><span class="p">)</span>
<span class="nb">len</span><span class="p">(</span><span class="n">up</span><span class="p">)</span> <span class="c1"># -> k, where 0 <= k <= [interface count]</span>
</pre></div>
</div>
<p>Thus, always expect a list in the response, running any
<cite>IPRoute()</cite> netlink request.</p>
<div class="section" id="nlmsg-error-responses">
<h3>NLMSG_ERROR responses<a class="headerlink" href="#nlmsg-error-responses" title="Permalink to this headline">¶</a></h3>
<p>Some kernel subsystems return <cite>NLMSG_ERROR</cite> in response to
any request. It is OK as long as <cite>nlmsg[“header”][“error”] is None</cite>.
Otherwise an exception will be raised by the parser.</p>
<p>So if instead of an exception you get a <cite>NLMSG_ERROR</cite> message,
it means <cite>error == 0</cite>, the same as <cite>$? == 0</cite> in bash.</p>
</div>
<div class="section" id="how-to-work-with-messages">
<h3>How to work with messages<a class="headerlink" href="#how-to-work-with-messages" title="Permalink to this headline">¶</a></h3>
<p>Every netlink message contains header, fields and NLAs
(netlink attributes). Every NLA is a netlink message…
(see “recursion”).</p>
<p>And the library provides parsed messages according to
this scheme. Every RTNL message contains:</p>
<ul class="simple">
<li><cite>nlmsg[‘header’]</cite> – parsed header</li>
<li><cite>nlmsg[‘attrs’]</cite> – NLA chain (parsed on demand)</li>
<li>0 .. k data fields, e.g. <cite>nlmsg[‘flags’]</cite> etc.</li>
<li><cite>nlmsg.header</cite> – the header fields spec</li>
<li><cite>nlmsg.fields</cite> – the data fields spec</li>
<li><cite>nlmsg.nla_map</cite> – NLA spec</li>
</ul>
<p>An important parser feature is that NLAs are parsed
on demand, when someone tries to access them. Otherwise
the parser doesn’t waste CPU cycles.</p>
<p>The NLA chain is a list-like structure, not a dictionary.
The netlink standard doesn’t require NLAs to be unique
within one message:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'attrs'</span><span class="p">:</span> <span class="p">[(</span><span class="s1">'IFLA_IFNAME'</span><span class="p">,</span> <span class="s1">'lo'</span><span class="p">),</span> <span class="c1"># [1]</span>
<span class="p">(</span><span class="s1">'IFLA_TXQLEN'</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_OPERSTATE'</span><span class="p">,</span> <span class="s1">'UNKNOWN'</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_LINKMODE'</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_MTU'</span><span class="p">,</span> <span class="mi">65536</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_GROUP'</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_PROMISCUITY'</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_NUM_TX_QUEUES'</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_NUM_RX_QUEUES'</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'IFLA_CARRIER'</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="o">...</span><span class="p">],</span>
<span class="s1">'change'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'event'</span><span class="p">:</span> <span class="s1">'RTM_NEWLINK'</span><span class="p">,</span> <span class="c1"># [2]</span>
<span class="s1">'family'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'flags'</span><span class="p">:</span> <span class="mi">65609</span><span class="p">,</span>
<span class="s1">'header'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'error'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span> <span class="c1"># [3]</span>
<span class="s1">'flags'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s1">'length'</span><span class="p">:</span> <span class="mi">1180</span><span class="p">,</span>
<span class="s1">'pid'</span><span class="p">:</span> <span class="mi">28233</span><span class="p">,</span>
<span class="s1">'sequence_number'</span><span class="p">:</span> <span class="mi">257</span><span class="p">,</span> <span class="c1"># [4]</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="mi">16</span><span class="p">},</span> <span class="c1"># [5]</span>
<span class="s1">'ifi_type'</span><span class="p">:</span> <span class="mi">772</span><span class="p">,</span>
<span class="s1">'index'</span><span class="p">:</span> <span class="mi">1</span><span class="p">}</span>
<span class="c1"># [1] every NLA is parsed upon access</span>
<span class="c1"># [2] this field is injected by the RTNL parser</span>
<span class="c1"># [3] if not None, an exception will be raised</span>
<span class="c1"># [4] more details in the netlink description</span>
<span class="c1"># [5] 16 == RTM_NEWLINK</span>
</pre></div>
</div>
<p>To access fields:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">msg</span><span class="p">[</span><span class="s1">'index'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span>
</pre></div>
</div>
<p>To access one NLA:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">msg</span><span class="o">.</span><span class="n">get_attr</span><span class="p">(</span><span class="s1">'IFLA_CARRIER'</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
</pre></div>
</div>
<p>When an NLA with the specified name is not present in the
chain, <cite>get_attr()</cite> returns <cite>None</cite>. To get the list of all
NLAs of that name, use <cite>get_attrs()</cite>. A real example with
NLA hierarchy, take notice of <cite>get_attr()</cite> and
<cite>get_attrs()</cite> usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># for macvlan interfaces there may be several</span>
<span class="c1"># IFLA_MACVLAN_MACADDR NLA provided, so use</span>
<span class="c1"># get_attrs() to get all the list, not only</span>
<span class="c1"># the first one</span>
<span class="p">(</span><span class="n">msg</span>
<span class="o">.</span><span class="n">get_attr</span><span class="p">(</span><span class="s1">'IFLA_LINKINFO'</span><span class="p">)</span> <span class="c1"># one NLA</span>
<span class="o">.</span><span class="n">get_attr</span><span class="p">(</span><span class="s1">'IFLA_INFO_DATA'</span><span class="p">)</span> <span class="c1"># one NLA</span>
<span class="o">.</span><span class="n">get_attrs</span><span class="p">(</span><span class="s1">'IFLA_MACVLAN_MACADDR'</span><span class="p">))</span> <span class="c1"># a list of</span>
</pre></div>
</div>
<p>The protocol itself has no limit for number of NLAs of the
same type in one message, that’s why we can not make a dictionary
from them – unlike PF_ROUTE messages.</p>
</div>
</div>
<div class="section" id="module-pyroute2.iproute.bsd">
<span id="bsd-notes"></span><h2>BSD notes<a class="headerlink" href="#module-pyroute2.iproute.bsd" title="Permalink to this headline">¶</a></h2>
<p>The library provides very basic RTNL API for BSD systems
via protocol emulation. Only getters are supported yet, no
setters.</p>
<p>BSD employs PF_ROUTE sockets to send notifications about
network object changes, but the protocol doesn not allow
changing links/addresses/etc like Netlink.</p>
<p>To change network setting one have to rely on system calls
or external tools. Thus IPRoute on BSD systems is not as
effective as on Linux, where all the changes are done via
Netlink.</p>
<p>The monitoring started with <cite>bind()</cite> is implemented as an
implicit thread, started by the <cite>bind()</cite> call. This is done
to have only one notification FD, used both for normal calls
and notifications. This allows to use IPRoute objects in
poll/select calls.</p>
<p>On Linux systems RTNL API is provided by the netlink protocol,
so no implicit threads are started by default to monitor the
system updates. <cite>IPRoute.bind(…)</cite> may start the async cache
thread, but only when asked explicitly:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">#</span>
<span class="c1"># Normal monitoring. Always starts monitoring thread on</span>
<span class="c1"># FreeBSD / OpenBSD, no threads on Linux.</span>
<span class="c1">#</span>
<span class="k">with</span> <span class="n">IPRoute</span><span class="p">()</span> <span class="k">as</span> <span class="n">ipr</span><span class="p">:</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">bind</span><span class="p">()</span>
<span class="o">...</span>
<span class="c1">#</span>
<span class="c1"># Monitoring with async cache. Always starts cache thread</span>
<span class="c1"># on Linux, ignored on FreeBSD / OpenBSD.</span>
<span class="c1">#</span>
<span class="k">with</span> <span class="n">IPRoute</span><span class="p">()</span> <span class="k">as</span> <span class="n">ipr</span><span class="p">:</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">async_cache</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="o">...</span>
</pre></div>
</div>
<p>On all the supported platforms, be it Linux or BSD, the
<cite>IPRoute.recv(…)</cite> method returns valid netlink RTNL raw binary
payload and <cite>IPRoute.get(…)</cite> returns parsed RTNL messages.</p>
</div>
<div class="section" id="module-pyroute2.iproute.linux">
<span id="iproute-api"></span><h2>IPRoute API<a class="headerlink" href="#module-pyroute2.iproute.linux" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pyroute2.iproute.linux.IPBatch">
<em class="property">class </em><code class="descclassname">pyroute2.iproute.linux.</code><code class="descname">IPBatch</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.IPBatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Netlink requests compiler. Does not send any requests, but
instead stores them in the internal binary buffer. The
contents of the buffer can be used to send batch requests,
to test custom netlink parsers and so on.</p>
<p>Uses <cite>RTNL_API</cite> and provides all the same API as normal
<cite>IPRoute</cite> objects:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create the batch compiler</span>
<span class="n">ipb</span> <span class="o">=</span> <span class="n">IPBatch</span><span class="p">()</span>
<span class="c1"># compile requests into the internal buffer</span>
<span class="n">ipb</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">550</span><span class="p">,</span> <span class="n">ifname</span><span class="o">=</span><span class="s2">"test"</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="s2">"dummy"</span><span class="p">)</span>
<span class="n">ipb</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">550</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="s2">"up"</span><span class="p">)</span>
<span class="n">ipb</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">550</span><span class="p">,</span> <span class="n">address</span><span class="o">=</span><span class="s2">"10.0.0.2"</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">)</span>
<span class="c1"># save the buffer</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">ipb</span><span class="o">.</span><span class="n">batch</span>
<span class="c1"># reset the buffer</span>
<span class="n">ipb</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="o">...</span>
<span class="c1"># send the buffer</span>
<span class="n">IPRoute</span><span class="p">()</span><span class="o">.</span><span class="n">sendto</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="pyroute2.iproute.linux.IPRoute">
<em class="property">class </em><code class="descclassname">pyroute2.iproute.linux.</code><code class="descname">IPRoute</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.IPRoute" title="Permalink to this definition">¶</a></dt>
<dd><p>Regular ordinary utility class, see RTNL API for the list of methods.</p>
</dd></dl>
<dl class="class">
<dt id="pyroute2.iproute.linux.RTNL_API">
<em class="property">class </em><code class="descclassname">pyroute2.iproute.linux.</code><code class="descname">RTNL_API</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API" title="Permalink to this definition">¶</a></dt>
<dd><p><cite>RTNL_API</cite> should not be instantiated by itself. It is intended
to be used as a mixin class. Following classes use <cite>RTNL_API</cite>:</p>
<ul class="simple">
<li><cite>IPRoute</cite> – RTNL API to the current network namespace</li>
<li><cite>NetNS</cite> – RTNL API to another network namespace</li>
<li><cite>IPBatch</cite> – RTNL compiler</li>
<li><cite>ShellIPR</cite> – RTNL via standard I/O, runs IPRoute in a shell</li>
</ul>
<p>It is an old-school API, that provides access to rtnetlink as is.
It helps you to retrieve and change almost all the data, available
through rtnetlink:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pyroute2</span> <span class="k">import</span> <span class="n">IPRoute</span>
<span class="n">ipr</span> <span class="o">=</span> <span class="n">IPRoute</span><span class="p">()</span>
<span class="c1"># create an interface</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">ifname</span><span class="o">=</span><span class="s1">'brx'</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="s1">'bridge'</span><span class="p">)</span>
<span class="c1"># lookup the index</span>
<span class="n">dev</span> <span class="o">=</span> <span class="n">ipr</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'brx'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="c1"># bring it down</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s1">'set'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="s1">'down'</span><span class="p">)</span>
<span class="c1"># change the interface MAC address and rename it just for fun</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s1">'set'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span>
<span class="n">address</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s1">'br-ctrl'</span><span class="p">)</span>
<span class="c1"># add primary IP address</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span>
<span class="n">address</span><span class="o">=</span><span class="s1">'10.0.0.1'</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">,</span>
<span class="n">broadcast</span><span class="o">=</span><span class="s1">'10.0.0.255'</span><span class="p">)</span>
<span class="c1"># add secondary IP address</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span>
<span class="n">address</span><span class="o">=</span><span class="s1">'10.0.0.2'</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">,</span>
<span class="n">broadcast</span><span class="o">=</span><span class="s1">'10.0.0.255'</span><span class="p">)</span>
<span class="c1"># bring it up</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s1">'set'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="s1">'up'</span><span class="p">)</span>
</pre></div>
</div>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.addr">
<code class="descname">addr</code><span class="sig-paren">(</span><em>command</em>, <em>index=None</em>, <em>address=None</em>, <em>mask=None</em>, <em>family=None</em>, <em>scope=None</em>, <em>match=None</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.addr" title="Permalink to this definition">¶</a></dt>
<dd><p>Address operations</p>
<ul class="simple">
<li>command – add, delete</li>
<li>index – device index</li>
<li>address – IPv4 or IPv6 address</li>
<li>mask – address mask</li>
<li>family – socket.AF_INET for IPv4 or socket.AF_INET6 for IPv6</li>
<li>scope – the address scope, see /etc/iproute2/rt_scopes</li>
<li>**kwarg – any ifaddrmsg field or NLA</li>
</ul>
<p>Later the method signature will be changed to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">addr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">match</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwarg</span><span class="p">):</span>
<span class="c1"># the method body</span>
</pre></div>
</div>
<p>So only keyword arguments (except of the command) will be accepted.
The reason for this change is an unification of API.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">idx</span> <span class="o">=</span> <span class="mi">62</span>
<span class="n">ip</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span> <span class="n">address</span><span class="o">=</span><span class="s1">'10.0.0.1'</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span> <span class="n">address</span><span class="o">=</span><span class="s1">'10.0.0.2'</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">)</span>
</pre></div>
</div>
<p>With more NLAs:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># explicitly set broadcast address</span>
<span class="n">ip</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span>
<span class="n">address</span><span class="o">=</span><span class="s1">'10.0.0.3'</span><span class="p">,</span>
<span class="n">broadcast</span><span class="o">=</span><span class="s1">'10.0.0.255'</span><span class="p">,</span>
<span class="n">prefixlen</span><span class="o">=</span><span class="mi">24</span><span class="p">)</span>
<span class="c1"># make the secondary address visible to ifconfig: add label</span>
<span class="n">ip</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span>
<span class="n">address</span><span class="o">=</span><span class="s1">'10.0.0.4'</span><span class="p">,</span>
<span class="n">broadcast</span><span class="o">=</span><span class="s1">'10.0.0.255'</span><span class="p">,</span>
<span class="n">prefixlen</span><span class="o">=</span><span class="mi">24</span><span class="p">,</span>
<span class="n">label</span><span class="o">=</span><span class="s1">'eth0:1'</span><span class="p">)</span>
</pre></div>
</div>
<p>Configure p2p address on an interface:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span>
<span class="n">address</span><span class="o">=</span><span class="s1">'10.1.1.2'</span><span class="p">,</span>
<span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">,</span>
<span class="n">local</span><span class="o">=</span><span class="s1">'10.1.1.1'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.brport">
<code class="descname">brport</code><span class="sig-paren">(</span><em>command</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.brport" title="Permalink to this definition">¶</a></dt>
<dd><p>Set bridge port parameters. Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">idx</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'eth0'</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">brport</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span> <span class="n">unicast_flood</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">cost</span><span class="o">=</span><span class="mi">200</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">brport</span><span class="p">(</span><span class="s2">"show"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">idx</span><span class="p">)</span>
</pre></div>
</div>
<p>Possible keywords are NLA names for the <cite>protinfo_bridge</cite> class,
without the prefix and in lower letters.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.fdb">
<code class="descname">fdb</code><span class="sig-paren">(</span><em>command</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.fdb" title="Permalink to this definition">¶</a></dt>
<dd><p>Bridge forwarding database management.</p>
<dl class="docutils">
<dt>More details:</dt>
<dd><ul class="first last simple">
<li>kernel:Documentation/networking/switchdev.txt</li>
<li>pyroute2.netlink.rtnl.ndmsg</li>
</ul>
</dd>
</dl>
<p><strong>add</strong></p>
<p>Add a new FDB record. Works in the same way as ARP cache
management, but some additional NLAs can be used:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># simple FDB record</span>
<span class="c1">#</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">ifindex</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'br0'</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">lladdr</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'10.0.0.1'</span><span class="p">)</span>
<span class="c1"># specify vlan</span>
<span class="c1"># NB: vlan should exist on the device, use</span>
<span class="c1"># `vlan_filter()`</span>
<span class="c1">#</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">ifindex</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'br0'</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">lladdr</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'10.0.0.1'</span><span class="p">,</span>
<span class="n">vlan</span><span class="o">=</span><span class="mi">200</span><span class="p">)</span>
<span class="c1"># specify vxlan id and port</span>
<span class="c1"># NB: works only for vxlan devices, use</span>
<span class="c1"># `link("add", kind="vxlan", ...)`</span>
<span class="c1">#</span>
<span class="c1"># if port is not specified, the default one is used</span>
<span class="c1"># by the kernel.</span>
<span class="c1">#</span>
<span class="c1"># if vni (vxlan id) is equal to the device vni,</span>
<span class="c1"># the kernel doesn't report it back</span>
<span class="c1">#</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">ifindex</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'vx500'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">lladdr</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'10.0.0.1'</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span class="mi">5678</span><span class="p">,</span>
<span class="n">vni</span><span class="o">=</span><span class="mi">600</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>append</strong></p>
<p>Append a new FDB record. The same syntax as for <strong>add</strong>.</p>
<p><strong>del</strong></p>
<p>Remove an existing FDB record. The same syntax as for <strong>add</strong>.</p>
<p><strong>dump</strong></p>
<p>Dump all the FDB records. If any <cite>**kwarg</cite> is provided,
results will be filtered:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># dump all the records</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'dump'</span><span class="p">)</span>
<span class="c1"># show only specific lladdr, dst, vlan etc.</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'dump'</span><span class="p">,</span> <span class="n">lladdr</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'dump'</span><span class="p">,</span> <span class="n">dst</span><span class="o">=</span><span class="s1">'10.0.0.1'</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">fdb</span><span class="p">(</span><span class="s1">'dump'</span><span class="p">,</span> <span class="n">vlan</span><span class="o">=</span><span class="mi">200</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.flush_addr">
<code class="descname">flush_addr</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.flush_addr" title="Permalink to this definition">¶</a></dt>
<dd><p>Flush IP addresses.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># flush all addresses on the interface with index 2:</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">flush_addr</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="c1"># flush all addresses with IFA_LABEL='eth0':</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">flush_addr</span><span class="p">(</span><span class="n">label</span><span class="o">=</span><span class="s1">'eth0'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.flush_routes">
<code class="descname">flush_routes</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.flush_routes" title="Permalink to this definition">¶</a></dt>
<dd><p>Flush routes – purge route records from a table.
Arguments are the same as for <cite>get_routes()</cite>
routine. Actually, this routine implements a pipe from
<cite>get_routes()</cite> to <cite>nlm_request()</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.flush_rules">
<code class="descname">flush_rules</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.flush_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>Flush rules. Please keep in mind, that by default the function
operates on <strong>all</strong> rules of <strong>all</strong> families. To work only on
IPv4 rules, one should explicitly specify <cite>family=AF_INET</cite>.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># flush all IPv4 rule with priorities above 5 and below 32000</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">flush_rules</span><span class="p">(</span><span class="n">family</span><span class="o">=</span><span class="n">AF_INET</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="mi">5</span> <span class="o"><</span> <span class="n">x</span> <span class="o"><</span> <span class="mi">32000</span><span class="p">)</span>
<span class="c1"># flush all IPv6 rules that point to table 250:</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">flush_rules</span><span class="p">(</span><span class="n">family</span><span class="o">=</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET6</span><span class="p">,</span> <span class="n">table</span><span class="o">=</span><span class="mi">250</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_addr">
<code class="descname">get_addr</code><span class="sig-paren">(</span><em>family=0</em>, <em>match=None</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_addr" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump addresses.</p>
<p>If family is not specified, both AF_INET and AF_INET6 addresses
will be dumped:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># get all addresses</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span>
</pre></div>
</div>
<p>It is possible to apply filters on the results:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># get addresses for the 2nd interface</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_addr</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="c1"># get addresses with IFA_LABEL == 'eth0'</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_addr</span><span class="p">(</span><span class="n">label</span><span class="o">=</span><span class="s1">'eth0'</span><span class="p">)</span>
<span class="c1"># get all the subnet addresses on the interface, identified</span>
<span class="c1"># by broadcast address (should be explicitly specified upon</span>
<span class="c1"># creation)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_addr</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">broadcast</span><span class="o">=</span><span class="s1">'192.168.1.255'</span><span class="p">)</span>
</pre></div>
</div>
<p>A custom predicate can be used as a filter:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">get_addr</span><span class="p">(</span><span class="n">match</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">[</span><span class="s1">'index'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_classes">
<code class="descname">get_classes</code><span class="sig-paren">(</span><em>index=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_classes" title="Permalink to this definition">¶</a></dt>
<dd><p>Get classes for specified interface.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_default_routes">
<code class="descname">get_default_routes</code><span class="sig-paren">(</span><em>family=0</em>, <em>table=254</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_default_routes" title="Permalink to this definition">¶</a></dt>
<dd><p>Get default routes</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_filters">
<code class="descname">get_filters</code><span class="sig-paren">(</span><em>index=0</em>, <em>handle=0</em>, <em>parent=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_filters" title="Permalink to this definition">¶</a></dt>
<dd><p>Get filters for specified interface, handle and parent.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_links">
<code class="descname">get_links</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_links" title="Permalink to this definition">¶</a></dt>
<dd><p>Get network interfaces.</p>
<p>By default returns all interfaces. Arguments vector
can contain interface indices or a special keyword
‘all’:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">get_links</span><span class="p">()</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="s1">'all'</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
<span class="n">interfaces</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="o">*</span><span class="n">interfaces</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_neighbours">
<code class="descname">get_neighbours</code><span class="sig-paren">(</span><em>family=0</em>, <em>match=None</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_neighbours" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump ARP cache records.</p>
<p>The <cite>family</cite> keyword sets the family for the request:
e.g. <cite>AF_INET</cite> or <cite>AF_INET6</cite> for arp cache, <cite>AF_BRIDGE</cite>
for fdb.</p>
<p>If other keyword arguments not empty, they are used as
filter. Also, one can explicitly set filter as a function
with the <cite>match</cite> parameter.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># get neighbours on the 3rd link:</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_neighbours</span><span class="p">(</span><span class="n">ifindex</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
<span class="c1"># get a particular record by dst:</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_neighbours</span><span class="p">(</span><span class="n">dst</span><span class="o">=</span><span class="s1">'172.16.0.1'</span><span class="p">)</span>
<span class="c1"># get fdb records:</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_neighbours</span><span class="p">(</span><span class="n">AF_BRIDGE</span><span class="p">)</span>
<span class="c1"># and filter them by a function:</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_neighbours</span><span class="p">(</span><span class="n">AF_BRIDGE</span><span class="p">,</span> <span class="n">match</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">[</span><span class="s1">'state'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_ntables">
<code class="descname">get_ntables</code><span class="sig-paren">(</span><em>family=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_ntables" title="Permalink to this definition">¶</a></dt>
<dd><p>Get neighbour tables</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_qdiscs">
<code class="descname">get_qdiscs</code><span class="sig-paren">(</span><em>index=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_qdiscs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get all queue disciplines for all interfaces or for specified
one.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_routes">
<code class="descname">get_routes</code><span class="sig-paren">(</span><em>family=255</em>, <em>match=None</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_routes" title="Permalink to this definition">¶</a></dt>
<dd><p>Get all routes. You can specify the table. There
are 255 routing classes (tables), and the kernel
returns all the routes on each request. So the
routine filters routes from full output.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">get_routes</span><span class="p">()</span> <span class="c1"># get all the routes for all families</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_routes</span><span class="p">(</span><span class="n">family</span><span class="o">=</span><span class="n">AF_INET6</span><span class="p">)</span> <span class="c1"># get only IPv6 routes</span>
<span class="n">ip</span><span class="o">.</span><span class="n">get_routes</span><span class="p">(</span><span class="n">table</span><span class="o">=</span><span class="mi">254</span><span class="p">)</span> <span class="c1"># get routes from 254 table</span>
</pre></div>
</div>
<p>The default family=255 is a hack. Despite the specs,
the kernel returns only IPv4 routes for AF_UNSPEC family.
But it returns all the routes for all the families if one
uses an invalid value here. Hack but true. And let’s hope
the kernel team will not fix this bug.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_rules">
<code class="descname">get_rules</code><span class="sig-paren">(</span><em>family=0</em>, <em>match=None</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>Get all rules. By default return all rules. To explicitly
request the IPv4 rules use <cite>family=AF_INET</cite>.</p>
<dl class="docutils">
<dt>Example::</dt>
<dd>ip.get_rules() # get all the rules for all families
ip.get_rules(family=AF_INET6) # get only IPv6 rules</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.get_vlans">
<code class="descname">get_vlans</code><span class="sig-paren">(</span><em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.get_vlans" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump available vlan info on bridge ports</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.link">
<code class="descname">link</code><span class="sig-paren">(</span><em>command</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.link" title="Permalink to this definition">¶</a></dt>
<dd><p>Link operations.</p>
<dl class="docutils">
<dt>Keywords to set up ifinfmsg fields:</dt>
<dd><ul class="first last simple">
<li>index – interface index</li>
<li>family – AF_BRIDGE for bridge operations, otherwise 0</li>
<li>flags – device flags</li>
<li>change – change mask</li>
</ul>
</dd>
</dl>
<p>All other keywords will be translated to NLA names, e.g.
<cite>mtu -> IFLA_MTU</cite>, <cite>af_spec -> IFLA_AF_SPEC</cite> etc. You can
provide a complete NLA structure or let filters do it for
you. E.g., these pairs show equal statements:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># set device MTU</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">mtu</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">IFLA_MTU</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span>
<span class="c1"># add vlan device</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">ifname</span><span class="o">=</span><span class="s2">"test"</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="s2">"dummy"</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">ifname</span><span class="o">=</span><span class="s2">"test"</span><span class="p">,</span>
<span class="n">IFLA_LINKINFO</span><span class="o">=</span><span class="p">{</span><span class="s1">'attrs'</span><span class="p">:</span> <span class="p">[[</span><span class="s1">'IFLA_INFO_KIND'</span><span class="p">,</span> <span class="s1">'dummy'</span><span class="p">]]})</span>
</pre></div>
</div>
<p>Filters are implemented in the <cite>pyroute2.netlink.rtnl.req</cite> module.
You can contribute your own if you miss shortcuts.</p>
<p>Commands:</p>
<p><strong>add</strong></p>
<p>To create an interface, one should specify the interface kind:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"test"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"dummy"</span><span class="p">)</span>
</pre></div>
</div>
<p>The kind can be any of those supported by kernel. It can be
<cite>dummy</cite>, <cite>bridge</cite>, <cite>bond</cite> etc. On modern kernels one can specify
even interface index:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"br-test"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"bridge"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="mi">2345</span><span class="p">)</span>
</pre></div>
</div>
<p>Specific type notes:</p>
<p>► gre</p>
<p>Create GRE tunnel:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"grex"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"gre"</span><span class="p">,</span>
<span class="n">gre_local</span><span class="o">=</span><span class="s2">"172.16.0.1"</span><span class="p">,</span>
<span class="n">gre_remote</span><span class="o">=</span><span class="s2">"172.16.0.101"</span><span class="p">,</span>
<span class="n">gre_ttl</span><span class="o">=</span><span class="mi">16</span><span class="p">)</span>
</pre></div>
</div>
<p>The keyed GRE requires explicit iflags/oflags specification:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"grex"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"gre"</span><span class="p">,</span>
<span class="n">gre_local</span><span class="o">=</span><span class="s2">"172.16.0.1"</span><span class="p">,</span>
<span class="n">gre_remote</span><span class="o">=</span><span class="s2">"172.16.0.101"</span><span class="p">,</span>
<span class="n">gre_ttl</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span>
<span class="n">gre_ikey</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">gre_okey</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">gre_iflags</span><span class="o">=</span><span class="mi">32</span><span class="p">,</span>
<span class="n">gre_oflags</span><span class="o">=</span><span class="mi">32</span><span class="p">)</span>
</pre></div>
</div>
<p>Support for GRE over IPv6 is also included; use <cite>kind=ip6gre</cite> and
<cite>ip6gre_</cite> as the prefix for its values.</p>
<p>► macvlan</p>
<p>Macvlan interfaces act like VLANs within OS. The macvlan driver
provides an ability to add several MAC addresses on one interface,
where every MAC address is reflected with a virtual interface in
the system.</p>
<p>In some setups macvlan interfaces can replace bridge interfaces,
providing more simple and at the same time high-performance
solution:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"mvlan0"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"macvlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"em1"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">macvlan_mode</span><span class="o">=</span><span class="s2">"private"</span><span class="p">)</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
</pre></div>
</div>
<p>Several macvlan modes are available: “private”, “vepa”, “bridge”,
“passthru”. Ususally the default is “vepa”.</p>
<p>► macvtap</p>
<p>Almost the same as macvlan, but creates also a character tap device:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"mvtap0"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"macvtap"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"em1"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">macvtap_mode</span><span class="o">=</span><span class="s2">"vepa"</span><span class="p">)</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
</pre></div>
</div>
<p>Will create a device file <cite>“/dev/tap%s” % index</cite></p>
<p>► tuntap</p>
<p>Possible <cite>tuntap</cite> keywords:</p>
<blockquote>
<div><ul class="simple">
<li><cite>mode</cite> — “tun” or “tap”</li>
<li><cite>uid</cite> — integer</li>
<li><cite>gid</cite> — integer</li>
<li><cite>ifr</cite> — dict of tuntap flags (see ifinfmsg:… tuntap_data)</li>
</ul>
</div></blockquote>
<p>Create a tap interface:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"tap0"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"tuntap"</span><span class="p">,</span>
<span class="n">mode</span><span class="o">=</span><span class="s2">"tap"</span><span class="p">)</span>
</pre></div>
</div>
<p>Tun/tap interfaces are created using <cite>ioctl()</cite>, but the library
provides a transparent way to manage them using netlink API.</p>
<p>► veth</p>
<p>To properly create <cite>veth</cite> interface, one should specify
<cite>peer</cite> also, since <cite>veth</cite> interfaces are created in pairs:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># simple call</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">ifname</span><span class="o">=</span><span class="s2">"v1p0"</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="s2">"veth"</span><span class="p">,</span> <span class="n">peer</span><span class="o">=</span><span class="s2">"v1p1"</span><span class="p">)</span>
<span class="c1"># set up specific veth peer attributes</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"v1p0"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"veth"</span><span class="p">,</span>
<span class="n">peer</span><span class="o">=</span><span class="p">{</span><span class="s2">"ifname"</span><span class="p">:</span> <span class="s2">"v1p1"</span><span class="p">,</span>
<span class="s2">"net_ns_fd"</span><span class="p">:</span> <span class="s2">"test_netns"</span><span class="p">})</span>
</pre></div>
</div>
<p>► vlan</p>
<p>VLAN interfaces require additional parameters, <cite>vlan_id</cite> and
<cite>link</cite>, where <cite>link</cite> is a master interface to create VLAN on:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"v100"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">vlan_id</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
</pre></div>
</div>
<p>There is a possibility to create also 802.1ad interfaces:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create external vlan 802.1ad, s-tag</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"v100s"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">vlan_id</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span>
<span class="n">vlan_protocol</span><span class="o">=</span><span class="mh">0x88a8</span><span class="p">)</span>
<span class="c1"># create internal vlan 802.1q, c-tag</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"v100c"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"v100s"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">vlan_protocol</span><span class="o">=</span><span class="mh">0x8100</span><span class="p">)</span>
</pre></div>
</div>
<p>► vrf</p>
<p>VRF interfaces (see linux/Documentation/networking/vrf.txt):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"vrf-foo"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vrf"</span><span class="p">,</span>
<span class="n">vrf_table</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
</pre></div>
</div>
<p>► vxlan</p>
<p>VXLAN interfaces are like VLAN ones, but require a bit more
parameters:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"vx101"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vxlan"</span><span class="p">,</span>
<span class="n">vxlan_link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">vxlan_id</span><span class="o">=</span><span class="mi">101</span><span class="p">,</span>
<span class="n">vxlan_group</span><span class="o">=</span><span class="s1">'239.1.1.1'</span><span class="p">,</span>
<span class="n">vxlan_ttl</span><span class="o">=</span><span class="mi">16</span><span class="p">)</span>
</pre></div>
</div>
<p>All possible vxlan parameters are listed in the module
<cite>pyroute2.netlink.rtnl.ifinfmsg:… vxlan_data</cite>.</p>
<p><strong>set</strong></p>
<p>Set interface attributes:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># get interface index</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="c1"># put link down</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="s2">"down"</span><span class="p">)</span>
<span class="c1"># rename and set MAC addr</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">address</span><span class="o">=</span><span class="s2">"00:11:22:33:44:55"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"bala"</span><span class="p">)</span>
<span class="c1"># set MTU and TX queue length</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">mtu</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">txqlen</span><span class="o">=</span><span class="mi">2000</span><span class="p">)</span>
<span class="c1"># bring link up</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="s2">"up"</span><span class="p">)</span>
</pre></div>
</div>
<p>Keyword “state” is reserved. State can be “up” or “down”,
it is a shortcut:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">state</span><span class="o">=</span><span class="s2">"up"</span><span class="p">:</span> <span class="n">flags</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">1</span>
<span class="n">state</span><span class="o">=</span><span class="s2">"down"</span><span class="p">:</span> <span class="n">flags</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="mi">0</span>
</pre></div>
</div>
<p><strong>del</strong></p>
<p>Destroy the interface:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"del"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"dummy0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
</pre></div>
</div>
<p><strong>dump</strong></p>
<p>Dump info for all interfaces</p>
<p><strong>get</strong></p>
<p>Get specific interface info:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"get"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"br0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
</pre></div>
</div>
<p><strong>vlan-add</strong>
<strong>vlan-del</strong></p>
<p>These command names are confusing and thus are deprecated.
Use <cite>IPRoute.vlan_filter()</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.link_lookup">
<code class="descname">link_lookup</code><span class="sig-paren">(</span><em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.link_lookup" title="Permalink to this definition">¶</a></dt>
<dd><p>Lookup interface index (indeces) by first level NLA
value.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">address</span><span class="o">=</span><span class="s2">"52:54:00:9d:4e:3d"</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"lo"</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">operstate</span><span class="o">=</span><span class="s2">"UP"</span><span class="p">)</span>
</pre></div>
</div>
<p>Please note, that link_lookup() returns list, not one
value.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.neigh">
<code class="descname">neigh</code><span class="sig-paren">(</span><em>command</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.neigh" title="Permalink to this definition">¶</a></dt>
<dd><p>Neighbours operations, same as <cite>ip neigh</cite> or <cite>bridge fdb</cite></p>
<p><strong>add</strong></p>
<p>Add a neighbour record, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pyroute2</span> <span class="k">import</span> <span class="n">IPRoute</span>
<span class="kn">from</span> <span class="nn">pyroute2.netlink.rtnl</span> <span class="k">import</span> <span class="n">ndmsg</span>
<span class="c1"># add a permanent record on veth0</span>
<span class="n">idx</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'veth0'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ip</span><span class="o">.</span><span class="n">neigh</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'172.16.45.1'</span><span class="p">,</span>
<span class="n">lladdr</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">,</span>
<span class="n">ifindex</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span>
<span class="n">state</span><span class="o">=</span><span class="n">ndmsg</span><span class="o">.</span><span class="n">states</span><span class="p">[</span><span class="s1">'permanent'</span><span class="p">])</span>
</pre></div>
</div>
<p><strong>set</strong></p>
<p>Set an existing record or create a new one, if it doesn’t exist.
The same as above, but the command is “set”:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">neigh</span><span class="p">(</span><span class="s1">'set'</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'172.16.45.1'</span><span class="p">,</span>
<span class="n">lladdr</span><span class="o">=</span><span class="s1">'00:11:22:33:44:55'</span><span class="p">,</span>
<span class="n">ifindex</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span>
<span class="n">state</span><span class="o">=</span><span class="n">ndmsg</span><span class="o">.</span><span class="n">states</span><span class="p">[</span><span class="s1">'permanent'</span><span class="p">])</span>
</pre></div>
</div>
<p><strong>change</strong></p>
<p>Change an existing record. If the record doesn’t exist, fail.</p>
<p><strong>del</strong></p>
<p>Delete an existing record.</p>
<p><strong>dump</strong></p>
<p>Dump all the records in the NDB:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">neigh</span><span class="p">(</span><span class="s1">'dump'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.route">
<code class="descname">route</code><span class="sig-paren">(</span><em>command</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.route" title="Permalink to this definition">¶</a></dt>
<dd><p>Route operations.</p>
<p>Keywords to set up rtmsg fields:</p>
<ul class="simple">
<li>dst_len, src_len – destination and source mask(see <cite>dst</cite> below)</li>
<li>tos – type of service</li>
<li>table – routing table</li>
<li>proto – <cite>redirect</cite>, <cite>boot</cite>, <cite>static</cite> (see <cite>rt_proto</cite>)</li>
<li>scope – routing realm</li>
<li>type – <cite>unicast</cite>, <cite>local</cite>, etc. (see <cite>rt_type</cite>)</li>
</ul>
<p><cite>pyroute2/netlink/rtnl/rtmsg.py</cite> rtmsg.nla_map:</p>
<ul class="simple">
<li>table – routing table to use (default: 254)</li>
<li>gateway – via address</li>
<li>prefsrc – preferred source IP address</li>
<li>dst – the same as <cite>prefix</cite></li>
<li>iif – incoming traffic interface</li>
<li>oif – outgoing traffic interface</li>
</ul>
<p>etc.</p>
<p>One can specify mask not as <cite>dst_len</cite>, but as a part of <cite>dst</cite>,
e.g.: <cite>dst=”10.0.0.0/24”</cite>.</p>
<p>Commands:</p>
<p><strong>add</strong></p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0/24"</span><span class="p">,</span> <span class="n">gateway</span><span class="o">=</span><span class="s2">"192.168.0.1"</span><span class="p">)</span>
</pre></div>
</div>
<p>It is possible to set also route metrics. There are two ways
to do so. The first is to use ‘raw’ NLA notation:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0"</span><span class="p">,</span>
<span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">,</span>
<span class="n">gateway</span><span class="o">=</span><span class="s2">"192.168.0.1"</span><span class="p">,</span>
<span class="n">metrics</span><span class="o">=</span><span class="p">{</span><span class="s2">"attrs"</span><span class="p">:</span> <span class="p">[[</span><span class="s2">"RTAX_MTU"</span><span class="p">,</span> <span class="mi">1400</span><span class="p">],</span>
<span class="p">[</span><span class="s2">"RTAX_HOPLIMIT"</span><span class="p">,</span> <span class="mi">16</span><span class="p">]]})</span>
</pre></div>
</div>
<p>The second way is to use shortcuts, provided by <cite>IPRouteRequest</cite>
class, which is applied to <cite>**kwarg</cite> automatically:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0/24"</span><span class="p">,</span>
<span class="n">gateway</span><span class="o">=</span><span class="s2">"192.168.0.1"</span><span class="p">,</span>
<span class="n">metrics</span><span class="o">=</span><span class="p">{</span><span class="s2">"mtu"</span><span class="p">:</span> <span class="mi">1400</span><span class="p">,</span>
<span class="s2">"hoplimit"</span><span class="p">:</span> <span class="mi">16</span><span class="p">})</span>
</pre></div>
</div>
<p>…</p>
<p>More <cite>route()</cite> examples. Blackhole route:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0/24"</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="s2">"blackhole"</span><span class="p">)</span>
</pre></div>
</div>
<p>Multipath route:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0/24"</span><span class="p">,</span>
<span class="n">multipath</span><span class="o">=</span><span class="p">[{</span><span class="s2">"gateway"</span><span class="p">:</span> <span class="s2">"192.168.0.1"</span><span class="p">,</span> <span class="s2">"hops"</span><span class="p">:</span> <span class="mi">2</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"gateway"</span><span class="p">:</span> <span class="s2">"192.168.0.2"</span><span class="p">,</span> <span class="s2">"hops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"gateway"</span><span class="p">:</span> <span class="s2">"192.168.0.3"</span><span class="p">}])</span>
</pre></div>
</div>
<p>MPLS lwtunnel on eth0:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">idx</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'eth0'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0/24"</span><span class="p">,</span>
<span class="n">oif</span><span class="o">=</span><span class="n">idx</span><span class="p">,</span>
<span class="n">encap</span><span class="o">=</span><span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mpls"</span><span class="p">,</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="s2">"200/300"</span><span class="p">})</span>
</pre></div>
</div>
<p>MPLS multipath:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">idx</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'eth0'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ip</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s2">"10.0.0.0/24"</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span>
<span class="n">multipath</span><span class="o">=</span><span class="p">[{</span><span class="s2">"gateway"</span><span class="p">:</span> <span class="s2">"192.168.0.1"</span><span class="p">,</span>
<span class="s2">"encap"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mpls"</span><span class="p">,</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="mi">200</span><span class="p">}},</span>
<span class="p">{</span><span class="s2">"ifindex"</span><span class="p">:</span> <span class="n">idx</span><span class="p">,</span>
<span class="s2">"encap"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mpls"</span><span class="p">,</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="mi">300</span><span class="p">}}])</span>
</pre></div>
</div>
<p>MPLS target can be int, string, dict or list:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"labels"</span><span class="p">:</span> <span class="mi">300</span> <span class="c1"># simple label</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="s2">"300"</span> <span class="c1"># the same</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="p">(</span><span class="mi">200</span><span class="p">,</span> <span class="mi">300</span><span class="p">)</span> <span class="c1"># stacked</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="s2">"200/300"</span> <span class="c1"># the same</span>
<span class="c1"># explicit label definition</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"bos"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"label"</span><span class="p">:</span> <span class="mi">300</span><span class="p">,</span>
<span class="s2">"tc"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">16</span><span class="p">}</span>
</pre></div>
</div>
<p><strong>change</strong>, <strong>replace</strong></p>
<p>Commands <cite>change</cite> and <cite>replace</cite> have the same meanings, as
in ip-route(8): <cite>change</cite> modifies only existing route, while
<cite>replace</cite> creates a new one, if there is no such route yet.</p>
<p><strong>del</strong></p>
<p>Remove the route. The same syntax as for <strong>add</strong>.</p>
<p><strong>get</strong></p>
<p>Get route by spec.</p>
<p><strong>dump</strong></p>
<p>Dump all routes.</p>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.rule">
<code class="descname">rule</code><span class="sig-paren">(</span><em>command</em>, <em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.rule" title="Permalink to this definition">¶</a></dt>
<dd><p>Rule operations</p>
<blockquote>
<div><ul class="simple">
<li>command — add, delete</li>
<li>table — 0 < table id < 253</li>
<li>priority — 0 < rule’s priority < 32766</li>
<li>action — type of rule, default ‘FR_ACT_NOP’ (see fibmsg.py)</li>
<li><dl class="first docutils">
<dt>rtscope — routing scope, default RT_SCOPE_UNIVERSE</dt>
<dd><cite>(RT_SCOPE_UNIVERSE|RT_SCOPE_SITE| RT_SCOPE_LINK|RT_SCOPE_HOST|RT_SCOPE_NOWHERE)</cite></dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>family — rule’s family (socket.AF_INET (default) or</dt>
<dd>socket.AF_INET6)</dd>
</dl>
</li>
<li>src — IP source for Source Based (Policy Based) routing’s rule</li>
<li>dst — IP for Destination Based (Policy Based) routing’s rule</li>
<li>src_len — Mask for Source Based (Policy Based) routing’s rule</li>
<li><dl class="first docutils">
<dt>dst_len — Mask for Destination Based (Policy Based) routing’s</dt>
<dd>rule</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>iifname — Input interface for Interface Based (Policy Based)</dt>
<dd>routing’s rule</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>oifname — Output interface for Interface Based (Policy Based)</dt>
<dd>routing’s rule</dd>
</dl>
</li>
</ul>
</div></blockquote>
<p>All packets route via table 10:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 32000: from all lookup 10</span>
<span class="c1"># ...</span>
<span class="n">ip</span><span class="o">.</span><span class="n">rule</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="n">table</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">32000</span><span class="p">)</span>
</pre></div>
</div>
<p>Default action:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 32001: from all lookup 11 unreachable</span>
<span class="c1"># ...</span>
<span class="n">iproute</span><span class="o">.</span><span class="n">rule</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="mi">11</span><span class="p">,</span>
<span class="n">priority</span><span class="o">=</span><span class="mi">32001</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s1">'FR_ACT_UNREACHABLE'</span><span class="p">)</span>
</pre></div>
</div>
<p>Use source address to choose a routing table:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 32004: from 10.64.75.141 lookup 14</span>
<span class="c1"># ...</span>
<span class="n">iproute</span><span class="o">.</span><span class="n">rule</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="mi">14</span><span class="p">,</span>
<span class="n">priority</span><span class="o">=</span><span class="mi">32004</span><span class="p">,</span>
<span class="n">src</span><span class="o">=</span><span class="s1">'10.64.75.141'</span><span class="p">)</span>
</pre></div>
</div>
<p>Use dst address to choose a routing table:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 32005: from 10.64.75.141/24 lookup 15</span>
<span class="c1"># ...</span>
<span class="n">iproute</span><span class="o">.</span><span class="n">rule</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="mi">15</span><span class="p">,</span>
<span class="n">priority</span><span class="o">=</span><span class="mi">32005</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'10.64.75.141'</span><span class="p">,</span>
<span class="n">dst_len</span><span class="o">=</span><span class="mi">24</span><span class="p">)</span>
</pre></div>
</div>
<p>Match fwmark:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 32006: from 10.64.75.141 fwmark 0xa lookup 15</span>
<span class="c1"># ...</span>
<span class="n">iproute</span><span class="o">.</span><span class="n">rule</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="mi">15</span><span class="p">,</span>
<span class="n">priority</span><span class="o">=</span><span class="mi">32006</span><span class="p">,</span>
<span class="n">dst</span><span class="o">=</span><span class="s1">'10.64.75.141'</span><span class="p">,</span>
<span class="n">fwmark</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.tc">
<code class="descname">tc</code><span class="sig-paren">(</span><em>command</em>, <em>kind=None</em>, <em>index=0</em>, <em>handle=0</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.tc" title="Permalink to this definition">¶</a></dt>
<dd><p>“Swiss knife” for traffic control. With the method you can
add, delete or modify qdiscs, classes and filters.</p>
<ul class="simple">
<li>command – add or delete qdisc, class, filter.</li>
<li>kind – a string identifier – “sfq”, “htb”, “u32” and so on.</li>
<li>handle – integer or string</li>
</ul>
<p>Command can be one of (“add”, “del”, “add-class”, “del-class”,
“add-filter”, “del-filter”) (see <cite>commands</cite> dict in the code).</p>
<p>Handle notice: traditional iproute2 notation, like “1:0”, actually
represents two parts in one four-bytes integer:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span><span class="p">:</span><span class="mi">0</span> <span class="o">-></span> <span class="mh">0x10000</span>
<span class="mi">1</span><span class="p">:</span><span class="mi">1</span> <span class="o">-></span> <span class="mh">0x10001</span>
<span class="n">ff</span><span class="p">:</span><span class="mi">0</span> <span class="o">-></span> <span class="mh">0xff0000</span>
<span class="n">ffff</span><span class="p">:</span><span class="mi">1</span> <span class="o">-></span> <span class="mh">0xffff0001</span>
</pre></div>
</div>
<p>Target notice: if your target is a class/qdisc that applies an
algorithm that can only apply to upstream traffic profile, but your
keys variable explicitly references a match that is only relevant for
upstream traffic, the kernel will reject the filter. Unless you’re
dealing with devices like IMQs</p>
<p>For pyroute2 tc() you can use both forms: integer like 0xffff0000
or string like ‘ffff:0000’. By default, handle is 0, so you can add
simple classless queues w/o need to specify handle. Ingress queue
causes handle to be 0xffff0000.</p>
<p>So, to set up sfq queue on interface 1, the function call
will be like that:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span> <span class="o">=</span> <span class="n">IPRoute</span><span class="p">()</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"sfq"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>Instead of string commands (“add”, “del”…), you can use also
module constants, <cite>RTM_NEWQDISC</cite>, <cite>RTM_DELQDISC</cite> and so on:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span> <span class="o">=</span> <span class="n">IPRoute</span><span class="p">()</span>
<span class="n">flags</span> <span class="o">=</span> <span class="n">NLM_F_REQUEST</span> <span class="o">|</span> <span class="n">NLM_F_ACK</span> <span class="o">|</span> <span class="n">NLM_F_CREATE</span> <span class="o">|</span> <span class="n">NLM_F_EXCL</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">((</span><span class="n">RTM_NEWQDISC</span><span class="p">,</span> <span class="n">flags</span><span class="p">),</span> <span class="s2">"sfq"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>It should be noted that “change”, “change-class” and
“change-filter” work like “replace”, “replace-class” and
“replace-filter”, except they will fail if the node doesn’t
exist (while it would have been created by “replace”). This is
not the same behaviour as with “tc” where “change” can be used
to modify the value of some options while leaving the others
unchanged. However, as not all entities support this
operation, we believe the “change” commands as implemented
here are more useful.</p>
<p>Also available “modules” (returns tc plugins dict) and “help”
commands:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">help</span><span class="p">(</span><span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"modules"</span><span class="p">)[</span><span class="s2">"htb"</span><span class="p">])</span>
<span class="nb">print</span><span class="p">(</span><span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"help"</span><span class="p">,</span> <span class="s2">"htb"</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="pyroute2.iproute.linux.RTNL_API.vlan_filter">
<code class="descname">vlan_filter</code><span class="sig-paren">(</span><em>command</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RTNL_API.vlan_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Vlan filters is another approach to support vlans in Linux.
Before vlan filters were introduced, there was only one way
to bridge vlans: one had to create vlan interfaces and
then add them as ports:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="o">+------+</span> <span class="o">+----------+</span>
<span class="n">net</span> <span class="o">--></span> <span class="o">|</span> <span class="n">eth0</span> <span class="o">|</span> <span class="o"><--></span> <span class="o">|</span> <span class="n">eth0</span><span class="o">.</span><span class="mi">500</span> <span class="o">|</span> <span class="o"><---+</span>
<span class="o">+------+</span> <span class="o">+----------+</span> <span class="o">|</span>
<span class="n">v</span>
<span class="o">+------+</span> <span class="o">+-----+</span>
<span class="n">net</span> <span class="o">--></span> <span class="o">|</span> <span class="n">eth1</span> <span class="o">|</span> <span class="o">|</span> <span class="n">br0</span> <span class="o">|</span>
<span class="o">+------+</span> <span class="o">+-----+</span>
<span class="o">^</span>
<span class="o">+------+</span> <span class="o">+----------+</span> <span class="o">|</span>
<span class="n">net</span> <span class="o">--></span> <span class="o">|</span> <span class="n">eth2</span> <span class="o">|</span> <span class="o"><--></span> <span class="o">|</span> <span class="n">eth0</span><span class="o">.</span><span class="mi">500</span> <span class="o">|</span> <span class="o"><---+</span>
<span class="o">+------+</span> <span class="o">+----------+</span>
</pre></div>
</div>
<p>It means that one has to create as many bridges, as there were
vlans. Vlan filters allow to bridge together underlying interfaces
and create vlans already on the bridge:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># v500 label shows which interfaces have vlan filter</span>
<span class="o">+------+</span> <span class="n">v500</span>
<span class="n">net</span> <span class="o">--></span> <span class="o">|</span> <span class="n">eth0</span> <span class="o">|</span> <span class="o"><-------+</span>
<span class="o">+------+</span> <span class="o">|</span>
<span class="n">v</span>
<span class="o">+------+</span> <span class="o">+-----+</span> <span class="o">+---------+</span>
<span class="n">net</span> <span class="o">--></span> <span class="o">|</span> <span class="n">eth1</span> <span class="o">|</span> <span class="o"><--></span> <span class="o">|</span> <span class="n">br0</span> <span class="o">|<-->|</span> <span class="n">br0v500</span> <span class="o">|</span>
<span class="o">+------+</span> <span class="o">+-----+</span> <span class="o">+---------+</span>
<span class="o">^</span>
<span class="o">+------+</span> <span class="n">v500</span> <span class="o">|</span>
<span class="n">net</span> <span class="o">--></span> <span class="o">|</span> <span class="n">eth2</span> <span class="o">|</span> <span class="o"><-------+</span>
<span class="o">+------+</span>
</pre></div>
</div>
<p>In this example vlan 500 will be allowed only on ports <cite>eth0</cite> and
<cite>eth2</cite>, though all three eth nics are bridged.</p>
<p>Some example code:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create bridge</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"br0"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"bridge"</span><span class="p">)</span>
<span class="c1"># attach a port</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">master</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"br0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
<span class="c1"># set vlan filter</span>
<span class="n">ip</span><span class="o">.</span><span class="n">vlan_filter</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">vlan_info</span><span class="o">=</span><span class="p">{</span><span class="s2">"vid"</span><span class="p">:</span> <span class="mi">500</span><span class="p">})</span>
<span class="c1"># create vlan interface on the bridge</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"br0v500"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"br0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">vlan_id</span><span class="o">=</span><span class="mi">500</span><span class="p">)</span>
<span class="c1"># set all UP</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"br0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">state</span><span class="o">=</span><span class="s2">"up"</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"br0v500"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">state</span><span class="o">=</span><span class="s2">"up"</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"set"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">state</span><span class="o">=</span><span class="s2">"up"</span><span class="p">)</span>
<span class="c1"># set IP address</span>
<span class="n">ip</span><span class="o">.</span><span class="n">addr</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="n">ip</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"br0v500"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">address</span><span class="o">=</span><span class="s2">"172.16.5.2"</span><span class="p">,</span>
<span class="n">mask</span><span class="o">=</span><span class="mi">24</span><span class="p">)</span>
<span class="n">Now</span> <span class="nb">all</span> <span class="n">the</span> <span class="n">traffic</span> <span class="n">to</span> <span class="n">the</span> <span class="n">network</span> <span class="mf">172.16</span><span class="o">.</span><span class="mf">5.2</span><span class="o">/</span><span class="mi">24</span> <span class="n">will</span> <span class="n">go</span>
<span class="n">to</span> <span class="n">vlan</span> <span class="mi">500</span> <span class="n">only</span> <span class="n">via</span> <span class="n">ports</span> <span class="n">that</span> <span class="n">have</span> <span class="n">such</span> <span class="n">vlan</span> <span class="nb">filter</span><span class="o">.</span>
</pre></div>
</div>
<p>Required arguments for <cite>vlan_filter()</cite> – <cite>index</cite> and <cite>vlan_info</cite>.
Vlan info struct:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">"vid"</span><span class="p">:</span> <span class="n">uint16</span><span class="p">,</span>
<span class="s2">"flags"</span><span class="p">:</span> <span class="n">uint16</span><span class="p">}</span>
</pre></div>
</div>
<dl class="docutils">
<dt>More details:</dt>
<dd><ul class="first last simple">
<li>kernel:Documentation/networking/switchdev.txt</li>
<li>pyroute2.netlink.rtnl.ifinfmsg:… vlan_info</li>
</ul>
</dd>
<dt>One can specify <cite>flags</cite> as int or as a list of flag names:</dt>
<dd><ul class="first last simple">
<li><cite>master</cite> == 0x1</li>
<li><cite>pvid</cite> == 0x2</li>
<li><cite>untagged</cite> == 0x4</li>
<li><cite>range_begin</cite> == 0x8</li>
<li><cite>range_end</cite> == 0x10</li>
<li><cite>brentry</cite> == 0x20</li>
</ul>
</dd>
</dl>
<p>E.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">"vid"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
<span class="s2">"flags"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"pvid"</span><span class="p">,</span> <span class="s2">"untagged"</span><span class="p">]}</span>
<span class="c1"># is equal to</span>
<span class="p">{</span><span class="s2">"vid"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
<span class="s2">"flags"</span><span class="p">:</span> <span class="mi">6</span><span class="p">}</span>
</pre></div>
</div>
<p>Commands:</p>
<p><strong>add</strong></p>
<p>Add vlan filter to a bridge port. Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">vlan_filter</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">vlan_info</span><span class="o">=</span><span class="p">{</span><span class="s2">"vid"</span><span class="p">:</span> <span class="mi">200</span><span class="p">})</span>
</pre></div>
</div>
<p><strong>del</strong></p>
<p>Remove vlan filter from a bridge port. Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">vlan_filter</span><span class="p">(</span><span class="s2">"del"</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">vlan_info</span><span class="o">=</span><span class="p">{</span><span class="s2">"vid"</span><span class="p">:</span> <span class="mi">200</span><span class="p">})</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyroute2.iproute.linux.RawIPRoute">
<em class="property">class </em><code class="descclassname">pyroute2.iproute.linux.</code><code class="descname">RawIPRoute</code><span class="sig-paren">(</span><em>*argv</em>, <em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.iproute.linux.RawIPRoute" title="Permalink to this definition">¶</a></dt>
<dd><p>The same as <cite>IPRoute</cite>, but does not use the netlink proxy.
Thus it can not manage e.g. tun/tap interfaces.</p>
</dd></dl>
</div>
<div class="section" id="module-pyroute2.netlink.rtnl.tcmsg.sched_drr">
<span id="queueing-disciplines"></span><h2>Queueing disciplines<a class="headerlink" href="#module-pyroute2.netlink.rtnl.tcmsg.sched_drr" title="Permalink to this headline">¶</a></h2>
<div class="section" id="drr">
<h3>drr<a class="headerlink" href="#drr" title="Permalink to this headline">¶</a></h3>
<p>The qdisc doesn’t accept any parameters, but the class
accepts <cite>quantum</cite> parameter:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="s1">'drr'</span><span class="p">,</span> <span class="n">interface</span><span class="p">,</span> <span class="s1">'1:'</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s1">'add-class'</span><span class="p">,</span> <span class="s1">'drr'</span><span class="p">,</span> <span class="n">interface</span><span class="p">,</span> <span class="s1">'1:10'</span><span class="p">,</span> <span class="n">quantum</span><span class="o">=</span><span class="mi">1600</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s1">'add-class'</span><span class="p">,</span> <span class="s1">'drr'</span><span class="p">,</span> <span class="n">interface</span><span class="p">,</span> <span class="s1">'1:20'</span><span class="p">,</span> <span class="n">quantum</span><span class="o">=</span><span class="mi">1600</span><span class="p">)</span>
</pre></div>
</div>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_drr.options">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_drr.</code><code class="descname">options</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_drr.options" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_drr.stats">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_drr.</code><code class="descname">stats</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_drr.stats" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_drr.stats2">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_drr.</code><code class="descname">stats2</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_drr.stats2" title="Permalink to this definition">¶</a></dt>
<dd><dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_drr.stats2.stats_app">
<em class="property">class </em><code class="descname">stats_app</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_drr.stats2.stats_app" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<span class="target" id="module-pyroute2.netlink.rtnl.tcmsg.sched_choke"></span><div class="section" id="choke">
<h3>choke<a class="headerlink" href="#choke" title="Permalink to this headline">¶</a></h3>
<p>Parameters:</p>
<blockquote>
<div><ul class="simple">
<li><cite>limit</cite> (required) – int</li>
<li><cite>bandwith</cite> (required) – str/int</li>
<li><cite>min</cite> – int</li>
<li><cite>max</cite> – int</li>
<li><cite>avpkt</cite> – str/int, packet size</li>
<li><cite>burst</cite> – int</li>
<li><cite>probability</cite> – float</li>
<li><cite>ecn</cite> – bool</li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s1">'add'</span><span class="p">,</span> <span class="s1">'choke'</span><span class="p">,</span> <span class="n">interface</span><span class="p">,</span>
<span class="n">limit</span><span class="o">=</span><span class="mi">5500</span><span class="p">,</span>
<span class="n">bandwith</span><span class="o">=</span><span class="s2">"10mbit"</span><span class="p">,</span>
<span class="n">ecn</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.options">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_choke.</code><code class="descname">options</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.options" title="Permalink to this definition">¶</a></dt>
<dd><dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.options.qopt">
<em class="property">class </em><code class="descname">qopt</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.options.qopt" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.options.stab">
<em class="property">class </em><code class="descname">stab</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.options.stab" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.options.stab.encode">
<code class="descname">encode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.options.stab.encode" title="Permalink to this definition">¶</a></dt>
<dd><p>Encode the message into the binary buffer:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">msg</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span>
<span class="n">sock</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<p>If you want to customize the encoding process, override
the method:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">CustomMessage</span><span class="p">(</span><span class="n">nlmsg</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="o">...</span> <span class="c1"># do some custom data tuning</span>
<span class="n">nlmsg</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.stats">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_choke.</code><code class="descname">stats</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.stats" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.stats2">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_choke.</code><code class="descname">stats2</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.stats2" title="Permalink to this definition">¶</a></dt>
<dd><dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_choke.stats2.stats_app">
<em class="property">class </em><code class="descname">stats_app</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_choke.stats2.stats_app" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<span class="target" id="module-pyroute2.netlink.rtnl.tcmsg.sched_clsact"></span><div class="section" id="clsact">
<h3>clsact<a class="headerlink" href="#clsact" title="Permalink to this headline">¶</a></h3>
<p>The clsact qdisc provides a mechanism to attach integrated
filter-action classifiers to an interface, either at ingress or egress,
or both. The use case shown here is using a bpf program (implemented
elsewhere) to direct the packet processing. The example also uses the
direct-action feature to specify what to do with each packet (pass,
drop, redirect, etc.).</p>
<p>BPF ingress/egress example using clsact qdisc:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># open_bpf_fd is outside the scope of pyroute2</span>
<span class="c1">#fd = open_bpf_fd()</span>
<span class="n">eth0</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"clsact"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">)</span>
<span class="c1"># add ingress clsact</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"bpf"</span><span class="p">,</span> <span class="n">idx</span><span class="p">,</span> <span class="s2">":1"</span><span class="p">,</span> <span class="n">fd</span><span class="o">=</span><span class="n">fd</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"myprog"</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="s2">"ffff:fff2"</span><span class="p">,</span> <span class="n">classid</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">direct_action</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># add egress clsact</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"bpf"</span><span class="p">,</span> <span class="n">idx</span><span class="p">,</span> <span class="s2">":1"</span><span class="p">,</span> <span class="n">fd</span><span class="o">=</span><span class="n">fd</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"myprog"</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="s2">"ffff:fff3"</span><span class="p">,</span> <span class="n">classid</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">direct_action</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</div>
<span class="target" id="module-pyroute2.netlink.rtnl.tcmsg.sched_hfsc"></span><div class="section" id="hfsc">
<h3>hfsc<a class="headerlink" href="#hfsc" title="Permalink to this headline">¶</a></h3>
<p>Simple HFSC example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">eth0</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"hfsc"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">handle</span><span class="o">=</span><span class="s2">"1:"</span><span class="p">,</span>
<span class="n">default</span><span class="o">=</span><span class="s2">"1:1"</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-class"</span><span class="p">,</span> <span class="s2">"hfsc"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">handle</span><span class="o">=</span><span class="s2">"1:1"</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="s2">"1:0"</span>
<span class="n">rsc</span><span class="o">=</span><span class="p">{</span><span class="s2">"m2"</span><span class="p">:</span> <span class="s2">"5mbit"</span><span class="p">})</span>
</pre></div>
</div>
<p>HFSC curve nla types:</p>
<ul class="simple">
<li><cite>rsc</cite>: real-time curve</li>
<li><cite>fsc</cite>: link-share curve</li>
<li><cite>usc</cite>: upper-limit curve</li>
</ul>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_hfsc.options_hfsc">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_hfsc.</code><code class="descname">options_hfsc</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_hfsc.options_hfsc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_hfsc.options_hfsc_class">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_hfsc.</code><code class="descname">options_hfsc_class</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_hfsc.options_hfsc_class" title="Permalink to this definition">¶</a></dt>
<dd><dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_hfsc.options_hfsc_class.hfsc_curve">
<em class="property">class </em><code class="descname">hfsc_curve</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_hfsc.options_hfsc_class.hfsc_curve" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_hfsc.stats2">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_hfsc.</code><code class="descname">stats2</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_hfsc.stats2" title="Permalink to this definition">¶</a></dt>
<dd><dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_hfsc.stats2.stats_app">
<em class="property">class </em><code class="descname">stats_app</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_hfsc.stats2.stats_app" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<span class="target" id="module-pyroute2.netlink.rtnl.tcmsg.sched_htb"></span><div class="section" id="htb">
<h3>htb<a class="headerlink" href="#htb" title="Permalink to this headline">¶</a></h3>
<p>TODO: list parameters</p>
<p>An example with htb qdisc, lets assume eth0 == 2:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># u32 --> +--> htb 1:10 --> sfq 10:0</span>
<span class="c1"># | |</span>
<span class="c1"># | |</span>
<span class="c1"># eth0 -- htb 1:0 -- htb 1:1</span>
<span class="c1"># | |</span>
<span class="c1"># | |</span>
<span class="c1"># u32 --> +--> htb 1:20 --> sfq 20:0</span>
<span class="n">eth0</span> <span class="o">=</span> <span class="mi">2</span>
<span class="c1"># add root queue 1:0</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"htb"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span> <span class="mh">0x10000</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mh">0x200000</span><span class="p">)</span>
<span class="c1"># root class 1:1</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-class"</span><span class="p">,</span> <span class="s2">"htb"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span> <span class="mh">0x10001</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10000</span><span class="p">,</span>
<span class="n">rate</span><span class="o">=</span><span class="s2">"256kbit"</span><span class="p">,</span>
<span class="n">burst</span><span class="o">=</span><span class="mi">1024</span> <span class="o">*</span> <span class="mi">6</span><span class="p">)</span>
<span class="c1"># two branches: 1:10 and 1:20</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-class"</span><span class="p">,</span> <span class="s2">"htb"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span> <span class="mh">0x10010</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10001</span><span class="p">,</span>
<span class="n">rate</span><span class="o">=</span><span class="s2">"192kbit"</span><span class="p">,</span>
<span class="n">burst</span><span class="o">=</span><span class="mi">1024</span> <span class="o">*</span> <span class="mi">6</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-class"</span><span class="p">,</span> <span class="s2">"htb"</span><span class="p">,</span> <span class="n">eht0</span><span class="p">,</span> <span class="mh">0x10020</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10001</span><span class="p">,</span>
<span class="n">rate</span><span class="o">=</span><span class="s2">"128kbit"</span><span class="p">,</span>
<span class="n">burst</span><span class="o">=</span><span class="mi">1024</span> <span class="o">*</span> <span class="mi">6</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="c1"># two leaves: 10:0 and 20:0</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"sfq"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span> <span class="mh">0x100000</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10010</span><span class="p">,</span>
<span class="n">perturb</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"sfq"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span> <span class="mh">0x200000</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10020</span><span class="p">,</span>
<span class="n">perturb</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
<span class="c1"># two filters: one to load packets into 1:10 and the</span>
<span class="c1"># second to 1:20</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"u32"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10000</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="mh">0x10010</span><span class="p">,</span>
<span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="s2">"0x0006/0x00ff+8"</span><span class="p">,</span> <span class="s2">"0x0000/0xffc0+2"</span><span class="p">])</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"u32"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10000</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="mh">0x10020</span><span class="p">,</span>
<span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="s2">"0x5/0xf+0"</span><span class="p">,</span> <span class="s2">"0x10/0xff+33"</span><span class="p">])</span>
</pre></div>
</div>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_htb.options">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_htb.</code><code class="descname">options</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_htb.options" title="Permalink to this definition">¶</a></dt>
<dd><dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_htb.options.htb_glob">
<em class="property">class </em><code class="descname">htb_glob</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_htb.options.htb_glob" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_htb.options.htb_parms">
<em class="property">class </em><code class="descname">htb_parms</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_htb.options.htb_parms" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyroute2.netlink.rtnl.tcmsg.sched_htb.stats">
<em class="property">class </em><code class="descclassname">pyroute2.netlink.rtnl.tcmsg.sched_htb.</code><code class="descname">stats</code><span class="sig-paren">(</span><em>data=None</em>, <em>offset=0</em>, <em>length=None</em>, <em>parent=None</em>, <em>init=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.netlink.rtnl.tcmsg.sched_htb.stats" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
<div class="section" id="module-pyroute2.netlink.rtnl.tcmsg.cls_u32">
<span id="filters"></span><h2>Filters<a class="headerlink" href="#module-pyroute2.netlink.rtnl.tcmsg.cls_u32" title="Permalink to this headline">¶</a></h2>
<div class="section" id="u32">
<h3>u32<a class="headerlink" href="#u32" title="Permalink to this headline">¶</a></h3>
<p>Filters can take an <cite>action</cite> argument, which affects the packet
behavior when the filter matches. Currently the gact, bpf, and police
action types are supported, and can be attached to the u32 and bpf
filter types:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># An action can be a simple string, which translates to a gact type</span>
<span class="n">action</span> <span class="o">=</span> <span class="s2">"drop"</span>
<span class="c1"># Or it can be an explicit type (these are equivalent)</span>
<span class="n">action</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">kind</span><span class="o">=</span><span class="s2">"gact"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"drop"</span><span class="p">)</span>
<span class="c1"># There can also be a chain of actions, which depend on the return</span>
<span class="c1"># value of the previous action.</span>
<span class="n">action</span> <span class="o">=</span> <span class="p">[</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">kind</span><span class="o">=</span><span class="s2">"bpf"</span><span class="p">,</span> <span class="n">fd</span><span class="o">=</span><span class="n">fd</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"ok"</span><span class="p">),</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">kind</span><span class="o">=</span><span class="s2">"police"</span><span class="p">,</span> <span class="n">rate</span><span class="o">=</span><span class="s2">"10kbit"</span><span class="p">,</span> <span class="n">burst</span><span class="o">=</span><span class="mi">10240</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="mi">0</span><span class="p">),</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">kind</span><span class="o">=</span><span class="s2">"gact"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"ok"</span><span class="p">),</span>
<span class="p">]</span>
<span class="c1"># Add the action to a u32 match-all filter</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span> <span class="s2">"htb"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span> <span class="mh">0x10000</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mh">0x200000</span><span class="p">)</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"u32"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10000</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">protocols</span><span class="o">.</span><span class="n">ETH_P_ALL</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="mh">0x10020</span><span class="p">,</span>
<span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="s2">"0x0/0x0+0"</span><span class="p">],</span>
<span class="n">action</span><span class="o">=</span><span class="n">action</span><span class="p">)</span>
<span class="c1"># Add two more filters: One to send packets with a src address of</span>
<span class="c1"># 192.168.0.1/32 into 1:10 and the second to send packets with a</span>
<span class="c1"># dst address of 192.168.0.0/24 into 1:20</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"u32"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10000</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="mh">0x10010</span><span class="p">,</span>
<span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="s2">"0xc0a80001/0xffffffff+12"</span><span class="p">])</span>
<span class="c1"># 0xc0a800010 = 192.168.0.1</span>
<span class="c1"># 0xffffffff = 255.255.255.255 (/32)</span>
<span class="c1"># 12 = Source network field bit offset</span>
<span class="n">ip</span><span class="o">.</span><span class="n">tc</span><span class="p">(</span><span class="s2">"add-filter"</span><span class="p">,</span> <span class="s2">"u32"</span><span class="p">,</span> <span class="n">eth0</span><span class="p">,</span>
<span class="n">parent</span><span class="o">=</span><span class="mh">0x10000</span><span class="p">,</span>
<span class="n">prio</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="mh">0x10020</span><span class="p">,</span>
<span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="s2">"0xc0a80000/0xffffff00+16"</span><span class="p">])</span>
<span class="c1"># 0xc0a80000 = 192.168.0.0</span>
<span class="c1"># 0xffffff00 = 255.255.255.0 (/24)</span>
<span class="c1"># 16 = Destination network field bit offset</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">IPRoute module</a><ul>
<li><a class="reference internal" href="#classes">Classes</a></li>
<li><a class="reference internal" href="#responses-as-lists">Responses as lists</a><ul>
<li><a class="reference internal" href="#nlmsg-error-responses">NLMSG_ERROR responses</a></li>
<li><a class="reference internal" href="#how-to-work-with-messages">How to work with messages</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-pyroute2.iproute.bsd">BSD notes</a></li>
<li><a class="reference internal" href="#module-pyroute2.iproute.linux">IPRoute API</a></li>
<li><a class="reference internal" href="#module-pyroute2.netlink.rtnl.tcmsg.sched_drr">Queueing disciplines</a><ul>
<li><a class="reference internal" href="#drr">drr</a></li>
<li><a class="reference internal" href="#choke">choke</a></li>
<li><a class="reference internal" href="#clsact">clsact</a></li>
<li><a class="reference internal" href="#hfsc">hfsc</a></li>
<li><a class="reference internal" href="#htb">htb</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-pyroute2.netlink.rtnl.tcmsg.cls_u32">Filters</a><ul>
<li><a class="reference internal" href="#u32">u32</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="usage.html"
title="previous chapter">Quickstart</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ipdb.html"
title="next chapter">IPDB module</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/iproute.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ipdb.html" title="IPDB module"
>next</a> |</li>
<li class="right" >
<a href="usage.html" title="Quickstart"
>previous</a> |</li>
<li class="nav-item"><a href="http://pyroute2.org">Project home</a> »</li>
<li class="nav-item nav-item-0"><a href="index.html">pyroute2 0.5.2 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013, Peter V. Saveliev.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
</div>
</body>
</html>
|
