skip to navigation
skip to content

pyroute2 0.4.6

Python Netlink library

![E/// logo](docs/ericsson.png “supported by Ericsson”)

pyroute2

Pyroute2 is a pure Python netlink and Linux network configuration library. It requires only Python stdlib, no 3rd party libraries. Later it can change, but the deps tree will remain as simple, as it is possible.

The library provides several modules:

  • Netlink protocol implementations (RTNetlink, TaskStats, etc)
    • rtnl, network settings — addresses, routes, traffic controls
    • nl80211 — wireless functions API (work in progress)
    • nfnetlink — netfilter API: ipset, nftables (work in progress), …
    • ipq — simplest userspace packet filtering, iptables QUEUE target
    • taskstats — extended process statistics
  • Simple netlink socket object, that can be used in poll/select

  • Network configuration module IPRoute provides API that in some way resembles ip/tc functionality

  • IPDB is an async transactional database of Linux network settings

network namespace samples

Network namespace manipulation:

from pyroute2 import netns
# create netns
netns.create('test')
# list
print(netns.listnetns())
# remove netns
netns.remove('test')

Create veth interfaces pair and move to netns:

from pyroute2 import IPDB

ip = IPDB()
# create interface pair
ip.create(ifname='v0p0', kind='veth', peer='v0p1').commit()
# move peer to netns
with ip.interfaces.v0p1 as veth:
    veth.net_ns_fd = 'test'
# don't forget to release before exit
ip.release()

List interfaces in some netns:

from pyroute2 import NetNS
from pprint import pprint

ns = NetNS('test')
pprint(ns.get_links())
ns.close()

More details and samples see in the documentation.

installation

make install or pip install pyroute2

requires

Python >= 2.7

The pyroute2 testing framework requires flake8, coverage, nosetests.

compatibility

Starting with the version 0.4.0, the library doesn’t support bridge and bond management via external utilities, only via netlink. The main development and testing is done on the net-next kernel.

The transparent use of the external utilities is still provided by the branch 0.3.x, which will be supported with critical bugfixes. It makes it suitable for LTS distros. But no new features will be provided for the branch 0.3.x.

 
File Type Py Version Uploaded on Size
pyroute2-0.4.6.tar.gz (md5) Source 2016-08-18 444KB