---
id: os-ken
version: "4.2.1"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# os-ken — A component-based software defined networking framework for OpenStack

License: permissive · Maintenance: active · Downloads: 141.1K/mo

## What it is and what it does

os-ken is a fork of the Ryu SDN framework adapted for OpenStack Neutron. It provides a Python-based platform for building OpenFlow controllers that can manage and monitor network switches and devices programmatically. The framework is component-based, meaning you build applications by extending base classes and registering event handlers for network events like switch connections and packet arrivals.

The package sits at the intersection of network infrastructure and application logic—it handles the low-level OpenFlow protocol details (via dependencies like ncclient and msgpack) while exposing a higher-level event-driven API. It's designed for operators and developers working within OpenStack environments who need to implement custom network policies, traffic engineering, or monitoring on top of their SDN infrastructure.

Use it for:

- Build custom OpenFlow controllers to manage network traffic policies in OpenStack deployments.
- Monitor and react to network events (switch joins, packet arrivals) in a programmatic way.
- Implement network slicing or traffic engineering logic on top of OpenFlow switches.
- Prototype and test SDN applications in OpenStack lab or production environments.
- Integrate network control logic directly into OpenStack Neutron workflows.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

os-ken is a component-based software defined networking framework for OpenStack that enables programmatic control and monitoring of network switches and devices through OpenFlow protocols.

Yes, if you are working within an OpenStack environment and need to build or extend SDN applications. The package is actively maintained, has low install friction, carries a permissive license, and has no known vulnerabilities. It is not a general-purpose networking library—it is specifically tailored for OpenStack Neutron and OpenFlow-based infrastructure, so install it only if that matches your deployment model.

## Install

pip install os-ken
uv add os-ken
poetry add os-ken

## Installing os-ken

Before you install: Low install friction with a pure-Python wheel distribution. Active maintenance status with a recent release within 63 days. Ten runtime dependencies including eventlet, msgpack, and ncclient provide the networking and async foundations the framework needs.

License in practice: Apache License 2.0 (permissive) allows use in commercial and proprietary projects with minimal restrictions; you must retain license notices and disclaim warranties.

Quickstart:

pip install os-ken

from os_ken.base import app_manager
from os_ken.controller import ofp_event
from os_ken.ofproto import ofproto_v1_3

class SimpleSwitch(app_manager.RyuApp):
    OFP_VERSIONS = [ofproto_v1_3.OFP_VERSION]

Requires Python 3.10 or later; intended for OpenStack deployments or environments with OpenFlow-capable network hardware or simulators.

Verify before relying:

- Whether the package works with specific OpenFlow versions beyond what the classifiers indicate.
- Performance characteristics and scalability limits for large network topologies.
- Integration requirements and compatibility with specific OpenStack releases.

## Package facts

- License: Apache-2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 141.1K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

software defined networking framework, openflow controller, openstack network control, sdn framework python, network switch programming, openstack neutron networking, programmable network devices, openflow, sdn, openstack

[View on SkillFed](https://skillfed.io/packages/os-ken) · [View on PyPI](https://pypi.org/project/os-ken/)