Vector Packet Processor

https://s3-docs.fd.io/vpp/24.06
Admin
FD.io's Vector Packet Processor (VPP) is a fast, scalable, multi-platform layer 2-4 network stack...
Tokens:1,989,169
Snippets:9,416
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### VPP Getting Started

Source: https://s3-docs.fd.io/vpp/24.06/developer/build-run-debug/testing_vpp

Guides for new users to get started with VPP, including installation, running VPP, tutorials, and troubleshooting common issues.

```APIDOC
Getting started:
  - Downloading and Installing VPP: Procedures for obtaining and installing VPP.
  - Running VPP: Initial steps to launch and operate VPP.
  - Progressive VPP Tutorial: A step-by-step guide to learning VPP.
  - Troubleshooting: Common problems and solutions for VPP users.
```

--------------------------------

### VPP Getting Started

Source: https://s3-docs.fd.io/vpp/24.06/contributing/reportingissues/index

Guides for new users of VPP, covering essential steps like downloading, installation, running VPP, progressive tutorials, and troubleshooting common issues.

```APIDOC
Getting started:
  - Downloading and Installing VPP: https://s3-docs.fd.io/vpp/24.06/gettingstarted/installing/index.html
  - Running VPP: https://s3-docs.fd.io/vpp/24.06/gettingstarted/running/index.html
  - Progressive VPP Tutorial: https://s3-docs.fd.io/vpp/24.06/gettingstarted/progressivevpp/index.html
  - Troubleshooting: https://s3-docs.fd.io/vpp/24.06/gettingstarted/troubleshooting/index.html
```

--------------------------------

### VPP Debug CLI Getting Started

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v24.06

Guide to getting started with the VPP debug Command Line Interface (CLI). This section covers initial setup and basic usage for debugging and managing VPP instances.

```APIDOC
Debug CLI Getting Started:
  Introduction to the VPP debug CLI.
  Covers initial setup and basic commands for VPP management.
  Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
```

--------------------------------

### VPP Configuration Getting Started

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v24.06

Guide to getting started with VPP configuration. This section explains how to set up and manage VPP's configuration files for various operational needs.

```APIDOC
Configuration Getting Started:
  Introduction to VPP configuration.
  Covers initial setup and basic configuration file management.
  Reference: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
```

--------------------------------

### VPP Debug CLI Getting Started

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v24.02

Guide to getting started with the VPP debug Command Line Interface (CLI). This section explains basic usage, commands, and how to navigate the CLI environment.

```APIDOC
CLI Reference:
  Topic: Getting Started with the debug CLI
  Purpose: Introduction to VPP's interactive command-line tool
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
```

--------------------------------

### VPP Command Line Configuration Example

Source: https://s3-docs.fd.io/vpp/24.06/_sources/configuration/config_getting_started.rst

Demonstrates how to start VPP with configuration data passed directly via the command line, specifying the 'unix' section with interactive and CLI listen parameters.

```console
$ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
```

--------------------------------

### VPP Configuration Guides

Source: https://s3-docs.fd.io/vpp/24.06/cli-reference/clis/clicmd_src_vnet_session

Guides for getting started with VPP configuration and a comprehensive configuration reference.

```APIDOC
Configuration Guides:

Getting started with the configuration
  - Introduces the basics of VPP configuration.

Configuration Reference
  - Detailed reference for all VPP configuration options.
```

--------------------------------

### VPP Startup Configuration File Example

Source: https://s3-docs.fd.io/vpp/24.06/_sources/configuration/config_getting_started.rst

Presents a typical startup.conf file content for VPP, including sections for 'unix', 'api-trace', and 'dpdk' with common parameters.

```console
$ cat /etc/vpp/startup.conf
unix {
  nodaemon
  log /var/log/vpp/vpp.log
  full-coredump
  cli-listen localhost:5002
}

api-trace {
  on
}

dpdk {
  dev 0000:03:00.0
}
```

--------------------------------

### VPP Configuration Guide

Source: https://s3-docs.fd.io/vpp/24.06/developer/plugins/srv6/as_plugin_doc

Documentation on configuring VPP, including getting started with configuration files and a comprehensive reference.

```APIDOC
VPP Configuration:

- Getting started with the configuration: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
- Configuration Reference: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Configuration Getting Started

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v24.02

An introductory guide to VPP's configuration system. It explains how to set up and manage VPP configurations for various network scenarios.

```APIDOC
Configuration Documentation:
  Topic: Getting started with the configuration
  Purpose: Guide to VPP configuration files and setup
  Link: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
```

--------------------------------

### VPP Configuration Guides

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v23.02

Information on configuring VPP, including guides for getting started with configuration files and a detailed reference of configuration options.

```APIDOC
VPP Configuration:
  Getting Started:
    URL: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
    Description: A guide to help users begin configuring VPP, covering essential concepts and initial setup.
  Configuration Reference:
    URL: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
    Description: A comprehensive reference detailing all available configuration parameters and options for VPP.
```

--------------------------------

### VPP Configuration Guide

Source: https://s3-docs.fd.io/vpp/24.06/gettingstarted/progressivevpp/routing

Information on configuring VPP, including getting started with configuration files and a detailed reference.

```APIDOC
Getting started with the configuration:
  Description: Basic steps and examples for setting up VPP configuration.
  Link: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html

Configuration Reference:
  Description: Detailed documentation of VPP configuration parameters and options.
  Link: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Startup Command with Configuration File

Source: https://s3-docs.fd.io/vpp/24.06/_sources/configuration/config_getting_started.rst

Illustrates the command to start VPP and instruct it to load a specific startup configuration file using the '-c' option.

```console
$ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
```

--------------------------------

### VPP Configuration Guides

Source: https://s3-docs.fd.io/vpp/24.06/cli-reference/index

Links to essential documentation for getting started with VPP configuration and a comprehensive reference for configuration options. These guides are crucial for setting up and managing VPP deployments.

```APIDOC
VPP Configuration Documentation:

This section provides access to VPP configuration resources, including introductory guides and detailed reference materials.

1. Getting Started with Configuration:
   - Description: A guide to help users begin configuring VPP, covering initial setup and basic principles.
   - Content: Typically includes information on configuration file formats, essential parameters, and common starting points.

2. Configuration Reference:
   - Description: A comprehensive reference detailing all available configuration options, parameters, and their behaviors.
   - Content: Covers advanced settings, module-specific configurations, and detailed explanations of configuration directives.

Example Configuration Snippet (Conceptual):

# Example VPP configuration file snippet

setup {
  # Network interface configuration
  ･･･
}

plugins {
  # Plugin loading configuration
  ･･･
}

# Specific feature configuration
feature_name {
  parameter_a = value_a
  parameter_b = value_b
}

Related Configuration Topics:
  - Interface configuration
  - Feature enabling/disabling
  - Performance tuning parameters
```

--------------------------------

### VPP Configuration

Source: https://s3-docs.fd.io/vpp/24.06/developer/corearchitecture/multi_thread

Documentation on VPP configuration, including getting started guides and a full configuration reference.

```APIDOC
Configuration - Getting Started:
  Description: Guide to getting started with VPP configuration.
  Link: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html

Configuration - Reference:
  Description: Detailed reference for VPP configuration options.
  Link: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Configuration Documentation

Source: https://s3-docs.fd.io/vpp/24.06/developer/plugins/srv6/ad_flow_plugin_doc

Links to documentation for VPP configuration files, covering getting started guides and a comprehensive configuration reference.

```APIDOC
Configuration Documentation Links:
- Getting started with the configuration: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
- Configuration Reference: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Configuration File Guide

Source: https://s3-docs.fd.io/vpp/24.06/developer/corearchitecture/buildsystem/cmakeandninja

Details the process of configuring VPP, including getting started with configuration files and a comprehensive reference for all configuration options.

```APIDOC
VPP Configuration:

- Getting Started: Guide to initial VPP configuration.
  - Reference: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html

- Configuration Reference: Detailed documentation of all configuration parameters and their usage.
  - Reference: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Configuration Documentation Links

Source: https://s3-docs.fd.io/vpp/24.06/cli-reference/clis/clicmd_src_vlib

Links to VPP configuration guides, including getting started information and a comprehensive configuration reference.

```APIDOC
Getting started with the configuration: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
Configuration Reference: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html

```

--------------------------------

### VPP Configuration File Guide

Source: https://s3-docs.fd.io/vpp/24.06/interfacing/cpp/index

Guidance on using VPP's configuration files. This includes getting started with configuration and a detailed reference for configuration options.

```APIDOC
VPP Configuration:
  Defines how VPP is initialized and configured at startup.
  Covers parameters for interfaces, plugins, and system settings.
  Refer to 'configuration/config_getting_started.html' and 'configuration/reference.html' for details.
```

--------------------------------

### VPP GDB Command Line Configuration

Source: https://s3-docs.fd.io/vpp/24.06/_sources/configuration/config_getting_started.rst

Shows a simplified command to start VPP within a GDB session, focusing on the 'unix' section for interactive mode.

```console
(gdb) run unix interactive
```

--------------------------------

### VPP Configuration Documentation

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v23.10

Information on configuring VPP, with guides on getting started with configuration files and a comprehensive configuration reference.

```markdown
https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Debug CLI Reference

Source: https://s3-docs.fd.io/vpp/24.06/gettingstarted/progressivevpp/routing

Guides for using the VPP debug Command Line Interface (CLI), including getting started and specific command references.

```APIDOC
Getting Started with the debug CLI:
  Description: Introduction to using the VPP debug CLI for monitoring and control.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html

Interface Commands:
  Description: Reference for CLI commands related to network interfaces.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html

CLI Reference:
  Description: Comprehensive reference for all VPP debug CLI commands.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/index.html
```

--------------------------------

### Start Loopback Application

Source: https://s3-docs.fd.io/vpp/24.06/_sources/interfacing/libmemif/examples_doc.rst

Command to execute the loopback example application. This application establishes two memif connections to demonstrate zero-copy packet forwarding and looping.

```shell
./examples/loopback
```

--------------------------------

### VPP Debug CLI Documentation

Source: https://s3-docs.fd.io/vpp/24.06/aboutvpp/releasenotes/v23.10

Guides for using the VPP debug Command Line Interface (CLI), including getting started instructions and references for interface commands.

```markdown
https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html
```

--------------------------------

### Check and Install VPP Dependencies

Source: https://s3-docs.fd.io/vpp/24.06/developer/build-run-debug/building

This section details how to prepare the build environment by ensuring no conflicting VPP or DPDK packages are installed. It then guides on installing the 'make' utility if it's missing and proceeds to install VPP's required dependencies using the 'make' command.

```shell
$ dpkg -l | grep vpp
$ dpkg -l | grep dpdk
$ sudo apt update
$ sudo apt install make
$ make install-dep
```

--------------------------------

### Install Mandatory VPP Packages

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/installing/ubuntu.rst

Installs the core VPP package along with essential plugins for its operation, ensuring the fundamental components are in place.

```console
sudo apt-get update
sudo apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
```

--------------------------------

### Update OS and Install Curl

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/installing/ubuntu.rst

Updates the Ubuntu operating system by fetching the latest package lists, upgrading installed packages, and installing the 'curl' utility required for downloading setup scripts.

```console
sudo apt-get update
sudo apt-get dist-upgrade -y
sudo apt-get install curl
```

--------------------------------

### Start ICMP Responder Application

Source: https://s3-docs.fd.io/vpp/24.06/_sources/interfacing/libmemif/examples_doc.rst

Command to launch the ICMP Responder example application, which acts as a memif slave. It connects to the VPP master and replies to ICMPv4 packets.

```shell
./examples/icmp_responder
```

--------------------------------

### Install Optional VPP Packages

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/installing/ubuntu.rst

Installs additional packages that provide debugging symbols, development headers, and Python API bindings for VPP.

```console
sudo apt-get install vpp-api-python python3-vpp-api vpp-dbg vpp-dev
```

--------------------------------

### Project Setup

Source: https://s3-docs.fd.io/vpp/24.06/interfacing/go/index

Steps to set up the Go project directory and add the govpp dependency.

```shell
cd"$HOME/myproject"
go
```

--------------------------------

### Create Vagrant Directory

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/settingupenvironment.rst

Commands to create a new directory for Vagrant projects and navigate into it. This is the initial step for setting up the VPP tutorial environment.

```console
$ mkdir vpp-tutorial
$ cd vpp-tutorial
```

--------------------------------

### VPP startup.conf Configuration Example

Source: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started

Provides a sample VPP startup configuration file (startup.conf). This file specifies VPP settings like logging, core dumps, CLI listening, API tracing, and DPDK device configuration. The file content mirrors command-line arguments.

```configuration
$ catunix {
  nodaemon
  log /var/log/vpp/vpp.log
  full-coredump
  cli-listen localhost:5002
}

api-trace {
  on
}

dpdk {
  dev 0000:03:00.0
}


```

--------------------------------

### VPP Startup File Example 2

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/settingupenvironment.rst

Content for the second VPP startup configuration file (startup2.conf). Similar to the first, it disables DPDK and configures unique API segment prefix and CLI socket for a second VPP instance.

```console
unix {
  cli-listen /run/vpp/cli-vpp2.sock
}
api-segment { prefix vpp2 }
plugins { plugin dpdk_plugin.so { disable } }
```

--------------------------------

### VPP Configuration

Source: https://s3-docs.fd.io/vpp/24.06/interfacing/binapi/index

Documentation on how to configure VPP, including getting started guides and a detailed reference for configuration parameters.

```APIDOC
Configuration Getting Started:
  - Introduces the basics of VPP configuration files.
  - Explains how to set up initial VPP parameters.

Configuration Reference:
  - Detailed listing of all configurable parameters.
  - Describes the syntax, options, and effects of each configuration setting.
```

--------------------------------

### Quickstart: Configure and Create AF_XDP Interface

Source: https://s3-docs.fd.io/vpp/24.06/developer/devicedrivers/af_xdp

A sequence of commands to bring up a Linux interface, enable promiscuous mode, and then create a VPP AF_XDP interface associated with it. It also includes steps for setting an IP address, bringing the interface up, and testing connectivity.

```shell
~# ip l set dev enp216s0f0 promisc on up
~# vppctl create int af_xdp host-if enp216s0f0 num-rx-queues all
~# vppctl set int ip addr enp216s0f0/0 1.1.1.1/24
~# vppctl set int st enp216s0f0/0 up
~# vppctl ping 1.1.1.100
```

--------------------------------

### VPP Configuration

Source: https://s3-docs.fd.io/vpp/24.06/developer/plugins/dhcp6_pd

Information on how to configure the Vector Packet Processor (VPP), including getting started guides and a detailed reference for configuration parameters.

```APIDOC
Configuration Getting Started:
  Description: An introductory guide to setting up and configuring VPP for various use cases.
  Reference: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html

Configuration Reference:
  Description: A detailed listing and explanation of all configuration options available in VPP, covering parameters for features, plugins, and system settings.
  Reference: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### VPP Startup File Example 1

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/settingupenvironment.rst

Content for the first VPP startup configuration file (startup1.conf). It disables the DPDK plugin and sets a specific API segment prefix and CLI socket for the VPP instance.

```console
unix {
  cli-listen /run/vpp/cli-vpp1.sock
}
api-segment { prefix vpp1 }
plugins { plugin dpdk_plugin.so { disable } }
```

--------------------------------

### VPP Configuration Utility Example Run

Source: https://s3-docs.fd.io/vpp/24.06/_sources/developer/extras/vpp_config.rst

Demonstrates an interactive session with the VPP configuration utility, showing system information retrieval and the main menu for configuration tasks.

```console
# pip install vpp-config
# vpp-config

Welcome to the VPP system configuration utility

These are the files we will modify:

/etc/vpp/startup.conf
/etc/sysctl.d/80-vpp.conf
/etc/default/grub

Before we change them, we'll create working copies in ``/usr/local/vpp/vpp-config/dryrun``
Please inspect them carefully before applying the actual configuration (option 3)!

What would you like to do?

1) Show basic system information
2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
        and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
3) Full configuration (WARNING: This will change the system configuration)
4) Install/Uninstall VPP.
5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
6) Install QEMU patch (Needed when running openstack).
9 or q) Quit

Command: 1

NODE: DUT1

CPU:
              Model name:    Intel(R) Xeon(R) CPU E5-2667 v3 @ 3.20GHz
                  CPU(s):    32
      Thread(s) per core:    2
      Core(s) per socket:    8
              Socket(s):    2
      NUMA node0 CPU(s):    0-7,16-23
      NUMA node1 CPU(s):    8-15,24-31
            CPU max MHz:    3600.0000
            CPU min MHz:    1200.0000
                    SMT:    Enabled

VPP Threads: (Name:Cpu Number)

Grub Command Line:
  Current: BOOT_IMAGE=/boot/vmlinuz-4.4.0-96-generic root=UUID=d760b82f-f37b-47e2-9815-db8d479a3557 ro
  Configured: GRUB_CMDLINE_LINUX_DEFAULT=""

Huge Pages:
  Total System Memory           : 65863484 kB
  Total Free Memory             : 41325924 kB
  Actual Huge Page Total        : 8192
  Configured Huge Page Total    : 1024
  Huge Pages Free               : 8192
  Huge Page Size                : 2048 kB

Devices:

Status:
  Not Installed

What would you like to do?

1) Show basic system information
2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
        and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
3) Full configuration (WARNING: This will change the system configuration)
4) Install/Uninstall VPP.

```

--------------------------------

### VPP Configuration Guide

Source: https://s3-docs.fd.io/vpp/24.06/contributing/reportingissues/index

Information on how to configure VPP, including getting started with the configuration file and understanding its structure and options.

```APIDOC
Configuration file:
  - Getting started with the configuration: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
```

--------------------------------

### Build and Run VPP with Sample Plugin

Source: https://s3-docs.fd.io/vpp/24.06/_sources/developer/plugindoc/sample_plugin_doc.rst

Instructions for building VPP with the sample plugin enabled and running VPP to load the plugin. This involves setting an environment variable and executing make commands.

```shell
$ make wipe
$ SAMPLE_PLUGIN=yes make build
```

```shell
$ export SAMPLE_PLUGIN=yes
$ make build
```

```shell
$ make run
```

--------------------------------

### Build and Launch

Source: https://s3-docs.fd.io/vpp/24.06/interfacing/go/index

Steps to build and launch the Go application after setting up the project.

```shell
cd"$HOME/myproject"
go
```

--------------------------------

### VPP Startup Command Example

Source: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started

Illustrates a basic VPP startup command, often used with the '-c' option to specify a configuration file. The command itself is typically executed with administrative privileges.

```bash
$ sudo

```

--------------------------------

### VPP Debug CLI Reference

Source: https://s3-docs.fd.io/vpp/24.06/developer/plugins/srv6/as_plugin_doc

Guides and references for using the VPP debug Command Line Interface (CLI), including getting started and specific command categories.

```APIDOC
VPP Debug CLI:

- Getting Started with the debug CLI: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
- Interface Commands: https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html
- Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/index.html
```

--------------------------------

### VPP Debug CLI Reference

Source: https://s3-docs.fd.io/vpp/24.06/developer/plugins/srv6/ad_flow_plugin_doc

Provides links to documentation for the VPP debug Command Line Interface (CLI), including getting started guides and specific command references.

```APIDOC
Debug CLI Documentation Links:
- Getting Started with the debug CLI: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
- Interface Commands: https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html
- Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/index.html
```

--------------------------------

### Boot and SSH into Vagrant VM

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/settingupenvironment.rst

Commands to start the Vagrant virtual machine and connect to it via SSH. It also includes steps for updating the VM and rebooting.

```console
$ vagrant up
$ vagrant ssh
$ sudo bash
# apt-get update
# reboot -n
$ # Wait for the VM to reboot
$ vagrant ssh
```

--------------------------------

### VPP Debug CLI Commands

Source: https://s3-docs.fd.io/vpp/24.06/developer/plugins/srv6/ad_plugin_doc

Documentation and guides for using the VPP debug Command Line Interface (CLI). This section covers getting started, interface-specific commands, and general reference.

```CLI
Getting Started with the debug CLI:
  Provides an introduction to the VPP debug CLI, its usage, and basic commands.
  Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html

Interface Commands:
  Details specific CLI commands for managing and inspecting network interfaces within VPP.
  Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html

CLI Reference:
  A comprehensive reference for all available VPP debug CLI commands.
  Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/index.html
```

--------------------------------

### Install and Initialize LXD

Source: https://s3-docs.fd.io/vpp/24.06/_sources/usecases/container_test.rst

Installs the LXD snap package and initializes the LXD daemon. 'lxd init' prompts for configuration, with defaults generally recommended except for the storage pool.

```bash
# snap install lxd
# lxd init
```

--------------------------------

### Start VPP Testbench Containers

Source: https://s3-docs.fd.io/vpp/24.06/_sources/usecases/vpp_testbench/labs/intro_to_vpp/index.rst

Launches the VPP testbench client and server containers using the 'make start' command. This involves creating necessary Docker networks and running the containers, which then execute entrypoint scripts to set up links.

```shell
vagrant@ubuntu-focal$> make start
# Create Docker bridge network.
bash -c " . vpp_testbench_helpers.sh; host_only_create_docker_networks; "
6e071e533e239380b2fe92d6e0844c42736ec186226fbb20d89706f9a80f935f
# Launch the containers.
bash -c " . vpp_testbench_helpers.sh; host_only_run_testbench_client_container
vpp-testbench-client:local; host_only_run_testbench_server_container
vpp-testbench-server:local; "
720fed0a94fd715694d73a41317f05a3f36860a6d5ae54db2d7cb7f2dcaf7924
ccf166993d09e399f7b10d372c47cc9e72ce6092ef70ea206c699263da844e1b
# Entrypoint scripts will bring up the various links.
# Use "docker ps" to check status of containers, see if their health
# probes are working as expected (i.e. "health"), etc.
```

--------------------------------

### VPP Startup Configuration Example

Source: https://s3-docs.fd.io/vpp/24.06/usecases/contiv/VPP_CONFIG

An example of a VPP startup configuration file (`/etc/vpp/contiv-vswitch.conf`). It includes settings for the VPP Unix socket, NAT, DPDK device binding using a PCI address, and API trace settings.

```configuration
unix {
    nodaemon
    cli-listen /run/vpp/cli.sock
    cli-no-pager
    coredump-size unlimited
    full-coredump
    poll-sleep-usec 100
}
nat {
    endpoint-dependent
}
dpdk {
    dev 0000:00:03.0
}
api-trace {
   on
   nitems 500
}
```

--------------------------------

### Configure Kubelet Feature Gates

Source: https://s3-docs.fd.io/vpp/24.06/_sources/usecases/contiv/MANUAL_INSTALL.rst

Example of setting environment variables for Kubelet, specifically disabling the HugePages feature gate. This is part of the initial environment setup.

```bash
Environment="KUBELET_EXTRA_ARGS=--feature-gates HugePages=false"
```

--------------------------------

### Run VPP Loopback Example

Source: https://s3-docs.fd.io/vpp/24.06/interfacing/libmemif/examples_doc

Executes the VPP loopback example application from the command line. This is the primary step to test the loopback functionality.

```shell
./examples/loopback
```

--------------------------------

### VPP Debug CLI Reference

Source: https://s3-docs.fd.io/vpp/24.06/gettingstarted/troubleshooting/mem

Documentation for the VPP Debug Command Line Interface (CLI), including getting started guides and specific command categories like interface commands.

```APIDOC
Debug CLI Reference:
  - Getting Started with the debug CLI: Introduces the VPP CLI and its basic usage.
  - Interface Commands: Details commands related to network interfaces, their configuration, and status.
  - General Reference: Comprehensive listing and description of all available CLI commands.
```

--------------------------------

### Start VPP Instance with Configuration

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/runningvpp.rst

Demonstrates launching a VPP instance using a specified startup configuration file. It shows the typical output during initialization and suggests adding 'nodaemon' for enhanced debugging information.

```console
$ sudo /usr/bin/vpp -c startup1.conf
vlib_plugin_early_init:361: plugin path /usr/lib/vpp_plugins:/usr/lib/vpp_plugins
load_one_plugin:189: Loaded plugin: abf_plugin.so (ACL based Forwarding)
load_one_plugin:189: Loaded plugin: acl_plugin.so (Access Control Lists)
load_one_plugin:189: Loaded plugin: avf_plugin.so (Intel Adaptive Virtual Function (AVF) Device Plugin)
.........
$
```

--------------------------------

### Install VPP Packages via APT

Source: https://s3-docs.fd.io/vpp/24.06/gettingstarted/progressivevpp/settingupenvironment

Steps to install VPP packages by configuring the APT sources list. This involves adding the fd.io release repository, fetching the GPG key, and then installing the VPP packages using apt-get.

```shell
$ sudo sh -c 'echo "deb https://packagecloud.io/fdio/release/ubuntu jammy main" > /etc/apt/sources.list.d/99fd.io.list'

# Get the key.
$ curl -fsSL https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -

# Then execute the following commands.
$ sudo apt-get update
$ sudo apt-get install -y vpp vpp-plugins vpp-api-python
```

--------------------------------

### Add VPP Repository and Install

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/settingupenvironment.rst

Shell commands to add the FD.io VPP package repository to the Ubuntu system and install VPP packages. This involves writing to a sources.list file, fetching the GPG key, and updating the package list.

```console
$ sudo bash
# echo "deb https://packagecloud.io/fdio/release/ubuntu jammy main" > /etc/apt/sources.list.d/99fd.io.list
# 
# curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
# 
# apt-get update
# apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
# 
# service vpp stop
```

--------------------------------

### VPP Debug CLI Reference

Source: https://s3-docs.fd.io/vpp/24.06/contributing/reportingissues/index

Guides and references for using the VPP debug Command Line Interface (CLI). This section covers getting started, specific command categories like interface commands, and a general reference.

```APIDOC
Debug CLI:
  - Getting Started with the debug CLI: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
  - Interface Commands: https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html
  - Reference: https://s3-docs.fd.io/vpp/24.06/cli-reference/index.html
```

--------------------------------

### VPP Debug CLI Commands

Source: https://s3-docs.fd.io/vpp/24.06/cli-reference/clis/clicmd_src_vlib_unix_cli_c

Reference and guides for using the VPP debug Command Line Interface (CLI). This section covers getting started, specific command categories like interface commands, and detailed command syntax.

```APIDOC
Getting Started with the debug CLI:
  Description: An introduction to using the VPP debug CLI, including basic operations and setup.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/gettingstarted/index.html
```

```APIDOC
Interface Commands:
  Description: Documentation for CLI commands related to managing and inspecting network interfaces within VPP.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/interface/index.html
```

```APIDOC
ARP and Loopback CLI Commands:
  Description: Specific CLI commands for configuring and managing ARP and loopback interfaces in VPP.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/clis/clicmd_src_vnet_ethernet.html
```

```APIDOC
Circular Journal CLI Commands:
  Description: Details on CLI commands for managing the circular journal, a logging mechanism in VPP.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/clis/clicmd_extras_deprecated_vlib_unix_cj_c.html
```

```APIDOC
VPP Core CLI Commands:
  Description: Documentation for fundamental VPP CLI commands, including 'define' and 'echo', used for system interaction and debugging.
  Link: https://s3-docs.fd.io/vpp/24.06/cli-reference/clis/clicmd_src_vlib_unix_cli_c.html
```

--------------------------------

### VPP Configuration

Source: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started

Information on how to configure VPP, including command-line arguments and the primary startup configuration file.

```APIDOC
VPP Configuration:
  - Getting Started: https://s3-docs.fd.io/vpp/24.06/configuration/config_getting_started.html
    - Command-line Arguments: Details on arguments used to control VPP startup behavior.
    - Configuration File (startup.conf): Explanation of the main configuration file for VPP.
  - Configuration Reference:
    - Description: Detailed reference for all configuration options available in VPP.
    - Reference: https://s3-docs.fd.io/vpp/24.06/configuration/reference.html
```

--------------------------------

### AF_XDP Interface Setup Quickstart

Source: https://s3-docs.fd.io/vpp/24.06/_sources/developer/devicedrivers/af_xdp.rst

A step-by-step guide to configure and bring up an AF_XDP interface using VPP and Linux commands. This includes setting the interface to promiscuous mode, creating the AF_XDP interface, assigning an IP address, and verifying connectivity.

```shell
~# ip l set dev enp216s0f0 promisc on up
~# vppctl create int af_xdp host-if enp216s0f0 num-rx-queues all
~# vppctl set int ip addr enp216s0f0/0 1.1.1.1/24
~# vppctl set int st enp216s0f0/0 up
~# vppctl ping 1.1.1.100
```

--------------------------------

### VPP Packet Generator Setup Script Example

Source: https://s3-docs.fd.io/vpp/24.06/developer/corearchitecture/vnet

An example of a VPP packet generator setup script. It configures an interface, creates a packet generator stream with specific packet data, rate, and size, and defines IP and UDP payload details.

```VPP CLI
loop create
set int ip address loop0 192.168.1.1/24
set int state loop0 up

packet-generator new {
    name pg0
    limit 100
    rate 1e6
    size 300-300
    interface loop0
    node ethernet-input
    data { IP4: 1.2.3 -> 4.5.6
           UDP: 192.168.1.10 - 192.168.1.254 -> 192.168.2.10
           UDP: 1234 -> 2345
           incrementing 286
    }
}
```

--------------------------------

### VPP Startup Configuration Example with nodaemon

Source: https://s3-docs.fd.io/vpp/24.06/_sources/gettingstarted/progressivevpp/runningvpp.rst

Provides an example of a VPP startup configuration file ('startup.conf'). It highlights the 'nodaemon' option within the 'unix' section, which is useful for debugging by keeping VPP in the foreground and printing more output.

```console
unix {nodaemon cli-listen /run/vpp/cli-vpp1.sock}
api-segment { prefix vpp1 }
plugins { plugin dpdk_plugin.so { disable }}
```

--------------------------------

### TRex Installation and Setup

Source: https://s3-docs.fd.io/vpp/24.06/_sources/usecases/simpleperf/trex.rst

Steps to download, extract, and navigate to the TRex installation directory. This prepares the environment for running the traffic generator.

```console
NET2S22C05$ wget --no-cache http://trex-tgn.cisco.com/trex/release/latest
NET2S22C05$ tar -xzvf latest
NET2S22C05$ cd v2.37
```

--------------------------------

### Install VPP Prerequisites and Configure

Source: https://s3-docs.fd.io/vpp/24.06/usecases/containers/containerSetup

This snippet shows commands to set up DHCP, install VPP packages using apt-get, and configure VPP startup settings by appending to the startup.conf file. It assumes a Debian-based container environment.

```shell
root@cone:/# dhclient
root@cone:/# apt-get install curl
root@cone:/# apt-get update
root@cone:/# apt-get install vpp
root@cone:/# sh -c 'echo "\ndpdk {\n   no-pci\n}" >> /etc/vpp/startup.conf'
```

--------------------------------

### Kubelet Configuration Example for Multi-Homed Nodes

Source: https://s3-docs.fd.io/vpp/24.06/usecases/contiv/CUSTOM_MGMT_NETWORK

Provides concrete examples of the Kubelet configuration for two different nodes in a multi-node deployment. Each example specifies the management IP address to be used for Kubernetes traffic, assuming a specific network setup.

```shell
Environment="KUBELET_EXTRA_ARGS=--fail-swap-on=false --node-ip=192.168.56.105"
```

```shell
Environment="KUBELET_EXTRA_ARGS=--fail-swap-on=false --node-ip=192.168.56.106"
```

--------------------------------

### Start VPP Service

Source: https://s3-docs.fd.io/vpp/24.06/usecases/containers/containerSetup

This command is used to start the VPP service within the container. The exact service name or command might vary depending on the VPP installation method.

```shell
root@cone:/# service vpp start
```

--------------------------------

### VPP Routing Tutorial: Setup Return Route on VPP2

Source: https://s3-docs.fd.io/vpp/24.06/gettingstarted/progressivevpp/routing

Illustrates how to configure a return route on a VPP instance (vpp2) to direct traffic back to the host network.

```bash
$ sudo vpp# ip route add 10.10.1.0/24  via 10.10.2.1
```

--------------------------------

### Install hs-test Dependencies

Source: https://s3-docs.fd.io/vpp/24.06/_sources/developer/extras/hs_test.rst

Installs the necessary dependencies for the hs-test framework. This command should be run before starting test development or execution.

```shell
make install-deps
```

--------------------------------

### Install Keychain on Ubuntu

Source: https://s3-docs.fd.io/vpp/24.06/_sources/contributing/gitreview.rst

Installs the keychain utility on Ubuntu systems, which is often a dependency for SSH key management in Git workflows.

```console
$ sudo apt-get install keychain
```

--------------------------------

### Update OS and Install Curl

Source: https://s3-docs.fd.io/vpp/24.06/gettingstarted/installing/ubuntu

Updates the operating system to the latest versions and installs the curl package. Curl is required to download the packagecloud setup script for repository configuration.

```bash
sudo apt-get update
sudo apt-get dist-upgrade -y
sudo apt-get install curl
```

--------------------------------

### Start VPP in GDB

Source: https://s3-docs.fd.io/vpp/24.06/_sources/developer/build-run-debug/gdb_examples.rst

Demonstrates how to launch the VPP executable within a GDB session, specifying a custom startup configuration file. This is useful for debugging VPP startup issues.

```console
(gdb) run -c /etc/vpp/startup.conf
Starting program: /scratch/vpp-master/build-root/install-vpp_debug-native/vpp/bin/vpp -c /etc/vpp/startup.conf
 Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
 vlib_plugin_early_init:361: plugin path /scratch/vpp-master/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins:/scratch/vpp-master/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins
 ....
```

--------------------------------

### Launching VPP Testbench Containers

Source: https://s3-docs.fd.io/vpp/24.06/usecases/vpp_testbench/labs/intro_to_vpp/index

Commands to create Docker networks and launch the VPP test bench client and server containers. It includes executing helper scripts and shows example output hashes for container IDs.

```shell
vagrant@ubuntu-focal$> # Create Docker bridge network.
bash" . vpp_testbench_helpers.sh; host_only_create_docker_networks; "
6e071e533e239380b2fe92d6e0844c42736ec186226fbb20d89706f9a80f935f
# Launch the containers.
bash" . vpp_testbench_helpers.sh; host_only_run_testbench_client_container
vpp-testbench-client:local; host_only_run_testbench_server_container
vpp-testbench-server:local; "
720fed0a94fd715694d73a41317f05a3f36860a6d5ae54db2d7cb7f2dcaf7924
ccf166993d09e399f7b10d372c47cc9e72ce6092ef70ea206c699263da844e1b
# Entrypoint scripts will bring up the various links.
# Use "docker ps" to check status of containers, see if their health
# probes are working as expected (i.e. "health"), etc.
```

--------------------------------

### VPP Interactive Command Example

Source: https://s3-docs.fd.io/vpp/24.06/developer/extras/vpp_config

Demonstrates an interactive menu for VPP operations, including installation, dry runs, and quitting the interface. The example shows selecting option 'q' to quit.

```shell
4) Install/Uninstall VPP.
5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
6) Install QEMU patch (Needed when running openstack).
9 or q) Quit

Command: q
#
```
Tokens:
Raw