- Notifications
You must be signed in to change notification settings - Fork251
Python Netlink and PF_ROUTE library — network configuration and monitoring
License
svinota/pyroute2
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Pyroute2 is a pure Python networking framework. The core requires only Pythonstdlib, no 3rd party libraries. The library was started as an RTNL protocolimplementation, so the name ispyroute2, but now it supports severalprotocols, including non-netlink. Here are some supported netlink familiesand protocols:
- dhcp --- dynamic host configuration protocol for IPv4
- 9p2000 --- Plan9 file system protocol
Netlink:
- rtnl, network settings --- addresses, routes, traffic controls
- nfnetlink --- netfilter API
- ipq --- simplest userspace packet filtering, iptables QUEUE target
- devlink --- manage and monitor devlink-enabled hardware
- generic --- generic netlink families
- uevent --- same uevent messages as in udev
Netfilter API:
- ipset --- IP sets
- nftables --- packet filtering
- nfct --- connection tracking
Generic netlink:
- ethtool --- low-level network interface setup
- wireguard --- VPN setup
- nl80211 --- wireless functions API (basic support)
- taskstats --- extended process statistics
- acpi_events --- ACPI events monitoring
- thermal_events --- thermal events monitoring
- VFS_DQUOT --- disk quota events monitoring
On the low level the library provides socket objects with anextended API. The additional functionality aims to:
- Help to open/bind netlink sockets
- Discover generic netlink protocols and multicast groups
- Construct, encode and decode netlink and PF_ROUTE messages
Pyroute2 runs natively on Linux and emulates some limited subsetof RTNL netlink API on BSD systems on top of PF_ROUTE notificationsand standard system tools.
Other platforms are not supported.
Low-levelIPRoute utility --- Linux network configuration, thisclass is almost a 1-to-1 RTNL mapping. There are no implicitinterface lookups and so on.
Get notifications about network settings changes:
frompyroute2importIPRoutewithIPRoute()asipr:ipr.bind()# <--- start listening for RTNL broadcastsformessageinipr.get():# receive the broadcastsprint(message)
More examples:
fromsocketimportAF_INETfrompyroute2importIPRoute# get access to the netlink socketipr=IPRoute()# no monitoring here -- thus no bind()# print interfacesforlinkinipr.get_links():print(link)# create VETH pair and move v0p1 to netns 'test'ipr.link('add',ifname='v0p0',peer='v0p1',kind='veth')# wait for the devices:peer,veth=ipr.poll(ipr.link,'dump',timeout=5,ifname=lambdax:xin ('v0p0','v0p1'))ipr.link('set',index=peer['index'],net_ns_fd='test')# bring v0p0 up and add an addressipr.link('set',index=veth['index'],state='up')ipr.addr('add',index=veth['index'],address='10.0.0.1',prefixlen=24)# release Netlink socketip.close()
While IPRoute provides a synchronous RTNL API, it is actually buildaround the asyncio-based core.
The same example as above can look like that:
importasynciofrompyroute2importAsyncIPRouteasyncdefmain():# get access to the netlink socketipr=AsyncIPRoute()# print interfacesasyncforlinkinawaitipr.get_links():print(link)# create VETH pair and move v0p1 to netns 'test'awaitipr.link('add',ifname='v0p0',peer='v0p1',kind='veth')# wait for the devices:peer,veth=awaitipr.poll(ipr.link,'dump',timeout=5,ifname=lambdax:xin ('v0p0','v0p1') )awaitipr.link('set',index=peer['index'],net_ns_fd='test') ...ipr.close()asyncio.run(main())
Please notice that .close() is synchronous in any case.
frompyroute2importnetns# create netnsnetns.create('test')# listprint(netns.listnetns())# remove netnsnetns.remove('test')
Createveth interfaces pair and move tonetns:
frompyroute2importIPRoutewithIPRoute()asipr:# create interface pairipr.link('add',ifname='v0p0',kind='veth',peer='v0p1')# wait for the peer (peer,)=ipr.poll(ipr.link,'dump',timeout=5,ifname='v0p1')# move the peer to the 'test' netns:ipr.link('set',index=peer['index'],net_ns_fd='test')
List interfaces in somenetns:
frompyroute2importIPRoutewithIPRoute(netns='test')asipr:forlinkinipr.get_links():print(link)
More details and samples see in the documentation.
Key features:
- Data integrity
- Transactions with commit/rollback changes
- State synchronization
- Multiple sources, including netns and remote systems
A "Hello world" example:
frompyroute2importNDBwithNDB()asndb:withndb.interfaces['eth0']aseth0:# set one parametereth0.set(state='down')eth0.commit()# make sure that the interface is down# or multiple parameters at onceeth0.set(ifname='hello_world!',state='up')eth0.commit()# rename, bring up and wait for success# --> <-- here you can be sure that the interface is up & renamed
Using pypi:
pip install pyroute2
Using git:
pip install git+https://github.com/svinota/pyroute2.git
Using source, requires make and nox
git clone https://github.com/svinota/pyroute2.gitcd pyroute2make installPython >= 3.9
About
Python Netlink and PF_ROUTE library — network configuration and monitoring