7 =======================================
8 VPP Configuration File - 'startup.conf'
9 =======================================
12 After a successful installation, VPP installs a startup config file named
13 *'startup.conf'* in the *'/etc/vpp/'*' directory. This file can be tailored to
14 make VPP run as desired, but contains default values for typical installations.
15 Below are more details about this file and parameter and values it contains.
20 The VPP network stack comes with several configuration options that can be
21 provided either on the command line when VPP is started, or in a configuration
22 file. Specific applications built on the stack have been known to require a dozen
23 arguments, depending on requirements.
25 Command-line Arguments
26 ----------------------
28 Parameters are grouped by a section name. When providing more than one
29 parameter to a section, all parameters for that section must be wrapped in
30 curly braces. For example, to start VPP with configuration data via the
31 command line with the section name *'unix'*:
33 .. code-block:: console
35 $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
37 The command line can be presented as a single string or as several; anything
38 given on the command line is concatenated with spaces into a single string
39 before parsing. VPP applications must be able to locate their own executable
40 images. The simplest way to ensure this will work is to invoke a VPP
41 application by giving its absolute path. For example:
42 *'/usr/bin/vpp <options>'* At startup, VPP applications parse through their
43 own ELF-sections [primarily] to make lists of init, configuration, and exit
46 When developing with VPP, in gdb it's often sufficient to start an application
49 .. code-block:: console
51 (gdb) run unix interactive
56 It is also possible to supply the configuration parameters in a startup
57 configuration. The path of the file is provided to the VPP application on its
58 command line. The format of the configuration file is a simple text file with
59 the same content as the command line, but with the benefit of being able to use
60 newlines to make the content easier to read. For example:
62 .. code-block:: console
64 $ cat /etc/vpp/startup.conf
67 log /var/log/vpp/vpp.log
69 cli-listen localhost:5002
80 VPP is then instructed to load this file with the -c option. For example:
82 .. code-block:: console
84 $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
86 When the VPP service is started, VPP is started with this option via another
87 installed file, vpp.service (Ubuntu: /lib/systemd/system/vpp.service and
88 CentOS: /usr/lib/systemd/system/vpp.service). See *'ExecStart'* below:
90 .. code-block:: console
92 $ cat /lib/systemd/system/vpp.service
94 Description=vector packet processing engine
99 ExecStartPre=-/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
100 ExecStartPre=-/sbin/modprobe uio_pci_generic
101 ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
102 ExecStopPost=/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
106 WantedBy=multi-user.target
109 Configuration Parameters
110 ------------------------
112 Below is the list of section names and their associated parameters. This is not
113 an exhaustive list of parameters available. The command-line argument parsers
114 can be found in the source code by searching for instances of the
115 **VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION** macro.
117 For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
118 cause the function *'foo_config'* to receive all parameters given in a
119 parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
122 List of Basic Parameters:
123 -------------------------
129 List of Advanced Parameters:
130 ----------------------------
169 Configure VPP startup and behavior type attributes, as well and any OS based
173 Attach CLI to stdin/out and provide a debugging command line interface.
176 **Example:** interactive
179 Do not fork / background the vpp process. Typical when invoking VPP
180 applications from a process monitor. Set by default in the default
181 *'startup.conf'* file.
183 **Example:** nodaemon
186 Logs the startup configuration and all subsequent CLI commands in filename.
187 Very useful in situations where folks don't remember or can't be bothered
188 to include CLI commands in bug reports. The default *'startup.conf'* file
189 is to write to *'/var/log/vpp/vpp.log'*.
191 In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
192 to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
193 However, if SELinux is enabled, then the new location is required for the file
194 to be properly labeled. Check your local *'startup.conf'* file for the log file
195 location on your system.
197 **Example:** log /var/log/vpp/vpp-debug.log
199 * **exec|startup-config <filename>**
200 Read startup operational configuration from filename. The contents of the file
201 will be performed as though entered at the CLI. The two keywords are aliases
202 for the same function; if both are specified, only the last will have an effect.
203 The file contains CLI commands, for example:
205 | $ cat /usr/share/vpp/scripts/interface-up.txt
206 | set interface state TenGigabitEthernet1/0/0 up
207 | set interface state TenGigabitEthernet1/0/1 up
209 **Example:** startup-config /usr/share/vpp/scripts/interface-up.txt
211 * **gid number|name>**
212 Sets the effective group ID to the input group ID or group name of the calling
218 Ask the Linux kernel to dump all memory-mapped address regions, instead of
221 **Example:** full-coredump
223 * **coredump-size unlimited|<n>G|<n>M|<n>K|<n>**
224 Set the maximum size of the coredump file. The input value can be set in
225 GB, MB, KB or bytes, or set to *'unlimited'*.
227 **Example:** coredump-size unlimited
229 * **cli-listen <ipaddress:port>|<socket-path>**
230 Bind the CLI to listen at address localhost on TCP port 5002. This will
231 accept an ipaddress:port pair or a filesystem path; in the latter case a
232 local Unix socket is opened instead. The default *'startup.conf'* file
233 is to open the socket *'/run/vpp/cli.sock'*.
235 **Example:** cli-listen localhost:5002
236 **Example:** cli-listen /run/vpp/cli.sock
239 Disable character-by-character I/O on stdin. Useful when combined with,
240 for example, emacs M-x gud-gdb.
242 **Example:** cli-line-mode
244 * **cli-prompt <string>**
245 Configure the CLI prompt to be string.
247 **Example:** cli-prompt vpp-2
249 * **cli-history-limit <n>**
250 Limit commmand history to <n> lines. A value of 0 disables command history.
253 **Example:** cli-history-limit 100
256 Disable the login banner on stdin and Telnet connections.
258 **Example:** cli-no-banner
261 Disable the output pager.
263 **Example:** cli-no-pager
265 * **cli-pager-buffer-limit <n>**
266 Limit pager buffer to <n> lines of output. A value of 0 disables the
267 pager. Default value: 100000
269 **Example:** cli-pager-buffer-limit 5000
271 * **runtime-dir <dir>**
272 Set the runtime directory, which is the default location for certain
273 files, like socket files. Default is based on User ID used to start VPP.
274 Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
275 defaults to *'/run/user/<uid>/vpp/'*.
277 **Example:** runtime-dir /tmp/vpp
279 * **poll-sleep-usec <n>**
280 Add a fixed-sleep between main loop poll. Default is 0, which is not to
283 **Example:** poll-sleep-usec 100
285 * **pidfile <filename>**
286 Writes the pid of the main thread in the given filename.
288 **Example:** pidfile /run/vpp/vpp1.pid
295 Command line DPDK configuration controls a number of parameters, including
296 device whitelisting, the number of CPUs available for launching
297 dpdk-eal-controlled threads, the number of I/O buffers, and the process
298 affinity mask. In addition, the DPDK configuration function attempts to support
299 all of the DPDK EAL configuration parameters.
301 All of the DPDK EAL options should be available.
302 See ../src/plugins/dpdk/device/dpdk_priv.h, look at the set of
303 "foreach_eal_XXX" macros.
305 Popular options include:
307 White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
308 string of the form "DDDD:BB:SS.F" where:
315 This is the same format used in the linux sysfs tree (i.e.
316 /sys/bus/pci/devices) for PCI device directory names.
318 **Example:** dev 0000:02:00.0
320 * **dev <pci-dev> { .. }**
321 When whitelisting specific interfaces by specifying PCI address,
322 additional custom parameters can also be specified. Valid options include:
324 * **num-rx-queues <n>**
325 Number of receive queues. Also enables RSS. Default value is 1.
326 * **num-tx-queues <n>**
327 Number of transmit queues. Default is equal to number of worker
328 threads or 1 if no workers treads.
329 * **num-rx-desc <n>**
330 Number of descriptors in receive ring. Increasing or reducing number
331 can impact performance. Default is 1024.
332 * **num-rt-desc <n>**
333 Number of descriptors in transmit ring. Increasing or reducing number
334 can impact performance. Default is 1024.
337 * **vlan-strip-offload on|off**:
338 VLAN strip offload mode for interface. VLAN stripping is off by default
339 for all NICs except VICs, using ENIC driver, which has VLAN stripping on
342 Enable the Hierarchical Quaity-of-Service (HQoS) scheduler, default is
343 disabled. This enables HQoS on specific output interface.
345 HQoS can also have its own set of custom parameters. Setting a custom
346 parameter also enables HQoS.
348 * **hqos-thread <n>**
349 HQoS thread used by this interface. To setup a pool of threads that
350 are shared by all HQoS interfaces, set via the*'cpu'* section using
351 either *'corelist-hqos-threads'* or *'coremask-hqos-threads'*.
363 * **vdev <eal-command>**
364 Provide a DPDK EAL command to specify bonded Ethernet interfaces, operating
365 modes and PCI addresses of slave links. Only XOR balanced (mode 2) mode is
370 | vdev eth_bond0,mode=2,slave=0000:0f:00.0,slave=0000:11:00.0,xmit_policy=l34
371 | vdev eth_bond1,mode=2,slave=0000:10:00.0,slave=0000:12:00.0,xmit_policy=l34
374 Increase number of buffers allocated. May be needed in scenarios with
375 large number of interfaces and worker threads, or a lot of physical
376 interfaces with multiple RSS queues. Value is per CPU socket. Default is
379 **Example:** num-mbufs 128000
382 When VPP is started, if an interface is not owned by the linux kernel
383 (interface is administratively down), VPP will attempt to manage the
384 interface. *'no-pci'* indicates that VPP should not walk the PCI table
385 looking for interfaces.
390 Don't use huge TLB pages. Potentially useful for running simulator images.
392 **Example:** no-hugetlb
395 Number of KNI interfaces. Refer to the DPDK documentation.
399 * **uio-driver uio_pci_generic|igb_uio|vfio-pci|auto**
400 Change UIO driver used by VPP. Default is *'auto'*.
402 **Example:** uio-driver igb_uio
405 Change hugepages allocation per-socket, needed only if there is need for
406 larger number of mbufs. Default is 64 hugepages on each detected CPU
409 **Example:** socket-mem 2048,2048
411 **Other options include:**
413 * **enable-tcp-udp-checksum**
414 Enables UDP/TCP RX checksum offload.
416 **Example:** enable-tcp-udp-checksum
419 Disable mutli-segment buffers, improves performance but disables Jumbo MTU
422 **Example:** no-multi-seg
424 * **no-tx-checksum-offload**
425 Disables UDP/TCP TX checksum offload. Typically needed for use faster
426 vector PMDs (together with no-multi-seg).
428 **Example:** no-tx-checksum-offload
430 * **decimal-interface-names**
431 Format DPDK device names with decimal, as opposed to hexadecimal.
433 **Example:** decimal-interface-names
435 * **log-level emergency|alert|critical|error|warning|notice|info|debug**
436 Set the log level for DPDK logs. Default is *'notice'*.
438 **Example:** log-level error
440 * **dev default { .. }**
441 Change default settings for all intefaces. This sections supports the
442 same set of custom parameters described in *'dev <pci-dev> { .. }*'.
456 Command-line CPU configuration controls the creation of named thread types, and
457 the cpu affinity thereof. In the VPP there is one main thread and optionally
458 the user can create worker(s). The main thread and worker thread(s) can be
459 pinned to CPU core(s) automatically or manually.
461 **Automatic Pinning:**
464 Create <n> worker threads.
466 **Example:** workers 4
469 Create <n> i/o threads.
474 Handle i/o devices from thread 0, hand off traffic to worker threads.
475 Requires "workers <n>".
477 **Example:** main-thread-io
480 Sets number of CPU core(s) to be skipped (1 ... N-1). Skipped CPU core(s)
481 are not used for pinning main thread and working thread(s). The main thread
482 is automatically pinned to the first available CPU core and worker(s) are
483 pinned to next free CPU core(s) after core assigned to main threadLeave
484 the low nn bits of the process affinity mask clear.
486 **Example:** skip-cores 4
491 Assign main thread to a specific core.
493 **Example:** main-core 1
495 * **coremask-workers <hex-mask>**
496 Place worker threads according to the bitmap hex-mask.
498 **Example:** coremask-workers 0x0000000000C0000C
500 * **corelist-workers <list>**
501 Same as coremask-workers but accepts a list of cores instead of a bitmap.
503 **Example:** corelist-workers 2-3,18-19
505 * **coremask-io <hex-mask>**
506 Place I/O threads according to the bitmap hex-mask.
508 **Example:** coremask-io 0x0000000003000030
510 * **corelist-io <list>**
511 Same as coremask-io but accepts a list of cores instead of a bitmap.
513 **Example:** corelist-io 4-5,20-21
515 * **coremask-hqos-threads <hex-mask>**
516 Place HQoS threads according to the bitmap hex-mask. A HQoS thread can
517 run multiple HQoS objects each associated with different output interfaces.
519 **Example:** coremask-hqos-threads 0x000000000C0000C0
521 * **corelist-hqos-threads <list>**
522 Same as coremask-hqos-threads but accepts a list of cores instead of a
525 **Example:** corelist-hqos-threads 6-7,22-23
532 **Example:** use-pthreads
534 * **thread-prefix <prefix>**
535 Set a prefix to be prepended to each thread name. The thread name already
536 contains an underscore. If not provided, the default is *'vpp'*.
537 Currently, prefix used on threads: *'vpp_main'*, *'vpp_stats'*
539 **Example:** thread-prefix vpp1
541 * **scheduler-policy rr|fifo|batch|idle|other**
544 **Example:** scheduler-policy fifo
546 * **scheduler-priority <n>**
547 Set the scheduler priority. Only valid if the *'scheduler-policy'* is set
548 to *'fifo'* or *'rr'*. The valid ranges for the scheduler priority depends
549 on the *'scheduler-policy'* and the current kernel version running. The
550 range is typically 1 to 99, but see the linux man pages for *'sched'* for
551 more details. If this value is not set, the current linux kernel default
554 **Example:** scheduler-priority 50
556 * **<thread-name> <count>**
557 Set the number of threads for a given thread (by name). Some threads, like
558 *'stats'*, have a fixed number of threads and cannot be changed. List of
559 possible threads include (but not limited too): hqos-threads, workers
561 **Example:** hqos-threads 2
565 The "main" thread always occupies the lowest core-id specified in the
566 DPDK [process-level] coremask.
568 Here's a full-bore manual placement example:
570 .. code-block:: console
572 /usr/bin/vpp unix interactive tuntap disable cpu { main-thread-io coremask-workers 18 coremask-stats 4 } dpdk { coremask 1e }
574 # taskset -a -p <vpe-pid>
575 pid 16251's current affinity mask: 2 # main thread
576 pid 16288's current affinity mask: ffffff # DPDK interrupt thread (not bound to a core)
577 pid 16289's current affinity mask: 4 # stats thread
578 pid 16290's current affinity mask: 8 # worker thread 0
579 pid 16291's current affinity mask: 10 # worker thread 1
584 "acl-plugin" Parameters
585 _______________________
587 The following parameters should only be set by those that are familiar with the
588 interworkings of VPP and the ACL Plugin.
590 The first three parameters, *connection hash buckets*, *connection hash memory*, and *connection count max*, set the **connection table per-interface parameters** for modifying how the two bounded-index extensible hash tables for IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4 (16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions** are initialized.
592 * **connection hash buckets <n>**
593 Sets the number of hash buckets (rounded up to a power of 2) in each of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
595 **Example:** connection hash buckets 65536
597 * **connection hash memory <n>**
598 Sets the number of bytes used for “backing store” allocation in each of the two bi-hash tables. Defaults to 1073741824 bytes.
600 **Example:** connection hash memory 1073741824
602 * **connection count max <n>**
603 Sets the maximum number of pool elements when allocating each per-worker pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
605 **Example:** connection count max 500000
607 * **main heap size <n>G|<n>M|<n>K|<n>**
608 Sets the size of the main memory heap that holds all the ACL module related allocations (other than hash.) Default size is 0, but during ACL heap initialization is equal to *per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*. Note that these variables are partially based on the **connection table per-interface parameters** mentioned above.
610 **Example:** main heap size 3G
612 The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*, and *hash lookup hash memory*, modify the initialization of the bi-hash lookup table used by the ACL plugin. This table is initialized when attempting to apply an ACL to the existing vector of ACLs looked up during packet processing (but it is found that the table does not exist / has not been initialized yet.)
614 * **hash lookup heap size <n>G|<n>M|<n>K|<n>**
615 Sets the size of the memory heap that holds all the miscellaneous allocations related to hash-based lookups. Default size is 67108864 bytes.
617 **Example:** hash lookup heap size 70M
619 * **hash lookup hash buckets <n>**
620 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash lookup table. Defaults to 65536 hash buckets.
622 **Example:** hash lookup hash buckets 65536
624 * **hash lookup hash memory <n>**
625 Sets the number of bytes used for “backing store” allocation in the bi-hash lookup table. Defaults to 67108864 bytes.
627 **Example:** hash lookup hash memory 67108864
629 * **use tuple merge <n>**
630 Sets a boolean value indicating whether or not to use TupleMerge for hash ACL's. Defaults to 1 (true), meaning the default implementation of hashing ACL's **does use** TupleMerge.
632 **Example:** use tuple merge 1
634 * **tuple merge split threshold <n>**
635 Sets the maximum amount of rules (ACE's) that can collide in a bi-hash lookup table before the table is split into two new tables. Splitting ensures less rule collisions by hashing colliding rules based on their common tuple (usually their maximum common tuple.) Splitting occurs when the *length of the colliding rules vector* is greater than this threshold amount. Defaults to a maximum of 39 rule collisions per table.
637 **Example:** tuple merge split threshold 30
639 * **reclassify sessions <n>**
640 Sets a boolean value indicating whether or not to take the epoch of the session into account when dealing with re-applying ACL's or changing already applied ACL's. Defaults to 0 (false), meaning the default implementation **does NOT** take the epoch of the session into account.
642 **Example:** reclassify sessions 1
646 "api-queue" Parameters
647 ______________________
649 The following parameters should only be set by those that are familiar with the
650 interworkings of VPP.
653 Sets the api queue length. Minimum valid queue length is 1024, which is
656 **Example:** length 2048
660 "api-segment" Parameters
661 ________________________
663 These values control various aspects of the binary API interface to VPP.
666 Sets the prefix prepended to the name used for shared memory (SHM)
667 segments. The default is empty, meaning shared memory segments are created
668 directly in the SHM directory *'/dev/shm'*. It is worth noting that on
669 many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
670 system; Ubuntu links it to *'/run/shm'*.
672 **Example:** prefix /run/shm
674 * **uid <number|name>**
675 Sets the user ID or name that should be used to set the ownership of the
676 shared memory segments. Defaults to the same user that VPP is started
679 **Example:** uid root
681 * **gid <number|name>**
682 Sets the group ID or name that should be used to set the ownership of the
683 shared memory segments. Defaults to the same group that VPP is started
688 The following parameters should only be set by those that are familiar with the
689 interworkings of VPP.
692 Set the base address for SVM global region. If not set, on AArch64, the
693 code will try to determine the base address. All other default to
696 **Example:** baseva 0x20000000
698 * **global-size <n>G|<n>M|<n>**
699 Set the global memory size, memory shared across all router instances,
700 packet buffers, etc. If not set, defaults to 64M. The input value can be
701 set in GB, MB or bytes.
703 **Example:** global-size 2G
705 * **global-pvt-heap-size <n>M|size <n>**
706 Set the size of the global VM private mheap. If not set, defaults to 128k.
707 The input value can be set in MB or bytes.
709 **Example:** global-pvt-heap-size size 262144
711 * **api-pvt-heap-size <n>M|size <n>**
712 Set the size of the api private mheap. If not set, defaults to 128k.
713 The input value can be set in MB or bytes.
715 **Example:** api-pvt-heap-size 1M
717 * **api-size <n>M|<n>G|<n>**
718 Set the size of the API region. If not set, defaults to 16M. The input
719 value can be set in GB, MB or bytes.
721 **Example:** api-size 64M
725 "api-trace" Parameters
726 ______________________
728 The ability to trace, dump, and replay control-plane API traces makes all the
729 difference in the world when trying to understand what the control-plane has
730 tried to ask the forwarding-plane to do.
733 Enable API trace capture from the beginning of time, and arrange for a
734 post-mortem dump of the API trace if the application terminates abnormally.
735 By default, the (circular) trace buffer will be configured to capture
736 256K traces. The default *'startup.conf'* file has trace enabled by default,
737 and unless there is a very strong reason, it should remain enabled.
742 Configure the circular trace buffer to contain the last <n> entries. By
743 default, the trace buffer captures the last 256K API messages received.
745 **Example:** nitems 524288
747 * **save-api-table <filename>**
748 Dumps the API message table to /tmp/<filename>.
750 **Example:** save-api-table apiTrace-07-04.txt
752 Typically, one simply enables the API message trace scheme:
761 Command line Buffer configuration controls buffer management.
763 * **memory-size-in-mb <n>**
764 Configure the memory size used for buffers. If not set, VPP defaults
767 **Example:** memory-size-in-mb 64
775 The circular journal (CJ) thread-safe circular log buffer scheme is
776 occasionally useful when chasing bugs. Calls to it should not be checked in.
777 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
778 When enabled, the number of records must be provided, there is no default
782 Configure the number of circular journal records in the circular buffer.
783 The number of records should be a power of 2.
785 **Example:** records 131072
788 Turns on logging at the earliest possible moment.
797 * **max-cache-size <n>**
809 "heapsize" Parameters
810 _____________________
812 Heapsize configuration controls the size of the main heap. The heap size is
813 configured very early in the boot sequence, before loading plug-ins or doing
814 much of anything else.
816 * **heapsize <n>M|<n>G**
817 Specifies the size of the heap in MB or GB. The default is 1GB. Setting the
818 main heap size to 4GB or more requires recompilation of the entire system
819 with CLIB_VEC64 > 0. See .../clib/clib/vec_bootstrap.h.
821 **Example:** heapsize 2G
828 IPv4 heap configuration. he heap size is configured very early in the boot
829 sequence, before loading plug-ins or doing much of anything else.
831 * **heap-size <n>G|<n>M|<n>K|<n>**
832 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
833 the destination IP lookup table. The input value can be set in GB, MB, KB
834 or bytes. The default value is 32MB.
836 **Example:** heap-size 64M
843 IPv6 heap configuration. he heap size is configured very early in the boot
844 sequence, before loading plug-ins or doing much of anything else.
847 * **heap-size <n>G|<n>M|<n>K|<n>**
848 Set the IPv6 forwarding table heap size. The input value can be set in GB,
849 MB, KB or bytes. The default value is 32MB.
851 **Example:** heap-size 64M
853 * **hash-buckets <n>**
854 Set the number of IPv6 forwarding table hash buckets. The default value is
857 **Example:** hash-buckets 131072
864 Configure Layer 2 MAC Address learning parameters.
867 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
868 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
869 4M entries (4194304).
871 **Example:** limit 8388608
878 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
879 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
880 are mutually exclusive:
883 Lookup tunnel by IPv6 source address.
885 **Example:** lookup-v6-src
888 Lookup tunnel by IPv6 destination address.
890 **Example:** lookup-v6-dst
892 * **lookup-session-id**
893 Lookup tunnel by L2TPv3 session identifier.
895 **Example:** lookup-session-id
907 * **unthrottle-time <n>**
912 * **default-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
917 * **default-syslog-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
927 * **lookup-table-buckets <n>**
932 * **lookup-table-memory <n>G|<n>M|<n>K|<n>**
934 The input value can be set in GB, MB, KB or bytes. The default value is 256KB.
938 * **timezone_offset <n>**
951 **Example:** customer edge
960 * **interface <name>**
970 * **max-n-bytes <n>**
975 * **min-n-bytes <n>**
998 **Example:** no-validate
1000 * **min-delay <n.n>**
1005 * **max-delay <n.n>**
1013 **Example:** no-delay
1015 * **n-packets <n.n>**
1026 * **translation hash buckets <n>**
1031 * **translation hash memory <n>**
1036 * **user hash buckets <n>**
1041 * **user hash memory <n>**
1046 * **max translations per user <n>**
1051 * **outside VRF id <n>**
1056 * **outside ip6 VRF id <n>**
1061 * **inside VRF id <n>**
1066 * **inside VRF id <n>**
1071 * **static mapping only**
1074 **Example:** static mapping only
1076 * **connection tracking**
1079 **Example:** connection tracking
1084 **Example:** deterministic
1086 * **nat64 bib hash buckets <n>**
1091 * **nat64 bib hash memory <n>**
1096 * **nat64 st hash buckets <n>**
1101 * **nat64 st hash memory <n>**
1109 **Example:** out2in dpo
1114 **Example:** dslite ce
1116 * **endpoint-dependent**
1119 **Example:** endpoint-dependent
1126 OAM configuration controls the (ip4-icmp) interval, and number of misses
1127 allowed before reporting an oam target down to any registered listener.
1129 * **interval <n.n>**
1130 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1131 Default is 2.04 seconds.
1133 **Example:** interval 3.5
1135 * **misses-allowed <n>**
1136 Number of misses before declaring an OAM target down. Default is 3 misses.
1138 **Example:** misses-allowed 5
1142 "plugins" Parameters
1143 ____________________
1144 A plugin can be disabled by default. It may still be in an experimental phase
1145 or only be needed in special circumstances. If this is the case, the plugin can
1146 be explicitely enabled in *'startup.conf'*. Also, a plugin that is enabled by
1147 default can be explicitely disabled in *'startup.conf'*.
1149 Another useful use of this section is to disable all the plugins, then enable
1150 only the plugins that are desired.
1153 Adjust the plugin path depending on where the VPP plugins are installed.
1155 **Example:** path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1157 * **name-filter <filter-name>**
1162 * **vat-path <path>**
1167 * **vat-name-filter <filter-name>**
1172 * **plugin <plugin.so> { .. }**
1173 Configure parameters for a given plugin. Valid parameters are as follows:
1176 Enable the given plugin.
1178 Disable the given plugin.
1179 * **skip-version-check**
1180 In the plugin registration, if *'.version_required'* is set, the
1181 plugin will not be loaded if there is version mismatch between
1182 plugin and VPP. This can be bypassed by setting "skip-version-check"
1183 for specific plugin.
1185 **Example:** plugin ila_plugin.so { enable skip-version-check }
1187 * **plugin default { .. }**
1188 Set the default behavior for all plugins. Valid parameters are as follows:
1191 Disable all plugins.
1194 | plugin default { disable }
1195 | plugin dpdk_plugin.so { enable }
1196 | plugin acl_plugin.so { enable }
1200 "plugin_path" Parameters
1201 ________________________
1203 Alternate syntax to choose plugin path. Plugin_path configuration controls the
1204 set of directories searched for vlib plugins. Supply a colon-separated list of
1205 (absolute) directory names: plugin_path dir1:dir2:...:dirN
1207 **Example:** plugin_path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1221 "session" Parameters
1222 ____________________
1224 * **event-queue-length <n>**
1229 * **preallocated-sessions <n>**
1234 * **v4-session-table-buckets <n>**
1239 * **v4-halfopen-table-buckets <n>**
1244 * **v6-session-table-buckets <n>**
1249 * **v6-halfopen-table-buckets <n>**
1254 * **v4-session-table-memory <n>G|<n>M|<n>K|<n>**
1256 The input value can be set in GB, MB, KB or bytes.
1260 * **v4-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1262 The input value can be set in GB, MB, KB or bytes.
1266 * **v6-session-table-memory <n>G|<n>M|<n>K|<n>**
1268 The input value can be set in GB, MB, KB or bytes.
1272 * **v6-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1274 The input value can be set in GB, MB, KB or bytes.
1278 * **local-endpoints-table-memory <n>G|<n>M|<n>K|<n>**
1280 The input value can be set in GB, MB, KB or bytes.
1284 * **local-endpoints-table-buckets <n>**
1289 * **evt_qs_memfd_seg**
1292 **Example:** evt_qs_memfd_seg
1296 "socketsvr" Parameters
1297 ______________________
1299 Create a socket server for API server (.../vlibmemory/socksvr_vlib.c.).
1300 If not set, API server doesn't run.
1302 * **socket-name <filename>**
1303 Configure API socket filename.
1305 **Example:** socket-name /run/vpp/vpp-api.sock
1308 Use the default API socket (/run/vpp-api.sock).
1310 **Example:** default
1317 Create a socket server for *'stats'* poller. If not set, 'stats'* poller
1320 * **socket-name <filename>**
1321 Configure *'stats'* socket filename.
1323 **Example:** socket-name /run/vpp/stats.sock
1326 Use the default *'stats'* socket (/run/vpp/stats.sock).
1328 **Example:** default
1332 "statseg" Parameters
1333 ____________________
1335 * **size <n>G|<n>M|<n>K|<n>**
1337 The input value can be set in GB, MB, KB or bytes.
1354 **Example:** disable
1361 * **preallocated-connections <n>**
1366 * **preallocated-half-open-connections <n>**
1371 * **buffer-fail-fraction <n.n>**
1381 * **se-test-cert-in-ca**
1384 **Example:** se-test-cert-in-ca
1386 * **ca-cert-path <filename>**
1388 If not set, the default is set to *'/etc/ssl/certs/ca-certificates.crt'*.
1397 The "tuntap" driver configures a point-to-point interface between the vpp
1398 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1399 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1400 is currently disabled by default. To [dynamically] create TAP interfaces - the
1401 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1402 "vnet" interface needs to manually configure, and VLAN and other settings if
1405 * **enable|disable**
1406 Enable or disable the tun/tap driver.
1410 * **ethernet|ether**
1411 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1412 tunnel). The two keywords are aliases for the same function.
1414 **Example:** ethernet
1416 * **have-normal-interface|have-normal**
1417 Treat the host Linux stack as a routing peer instead of programming VPP
1418 interface L3 addresses onto the tun/tap devices. The two keywords are
1419 aliases for the same function.
1421 **Example:** have-normal-interface
1424 Assign name to the tun/tap device.
1426 **Example:** name vpp1
1428 Here's a typical multiple parameter invocation:
1430 | tuntap { ethernet have-normal-interface name vpp1 }
1434 "vhost-user" Parameters
1435 _______________________
1437 Vhost-user configuration parameters control the vhost-user driver.
1439 * **coalesce-frames <n>**
1440 Subject to deadline-timer expiration - see next item - attempt to transmit
1441 at least <n> packet frames. Default is 32 frames.
1443 **Example:** coalesce-frames 64
1445 * **coalesce-time <seconds>**
1446 Hold packets no longer than (floating-point) seconds before transmitting
1447 them. Default is 0.001 seconds
1449 **Example:** coalesce-time 0.002
1451 * **dont-dump-memory**
1452 vhost-user shared-memory segments can add up to a large amount of memory, so
1453 it's handy to avoid adding them to corefiles when using a significant number
1456 **Example:** dont-dump-memory
1466 **Example:** memory-trace
1468 * **elog-events <n>**
1473 * **elog-post-mortem-dump**
1476 **Example:** elog-post-mortem-dump
Code Review / vpp.git / blob