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.
16 Below are more details about this file and the parameters and values it contains.
21 The VPP network stack comes with several configuration options that can be
22 provided either on the command line when VPP is started, or in a configuration
23 file. Specific applications built on the stack have been known to require a dozen
24 arguments, depending on requirements.
26 Command-line Arguments
27 ----------------------
29 Parameters are grouped by a section name. When providing more than one
30 parameter to a section, all parameters for that section must be wrapped in
31 curly braces. For example, to start VPP with configuration data via the
32 command line with the section name *'unix'*:
34 .. code-block:: console
36 $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
38 The command line can be presented as a single string or as several; anything
39 given on the command line is concatenated with spaces into a single string
40 before parsing. VPP applications must be able to locate their own executable
41 images. The simplest way to ensure this will work is to invoke a VPP
42 application by giving its absolute path. For example:
43 *'/usr/bin/vpp <options>'* At startup, VPP applications parse through their
44 own ELF-sections [primarily] to make lists of init, configuration, and exit
47 When developing with VPP, in gdb it's often sufficient to start an application
50 .. code-block:: console
52 (gdb) run unix interactive
57 It is also possible to supply the configuration parameters in a startup
58 configuration. The path of the file is provided to the VPP application on its
59 command line. The format of the configuration file is a simple text file with
60 the same content as the command line, but with the benefit of being able to use
61 newlines to make the content easier to read. For example:
63 .. code-block:: console
65 $ cat /etc/vpp/startup.conf
68 log /var/log/vpp/vpp.log
70 cli-listen localhost:5002
81 VPP is then instructed to load this file with the -c option. For example:
83 .. code-block:: console
85 $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
87 When the VPP service is started, VPP is started with this option via another
88 installed file, vpp.service (Ubuntu: /lib/systemd/system/vpp.service and
89 CentOS: /usr/lib/systemd/system/vpp.service). See *'ExecStart'* below:
91 .. code-block:: console
93 $ cat /lib/systemd/system/vpp.service
95 Description=vector packet processing engine
100 ExecStartPre=-/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
101 ExecStartPre=-/sbin/modprobe uio_pci_generic
102 ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
103 ExecStopPost=/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
107 WantedBy=multi-user.target
110 Configuration Parameters
111 ------------------------
113 Below is the list of section names and their associated parameters. This is not
114 an exhaustive list of parameters available. The command-line argument parsers
115 can be found in the source code by searching for instances of the
116 **VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION** macro.
118 For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
119 cause the function *'foo_config'* to receive all parameters given in a
120 parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
123 List of Basic Parameters:
124 -------------------------
130 List of Advanced Parameters:
131 ----------------------------
170 Configure VPP startup and behavior type attributes, as well and any OS based
174 Attach CLI to stdin/out and provide a debugging command line interface.
177 **Example:** interactive
180 Do not fork / background the vpp process. Typical when invoking VPP
181 applications from a process monitor. Set by default in the default
182 *'startup.conf'* file.
184 **Example:** nodaemon
187 Logs the startup configuration and all subsequent CLI commands in filename.
188 Very useful in situations where folks don't remember or can't be bothered
189 to include CLI commands in bug reports. The default *'startup.conf'* file
190 is to write to *'/var/log/vpp/vpp.log'*.
192 In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
193 to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
194 However, if SELinux is enabled, then the new location is required for the file
195 to be properly labeled. Check your local *'startup.conf'* file for the log file
196 location on your system.
198 **Example:** log /var/log/vpp/vpp-debug.log
200 * **exec|startup-config <filename>**
201 Read startup operational configuration from filename. The contents of the file
202 will be performed as though entered at the CLI. The two keywords are aliases
203 for the same function; if both are specified, only the last will have an effect.
204 The file contains CLI commands, for example:
206 | $ cat /usr/share/vpp/scripts/interface-up.txt
207 | set interface state TenGigabitEthernet1/0/0 up
208 | set interface state TenGigabitEthernet1/0/1 up
210 **Example:** startup-config /usr/share/vpp/scripts/interface-up.txt
212 * **gid number|name>**
213 Sets the effective group ID to the input group ID or group name of the calling
219 Ask the Linux kernel to dump all memory-mapped address regions, instead of
222 **Example:** full-coredump
224 * **coredump-size unlimited|<n>G|<n>M|<n>K|<n>**
225 Set the maximum size of the coredump file. The input value can be set in
226 GB, MB, KB or bytes, or set to *'unlimited'*.
228 **Example:** coredump-size unlimited
230 * **cli-listen <ipaddress:port>|<socket-path>**
231 Bind the CLI to listen at address localhost on TCP port 5002. This will
232 accept an ipaddress:port pair or a filesystem path; in the latter case a
233 local Unix socket is opened instead. The default *'startup.conf'* file
234 is to open the socket *'/run/vpp/cli.sock'*.
236 **Example:** cli-listen localhost:5002
237 **Example:** cli-listen /run/vpp/cli.sock
240 Disable character-by-character I/O on stdin. Useful when combined with,
241 for example, emacs M-x gud-gdb.
243 **Example:** cli-line-mode
245 * **cli-prompt <string>**
246 Configure the CLI prompt to be string.
248 **Example:** cli-prompt vpp-2
250 * **cli-history-limit <n>**
251 Limit commmand history to <n> lines. A value of 0 disables command history.
254 **Example:** cli-history-limit 100
257 Disable the login banner on stdin and Telnet connections.
259 **Example:** cli-no-banner
262 Disable the output pager.
264 **Example:** cli-no-pager
266 * **cli-pager-buffer-limit <n>**
267 Limit pager buffer to <n> lines of output. A value of 0 disables the
268 pager. Default value: 100000
270 **Example:** cli-pager-buffer-limit 5000
272 * **runtime-dir <dir>**
273 Set the runtime directory, which is the default location for certain
274 files, like socket files. Default is based on User ID used to start VPP.
275 Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
276 defaults to *'/run/user/<uid>/vpp/'*.
278 **Example:** runtime-dir /tmp/vpp
280 * **poll-sleep-usec <n>**
281 Add a fixed-sleep between main loop poll. Default is 0, which is not to
284 **Example:** poll-sleep-usec 100
286 * **pidfile <filename>**
287 Writes the pid of the main thread in the given filename.
289 **Example:** pidfile /run/vpp/vpp1.pid
296 Command line DPDK configuration controls a number of parameters, including
297 device whitelisting, the number of CPUs available for launching
298 dpdk-eal-controlled threads, the number of I/O buffers, and the process
299 affinity mask. In addition, the DPDK configuration function attempts to support
300 all of the DPDK EAL configuration parameters.
302 All of the DPDK EAL options should be available.
303 See ../src/plugins/dpdk/device/dpdk_priv.h, look at the set of
304 "foreach_eal_XXX" macros.
306 Popular options include:
308 White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
309 string of the form "DDDD:BB:SS.F" where:
316 This is the same format used in the linux sysfs tree (i.e.
317 /sys/bus/pci/devices) for PCI device directory names.
319 **Example:** dev 0000:02:00.0
321 * **dev <pci-dev> { .. }**
322 When whitelisting specific interfaces by specifying PCI address,
323 additional custom parameters can also be specified. Valid options include:
325 * **num-rx-queues <n>**
326 Number of receive queues. Also enables RSS. Default value is 1.
327 * **num-tx-queues <n>**
328 Number of transmit queues. Default is equal to number of worker
329 threads or 1 if no workers treads.
330 * **num-rx-desc <n>**
331 Number of descriptors in receive ring. Increasing or reducing number
332 can impact performance. Default is 1024.
333 * **num-rt-desc <n>**
334 Number of descriptors in transmit ring. Increasing or reducing number
335 can impact performance. Default is 1024.
338 * **vlan-strip-offload on|off**:
339 VLAN strip offload mode for interface. VLAN stripping is off by default
340 for all NICs except VICs, using ENIC driver, which has VLAN stripping on
343 Enable the Hierarchical Quaity-of-Service (HQoS) scheduler, default is
344 disabled. This enables HQoS on specific output interface.
346 HQoS can also have its own set of custom parameters. Setting a custom
347 parameter also enables HQoS.
349 * **hqos-thread <n>**
350 HQoS thread used by this interface. To setup a pool of threads that
351 are shared by all HQoS interfaces, set via the*'cpu'* section using
352 either *'corelist-hqos-threads'* or *'coremask-hqos-threads'*.
364 * **vdev <eal-command>**
365 Provide a DPDK EAL command to specify bonded Ethernet interfaces, operating
366 modes and PCI addresses of slave links. Only XOR balanced (mode 2) mode is
371 | vdev eth_bond0,mode=2,slave=0000:0f:00.0,slave=0000:11:00.0,xmit_policy=l34
372 | vdev eth_bond1,mode=2,slave=0000:10:00.0,slave=0000:12:00.0,xmit_policy=l34
375 Increase number of buffers allocated. May be needed in scenarios with
376 large number of interfaces and worker threads, or a lot of physical
377 interfaces with multiple RSS queues. Value is per CPU socket. Default is
380 **Example:** num-mbufs 128000
383 When VPP is started, if an interface is not owned by the linux kernel
384 (interface is administratively down), VPP will attempt to manage the
385 interface. *'no-pci'* indicates that VPP should not walk the PCI table
386 looking for interfaces.
391 Don't use huge TLB pages. Potentially useful for running simulator images.
393 **Example:** no-hugetlb
396 Number of KNI interfaces. Refer to the DPDK documentation.
400 * **uio-driver uio_pci_generic|igb_uio|vfio-pci|auto**
401 Change UIO driver used by VPP. Default is *'auto'*.
403 **Example:** uio-driver igb_uio
406 Change hugepages allocation per-socket, needed only if there is need for
407 larger number of mbufs. Default is 64 hugepages on each detected CPU
410 **Example:** socket-mem 2048,2048
412 **Other options include:**
414 * **enable-tcp-udp-checksum**
415 Enables UDP/TCP RX checksum offload.
417 **Example:** enable-tcp-udp-checksum
420 Disable mutli-segment buffers, improves performance but disables Jumbo MTU
423 **Example:** no-multi-seg
425 * **no-tx-checksum-offload**
426 Disables UDP/TCP TX checksum offload. Typically needed for use faster
427 vector PMDs (together with no-multi-seg).
429 **Example:** no-tx-checksum-offload
431 * **decimal-interface-names**
432 Format DPDK device names with decimal, as opposed to hexadecimal.
434 **Example:** decimal-interface-names
436 * **log-level emergency|alert|critical|error|warning|notice|info|debug**
437 Set the log level for DPDK logs. Default is *'notice'*.
439 **Example:** log-level error
441 * **dev default { .. }**
442 Change default settings for all intefaces. This sections supports the
443 same set of custom parameters described in *'dev <pci-dev> { .. }*'.
457 Command-line CPU configuration controls the creation of named thread types, and
458 the cpu affinity thereof. In the VPP there is one main thread and optionally
459 the user can create worker(s). The main thread and worker thread(s) can be
460 pinned to CPU core(s) automatically or manually.
462 **Automatic Pinning:**
465 Create <n> worker threads.
467 **Example:** workers 4
470 Create <n> i/o threads.
475 Handle i/o devices from thread 0, hand off traffic to worker threads.
476 Requires "workers <n>".
478 **Example:** main-thread-io
481 Sets number of CPU core(s) to be skipped (1 ... N-1). Skipped CPU core(s)
482 are not used for pinning main thread and working thread(s). The main thread
483 is automatically pinned to the first available CPU core and worker(s) are
484 pinned to next free CPU core(s) after core assigned to main threadLeave
485 the low nn bits of the process affinity mask clear.
487 **Example:** skip-cores 4
492 Assign main thread to a specific core.
494 **Example:** main-core 1
496 * **coremask-workers <hex-mask>**
497 Place worker threads according to the bitmap hex-mask.
499 **Example:** coremask-workers 0x0000000000C0000C
501 * **corelist-workers <list>**
502 Same as coremask-workers but accepts a list of cores instead of a bitmap.
504 **Example:** corelist-workers 2-3,18-19
506 * **coremask-io <hex-mask>**
507 Place I/O threads according to the bitmap hex-mask.
509 **Example:** coremask-io 0x0000000003000030
511 * **corelist-io <list>**
512 Same as coremask-io but accepts a list of cores instead of a bitmap.
514 **Example:** corelist-io 4-5,20-21
516 * **coremask-hqos-threads <hex-mask>**
517 Place HQoS threads according to the bitmap hex-mask. A HQoS thread can
518 run multiple HQoS objects each associated with different output interfaces.
520 **Example:** coremask-hqos-threads 0x000000000C0000C0
522 * **corelist-hqos-threads <list>**
523 Same as coremask-hqos-threads but accepts a list of cores instead of a
526 **Example:** corelist-hqos-threads 6-7,22-23
533 **Example:** use-pthreads
535 * **thread-prefix <prefix>**
536 Set a prefix to be prepended to each thread name. The thread name already
537 contains an underscore. If not provided, the default is *'vpp'*.
538 Currently, prefix used on threads: *'vpp_main'*, *'vpp_stats'*
540 **Example:** thread-prefix vpp1
542 * **scheduler-policy rr|fifo|batch|idle|other**
545 **Example:** scheduler-policy fifo
547 * **scheduler-priority <n>**
548 Set the scheduler priority. Only valid if the *'scheduler-policy'* is set
549 to *'fifo'* or *'rr'*. The valid ranges for the scheduler priority depends
550 on the *'scheduler-policy'* and the current kernel version running. The
551 range is typically 1 to 99, but see the linux man pages for *'sched'* for
552 more details. If this value is not set, the current linux kernel default
555 **Example:** scheduler-priority 50
557 * **<thread-name> <count>**
558 Set the number of threads for a given thread (by name). Some threads, like
559 *'stats'*, have a fixed number of threads and cannot be changed. List of
560 possible threads include (but not limited too): hqos-threads, workers
562 **Example:** hqos-threads 2
566 The "main" thread always occupies the lowest core-id specified in the
567 DPDK [process-level] coremask.
569 Here's a full-bore manual placement example:
571 .. code-block:: console
573 /usr/bin/vpp unix interactive tuntap disable cpu { main-thread-io coremask-workers 18 coremask-stats 4 } dpdk { coremask 1e }
575 # taskset -a -p <vpe-pid>
576 pid 16251's current affinity mask: 2 # main thread
577 pid 16288's current affinity mask: ffffff # DPDK interrupt thread (not bound to a core)
578 pid 16289's current affinity mask: 4 # stats thread
579 pid 16290's current affinity mask: 8 # worker thread 0
580 pid 16291's current affinity mask: 10 # worker thread 1
585 "acl-plugin" Parameters
586 _______________________
588 The following parameters should only be set by those that are familiar with the
589 interworkings of VPP and the ACL Plugin.
591 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.
593 * **connection hash buckets <n>**
594 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.
596 **Example:** connection hash buckets 65536
598 * **connection hash memory <n>**
599 Sets the number of bytes used for “backing store” allocation in each of the two bi-hash tables. Defaults to 1073741824 bytes.
601 **Example:** connection hash memory 1073741824
603 * **connection count max <n>**
604 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.
606 **Example:** connection count max 500000
608 * **main heap size <n>G|<n>M|<n>K|<n>**
609 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.
611 **Example:** main heap size 3G
613 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.)
615 * **hash lookup heap size <n>G|<n>M|<n>K|<n>**
616 Sets the size of the memory heap that holds all the miscellaneous allocations related to hash-based lookups. Default size is 67108864 bytes.
618 **Example:** hash lookup heap size 70M
620 * **hash lookup hash buckets <n>**
621 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash lookup table. Defaults to 65536 hash buckets.
623 **Example:** hash lookup hash buckets 65536
625 * **hash lookup hash memory <n>**
626 Sets the number of bytes used for “backing store” allocation in the bi-hash lookup table. Defaults to 67108864 bytes.
628 **Example:** hash lookup hash memory 67108864
630 * **use tuple merge <n>**
631 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.
633 **Example:** use tuple merge 1
635 * **tuple merge split threshold <n>**
636 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.
638 **Example:** tuple merge split threshold 30
640 * **reclassify sessions <n>**
641 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.
643 **Example:** reclassify sessions 1
647 "api-queue" Parameters
648 ______________________
650 The following parameters should only be set by those that are familiar with the
651 interworkings of VPP.
654 Sets the api queue length. Minimum valid queue length is 1024, which is
657 **Example:** length 2048
661 "api-segment" Parameters
662 ________________________
664 These values control various aspects of the binary API interface to VPP.
667 Sets the prefix prepended to the name used for shared memory (SHM)
668 segments. The default is empty, meaning shared memory segments are created
669 directly in the SHM directory *'/dev/shm'*. It is worth noting that on
670 many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
671 system; Ubuntu links it to *'/run/shm'*.
673 **Example:** prefix /run/shm
675 * **uid <number|name>**
676 Sets the user ID or name that should be used to set the ownership of the
677 shared memory segments. Defaults to the same user that VPP is started
680 **Example:** uid root
682 * **gid <number|name>**
683 Sets the group ID or name that should be used to set the ownership of the
684 shared memory segments. Defaults to the same group that VPP is started
689 The following parameters should only be set by those that are familiar with the
690 interworkings of VPP.
693 Set the base address for SVM global region. If not set, on AArch64, the
694 code will try to determine the base address. All other default to
697 **Example:** baseva 0x20000000
699 * **global-size <n>G|<n>M|<n>**
700 Set the global memory size, memory shared across all router instances,
701 packet buffers, etc. If not set, defaults to 64M. The input value can be
702 set in GB, MB or bytes.
704 **Example:** global-size 2G
706 * **global-pvt-heap-size <n>M|size <n>**
707 Set the size of the global VM private mheap. If not set, defaults to 128k.
708 The input value can be set in MB or bytes.
710 **Example:** global-pvt-heap-size size 262144
712 * **api-pvt-heap-size <n>M|size <n>**
713 Set the size of the api private mheap. If not set, defaults to 128k.
714 The input value can be set in MB or bytes.
716 **Example:** api-pvt-heap-size 1M
718 * **api-size <n>M|<n>G|<n>**
719 Set the size of the API region. If not set, defaults to 16M. The input
720 value can be set in GB, MB or bytes.
722 **Example:** api-size 64M
726 "api-trace" Parameters
727 ______________________
729 The ability to trace, dump, and replay control-plane API traces makes all the
730 difference in the world when trying to understand what the control-plane has
731 tried to ask the forwarding-plane to do.
734 Enable API trace capture from the beginning of time, and arrange for a
735 post-mortem dump of the API trace if the application terminates abnormally.
736 By default, the (circular) trace buffer will be configured to capture
737 256K traces. The default *'startup.conf'* file has trace enabled by default,
738 and unless there is a very strong reason, it should remain enabled.
743 Configure the circular trace buffer to contain the last <n> entries. By
744 default, the trace buffer captures the last 256K API messages received.
746 **Example:** nitems 524288
748 * **save-api-table <filename>**
749 Dumps the API message table to /tmp/<filename>.
751 **Example:** save-api-table apiTrace-07-04.txt
753 Typically, one simply enables the API message trace scheme:
762 Command line Buffer configuration controls buffer management.
764 * **memory-size-in-mb <n>**
765 Configure the memory size used for buffers. If not set, VPP defaults
768 **Example:** memory-size-in-mb 64
776 The circular journal (CJ) thread-safe circular log buffer scheme is
777 occasionally useful when chasing bugs. Calls to it should not be checked in.
778 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
779 When enabled, the number of records must be provided, there is no default
783 Configure the number of circular journal records in the circular buffer.
784 The number of records should be a power of 2.
786 **Example:** records 131072
789 Turns on logging at the earliest possible moment.
798 * **max-cache-size <n>**
810 "heapsize" Parameters
811 _____________________
813 Heapsize configuration controls the size of the main heap. The heap size is
814 configured very early in the boot sequence, before loading plug-ins or doing
815 much of anything else.
817 * **heapsize <n>M|<n>G**
818 Specifies the size of the heap in MB or GB. The default is 1GB. Setting the
819 main heap size to 4GB or more requires recompilation of the entire system
820 with CLIB_VEC64 > 0. See .../clib/clib/vec_bootstrap.h.
822 **Example:** heapsize 2G
829 IPv4 heap configuration. he heap size is configured very early in the boot
830 sequence, before loading plug-ins or doing much of anything else.
832 * **heap-size <n>G|<n>M|<n>K|<n>**
833 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
834 the destination IP lookup table. The input value can be set in GB, MB, KB
835 or bytes. The default value is 32MB.
837 **Example:** heap-size 64M
844 IPv6 heap configuration. he heap size is configured very early in the boot
845 sequence, before loading plug-ins or doing much of anything else.
848 * **heap-size <n>G|<n>M|<n>K|<n>**
849 Set the IPv6 forwarding table heap size. The input value can be set in GB,
850 MB, KB or bytes. The default value is 32MB.
852 **Example:** heap-size 64M
854 * **hash-buckets <n>**
855 Set the number of IPv6 forwarding table hash buckets. The default value is
858 **Example:** hash-buckets 131072
865 Configure Layer 2 MAC Address learning parameters.
868 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
869 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
870 4M entries (4194304).
872 **Example:** limit 8388608
879 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
880 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
881 are mutually exclusive:
884 Lookup tunnel by IPv6 source address.
886 **Example:** lookup-v6-src
889 Lookup tunnel by IPv6 destination address.
891 **Example:** lookup-v6-dst
893 * **lookup-session-id**
894 Lookup tunnel by L2TPv3 session identifier.
896 **Example:** lookup-session-id
908 * **unthrottle-time <n>**
913 * **default-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
918 * **default-syslog-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
928 * **lookup-table-buckets <n>**
933 * **lookup-table-memory <n>G|<n>M|<n>K|<n>**
935 The input value can be set in GB, MB, KB or bytes. The default value is 256KB.
939 * **timezone_offset <n>**
952 **Example:** customer edge
961 * **interface <name>**
971 * **max-n-bytes <n>**
976 * **min-n-bytes <n>**
999 **Example:** no-validate
1001 * **min-delay <n.n>**
1006 * **max-delay <n.n>**
1014 **Example:** no-delay
1016 * **n-packets <n.n>**
1027 * **translation hash buckets <n>**
1032 * **translation hash memory <n>**
1037 * **user hash buckets <n>**
1042 * **user hash memory <n>**
1047 * **max translations per user <n>**
1052 * **outside VRF id <n>**
1057 * **outside ip6 VRF id <n>**
1062 * **inside VRF id <n>**
1067 * **inside VRF id <n>**
1072 * **static mapping only**
1075 **Example:** static mapping only
1077 * **connection tracking**
1080 **Example:** connection tracking
1085 **Example:** deterministic
1087 * **nat64 bib hash buckets <n>**
1092 * **nat64 bib hash memory <n>**
1097 * **nat64 st hash buckets <n>**
1102 * **nat64 st hash memory <n>**
1110 **Example:** out2in dpo
1115 **Example:** dslite ce
1117 * **endpoint-dependent**
1120 **Example:** endpoint-dependent
1127 OAM configuration controls the (ip4-icmp) interval, and number of misses
1128 allowed before reporting an oam target down to any registered listener.
1130 * **interval <n.n>**
1131 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1132 Default is 2.04 seconds.
1134 **Example:** interval 3.5
1136 * **misses-allowed <n>**
1137 Number of misses before declaring an OAM target down. Default is 3 misses.
1139 **Example:** misses-allowed 5
1143 "plugins" Parameters
1144 ____________________
1145 A plugin can be disabled by default. It may still be in an experimental phase
1146 or only be needed in special circumstances. If this is the case, the plugin can
1147 be explicitely enabled in *'startup.conf'*. Also, a plugin that is enabled by
1148 default can be explicitely disabled in *'startup.conf'*.
1150 Another useful use of this section is to disable all the plugins, then enable
1151 only the plugins that are desired.
1154 Adjust the plugin path depending on where the VPP plugins are installed.
1156 **Example:** path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1158 * **name-filter <filter-name>**
1163 * **vat-path <path>**
1168 * **vat-name-filter <filter-name>**
1173 * **plugin <plugin.so> { .. }**
1174 Configure parameters for a given plugin. Valid parameters are as follows:
1177 Enable the given plugin.
1179 Disable the given plugin.
1180 * **skip-version-check**
1181 In the plugin registration, if *'.version_required'* is set, the
1182 plugin will not be loaded if there is version mismatch between
1183 plugin and VPP. This can be bypassed by setting "skip-version-check"
1184 for specific plugin.
1186 **Example:** plugin ila_plugin.so { enable skip-version-check }
1188 * **plugin default { .. }**
1189 Set the default behavior for all plugins. Valid parameters are as follows:
1192 Disable all plugins.
1195 | plugin default { disable }
1196 | plugin dpdk_plugin.so { enable }
1197 | plugin acl_plugin.so { enable }
1201 "plugin_path" Parameters
1202 ________________________
1204 Alternate syntax to choose plugin path. Plugin_path configuration controls the
1205 set of directories searched for vlib plugins. Supply a colon-separated list of
1206 (absolute) directory names: plugin_path dir1:dir2:...:dirN
1208 **Example:** plugin_path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1222 "session" Parameters
1223 ____________________
1225 * **event-queue-length <n>**
1230 * **preallocated-sessions <n>**
1235 * **v4-session-table-buckets <n>**
1240 * **v4-halfopen-table-buckets <n>**
1245 * **v6-session-table-buckets <n>**
1250 * **v6-halfopen-table-buckets <n>**
1255 * **v4-session-table-memory <n>G|<n>M|<n>K|<n>**
1257 The input value can be set in GB, MB, KB or bytes.
1261 * **v4-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1263 The input value can be set in GB, MB, KB or bytes.
1267 * **v6-session-table-memory <n>G|<n>M|<n>K|<n>**
1269 The input value can be set in GB, MB, KB or bytes.
1273 * **v6-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1275 The input value can be set in GB, MB, KB or bytes.
1279 * **local-endpoints-table-memory <n>G|<n>M|<n>K|<n>**
1281 The input value can be set in GB, MB, KB or bytes.
1285 * **local-endpoints-table-buckets <n>**
1290 * **evt_qs_memfd_seg**
1293 **Example:** evt_qs_memfd_seg
1297 "socketsvr" Parameters
1298 ______________________
1300 Create a socket server for API server (.../vlibmemory/socksvr_vlib.c.).
1301 If not set, API server doesn't run.
1303 * **socket-name <filename>**
1304 Configure API socket filename.
1306 **Example:** socket-name /run/vpp/vpp-api.sock
1309 Use the default API socket (/run/vpp-api.sock).
1311 **Example:** default
1318 Create a socket server for *'stats'* poller. If not set, 'stats'* poller
1321 * **socket-name <filename>**
1322 Configure *'stats'* socket filename.
1324 **Example:** socket-name /run/vpp/stats.sock
1327 Use the default *'stats'* socket (/run/vpp/stats.sock).
1329 **Example:** default
1333 "statseg" Parameters
1334 ____________________
1336 * **size <n>G|<n>M|<n>K|<n>**
1338 The input value can be set in GB, MB, KB or bytes.
1355 **Example:** disable
1362 * **preallocated-connections <n>**
1367 * **preallocated-half-open-connections <n>**
1372 * **buffer-fail-fraction <n.n>**
1382 * **se-test-cert-in-ca**
1385 **Example:** se-test-cert-in-ca
1387 * **ca-cert-path <filename>**
1389 If not set, the default is set to *'/etc/ssl/certs/ca-certificates.crt'*.
1398 The "tuntap" driver configures a point-to-point interface between the vpp
1399 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1400 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1401 is currently disabled by default. To [dynamically] create TAP interfaces - the
1402 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1403 "vnet" interface needs to manually configure, and VLAN and other settings if
1406 * **enable|disable**
1407 Enable or disable the tun/tap driver.
1411 * **ethernet|ether**
1412 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1413 tunnel). The two keywords are aliases for the same function.
1415 **Example:** ethernet
1417 * **have-normal-interface|have-normal**
1418 Treat the host Linux stack as a routing peer instead of programming VPP
1419 interface L3 addresses onto the tun/tap devices. The two keywords are
1420 aliases for the same function.
1422 **Example:** have-normal-interface
1425 Assign name to the tun/tap device.
1427 **Example:** name vpp1
1429 Here's a typical multiple parameter invocation:
1431 | tuntap { ethernet have-normal-interface name vpp1 }
1435 "vhost-user" Parameters
1436 _______________________
1438 Vhost-user configuration parameters control the vhost-user driver.
1440 * **coalesce-frames <n>**
1441 Subject to deadline-timer expiration - see next item - attempt to transmit
1442 at least <n> packet frames. Default is 32 frames.
1444 **Example:** coalesce-frames 64
1446 * **coalesce-time <seconds>**
1447 Hold packets no longer than (floating-point) seconds before transmitting
1448 them. Default is 0.001 seconds
1450 **Example:** coalesce-time 0.002
1452 * **dont-dump-memory**
1453 vhost-user shared-memory segments can add up to a large amount of memory, so
1454 it's handy to avoid adding them to corefiles when using a significant number
1457 **Example:** dont-dump-memory
1467 **Example:** memory-trace
1469 * **elog-events <n>**
1474 * **elog-post-mortem-dump**
1477 **Example:** elog-post-mortem-dump
Code Review / vpp.git / blob