Skip to main content

A VPP Configuration Utility

This tool reads a configuration file, checks it for syntax and semantic correctness, and then reconciles a running VPP daemon with its configuration. It is meant to be re-entrant and stateless. The tool connects to the VPP API and creates/removes all of the configuration in a minimally intrusive way.

You can simply install this package from [PyPi]:

$ pip install [--break-system-packages] vppcfg

vppcfg uses the VPP Python API bindings (vpp_papi), which are provided by the python3-vpp-api Debian package that ships with VPP. That copy matches the API of the running dataplane, so it is a prerequisite and is deliberately not pulled in from PyPI (the PyPI copy lags many releases behind and, installed into /usr/local, shadows the deb and breaks API parsing). If you previously installed vpp_papi from PyPI, remove it so the Debian package is used:

$ pip uninstall [--break-system-packages] vpp_papi

Running

usage: vppcfg [-h] [-d] [-q] [-f] {check,dump,plan,apply} ...

positional arguments:
  {check,dump,plan,apply}
    check               check given YAML config for validity (no VPP)
    dump                dump current running VPP configuration (VPP readonly)
    plan                plan changes from current VPP dataplane to target config (VPP readonly)
    apply               apply changes from current VPP dataplane to target config

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           enable debug logging, default False
  -q, --quiet           be quiet (only warnings/errors), default False
  -f, --force           force progress despite warnings, default False

Please see vppcfg <command> -h   for per-command arguments

Documentation

Main user-focused documentation:

Developer deep-dives:

Licensing

The code in this project is released under Apache 2.0 license. A copy of the license is provided in this repo here. All contributions are held against our contributing guidelines. Notably, all code must be licensed Apache 2.0, and all contributions must come with a certificate of origin in the form of a Signed-off-by field in the commit.

All documentation under the docs/ directory is licensed Creative Commons Attribution 4.0 International License (details). A copy of the license is provided in this repo here.

Metadata

Release files for vppcfg 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vppcfg 1.3.1
File Size Uploaded Provenance Actions
vppcfg-1.3.1.tar.gz 74.2 kB Without provenance Details for vppcfg-1.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vppcfg 1.3.1
File Interpreter ABI Platform Actions
vppcfg-1.3.1-py3-none-any.whl Python 3 none any Details for vppcfg-1.3.1-py3-none-any.whl

Total release size: 180.8 kB

Release files / vppcfg-1.3.1.tar.gz

Download URL vppcfg-1.3.1.tar.gz
Size 74.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ea87a653d855be0146785827167eb2aaeb507d95d692ef946e5cf5e698a9d008
BLAKE2b-256 checksum
How to use checksums
b1abbd1fed7b768ae5ca431fc95fd57b5a8c90abc074930a78eb49b1ae2bbb42
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Release files / vppcfg-1.3.1-py3-none-any.whl

Download URL vppcfg-1.3.1-py3-none-any.whl
Size 106.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c715883db4c4538df5dbf6ac676256aa25c1c468384e684ebd000bac86afb0d9
BLAKE2b-256 checksum
How to use checksums
1ea2b18eca4628b7667b8dbb0963827bf8a915ecbe743c78e55145dfd9fcb11c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Security for vppcfg 1.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page