---
id: os-vif
version: "5.1.0"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# os-vif — A library for plugging and unplugging virtual interfaces in OpenStack.

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

## What it is and what it does

os-vif is an OpenStack library that abstracts the mechanics of attaching and detaching virtual network interfaces to compute instances. It provides a plugin-based architecture (via stevedore) for different network backends and vNIC types, allowing Nova and other OpenStack services to manage instance networking without directly coupling to specific network implementations.

The library depends on the Oslo family of libraries (concurrency, config, logging, serialization, versioned objects) and ovsdbapp for database operations, making it a core component of OpenStack's networking infrastructure. It is maintained as part of the OpenStack project and targets modern Python versions (3.11–3.13).

Use it for:

- Attaching and detaching vNICs when provisioning or terminating OpenStack compute instances
- Supporting multiple network backend implementations (OVS, Linux bridge, etc.) through a unified plugin interface
- Managing virtual interface state and metadata in OpenStack Nova compute service
- Enabling network configuration changes on running instances without service restart

## Worth the install?

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

os-vif provides a library for managing the lifecycle of virtual network interfaces in OpenStack environments, handling attachment and detachment of vNICs to compute instances.

Yes, if you are operating or developing within OpenStack infrastructure. This is a foundational library for instance networking in OpenStack and is required by Nova. For non-OpenStack use cases, it has no relevance. No known security vulnerabilities as of the query date.

## Install

pip install os-vif
uv add os-vif
poetry add os-vif

## Installing os-vif

Before you install: Low install friction with a pure-Python wheel distribution. Active maintenance status with a release 44 days ago. Depends on 12 Oslo and OpenStack ecosystem libraries, all standard components in OpenStack deployments.

License in practice: Licensed under Apache License 2.0 (permissive), allowing commercial and private use with minimal restrictions beyond attribution and liability disclaimers.

Quickstart:

pip install os-vif

from os_vif import objects
from os_vif import plugin

# Typically used by OpenStack Nova to manage vNIC lifecycle
plugin.register()

Requires Python 3.11 or later; intended for use within OpenStack infrastructure, not standalone applications.

Verify before relying:

- Whether this library is required only for OpenStack operator/administrator use or also for application developers building on OpenStack
- Specific version compatibility guarantees with different OpenStack release series

## Package facts

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

## Tags

openstack virtual interface management, vnic attachment openstack, network interface plugging, openstack vif library, virtual interface lifecycle, openstack networking vif, compute instance interface management, openstack, networking, infrastructure

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