Pyroute2 netlink library

General information

• Pyroute2
  • Supported systems
  • IPRoute -- synchronous RTNL API
  • AsyncIPRoute -- asynchronous RTNL API
  • Network namespace management
  • NDB -- high level RTNL API
  • Installation
  • Requirements
  • Links
• Changelog
• Report a bug

Usage

• Quickstart
  • Netlink sockets
  • Resource release
  • Imports
• Library core
  • Intro
  • AsyncCoreSocket
  • Synchronous code
• Using the library in threaded environments
  • Network namespaces
  • Starting a child process: os.fork()
  • Starting a child process: multiprocessing
  • Threading and asyncio
• IPRoute and related modules
  • RTNL classes
  • Using namespaces
  • NLMSG_ERROR responses
  • How to work with messages
  • Linux systems
• NDB module intro
• NDB reference
  • NDB objects
  • RTNL objects
  • Views
  • Transactions
  • Record list filters
  • Network interfaces
  • IP addresses management
  • Routes management
  • Network probes
  • Database
  • RTNL sources
  • Debug and logging
• CI test fixtures
  • nsname()
  • test_link_ifinfmsg()
  • test_link()
  • test_link_address()
  • test_link_index()
  • test_link_ifname()
  • async_ipr()
  • sync_ipr()
  • async_context()
  • sync_context()
  • ndb()
  • TestInterface
  • TestContext
• Plan9 9p2000 protocol
  • Plan9ServerSocket
  • Plan9ClientSocket
• WiSet module
  • need_ipset_socket()
  • IPStats
  • WiSet
  • get_ipset_socket()
• IPSet module
  • PortRange
  • PortEntry
  • IPSet
• NetNS management
  • Basic network namespace management
  • listnetns()
  • ns_pids()
  • pid_to_ns()
  • create()
  • attach()
  • remove()
  • setns()
  • pushns()
  • popns()
  • dropns()
  • NSPopen
  • MetaPopen
  • NSPopen
• WireGuard module
• Generic netlink events protocols
  • ACPI events
  • Disk quota events

Howtos

• MPLS howto
  • MPLS labels
  • IPRoute
  • NDB
• Netlink debugging howto
  • pyroute2-decoder
  • filter functions

Man pages

• pyroute2-cli
• pyroute2-dhcp-client
• dhcp-server-detector

Development

• Project Contribution Guide
  • Setup the Environment
  • Test-Driven Development
  • Code Linting
  • Run Specific Test Modules
  • Test Session Configuration
  • Running with nox
  • Project Dependencies
  • Submit a Pull Request
  • IRC Channel
• Module architecture
  • Sockets
  • Netlink messages
  • PF_ROUTE messages
  • Internet protocols
• Netlink parser data flow
  • NetlinkRequest
  • Marshal: get and run parsers
  • Per-request parsers
  • NetlinkRequest: pick correct messages
• Netlink
  • basics
  • pyroute2 and netlink

Deprecated

• IPDB

Indices and tables

• Index

• Module Index

• Search Page