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.2.5

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.2.5
File Size Uploaded Provenance Actions
vppcfg-1.2.5.tar.gz 55.1 kB Without provenance Details for vppcfg-1.2.5.tar.gz

Built distribution (wheel)

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

Total release size: 136.2 kB

Release files / vppcfg-1.2.5.tar.gz

Download URL vppcfg-1.2.5.tar.gz
Size 55.1 kB
Tags Source
SHA-256 checksum
How to use checksums
ab14f19ca2e673f65308712fa7fcb3795b98655509c3e1c1a87ee6111c76a511
BLAKE2b-256 checksum
How to use checksums
f7e1d0fb692a29c1c45f855065a39d6b325f3bace99ebe9c72d5165ac034d2fc
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.2.5-py3-none-any.whl

Download URL vppcfg-1.2.5-py3-none-any.whl
Size 81.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ca733b6e800353f239b3975348fca2fe242fab935f56dd42f6dd344d4328cdbb
BLAKE2b-256 checksum
How to use checksums
4998ce8368b6265684b88d746df97b8970b2e79e9a15792b31ebb845c8aa2427
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.2.5

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