Skip to main content

Python Netlink library

Project description

![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.6

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.

Project details


Release history Release notifications | RSS feed

This version

0.4.5

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyroute2-0.4.5.tar.gz (454.8 kB view details)

Uploaded Source

File details

Details for the file pyroute2-0.4.5.tar.gz.

File metadata

  • Download URL: pyroute2-0.4.5.tar.gz
  • Upload date:
  • Size: 454.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyroute2-0.4.5.tar.gz
Algorithm Hash digest
SHA256 d80c83fcbb6385bf126d69345cabce01d0fbb870b6ad46dd4583e6c54e775061
MD5 c42e1fda8fc864fd96ed69d940fbad1c
BLAKE2b-256 b148c5de65e3f8bb8bdb1873167838ddc8d8545a7bd825bdc8031d474768eeed

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page