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 These parameters change the configuration of the ACL (access control list) plugin,
589 such as how the ACL bi-hash tables are initialized.
591 They should only be set by those that are familiar with the interworkings of VPP
594 The first three parameters, *connection hash buckets*, *connection hash memory*,
595 and *connection count max*, set the **connection table per-interface parameters**
596 for modifying how the two bounded-index extensible hash tables for
597 IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
598 (16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
601 * **connection hash buckets <n>**
602 Sets the number of hash buckets (rounded up to a power of 2) in each
603 of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
605 **Example:** connection hash buckets 65536
607 * **connection hash memory <n>**
608 Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
609 Defaults to 1073741824 bytes.
611 **Example:** connection hash memory 1073741824
613 * **connection count max <n>**
614 Sets the maximum number of pool elements when allocating each per-worker
615 pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
617 **Example:** connection count max 500000
619 * **main heap size <n>G|<n>M|<n>K|<n>**
620 Sets the size of the main memory heap that holds all the ACL module related
621 allocations (other than hash.) Default size is 0, but during
622 ACL heap initialization is equal to
623 *per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
624 Note that these variables are partially based on the
625 **connection table per-interface parameters** mentioned above.
627 **Example:** main heap size 3G
629 The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
630 and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
631 table used by the ACL plugin. This table is initialized when attempting to apply
632 an ACL to the existing vector of ACLs looked up during packet processing
633 (but it is found that the table does not exist / has not been initialized yet.)
635 * **hash lookup heap size <n>G|<n>M|<n>K|<n>**
636 Sets the size of the memory heap that holds all the miscellaneous allocations
637 related to hash-based lookups. Default size is 67108864 bytes.
639 **Example:** hash lookup heap size 70M
641 * **hash lookup hash buckets <n>**
642 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
643 lookup table. Defaults to 65536 hash buckets.
645 **Example:** hash lookup hash buckets 65536
647 * **hash lookup hash memory <n>**
648 Sets the allocated memory size (in bytes) for the bi-hash lookup table.
649 Defaults to 67108864 bytes.
651 **Example:** hash lookup hash memory 67108864
653 * **use tuple merge <n>**
654 Sets a boolean value indicating whether or not to use TupleMerge
655 for hash ACL's. Defaults to 1 (true), meaning the default implementation
656 of hashing ACL's **does use** TupleMerge.
658 **Example:** use tuple merge 1
660 * **tuple merge split threshold <n>**
661 Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
662 lookup table before the table is split into two new tables. Splitting ensures
663 less rule collisions by hashing colliding rules based on their common tuple
664 (usually their maximum common tuple.) Splitting occurs when the
665 *length of the colliding rules vector* is greater than this threshold amount.
666 Defaults to a maximum of 39 rule collisions per table.
668 **Example:** tuple merge split threshold 30
670 * **reclassify sessions <n>**
671 Sets a boolean value indicating whether or not to take the epoch of the session
672 into account when dealing with re-applying ACL's or changing already applied ACL's.
673 Defaults to 0 (false), meaning the default implementation **does NOT** take the
674 epoch of the session into account.
676 **Example:** reclassify sessions 1
680 "api-queue" Parameters
681 ______________________
683 The following parameters should only be set by those that are familiar with the
684 interworkings of VPP.
687 Sets the api queue length. Minimum valid queue length is 1024, which is
690 **Example:** length 2048
694 "api-segment" Parameters
695 ________________________
697 These values control various aspects of the binary API interface to VPP.
700 Sets the prefix prepended to the name used for shared memory (SHM)
701 segments. The default is empty, meaning shared memory segments are created
702 directly in the SHM directory *'/dev/shm'*. It is worth noting that on
703 many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
704 system; Ubuntu links it to *'/run/shm'*.
706 **Example:** prefix /run/shm
708 * **uid <number|name>**
709 Sets the user ID or name that should be used to set the ownership of the
710 shared memory segments. Defaults to the same user that VPP is started
713 **Example:** uid root
715 * **gid <number|name>**
716 Sets the group ID or name that should be used to set the ownership of the
717 shared memory segments. Defaults to the same group that VPP is started
722 The following parameters should only be set by those that are familiar with the
723 interworkings of VPP.
726 Set the base address for SVM global region. If not set, on AArch64, the
727 code will try to determine the base address. All other default to
730 **Example:** baseva 0x20000000
732 * **global-size <n>G|<n>M|<n>**
733 Set the global memory size, memory shared across all router instances,
734 packet buffers, etc. If not set, defaults to 64M. The input value can be
735 set in GB, MB or bytes.
737 **Example:** global-size 2G
739 * **global-pvt-heap-size <n>M|size <n>**
740 Set the size of the global VM private mheap. If not set, defaults to 128k.
741 The input value can be set in MB or bytes.
743 **Example:** global-pvt-heap-size size 262144
745 * **api-pvt-heap-size <n>M|size <n>**
746 Set the size of the api private mheap. If not set, defaults to 128k.
747 The input value can be set in MB or bytes.
749 **Example:** api-pvt-heap-size 1M
751 * **api-size <n>M|<n>G|<n>**
752 Set the size of the API region. If not set, defaults to 16M. The input
753 value can be set in GB, MB or bytes.
755 **Example:** api-size 64M
759 "api-trace" Parameters
760 ______________________
762 The ability to trace, dump, and replay control-plane API traces makes all the
763 difference in the world when trying to understand what the control-plane has
764 tried to ask the forwarding-plane to do.
767 Enable API trace capture from the beginning of time, and arrange for a
768 post-mortem dump of the API trace if the application terminates abnormally.
769 By default, the (circular) trace buffer will be configured to capture
770 256K traces. The default *'startup.conf'* file has trace enabled by default,
771 and unless there is a very strong reason, it should remain enabled.
776 Configure the circular trace buffer to contain the last <n> entries. By
777 default, the trace buffer captures the last 256K API messages received.
779 **Example:** nitems 524288
781 * **save-api-table <filename>**
782 Dumps the API message table to /tmp/<filename>.
784 **Example:** save-api-table apiTrace-07-04.txt
786 Typically, one simply enables the API message trace scheme:
795 Command line Buffer configuration controls buffer management.
797 * **memory-size-in-mb <n>**
798 Configure the memory size used for buffers. If not set, VPP defaults
801 **Example:** memory-size-in-mb 64
809 The circular journal (CJ) thread-safe circular log buffer scheme is
810 occasionally useful when chasing bugs. Calls to it should not be checked in.
811 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
812 When enabled, the number of records must be provided, there is no default
816 Configure the number of circular journal records in the circular buffer.
817 The number of records should be a power of 2.
819 **Example:** records 131072
822 Turns on logging at the earliest possible moment.
831 * **max-cache-size <n>**
832 Set the maximum number of active elements allowed in the pool of
833 dns cache entries. When resolving an expired entry or adding a new
834 static entry and the max number of active entries is reached,
835 a random, non-static entry is deleted. Defaults to 65535 entries.
837 **Example:** max-cache-size 65535
840 Currently not implemented. Defaults to 86400 seconds (24 hours.)
842 **Example:** max-ttl 86400
846 "heapsize" Parameters
847 _____________________
849 Heapsize configuration controls the size of the main heap. The heap size is
850 configured very early in the boot sequence, before loading plug-ins or doing
851 much of anything else.
853 * **heapsize <n>M|<n>G**
854 Specifies the size of the heap in MB or GB. The default is 1GB. Setting the
855 main heap size to 4GB or more requires recompilation of the entire system
856 with CLIB_VEC64 > 0. See .../clib/clib/vec_bootstrap.h.
858 **Example:** heapsize 2G
865 IPv4 heap configuration. he heap size is configured very early in the boot
866 sequence, before loading plug-ins or doing much of anything else.
868 * **heap-size <n>G|<n>M|<n>K|<n>**
869 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
870 the destination IP lookup table. The input value can be set in GB, MB, KB
871 or bytes. The default value is 32MB.
873 **Example:** heap-size 64M
880 IPv6 heap configuration. he heap size is configured very early in the boot
881 sequence, before loading plug-ins or doing much of anything else.
884 * **heap-size <n>G|<n>M|<n>K|<n>**
885 Set the IPv6 forwarding table heap size. The input value can be set in GB,
886 MB, KB or bytes. The default value is 32MB.
888 **Example:** heap-size 64M
890 * **hash-buckets <n>**
891 Set the number of IPv6 forwarding table hash buckets. The default value is
894 **Example:** hash-buckets 131072
901 Configure Layer 2 MAC Address learning parameters.
904 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
905 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
906 4M entries (4194304).
908 **Example:** limit 8388608
915 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
916 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
917 are mutually exclusive:
920 Lookup tunnel by IPv6 source address.
922 **Example:** lookup-v6-src
925 Lookup tunnel by IPv6 destination address.
927 **Example:** lookup-v6-dst
929 * **lookup-session-id**
930 Lookup tunnel by L2TPv3 session identifier.
932 **Example:** lookup-session-id
944 * **unthrottle-time <n>**
949 * **default-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
954 * **default-syslog-log-level emerg|alertcrit|err|warn|notice|info|debug|disabled**
964 * **lookup-table-buckets <n>**
965 Sets the number of hash buckets in the mactime bi-hash lookup table.
966 Defaults to 128 buckets.
968 **Example:** lookup-table-buckets 128
970 * **lookup-table-memory <n>G|<n>M|<n>K|<n>**
971 Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
972 The input value can be set in GB, MB, KB or bytes. The default value is 262144
973 (256 << 10) bytes or roughly 256KB.
975 **Example:** lookup-table-memory 300K
977 * **timezone_offset <n>**
978 Sets the timezone offset from UTC. Defaults to an offset of -5 hours
979 from UTC (US EST / EDT.)
981 **Example:** timezone_offset -5
989 Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
990 router. The boolean defaults to false, meaning the MAP node is not treated
993 **Example:** customer edge
1002 * **interface <name>**
1012 * **max-n-bytes <n>**
1017 * **min-n-bytes <n>**
1035 **Example:** verbose
1040 **Example:** no-validate
1042 * **min-delay <n.n>**
1047 * **max-delay <n.n>**
1055 **Example:** no-delay
1057 * **n-packets <n.n>**
1068 These parameters change the configuration of the NAT (Network address translation)
1069 plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
1070 endpoint dependent, or if the NAT is deterministic.
1072 For each NAT per thread data, the following 4 parameters change how certain
1073 bi-hash tables are initialized.
1075 * **translation hash buckets <n>**
1076 Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
1077 tables. Defaults to 1024 buckets.
1079 If the NAT is indicated to be endpoint dependent, which can be set with the
1080 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets
1081 the number of hash buckets in each of the two endpoint dependent sessions
1082 NAT bi-hash lookup tables.
1084 **Example:** translation hash buckets 1024
1086 * **translation hash memory <n>**
1087 Sets the allocated memory size (in bytes) for each of the two in/out NAT
1088 bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
1090 If the NAT is indicated to be endpoint dependent, which can be set with the
1091 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets the
1092 allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
1095 **Example:** translation hash memory 134217728
1097 * **user hash buckets <n>**
1098 Sets the number of hash buckets in the user bi-hash lookup table
1099 (src address lookup for a user.) Defaults to 128 buckets.
1101 **Example:** user hash buckets 128
1103 * **user hash memory <n>**
1104 Sets the allocated memory size (in bytes) for the user bi-hash lookup table
1105 (src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
1106 which is roughly 64 MB.
1108 **Example:** user hash memory 67108864
1110 * **max translations per user <n>**
1111 Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
1112 Defaults to 100. When this limit is reached, the least recently used translation
1115 **Example:** max translations per user 50
1117 * **outside VRF id <n>**
1122 * **outside ip6 VRF id <n>**
1127 * **inside VRF id <n>**
1132 * **inside VRF id <n>**
1137 * **static mapping only**
1140 **Example:** static mapping only
1142 * **connection tracking**
1145 **Example:** connection tracking
1148 Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
1149 meaning the NAT is not deterministic.
1151 **Example:** deterministic
1153 * **nat64 bib hash buckets <n>**
1154 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
1155 tables. Defaults to 1024 buckets.
1157 **Example:** nat64 bib hash buckets 1024
1159 * **nat64 bib hash memory <n>**
1160 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
1161 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
1162 which is roughly 128 MB.
1164 **Example:** nat64 bib hash memory 134217728
1166 * **nat64 st hash buckets <n>**
1167 Sets the number of hash buckets in each of the two in/out NAT64 session table
1168 bi-hash tables. Defaults to 2048 buckets.
1170 **Example:** nat64 st hash buckets 2048
1172 * **nat64 st hash memory <n>**
1173 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
1174 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
1177 **Example:** nat64 st hash memory 268435456
1182 **Example:** out2in dpo
1187 **Example:** dslite ce
1191 * **endpoint-dependent**
1192 Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
1193 Defaults to 0, meaning the NAT is not endpoint dependent.
1195 **Example:** endpoint-dependent
1202 OAM configuration controls the (ip4-icmp) interval, and number of misses
1203 allowed before reporting an oam target down to any registered listener.
1205 * **interval <n.n>**
1206 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1207 Default is 2.04 seconds.
1209 **Example:** interval 3.5
1211 * **misses-allowed <n>**
1212 Number of misses before declaring an OAM target down. Default is 3 misses.
1214 **Example:** misses-allowed 5
1218 "plugins" Parameters
1219 ____________________
1221 A plugin can be disabled by default. It may still be in an experimental phase
1222 or only be needed in special circumstances. If this is the case, the plugin can
1223 be explicitely enabled in *'startup.conf'*. Also, a plugin that is enabled by
1224 default can be explicitely disabled in *'startup.conf'*.
1226 Another useful use of this section is to disable all the plugins, then enable
1227 only the plugins that are desired.
1230 Adjust the plugin path depending on where the VPP plugins are installed.
1232 **Example:** path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1234 * **name-filter <filter-name>**
1239 * **vat-path <path>**
1244 * **vat-name-filter <filter-name>**
1249 * **plugin <plugin.so> { .. }**
1250 Configure parameters for a given plugin. Valid parameters are as follows:
1253 Enable the given plugin.
1255 Disable the given plugin.
1256 * **skip-version-check**
1257 In the plugin registration, if *'.version_required'* is set, the
1258 plugin will not be loaded if there is version mismatch between
1259 plugin and VPP. This can be bypassed by setting "skip-version-check"
1260 for specific plugin.
1262 **Example:** plugin ila_plugin.so { enable skip-version-check }
1264 * **plugin default { .. }**
1265 Set the default behavior for all plugins. Valid parameters are as follows:
1268 Disable all plugins.
1271 | plugin default { disable }
1272 | plugin dpdk_plugin.so { enable }
1273 | plugin acl_plugin.so { enable }
1277 "plugin_path" Parameters
1278 ________________________
1280 Alternate syntax to choose plugin path. Plugin_path configuration controls the
1281 set of directories searched for vlib plugins. Supply a colon-separated list of
1282 (absolute) directory names: plugin_path dir1:dir2:...:dirN
1284 **Example:** plugin_path /home/bms/vpp/build-root/install-vpp-native/vpp/lib64/vpp_plugins
1291 Configuration parameters for the local TCP/IP stack punt infrastructure.
1294 The filesystem pathname of a bound UNIX domain socket to be used with punt.
1300 "session" Parameters
1301 ____________________
1303 * **event-queue-length <n>**
1308 * **preallocated-sessions <n>**
1313 * **v4-session-table-buckets <n>**
1318 * **v4-halfopen-table-buckets <n>**
1323 * **v6-session-table-buckets <n>**
1328 * **v6-halfopen-table-buckets <n>**
1333 * **v4-session-table-memory <n>G|<n>M|<n>K|<n>**
1335 The input value can be set in GB, MB, KB or bytes.
1339 * **v4-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1341 The input value can be set in GB, MB, KB or bytes.
1345 * **v6-session-table-memory <n>G|<n>M|<n>K|<n>**
1347 The input value can be set in GB, MB, KB or bytes.
1351 * **v6-halfopen-table-memory <n>G|<n>M|<n>K|<n>**
1353 The input value can be set in GB, MB, KB or bytes.
1357 * **local-endpoints-table-memory <n>G|<n>M|<n>K|<n>**
1359 The input value can be set in GB, MB, KB or bytes.
1363 * **local-endpoints-table-buckets <n>**
1368 * **evt_qs_memfd_seg**
1371 **Example:** evt_qs_memfd_seg
1375 "socketsvr" Parameters
1376 ______________________
1378 Create a socket server for API server (.../vlibmemory/socksvr_vlib.c.).
1379 If not set, API server doesn't run.
1381 * **socket-name <filename>**
1382 Configure API socket filename.
1384 **Example:** socket-name /run/vpp/vpp-api.sock
1387 Use the default API socket (/run/vpp-api.sock).
1389 **Example:** default
1396 Create a socket server for *'stats'* poller. If not set, 'stats'* poller
1399 * **socket-name <filename>**
1400 Configure *'stats'* socket filename.
1402 **Example:** socket-name /run/vpp/stats.sock
1405 Use the default *'stats'* socket (/run/vpp/stats.sock).
1407 **Example:** default
1411 "statseg" Parameters
1412 ____________________
1414 * **size <n>G|<n>M|<n>K|<n>**
1415 Sets the size of the memory mapped stats segment object *stat_segment*.
1416 The input value can be set in GB, MB, KB or bytes. Defaults to 33554432
1417 (32 << 20) bytes or roughly 32 MB.
1419 **Example:** size 32M
1426 Configuration parameters for TAPCLI (dynamic tap interface hookup.)
1429 Sets interface MTU (maximum transmission unit) size in bytes. This size
1430 is also related to the number of MTU buffers. Defaults to 1500 bytes.
1432 **Example:** mtu 1500
1435 Disables TAPCLI. Default is that TAPCLI is enabled.
1437 **Example:** disable
1444 Configuration parameters for TCP host stack utilities. The following
1445 preallocation parameters are related to the initialization of fixed-size,
1446 preallocation pools.
1448 * **preallocated-connections <n>**
1449 Sets the number of preallocated TCP connections. Defaults to 0.
1450 The preallocated connections per thread is related to this value,
1451 equal to (preallocated_connections / (num_threads - 1)).
1453 **Example:** preallocated-connections 5
1455 * **preallocated-half-open-connections <n>**
1456 Sets the number of preallocated TCP half-open connections. Defaults to 0.
1458 **Example:** preallocated-half-open-connections 5
1460 * **buffer-fail-fraction <n.n>**
1461 Sets the TCP buffer fail fraction (a float) used for fault-injection
1462 when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
1465 **Example:** buffer-fail-fraction 0.0
1472 Configures TLS parameters, such as enabling the use of test certificates.
1473 These parameters affect the tlsmbedtls and tlsopenssl plugins.
1475 * **use-test-cert-in-ca**
1476 Sets a boolean value to 1 to indicate during the initialization of a
1477 TLS CA chain to attempt to parse and add test certificates to the chain.
1478 Defaults to 0, meaning test certificates are not used.
1480 **Example:** use-test-cert-in-ca
1482 * **ca-cert-path <filename>**
1483 Sets the filename path of the location of TLS CA certificates, used when
1484 initializing and loading TLS CA certificates during the initialization
1485 of a TLS CA chain. If not set, the default filename path is
1486 */etc/ssl/certs/ca-certificates.crt*.
1488 **Example:** ca-cert-path /etc/ssl/certs/ca-certificates.crt
1495 The "tuntap" driver configures a point-to-point interface between the vpp
1496 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1497 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1498 is currently disabled by default. To [dynamically] create TAP interfaces - the
1499 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1500 "vnet" interface needs to manually configure, and VLAN and other settings if
1503 * **enable|disable**
1504 Enable or disable the tun/tap driver.
1508 * **ethernet|ether**
1509 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1510 tunnel). The two keywords are aliases for the same function.
1512 **Example:** ethernet
1514 * **have-normal-interface|have-normal**
1515 Treat the host Linux stack as a routing peer instead of programming VPP
1516 interface L3 addresses onto the tun/tap devices. The two keywords are
1517 aliases for the same function.
1519 **Example:** have-normal-interface
1522 Assign name to the tun/tap device.
1524 **Example:** name vpp1
1526 Here's a typical multiple parameter invocation:
1528 | tuntap { ethernet have-normal-interface name vpp1 }
1532 "vhost-user" Parameters
1533 _______________________
1535 Vhost-user configuration parameters control the vhost-user driver.
1537 * **coalesce-frames <n>**
1538 Subject to deadline-timer expiration - see next item - attempt to transmit
1539 at least <n> packet frames. Default is 32 frames.
1541 **Example:** coalesce-frames 64
1543 * **coalesce-time <seconds>**
1544 Hold packets no longer than (floating-point) seconds before transmitting
1545 them. Default is 0.001 seconds
1547 **Example:** coalesce-time 0.002
1549 * **dont-dump-memory**
1550 vhost-user shared-memory segments can add up to a large amount of memory, so
1551 it's handy to avoid adding them to corefiles when using a significant number
1554 **Example:** dont-dump-memory
1561 These parameters configure VLIB, such as allowing you to choose whether to
1562 enable memory traceback or a post-mortem elog dump.
1565 Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
1568 **Example:** memory-trace
1570 * **elog-events <n>**
1571 Sets the number of elements/events (the size) of the event ring
1572 (a circular buffer of events.) This number rounds to a power of 2.
1573 Defaults to 131072 (128 << 10) elements.
1575 **Example:** elog-events 4096
1577 * **elog-post-mortem-dump**
1578 Enables the attempt of a post-mortem elog dump to
1579 */tmp/elog_post_mortem.<PID_OF_CALLING_PROCESS>* if os_panic or
1582 **Example:** elog-post-mortem-dump
Code Review / vpp.git / blob