3 =======================================
4 VPP Configuration File - 'startup.conf'
5 =======================================
8 After a successful installation, VPP installs a startup config file named
9 *startup.conf* in the */etc/vpp/* directory. This file can be tailored to
10 make VPP run as desired, but contains default values for typical installations.
12 Below are more details about this file and the parameters and values it contains.
17 The VPP network stack comes with several configuration options that can be
18 provided either on the command line when VPP is started, or in a configuration
19 file. Specific applications built on the stack have been known to require a dozen
20 arguments, depending on requirements.
22 Command-line Arguments
23 ----------------------
25 Parameters are grouped by a section name. When providing more than one
26 parameter to a section, all parameters for that section must be wrapped in
27 curly braces. For example, to start VPP with configuration data via the
28 command line with the section name *'unix'*:
30 .. code-block:: console
32 $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
34 The command line can be presented as a single string or as several; anything
35 given on the command line is concatenated with spaces into a single string
36 before parsing. VPP applications must be able to locate their own executable
37 images. The simplest way to ensure this will work is to invoke a VPP
38 application by giving its absolute path. For example:
39 *'/usr/bin/vpp <options>'* At startup, VPP applications parse through their
40 own ELF-sections [primarily] to make lists of init, configuration, and exit
43 When developing with VPP, in gdb it's often sufficient to start an application
46 .. code-block:: console
48 (gdb) run unix interactive
53 It is also possible to supply the configuration parameters in a startup
54 configuration. The path of the file is provided to the VPP application on its
55 command line. The format of the configuration file is a simple text file with
56 the same content as the command line, but with the benefit of being able to use
57 newlines to make the content easier to read. For example:
59 .. code-block:: console
61 $ cat /etc/vpp/startup.conf
64 log /var/log/vpp/vpp.log
66 cli-listen localhost:5002
77 VPP is then instructed to load this file with the -c option. For example:
79 .. code-block:: console
81 $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
83 When the VPP service is started, VPP is started with this option via another
84 installed file, vpp.service (Ubuntu: /lib/systemd/system/vpp.service and
85 CentOS: /usr/lib/systemd/system/vpp.service). See *'ExecStart'* below:
87 .. code-block:: console
89 $ cat /lib/systemd/system/vpp.service
91 Description=vector packet processing engine
96 ExecStartPre=-/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
97 ExecStartPre=-/sbin/modprobe uio_pci_generic
98 ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
99 ExecStopPost=/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
103 WantedBy=multi-user.target
106 Configuration Parameters
107 ------------------------
109 Below is the list of section names and their associated parameters. This is not
110 an exhaustive list of parameters available. The command-line argument parsers
111 can be found in the source code by searching for instances of the
112 **VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION** macro.
114 For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
115 cause the function *'foo_config'* to receive all parameters given in a
116 parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
119 List of Basic Parameters:
120 -------------------------
126 List of Advanced Parameters:
127 ----------------------------
166 Configure VPP startup and behavior type attributes, as well and any OS based
170 Attach CLI to stdin/out and provide a debugging command line interface.
173 **Example:** interactive
176 Do not fork / background the vpp process. Typical when invoking VPP
177 applications from a process monitor. Set by default in the default
178 *'startup.conf'* file.
180 **Example:** nodaemon
183 Logs the startup configuration and all subsequent CLI commands in filename.
184 Very useful in situations where folks don't remember or can't be bothered
185 to include CLI commands in bug reports. The default *'startup.conf'* file
186 is to write to *'/var/log/vpp/vpp.log'*.
188 In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
189 to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
190 However, if SELinux is enabled, then the new location is required for the file
191 to be properly labeled. Check your local *'startup.conf'* file for the log file
192 location on your system.
194 **Example:** log /var/log/vpp/vpp-debug.log
196 * **exec|startup-config <filename>**
197 Read startup operational configuration from filename. The contents of the file
198 will be performed as though entered at the CLI. The two keywords are aliases
199 for the same function; if both are specified, only the last will have an effect.
200 The file contains CLI commands, for example:
202 | $ cat /usr/share/vpp/scripts/interface-up.txt
203 | set interface state TenGigabitEthernet1/0/0 up
204 | set interface state TenGigabitEthernet1/0/1 up
206 **Example:** startup-config /usr/share/vpp/scripts/interface-up.txt
208 * **gid number|name>**
209 Sets the effective group ID to the input group ID or group name of the calling
215 Ask the Linux kernel to dump all memory-mapped address regions, instead of
218 **Example:** full-coredump
220 * **coredump-size unlimited|<n>G|<n>M|<n>K|<n>**
221 Set the maximum size of the coredump file. The input value can be set in
222 GB, MB, KB or bytes, or set to *'unlimited'*.
224 **Example:** coredump-size unlimited
226 * **cli-listen <ipaddress:port>|<socket-path>**
227 Bind the CLI to listen at address localhost on TCP port 5002. This will
228 accept an ipaddress:port pair or a filesystem path; in the latter case a
229 local Unix socket is opened instead. The default *'startup.conf'* file
230 is to open the socket *'/run/vpp/cli.sock'*.
232 **Example:** cli-listen localhost:5002
233 **Example:** cli-listen /run/vpp/cli.sock
236 Disable character-by-character I/O on stdin. Useful when combined with,
237 for example, emacs M-x gud-gdb.
239 **Example:** cli-line-mode
241 * **cli-prompt <string>**
242 Configure the CLI prompt to be string.
244 **Example:** cli-prompt vpp-2
246 * **cli-history-limit <n>**
247 Limit commmand history to <n> lines. A value of 0 disables command history.
250 **Example:** cli-history-limit 100
253 Disable the login banner on stdin and Telnet connections.
255 **Example:** cli-no-banner
258 Disable the output pager.
260 **Example:** cli-no-pager
262 * **cli-pager-buffer-limit <n>**
263 Limit pager buffer to <n> lines of output. A value of 0 disables the
264 pager. Default value: 100000
266 **Example:** cli-pager-buffer-limit 5000
268 * **runtime-dir <dir>**
269 Set the runtime directory, which is the default location for certain
270 files, like socket files. Default is based on User ID used to start VPP.
271 Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
272 defaults to *'/run/user/<uid>/vpp/'*.
274 **Example:** runtime-dir /tmp/vpp
276 * **poll-sleep-usec <n>**
277 Add a fixed-sleep between main loop poll. Default is 0, which is not to
280 **Example:** poll-sleep-usec 100
282 * **pidfile <filename>**
283 Writes the pid of the main thread in the given filename.
285 **Example:** pidfile /run/vpp/vpp1.pid
292 Command line DPDK configuration controls a number of parameters, including
293 device whitelisting, the number of CPUs available for launching
294 dpdk-eal-controlled threads, the number of I/O buffers, and the process
295 affinity mask. In addition, the DPDK configuration function attempts to support
296 all of the DPDK EAL configuration parameters.
298 All of the DPDK EAL options should be available.
299 See ../src/plugins/dpdk/device/dpdk_priv.h, look at the set of
300 "foreach_eal_XXX" macros.
302 Popular options include:
304 White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
305 string of the form "DDDD:BB:SS.F" where:
312 This is the same format used in the linux sysfs tree (i.e.
313 /sys/bus/pci/devices) for PCI device directory names.
315 **Example:** dev 0000:02:00.0
317 * **dev <pci-dev> { .. }**
318 When whitelisting specific interfaces by specifying PCI address,
319 additional custom parameters can also be specified. Valid options include:
321 * **num-rx-queues <n>**
322 Number of receive queues. Also enables RSS. Default value is 1.
323 * **num-tx-queues <n>**
324 Number of transmit queues. Default is equal to number of worker
325 threads or 1 if no workers treads.
326 * **num-rx-desc <n>**
327 Number of descriptors in receive ring. Increasing or reducing number
328 can impact performance. Default is 1024.
329 * **num-rt-desc <n>**
330 Number of descriptors in transmit ring. Increasing or reducing number
331 can impact performance. Default is 1024.
334 * **vlan-strip-offload on|off**:
335 VLAN strip offload mode for interface. VLAN stripping is off by default
336 for all NICs except VICs, using ENIC driver, which has VLAN stripping on
339 Enable the Hierarchical Quaity-of-Service (HQoS) scheduler, default is
340 disabled. This enables HQoS on specific output interface.
342 HQoS can also have its own set of custom parameters. Setting a custom
343 parameter also enables HQoS.
345 * **hqos-thread <n>**
346 HQoS thread used by this interface. To setup a pool of threads that
347 are shared by all HQoS interfaces, set via the*'cpu'* section using
348 either *'corelist-hqos-threads'* or *'coremask-hqos-threads'*.
360 * **vdev <eal-command>**
361 Provide a DPDK EAL command to specify bonded Ethernet interfaces, operating
362 modes and PCI addresses of slave links. Only XOR balanced (mode 2) mode is
367 | vdev eth_bond0,mode=2,slave=0000:0f:00.0,slave=0000:11:00.0,xmit_policy=l34
368 | vdev eth_bond1,mode=2,slave=0000:10:00.0,slave=0000:12:00.0,xmit_policy=l34
371 Increase number of buffers allocated. May be needed in scenarios with
372 large number of interfaces and worker threads, or a lot of physical
373 interfaces with multiple RSS queues. Value is per CPU socket. Default is
376 **Example:** num-mbufs 128000
379 When VPP is started, if an interface is not owned by the linux kernel
380 (interface is administratively down), VPP will attempt to manage the
381 interface. *'no-pci'* indicates that VPP should not walk the PCI table
382 looking for interfaces.
387 Don't use huge TLB pages. Potentially useful for running simulator images.
389 **Example:** no-hugetlb
392 Number of KNI interfaces. Refer to the DPDK documentation.
396 * **uio-driver uio_pci_generic|igb_uio|vfio-pci|auto**
397 Change UIO driver used by VPP. Default is *'auto'*.
399 **Example:** uio-driver igb_uio
402 Change hugepages allocation per-socket, needed only if there is need for
403 larger number of mbufs. Default is 64 hugepages on each detected CPU
406 **Example:** socket-mem 2048,2048
408 **Other options include:**
410 * **enable-tcp-udp-checksum**
411 Enables UDP/TCP RX checksum offload.
413 **Example:** enable-tcp-udp-checksum
416 Disable mutli-segment buffers, improves performance but disables Jumbo MTU
419 **Example:** no-multi-seg
421 * **no-tx-checksum-offload**
422 Disables UDP/TCP TX checksum offload. Typically needed for use faster
423 vector PMDs (together with no-multi-seg).
425 **Example:** no-tx-checksum-offload
427 * **decimal-interface-names**
428 Format DPDK device names with decimal, as opposed to hexadecimal.
430 **Example:** decimal-interface-names
432 * **log-level emergency|alert|critical|error|warning|notice|info|debug**
433 Set the log level for DPDK logs. Default is *'notice'*.
435 **Example:** log-level error
437 * **dev default { .. }**
438 Change default settings for all intefaces. This sections supports the
439 same set of custom parameters described in *'dev <pci-dev> { .. }*'.
453 Command-line CPU configuration controls the creation of named thread types, and
454 the cpu affinity thereof. In the VPP there is one main thread and optionally
455 the user can create worker(s). The main thread and worker thread(s) can be
456 pinned to CPU core(s) automatically or manually.
458 **Automatic Pinning:**
461 Create <n> worker threads.
463 **Example:** workers 4
466 Create <n> i/o threads.
471 Handle i/o devices from thread 0, hand off traffic to worker threads.
472 Requires "workers <n>".
474 **Example:** main-thread-io
477 Sets number of CPU core(s) to be skipped (1 ... N-1). Skipped CPU core(s)
478 are not used for pinning main thread and working thread(s). The main thread
479 is automatically pinned to the first available CPU core and worker(s) are
480 pinned to next free CPU core(s) after core assigned to main threadLeave
481 the low nn bits of the process affinity mask clear.
483 **Example:** skip-cores 4
488 Assign main thread to a specific core.
490 **Example:** main-core 1
492 * **coremask-workers <hex-mask>**
493 Place worker threads according to the bitmap hex-mask.
495 **Example:** coremask-workers 0x0000000000C0000C
497 * **corelist-workers <list>**
498 Same as coremask-workers but accepts a list of cores instead of a bitmap.
500 **Example:** corelist-workers 2-3,18-19
502 * **coremask-io <hex-mask>**
503 Place I/O threads according to the bitmap hex-mask.
505 **Example:** coremask-io 0x0000000003000030
507 * **corelist-io <list>**
508 Same as coremask-io but accepts a list of cores instead of a bitmap.
510 **Example:** corelist-io 4-5,20-21
512 * **coremask-hqos-threads <hex-mask>**
513 Place HQoS threads according to the bitmap hex-mask. A HQoS thread can
514 run multiple HQoS objects each associated with different output interfaces.
516 **Example:** coremask-hqos-threads 0x000000000C0000C0
518 * **corelist-hqos-threads <list>**
519 Same as coremask-hqos-threads but accepts a list of cores instead of a
522 **Example:** corelist-hqos-threads 6-7,22-23
529 **Example:** use-pthreads
531 * **thread-prefix <prefix>**
532 Set a prefix to be prepended to each thread name. The thread name already
533 contains an underscore. If not provided, the default is *'vpp'*.
534 Currently, prefix used on threads: *'vpp_main'*, *'vpp_stats'*
536 **Example:** thread-prefix vpp1
538 * **scheduler-policy rr|fifo|batch|idle|other**
541 **Example:** scheduler-policy fifo
543 * **scheduler-priority <n>**
544 Set the scheduler priority. Only valid if the *'scheduler-policy'* is set
545 to *'fifo'* or *'rr'*. The valid ranges for the scheduler priority depends
546 on the *'scheduler-policy'* and the current kernel version running. The
547 range is typically 1 to 99, but see the linux man pages for *'sched'* for
548 more details. If this value is not set, the current linux kernel default
551 **Example:** scheduler-priority 50
553 * **<thread-name> <count>**
554 Set the number of threads for a given thread (by name). Some threads, like
555 *'stats'*, have a fixed number of threads and cannot be changed. List of
556 possible threads include (but not limited too): hqos-threads, workers
558 **Example:** hqos-threads 2
562 The "main" thread always occupies the lowest core-id specified in the
563 DPDK [process-level] coremask.
565 Here's a full-bore manual placement example:
567 .. code-block:: console
569 /usr/bin/vpp unix interactive tuntap disable cpu { main-thread-io coremask-workers 18 coremask-stats 4 } dpdk { coremask 1e }
571 # taskset -a -p <vpe-pid>
572 pid 16251's current affinity mask: 2 # main thread
573 pid 16288's current affinity mask: ffffff # DPDK interrupt thread (not bound to a core)
574 pid 16289's current affinity mask: 4 # stats thread
575 pid 16290's current affinity mask: 8 # worker thread 0
576 pid 16291's current affinity mask: 10 # worker thread 1
581 "acl-plugin" Parameters
582 _______________________
584 These parameters change the configuration of the ACL (access control list) plugin,
585 such as how the ACL bi-hash tables are initialized.
587 They should only be set by those that are familiar with the interworkings of VPP
590 The first three parameters, *connection hash buckets*, *connection hash memory*,
591 and *connection count max*, set the **connection table per-interface parameters**
592 for modifying how the two bounded-index extensible hash tables for
593 IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
594 (16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
597 * **connection hash buckets <n>**
598 Sets the number of hash buckets (rounded up to a power of 2) in each
599 of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
601 **Example:** connection hash buckets 65536
603 * **connection hash memory <n>**
604 Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
605 Defaults to 1073741824 bytes.
607 **Example:** connection hash memory 1073741824
609 * **connection count max <n>**
610 Sets the maximum number of pool elements when allocating each per-worker
611 pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
613 **Example:** connection count max 500000
615 * **main heap size <n>G|<n>M|<n>K|<n>**
616 Sets the size of the main memory heap that holds all the ACL module related
617 allocations (other than hash.) Default size is 0, but during
618 ACL heap initialization is equal to
619 *per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
620 Note that these variables are partially based on the
621 **connection table per-interface parameters** mentioned above.
623 **Example:** main heap size 3G
625 The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
626 and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
627 table used by the ACL plugin. This table is initialized when attempting to apply
628 an ACL to the existing vector of ACLs looked up during packet processing
629 (but it is found that the table does not exist / has not been initialized yet.)
631 * **hash lookup heap size <n>G|<n>M|<n>K|<n>**
632 Sets the size of the memory heap that holds all the miscellaneous allocations
633 related to hash-based lookups. Default size is 67108864 bytes.
635 **Example:** hash lookup heap size 70M
637 * **hash lookup hash buckets <n>**
638 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
639 lookup table. Defaults to 65536 hash buckets.
641 **Example:** hash lookup hash buckets 65536
643 * **hash lookup hash memory <n>**
644 Sets the allocated memory size (in bytes) for the bi-hash lookup table.
645 Defaults to 67108864 bytes.
647 **Example:** hash lookup hash memory 67108864
649 * **use tuple merge <n>**
650 Sets a boolean value indicating whether or not to use TupleMerge
651 for hash ACL's. Defaults to 1 (true), meaning the default implementation
652 of hashing ACL's **does use** TupleMerge.
654 **Example:** use tuple merge 1
656 * **tuple merge split threshold <n>**
657 Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
658 lookup table before the table is split into two new tables. Splitting ensures
659 less rule collisions by hashing colliding rules based on their common tuple
660 (usually their maximum common tuple.) Splitting occurs when the
661 *length of the colliding rules vector* is greater than this threshold amount.
662 Defaults to a maximum of 39 rule collisions per table.
664 **Example:** tuple merge split threshold 30
666 * **reclassify sessions <n>**
667 Sets a boolean value indicating whether or not to take the epoch of the session
668 into account when dealing with re-applying ACL's or changing already applied ACL's.
669 Defaults to 0 (false), meaning the default implementation **does NOT** take the
670 epoch of the session into account.
672 **Example:** reclassify sessions 1
676 "api-queue" Parameters
677 ______________________
679 The following parameters should only be set by those that are familiar with the
680 interworkings of VPP.
683 Sets the api queue length. Minimum valid queue length is 1024, which is
686 **Example:** length 2048
690 "api-segment" Parameters
691 ________________________
693 These values control various aspects of the binary API interface to VPP.
696 Sets the prefix prepended to the name used for shared memory (SHM)
697 segments. The default is empty, meaning shared memory segments are created
698 directly in the SHM directory *'/dev/shm'*. It is worth noting that on
699 many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
700 system; Ubuntu links it to *'/run/shm'*.
702 **Example:** prefix /run/shm
704 * **uid <number|name>**
705 Sets the user ID or name that should be used to set the ownership of the
706 shared memory segments. Defaults to the same user that VPP is started
709 **Example:** uid root
711 * **gid <number|name>**
712 Sets the group ID or name that should be used to set the ownership of the
713 shared memory segments. Defaults to the same group that VPP is started
718 The following parameters should only be set by those that are familiar with the
719 interworkings of VPP.
722 Set the base address for SVM global region. If not set, on AArch64, the
723 code will try to determine the base address. All other default to
726 **Example:** baseva 0x20000000
728 * **global-size <n>G|<n>M|<n>**
729 Set the global memory size, memory shared across all router instances,
730 packet buffers, etc. If not set, defaults to 64M. The input value can be
731 set in GB, MB or bytes.
733 **Example:** global-size 2G
735 * **global-pvt-heap-size <n>M|size <n>**
736 Set the size of the global VM private mheap. If not set, defaults to 128k.
737 The input value can be set in MB or bytes.
739 **Example:** global-pvt-heap-size size 262144
741 * **api-pvt-heap-size <n>M|size <n>**
742 Set the size of the api private mheap. If not set, defaults to 128k.
743 The input value can be set in MB or bytes.
745 **Example:** api-pvt-heap-size 1M
747 * **api-size <n>M|<n>G|<n>**
748 Set the size of the API region. If not set, defaults to 16M. The input
749 value can be set in GB, MB or bytes.
751 **Example:** api-size 64M
755 "api-trace" Parameters
756 ______________________
758 The ability to trace, dump, and replay control-plane API traces makes all the
759 difference in the world when trying to understand what the control-plane has
760 tried to ask the forwarding-plane to do.
763 Enable API trace capture from the beginning of time, and arrange for a
764 post-mortem dump of the API trace if the application terminates abnormally.
765 By default, the (circular) trace buffer will be configured to capture
766 256K traces. The default *'startup.conf'* file has trace enabled by default,
767 and unless there is a very strong reason, it should remain enabled.
772 Configure the circular trace buffer to contain the last <n> entries. By
773 default, the trace buffer captures the last 256K API messages received.
775 **Example:** nitems 524288
777 * **save-api-table <filename>**
778 Dumps the API message table to /tmp/<filename>.
780 **Example:** save-api-table apiTrace-07-04.txt
782 Typically, one simply enables the API message trace scheme:
791 Command line Buffer configuration controls buffer management.
793 * **memory-size-in-mb <n>**
794 Configure the memory size used for buffers. If not set, VPP defaults
797 **Example:** memory-size-in-mb 64
805 The circular journal (CJ) thread-safe circular log buffer scheme is
806 occasionally useful when chasing bugs. Calls to it should not be checked in.
807 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
808 When enabled, the number of records must be provided, there is no default
812 Configure the number of circular journal records in the circular buffer.
813 The number of records should be a power of 2.
815 **Example:** records 131072
818 Turns on logging at the earliest possible moment.
827 * **max-cache-size <n>**
828 Set the maximum number of active elements allowed in the pool of
829 dns cache entries. When resolving an expired entry or adding a new
830 static entry and the max number of active entries is reached,
831 a random, non-static entry is deleted. Defaults to 65535 entries.
833 **Example:** max-cache-size 65535
836 Currently not implemented. Defaults to 86400 seconds (24 hours.)
838 **Example:** max-ttl 86400
842 "heapsize" Parameters
843 _____________________
845 Heapsize configuration controls the size of the main heap. The heap size is
846 configured very early in the boot sequence, before loading plug-ins or doing
847 much of anything else.
849 * **heapsize <n>M|<n>G**
850 Specifies the size of the heap in MB or GB. The default is 1GB. Setting the
851 main heap size to 4GB or more requires recompilation of the entire system
852 with CLIB_VEC64 > 0. See .../clib/clib/vec_bootstrap.h.
854 **Example:** heapsize 2G
861 IPv4 heap configuration. he heap size is configured very early in the boot
862 sequence, before loading plug-ins or doing much of anything else.
864 * **heap-size <n>G|<n>M|<n>K|<n>**
865 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
866 the destination IP lookup table. The input value can be set in GB, MB, KB
867 or bytes. The default value is 32MB.
869 **Example:** heap-size 64M
876 IPv6 heap configuration. he heap size is configured very early in the boot
877 sequence, before loading plug-ins or doing much of anything else.
880 * **heap-size <n>G|<n>M|<n>K|<n>**
881 Set the IPv6 forwarding table heap size. The input value can be set in GB,
882 MB, KB or bytes. The default value is 32MB.
884 **Example:** heap-size 64M
886 * **hash-buckets <n>**
887 Set the number of IPv6 forwarding table hash buckets. The default value is
890 **Example:** hash-buckets 131072
897 Configure Layer 2 MAC Address learning parameters.
900 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
901 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
902 4M entries (4194304).
904 **Example:** limit 8388608
911 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
912 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
913 are mutually exclusive:
916 Lookup tunnel by IPv6 source address.
918 **Example:** lookup-v6-src
921 Lookup tunnel by IPv6 destination address.
923 **Example:** lookup-v6-dst
925 * **lookup-session-id**
926 Lookup tunnel by L2TPv3 session identifier.
928 **Example:** lookup-session-id
940 * **unthrottle-time <n>**
945 * **default-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
950 * **default-syslog-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
960 * **lookup-table-buckets <n>**
961 Sets the number of hash buckets in the mactime bi-hash lookup table.
962 Defaults to 128 buckets.
964 **Example:** lookup-table-buckets 128
966 * **lookup-table-memory <n>G|<n>M|<n>K|<n>**
967 Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
968 The input value can be set in GB, MB, KB or bytes. The default value is 262144
969 (256 << 10) bytes or roughly 256KB.
971 **Example:** lookup-table-memory 300K
973 * **timezone_offset <n>**
974 Sets the timezone offset from UTC. Defaults to an offset of -5 hours
975 from UTC (US EST / EDT.)
977 **Example:** timezone_offset -5
985 Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
986 router. The boolean defaults to false, meaning the MAP node is not treated
989 **Example:** customer edge
998 * **interface <name>**
1008 * **max-n-bytes <n>**
1013 * **min-n-bytes <n>**
1031 **Example:** verbose
1036 **Example:** no-validate
1038 * **min-delay <n.n>**
1043 * **max-delay <n.n>**
1051 **Example:** no-delay
1053 * **n-packets <n.n>**
1064 These parameters change the configuration of the NAT (Network address translation)
1065 plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
1066 endpoint dependent, or if the NAT is deterministic.
1068 For each NAT per thread data, the following 4 parameters change how certain
1069 bi-hash tables are initialized.
1071 * **translation hash buckets <n>**
1072 Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
1073 tables. Defaults to 1024 buckets.
1075 If the NAT is indicated to be endpoint dependent, which can be set with the
1076 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets
1077 the number of hash buckets in each of the two endpoint dependent sessions
1078 NAT bi-hash lookup tables.
1080 **Example:** translation hash buckets 1024
1082 * **translation hash memory <n>**
1083 Sets the allocated memory size (in bytes) for each of the two in/out NAT
1084 bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
1086 If the NAT is indicated to be endpoint dependent, which can be set with the
1087 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets the
1088 allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
1091 **Example:** translation hash memory 134217728
1093 * **user hash buckets <n>**
1094 Sets the number of hash buckets in the user bi-hash lookup table
1095 (src address lookup for a user.) Defaults to 128 buckets.
1097 **Example:** user hash buckets 128
1099 * **user hash memory <n>**
1100 Sets the allocated memory size (in bytes) for the user bi-hash lookup table
1101 (src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
1102 which is roughly 64 MB.
1104 **Example:** user hash memory 67108864
1106 * **max translations per user <n>**
1107 Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
1108 Defaults to 100. When this limit is reached, the least recently used translation
1111 **Example:** max translations per user 50
1113 * **outside VRF id <n>**
1118 * **outside ip6 VRF id <n>**
1123 * **inside VRF id <n>**
1128 * **inside VRF id <n>**
1133 * **static mapping only**
1136 **Example:** static mapping only
1138 * **connection tracking**
1141 **Example:** connection tracking
1144 Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
1145 meaning the NAT is not deterministic.
1147 **Example:** deterministic
1149 * **nat64 bib hash buckets <n>**
1150 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
1151 tables. Defaults to 1024 buckets.
1153 **Example:** nat64 bib hash buckets 1024
1155 * **nat64 bib hash memory <n>**
1156 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
1157 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
1158 which is roughly 128 MB.
1160 **Example:** nat64 bib hash memory 134217728
1162 * **nat64 st hash buckets <n>**
1163 Sets the number of hash buckets in each of the two in/out NAT64 session table
1164 bi-hash tables. Defaults to 2048 buckets.
1166 **Example:** nat64 st hash buckets 2048
1168 * **nat64 st hash memory <n>**
1169 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
1170 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
1173 **Example:** nat64 st hash memory 268435456
1178 **Example:** out2in dpo
1183 **Example:** dslite ce
1187 * **endpoint-dependent**
1188 Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
1189 Defaults to 0, meaning the NAT is not endpoint dependent.
1191 **Example:** endpoint-dependent
1198 OAM configuration controls the (ip4-icmp) interval, and number of misses
1199 allowed before reporting an oam target down to any registered listener.
1201 * **interval <n.n>**
1202 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1203 Default is 2.04 seconds.
1205 **Example:** interval 3.5
1207 * **misses-allowed <n>**
1208 Number of misses before declaring an OAM target down. Default is 3 misses.
1210 **Example:** misses-allowed 5
1214 "plugins" Parameters
1215 ____________________
1217 A plugin can be disabled by default. It may still be in an experimental phase
1218 or only be needed in special circumstances. If this is the case, the plugin can
1219 be explicitely enabled in *'startup.conf'*. Also, a plugin that is enabled by
1220 default can be explicitely disabled in *'startup.conf'*.
1222 Another useful use of this section is to disable all the plugins, then enable
1223 only the plugins that are desired.
1226 Adjust the plugin path depending on where the VPP plugins are installed.
1228 **Example:** path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1230 * **name-filter <filter-name>**
1235 * **vat-path <path>**
1240 * **vat-name-filter <filter-name>**
1245 * **plugin <plugin.so> { .. }**
1246 Configure parameters for a given plugin. Valid parameters are as follows:
1249 Enable the given plugin.
1251 Disable the given plugin.
1252 * **skip-version-check**
1253 In the plugin registration, if *'.version_required'* is set, the
1254 plugin will not be loaded if there is version mismatch between
1255 plugin and VPP. This can be bypassed by setting "skip-version-check"
1256 for specific plugin.
1258 **Example:** plugin ila_plugin.so { enable skip-version-check }
1260 * **plugin default { .. }**
1261 Set the default behavior for all plugins. Valid parameters are as follows:
1264 Disable all plugins.
1267 | plugin default { disable }
1268 | plugin dpdk_plugin.so { enable }
1269 | plugin acl_plugin.so { enable }
1273 "plugin_path" Parameters
1274 ________________________
1276 Alternate syntax to choose plugin path. Plugin_path configuration controls the
1277 set of directories searched for vlib plugins. Supply a colon-separated list of
1278 (absolute) directory names: plugin_path dir1:dir2:...:dirN
1280 **Example:** plugin_path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1287 Configuration parameters for the local TCP/IP stack punt infrastructure.
1290 The filesystem pathname of a bound UNIX domain socket to be used with punt.
1296 "session" Parameters
1297 ____________________
1299 * **event-queue-length <n>**
1304 * **preallocated-sessions <n>**
1309 * **v4-session-table-buckets <n>**
1314 * **v4-halfopen-table-buckets <n>**
1319 * **v6-session-table-buckets <n>**
1324 * **v6-halfopen-table-buckets <n>**
1329 * **v4-session-table-memory <n>G|<n>M|<n>K|<n>**
1331 The input value can be set in GB, MB, KB or bytes.
1335 * **v4-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1337 The input value can be set in GB, MB, KB or bytes.
1341 * **v6-session-table-memory <n>G|<n>M|<n>K|<n>**
1343 The input value can be set in GB, MB, KB or bytes.
1347 * **v6-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1349 The input value can be set in GB, MB, KB or bytes.
1353 * **local-endpoints-table-memory <n>G|<n>M|<n>K|<n>**
1355 The input value can be set in GB, MB, KB or bytes.
1359 * **local-endpoints-table-buckets <n>**
1364 * **evt_qs_memfd_seg**
1367 **Example:** evt_qs_memfd_seg
1371 "socketsvr" Parameters
1372 ______________________
1374 Create a socket server for API server (.../vlibmemory/socksvr_vlib.c.).
1375 If not set, API server doesn't run.
1377 * **socket-name <filename>**
1378 Configure API socket filename.
1380 **Example:** socket-name /run/vpp/vpp-api.sock
1383 Use the default API socket (/run/vpp-api.sock).
1385 **Example:** default
1392 Create a socket server for *'stats'* poller. If not set, 'stats'* poller
1395 * **socket-name <filename>**
1396 Configure *'stats'* socket filename.
1398 **Example:** socket-name /run/vpp/stats.sock
1401 Use the default *'stats'* socket (/run/vpp/stats.sock).
1403 **Example:** default
1407 "statseg" Parameters
1408 ____________________
1410 * **size <n>G|<n>M|<n>K|<n>**
1411 Sets the size of the memory mapped stats segment object *stat_segment*.
1412 The input value can be set in GB, MB, KB or bytes. Defaults to 33554432
1413 (32 << 20) bytes or roughly 32 MB.
1415 **Example:** size 32M
1422 Configuration parameters for TAPCLI (dynamic tap interface hookup.)
1425 Sets interface MTU (maximum transmission unit) size in bytes. This size
1426 is also related to the number of MTU buffers. Defaults to 1500 bytes.
1428 **Example:** mtu 1500
1431 Disables TAPCLI. Default is that TAPCLI is enabled.
1433 **Example:** disable
1440 Configuration parameters for TCP host stack utilities. The following
1441 preallocation parameters are related to the initialization of fixed-size,
1442 preallocation pools.
1444 * **preallocated-connections <n>**
1445 Sets the number of preallocated TCP connections. Defaults to 0.
1446 The preallocated connections per thread is related to this value,
1447 equal to (preallocated_connections / (num_threads - 1)).
1449 **Example:** preallocated-connections 5
1451 * **preallocated-half-open-connections <n>**
1452 Sets the number of preallocated TCP half-open connections. Defaults to 0.
1454 **Example:** preallocated-half-open-connections 5
1456 * **buffer-fail-fraction <n.n>**
1457 Sets the TCP buffer fail fraction (a float) used for fault-injection
1458 when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
1461 **Example:** buffer-fail-fraction 0.0
1468 Configures TLS parameters, such as enabling the use of test certificates.
1469 These parameters affect the tlsmbedtls and tlsopenssl plugins.
1471 * **use-test-cert-in-ca**
1472 Sets a boolean value to 1 to indicate during the initialization of a
1473 TLS CA chain to attempt to parse and add test certificates to the chain.
1474 Defaults to 0, meaning test certificates are not used.
1476 **Example:** use-test-cert-in-ca
1478 * **ca-cert-path <filename>**
1479 Sets the filename path of the location of TLS CA certificates, used when
1480 initializing and loading TLS CA certificates during the initialization
1481 of a TLS CA chain. If not set, the default filename path is
1482 */etc/ssl/certs/ca-certificates.crt*.
1484 **Example:** ca-cert-path /etc/ssl/certs/ca-certificates.crt
1491 The "tuntap" driver configures a point-to-point interface between the vpp
1492 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1493 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1494 is currently disabled by default. To [dynamically] create TAP interfaces - the
1495 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1496 "vnet" interface needs to manually configure, and VLAN and other settings if
1499 * **enable|disable**
1500 Enable or disable the tun/tap driver.
1504 * **ethernet|ether**
1505 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1506 tunnel). The two keywords are aliases for the same function.
1508 **Example:** ethernet
1510 * **have-normal-interface|have-normal**
1511 Treat the host Linux stack as a routing peer instead of programming VPP
1512 interface L3 addresses onto the tun/tap devices. The two keywords are
1513 aliases for the same function.
1515 **Example:** have-normal-interface
1518 Assign name to the tun/tap device.
1520 **Example:** name vpp1
1522 Here's a typical multiple parameter invocation:
1524 | tuntap { ethernet have-normal-interface name vpp1 }
1528 "vhost-user" Parameters
1529 _______________________
1531 Vhost-user configuration parameters control the vhost-user driver.
1533 * **coalesce-frames <n>**
1534 Subject to deadline-timer expiration - see next item - attempt to transmit
1535 at least <n> packet frames. Default is 32 frames.
1537 **Example:** coalesce-frames 64
1539 * **coalesce-time <seconds>**
1540 Hold packets no longer than (floating-point) seconds before transmitting
1541 them. Default is 0.001 seconds
1543 **Example:** coalesce-time 0.002
1545 * **dont-dump-memory**
1546 vhost-user shared-memory segments can add up to a large amount of memory, so
1547 it's handy to avoid adding them to corefiles when using a significant number
1550 **Example:** dont-dump-memory
1557 These parameters configure VLIB, such as allowing you to choose whether to
1558 enable memory traceback or a post-mortem elog dump.
1561 Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
1564 **Example:** memory-trace
1566 * **elog-events <n>**
1567 Sets the number of elements/events (the size) of the event ring
1568 (a circular buffer of events.) This number rounds to a power of 2.
1569 Defaults to 131072 (128 << 10) elements.
1571 **Example:** elog-events 4096
1573 * **elog-post-mortem-dump**
1574 Enables the attempt of a post-mortem elog dump to
1575 */tmp/elog_post_mortem.<PID_OF_CALLING_PROCESS>* if os_panic or
1578 **Example:** elog-post-mortem-dump