3 ==========================================
4 VPP Configuration - CLI and 'startup.conf'
5 ==========================================
7 After a successful installation, VPP installs a startup config file named
8 *startup.conf* in the */etc/vpp/* directory. This file can be tailored to
9 make VPP run as desired, but contains default values for typical installations.
11 Below are more details about this file and some of the the parameters and values
14 Command-line Arguments
15 ----------------------
17 Before we describe details of the startup configuration file (startup.conf) it
18 should be mentioned that VPP can be started without a startup configuration
21 Parameters are grouped by a section name. When providing more than one
22 parameter to a section, all parameters for that section must be wrapped in
23 curly braces. For example, to start VPP with configuration data via the
24 command line with the section name *'unix'*:
26 .. code-block:: console
28 $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
30 The command line can be presented as a single string or as several; anything
31 given on the command line is concatenated with spaces into a single string
32 before parsing. VPP applications must be able to locate their own executable
33 images. The simplest way to ensure this will work is to invoke a VPP
34 application by giving its absolute path. For example:
35 *'/usr/bin/vpp <options>'* At startup, VPP applications parse through their
36 own ELF-sections [primarily] to make lists of init, configuration, and exit
39 When developing with VPP, in gdb it's often sufficient to start an application
42 .. code-block:: console
44 (gdb) run unix interactive
47 Startup Configuration File (startup.conf)
48 -----------------------------------------
50 The more typical way to specify the startup configuration to VPP is with the
51 startup configuration file (startup.conf).
53 The path of the file is provided to the VPP application on the command line.
54 This is typically at /etc/vpp/startup.conf. If VPP is installed as a package
55 a default startup.conf file is provided at this location.
57 The format of the configuration file is a simple text file with the same content
60 **A very simple startup.conf file:**
62 .. code-block:: console
64 $ cat /etc/vpp/startup.conf
67 log /var/log/vpp/vpp.log
69 cli-listen localhost:5002
80 VPP is instructed to load this file with the -c option. For example:
82 .. code-block:: console
84 $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
86 Configuration Parameters
87 ------------------------
89 Below is the list of some section names and their associated parameters.
90 This is not an exhaustive list, but should give you an idea of how VPP can be configured.
92 For all of the configuration parameters search the source code for instances of
93 **VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION**.
95 For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
96 cause the function *'foo_config'* to receive all parameters given in a
97 parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
102 Configures VPP startup and behavior type attributes, as well and any OS based
105 .. code-block:: console
109 log /var/log/vpp/vpp.log
111 cli-listen /run/vpp/cli.sock
118 Do not fork / background the vpp process. Typical when invoking VPP
119 applications from a process monitor. Set by default in the default
120 *'startup.conf'* file.
122 .. code-block:: console
129 Disable syslog and log errors to stderr instead. Typical when invoking
130 VPP applications from a process monitor like runit or daemontools that
131 pipe service's output to a dedicated log service, which will typically
132 attach a timestamp and rotate the logs as necessary.
134 .. code-block:: console
141 Attach CLI to stdin/out and provide a debugging command line interface.
143 .. code-block:: console
150 Logs the startup configuration and all subsequent CLI commands in filename.
151 Very useful in situations where folks don't remember or can't be bothered
152 to include CLI commands in bug reports. The default *'startup.conf'* file
153 is to write to *'/var/log/vpp/vpp.log'*.
155 In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
156 to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
157 However, if SELinux is enabled, then the new location is required for the file
158 to be properly labeled. Check your local *'startup.conf'* file for the log file
159 location on your system.
161 .. code-block:: console
163 log /var/log/vpp/vpp-debug.log
165 exec | startup-config <filename>
166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
168 Read startup operational configuration from filename. The contents of the file
169 will be performed as though entered at the CLI. The two keywords are aliases
170 for the same function; if both are specified, only the last will have an effect.
172 A file of CLI commands might look like:
174 .. code-block:: console
176 $ cat /usr/share/vpp/scripts/interface-up.txt
177 set interface state TenGigabitEthernet1/0/0 up
178 set interface state TenGigabitEthernet1/0/1 up
182 .. code-block:: console
184 startup-config /usr/share/vpp/scripts/interface-up.txt
189 Sets the effective group ID to the input group ID or group name of the calling
192 .. code-block:: console
199 Ask the Linux kernel to dump all memory-mapped address regions, instead of
202 .. code-block:: console
206 coredump-size unlimited | <n>G | <n>M | <n>K | <n>
207 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
209 Set the maximum size of the coredump file. The input value can be set in
210 GB, MB, KB or bytes, or set to *'unlimited'*.
212 .. code-block:: console
214 coredump-size unlimited
216 cli-listen <ipaddress:port> | <socket-path>
217 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
219 Bind the CLI to listen at address localhost on TCP port 5002. This will
220 accept an ipaddress:port pair or a filesystem path; in the latter case a
221 local Unix socket is opened instead. The default *'startup.conf'* file
222 is to open the socket *'/run/vpp/cli.sock'*.
224 .. code-block:: console
226 cli-listen localhost:5002
227 cli-listen /run/vpp/cli.sock
232 Disable character-by-character I/O on stdin. Useful when combined with,
233 for example, emacs M-x gud-gdb.
235 .. code-block:: console
242 Configure the CLI prompt to be string.
244 .. code-block:: console
248 cli-history-limit <n>
249 ^^^^^^^^^^^^^^^^^^^^^
251 Limit command history to <n> lines. A value of 0 disables command history.
254 .. code-block:: console
256 cli-history-limit 100
261 Disable the login banner on stdin and Telnet connections.
263 .. code-block:: console
270 Disable the output pager.
272 .. code-block:: console
276 cli-pager-buffer-limit <n>
277 ^^^^^^^^^^^^^^^^^^^^^^^^^^
279 Limit pager buffer to <n> lines of output. A value of 0 disables the
280 pager. Default value: 100000
282 .. code-block:: console
284 cli-pager-buffer-limit 5000
289 Set the runtime directory, which is the default location for certain
290 files, like socket files. Default is based on User ID used to start VPP.
291 Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
292 defaults to *'/run/user/<uid>/vpp/'*.
294 .. code-block:: console
301 Add a fixed-sleep between main loop poll. Default is 0, which is not to
304 .. code-block:: console
311 Writes the pid of the main thread in the given filename.
313 .. code-block:: console
315 pidfile /run/vpp/vpp1.pid
318 The api-trace Section
319 ---------------------
321 The ability to trace, dump, and replay control-plane API traces makes all the
322 difference in the world when trying to understand what the control-plane has
323 tried to ask the forwarding-plane to do.
325 Typically, one simply enables the API message trace scheme:
327 .. code-block:: console
336 Enable API trace capture from the beginning of time, and arrange for a
337 post-mortem dump of the API trace if the application terminates abnormally.
338 By default, the (circular) trace buffer will be configured to capture
339 256K traces. The default *'startup.conf'* file has trace enabled by default,
340 and unless there is a very strong reason, it should remain enabled.
342 .. code-block:: console
349 Configure the circular trace buffer to contain the last <n> entries. By
350 default, the trace buffer captures the last 256K API messages received.
352 .. code-block:: console
356 save-api-table <filename>
357 ^^^^^^^^^^^^^^^^^^^^^^^^^
359 Dumps the API message table to /tmp/<filename>.
361 .. code-block:: console
363 save-api-table apiTrace-07-04.txt
366 The api-segment Section
367 -----------------------
369 These values control various aspects of the binary API interface to VPP.
371 The default looks like the following:
373 .. code-block:: console
383 Sets the prefix prepended to the name used for shared memory (SHM)
384 segments. The default is empty, meaning shared memory segments are created
385 directly in the SHM directory *'/dev/shm'*. It is worth noting that on
386 many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
387 system; Ubuntu links it to *'/run/shm'*.
389 .. code-block:: console
396 Sets the user ID or name that should be used to set the ownership of the
397 shared memory segments. Defaults to the same user that VPP is started
400 .. code-block:: console
407 Sets the group ID or name that should be used to set the ownership of the
408 shared memory segments. Defaults to the same group that VPP is started
411 .. code-block:: console
415 **The following parameters should only be set by those that are familiar with the
416 interworkings of VPP.**
421 Set the base address for SVM global region. If not set, on AArch64, the
422 code will try to determine the base address. All other default to
425 .. code-block:: console
429 global-size <n>G | <n>M | <n>
430 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
432 Set the global memory size, memory shared across all router instances,
433 packet buffers, etc. If not set, defaults to 64M. The input value can be
434 set in GB, MB or bytes.
436 .. code-block:: console
440 global-pvt-heap-size <n>M | size <n>
441 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
443 Set the size of the global VM private mheap. If not set, defaults to 128k.
444 The input value can be set in MB or bytes.
446 .. code-block:: console
448 global-pvt-heap-size size 262144
450 api-pvt-heap-size <n>M | size <n>
451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
453 Set the size of the api private mheap. If not set, defaults to 128k.
454 The input value can be set in MB or bytes.
456 .. code-block:: console
460 api-size <n>M | <n>G | <n>
461 ^^^^^^^^^^^^^^^^^^^^^^^^^^
463 Set the size of the API region. If not set, defaults to 16M. The input
464 value can be set in GB, MB or bytes.
466 .. code-block:: console
473 Enables a Unix domain socket which processes binary API messages. See
474 .../vlibmemory/socket_api.c. If this parameter is not set, vpp
475 won't process binary API messages over sockets.
477 .. code-block:: console
480 # Explicitly name a socket file
481 socket-name /run/vpp/api.sock
483 # Use defaults as described below
487 The "default" keyword instructs vpp to use /run/vpp/api.sock when
488 running as root, otherwise to use /run/user/<uid>/api.sock.
493 In the VPP there is one main thread and optionally the user can create worker(s)
494 The main thread and worker thread(s) can be pinned to CPU core(s) manually or automatically
496 .. code-block:: console
500 corelist-workers 2-3,18-19
504 Manual pinning of thread(s) to CPU core(s)
505 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
510 Set logical CPU core where main thread runs, if main core is not set VPP will use
513 .. code-block:: console
520 Set logical CPU core(s) where worker threads are running
522 .. code-block:: console
524 corelist-workers 2-3,18-19
526 Automatic pinning of thread(s) to CPU core(s)
527 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
532 Sets number of CPU core(s) to be skipped (1 ... N-1), Skipped CPU core(s) are
533 not used for pinning main thread and working thread(s).
535 The main thread is automatically pinned to the first available CPU core and worker(s)
536 are pinned to next free CPU core(s) after core assigned to main thread
538 .. code-block:: console
545 Specify a number of workers to be created Workers are pinned to N consecutive
546 CPU cores while skipping "skip-cores" CPU core(s) and main thread's CPU core
548 .. code-block:: console
552 scheduler-policy other | batch | idle | fifo | rr
553 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
555 Set scheduling policy and priority of main and worker threads
557 Scheduling policy options are: other (SCHED_OTHER), batch (SCHED_BATCH)
558 idle (SCHED_IDLE), fifo (SCHED_FIFO), rr (SCHED_RR)
560 .. code-block:: console
562 scheduler-policy fifo
564 scheduler-priority number
565 ^^^^^^^^^^^^^^^^^^^^^^^^^
567 Scheduling priority is used only for "real-time policies (fifo and rr),
568 and has to be in the range of priorities supported for a particular policy
570 .. code-block:: console
572 scheduler-priority 50
577 .. code-block:: console
580 buffers-per-numa 128000
581 default data-size 2048
582 page-size default-hugepage
585 buffers-per-numa number
586 ^^^^^^^^^^^^^^^^^^^^^^^
588 Increase number of buffers allocated, needed only in scenarios with
589 large number of interfaces and worker threads. Value is per numa node.
590 Default is 16384 (8192 if running unpriviledged)
592 .. code-block:: console
594 buffers-per-numa 128000
596 default data-size number
597 ^^^^^^^^^^^^^^^^^^^^^^^^
599 Size of buffer data area, default is 2048
601 .. code-block:: console
603 default data-size 2048
608 Set the page size for buffer allocation
610 .. code-block:: console
616 page-size default-hugepage
622 .. code-block:: console
636 dev <pci-dev> | default { .. }
637 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
639 White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
640 string of the form "DDDD:BB:SS.F" where:
647 If the keyword **default** is used the values will apply to all the devices.
649 This is the same format used in the linux sysfs tree (i.e./sys/bus/pci/devices)
650 for PCI device directory names.
652 .. code-block:: console
663 Whitelist specific interface by specifying PCI address. When whitelisting specific
664 interfaces by specifying PCI address, additional custom parameters can also be
665 specified. Valid options include:
667 .. code-block:: console
675 Blacklist specific device type by specifying PCI vendor:device Whitelist entries
678 .. code-block:: console
687 .. code-block:: console
696 Number of receive queues. Also enables RSS. Default value is 1.
698 .. code-block:: console
707 Number of transmit queues. Default is equal to number of worker threads
708 or 1 if no workers treads.
710 .. code-block:: console
719 Number of descriptors in receive ring. Increasing or reducing number
720 can impact performance. Default is 1024.
722 .. code-block:: console
728 vlan-strip-offload on | off
729 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
731 VLAN strip offload mode for interface. VLAN stripping is off by default
732 for all NICs except VICs, using ENIC driver, which has VLAN stripping on
735 .. code-block:: console
738 vlan-strip-offload on|off
741 uio-driver driver-name
742 ^^^^^^^^^^^^^^^^^^^^^^
744 Change UIO driver used by VPP, Options are: igb_uio, vfio-pci, uio_pci_generic
748 .. code-block:: console
755 Disable multi-segment buffers, improves performance but disables Jumbo MTU support
757 .. code-block:: console
764 Change hugepages allocation per-socket, needed only if there is need for
765 larger number of mbufs. Default is 256M on each detected CPU socket
767 .. code-block:: console
771 no-tx-checksum-offload
772 ^^^^^^^^^^^^^^^^^^^^^^
774 Disables UDP / TCP TX checksum offload. Typically needed for use faster
775 vector PMDs (together with no-multi-seg)
777 .. code-block:: console
779 no-tx-checksum-offload
781 enable-tcp-udp-checksum
782 ^^^^^^^^^^^^^^^^^^^^^^^
784 Enable UDP / TCP TX checksum offload This is the reversed option of
785 'no-tx-checksum-offload'
787 .. code-block:: console
789 enable-tcp-udp-checksum
794 Configure VPP plugins.
796 .. code-block:: console
799 path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
800 plugin dpdk_plugin.so enable
806 Adjust the plugin path depending on where the VPP plugins are.
808 .. code-block:: console
810 path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
812 plugin plugin-name | default enable | disable
813 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
815 Disable all plugins by default and then selectively enable specific plugins
817 .. code-block:: console
819 plugin default disable
820 plugin dpdk_plugin.so enable
821 plugin acl_plugin.so enable
823 Enable all plugins by default and then selectively disable specific plugins
825 .. code-block:: console
827 plugin dpdk_plugin.so disable
828 plugin acl_plugin.so disable
833 .. code-block:: console
839 socket-name <filename>
840 ^^^^^^^^^^^^^^^^^^^^^^
842 Name of the stats segment socket defaults to /run/vpp/stats.sock.
844 .. code-block:: console
846 socket-name /run/vpp/stats.sock
851 The size of the stats segment, defaults to 32mb
853 .. code-block:: console
857 per-node-counters on | off
858 ^^^^^^^^^^^^^^^^^^^^^^^^^^
862 .. code-block:: console
866 update-interval <f64-seconds>
867 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
869 Sets the segment scrape / update interval
871 .. code-block:: console
876 Some Advanced Parameters:
877 -------------------------
883 These parameters change the configuration of the ACL (access control list) plugin,
884 such as how the ACL bi-hash tables are initialized.
886 They should only be set by those that are familiar with the interworkings of VPP
889 The first three parameters, *connection hash buckets*, *connection hash memory*,
890 and *connection count max*, set the **connection table per-interface parameters**
891 for modifying how the two bounded-index extensible hash tables for
892 IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
893 (16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
896 connection hash buckets <n>
897 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
899 Sets the number of hash buckets (rounded up to a power of 2) in each
900 of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
902 .. code-block:: console
904 connection hash buckets 65536
906 connection hash memory <n>
907 ^^^^^^^^^^^^^^^^^^^^^^^^^^
909 Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
910 Defaults to 1073741824 bytes.
912 .. code-block:: console
914 connection hash memory 1073741824
916 connection count max <n>
917 ^^^^^^^^^^^^^^^^^^^^^^^^
919 Sets the maximum number of pool elements when allocating each per-worker
920 pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
922 .. code-block:: console
924 connection count max 500000
926 main heap size <n>G | <n>M | <n>K | <n>
927 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
929 Sets the size of the main memory heap that holds all the ACL module related
930 allocations (other than hash.) Default size is 0, but during
931 ACL heap initialization is equal to
932 *per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
933 Note that these variables are partially based on the
934 **connection table per-interface parameters** mentioned above.
936 .. code-block:: console
940 The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
941 and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
942 table used by the ACL plugin. This table is initialized when attempting to apply
943 an ACL to the existing vector of ACLs looked up during packet processing
944 (but it is found that the table does not exist / has not been initialized yet.)
946 hash lookup heap size <n>G | <n>M | <n> K | <n>
947 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
949 Sets the size of the memory heap that holds all the miscellaneous allocations
950 related to hash-based lookups. Default size is 67108864 bytes.
952 .. code-block:: console
954 hash lookup heap size 70M
956 hash lookup hash buckets <n>
957 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
959 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
960 lookup table. Defaults to 65536 hash buckets.
962 .. code-block:: console
964 hash lookup hash buckets 65536
966 hash lookup hash memory <n>
967 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
969 Sets the allocated memory size (in bytes) for the bi-hash lookup table.
970 Defaults to 67108864 bytes.
972 .. code-block:: console
974 hash lookup hash memory 67108864
979 Sets a boolean value indicating whether or not to use TupleMerge
980 for hash ACL's. Defaults to 1 (true), meaning the default implementation
981 of hashing ACL's does use TupleMerge.
983 .. code-block:: console
987 tuple merge split threshold <n>
988 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
990 Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
991 lookup table before the table is split into two new tables. Splitting ensures
992 less rule collisions by hashing colliding rules based on their common tuple
993 (usually their maximum common tuple.) Splitting occurs when the
994 *length of the colliding rules vector* is greater than this threshold amount.
995 Defaults to a maximum of 39 rule collisions per table.
997 .. code-block:: console
999 tuple merge split threshold 30
1001 reclassify sessions <n>
1002 ^^^^^^^^^^^^^^^^^^^^^^^
1004 Sets a boolean value indicating whether or not to take the epoch of the session
1005 into account when dealing with re-applying ACL's or changing already applied ACL's.
1006 Defaults to 0 (false), meaning the default implementation does NOT take the
1007 epoch of the session into account.
1009 .. code-block:: console
1011 reclassify sessions 1
1021 Sets the api queue length. Minimum valid queue length is 1024, which is
1024 .. code-block:: console
1033 The circular journal (CJ) thread-safe circular log buffer scheme is
1034 occasionally useful when chasing bugs. Calls to it should not be checked in.
1035 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
1036 When enabled, the number of records must be provided, there is no default
1042 Configure the number of circular journal records in the circular buffer.
1043 The number of records should be a power of 2.
1045 .. code-block:: console
1052 Turns on logging at the earliest possible moment.
1054 .. code-block:: console
1064 Set the maximum number of active elements allowed in the pool of
1065 dns cache entries. When resolving an expired entry or adding a new
1066 static entry and the max number of active entries is reached,
1067 a random, non-static entry is deleted. Defaults to 65535 entries.
1069 .. code-block:: console
1071 max-cache-size 65535
1080 Specifies the default MTU size for Ethernet interfaces. Must be in
1081 the range of 64-9000. The default is 9000.
1083 .. code-block:: console
1090 Heapsize configuration controls the size of the main heap. The heap size is
1091 configured very early in the boot sequence, before loading plug-ins or doing
1092 much of anything else.
1094 heapsize <n>M | <n>G
1095 ^^^^^^^^^^^^^^^^^^^^
1097 Specifies the size of the heap in MB or GB. The default is 1GB.
1099 .. code-block:: console
1106 IPv4 heap configuration. he heap size is configured very early in the boot
1107 sequence, before loading plug-ins or doing much of anything else.
1109 heap-size <n>G | <n>M | <n>K | <n>
1110 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1112 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
1113 the destination IP lookup table. The input value can be set in GB, MB, KB
1114 or bytes. The default value is 32MB.
1116 .. code-block:: console
1123 IPv6 heap configuration. he heap size is configured very early in the boot
1124 sequence, before loading plug-ins or doing much of anything else.
1127 heap-size <n>G | <n>M | <n>K | <n>
1128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1130 Set the IPv6 forwarding table heap size. The input value can be set in GB,
1131 MB, KB or bytes. The default value is 32MB.
1133 .. code-block:: console
1140 Set the number of IPv6 forwarding table hash buckets. The default value is
1143 .. code-block:: console
1150 Configure Layer 2 MAC Address learning parameters.
1155 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
1156 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
1157 4M entries (4194304).
1159 .. code-block:: console
1166 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
1167 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
1168 are mutually exclusive:
1173 Lookup tunnel by IPv6 source address.
1175 .. code-block:: console
1182 Lookup tunnel by IPv6 destination address.
1184 .. code-block:: console
1191 Lookup tunnel by L2TPv3 session identifier.
1193 .. code-block:: console
1203 Number of entries in the global logging buffer. Defaults to 512.
1205 .. code-block:: console
1212 Set the global value for the time to wait (in seconds) before resuming
1213 logging of a log subclass that exceeded the per-subclass message-per-second
1214 threshold. Defaults to 3.
1216 .. code-block:: console
1220 default-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
1221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1223 Set the default logging level of the system log. Defaults to notice.
1225 .. code-block:: console
1227 default-log-level notice
1229 default-syslog-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
1230 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1232 Set the default logging level of the syslog target. Defaults to warning.
1234 .. code-block:: console
1236 default-syslog-log-level warning
1241 lookup-table-buckets <n>
1242 ^^^^^^^^^^^^^^^^^^^^^^^^
1244 Sets the number of hash buckets in the mactime bi-hash lookup table.
1245 Defaults to 128 buckets.
1247 .. code-block:: console
1249 lookup-table-buckets 128
1251 lookup-table-memory <n>G | <n>M | <n>K | <n>
1252 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1254 Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
1255 The input value can be set in GB, MB, KB or bytes. The default value is 262144
1256 (256 << 10) bytes or roughly 256KB.
1258 .. code-block:: console
1260 lookup-table-memory 300K
1265 Sets the timezone offset from UTC. Defaults to an offset of -5 hours
1266 from UTC (US EST / EDT.)
1268 .. code-block:: console
1276 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1278 Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
1279 router. The boolean defaults to false, meaning the MAP node is not treated
1282 .. code-block:: console
1289 These parameters change the configuration of the NAT (Network address translation)
1290 plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
1291 endpoint dependent, or if the NAT is deterministic.
1293 For each NAT per thread data, the following 4 parameters change how certain
1294 bi-hash tables are initialized.
1296 translation hash buckets <n>
1297 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1299 Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
1300 tables. Defaults to 1024 buckets.
1302 If the NAT is indicated to be endpoint dependent, which can be set with the
1303 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets
1304 the number of hash buckets in each of the two endpoint dependent sessions
1305 NAT bi-hash lookup tables.
1307 .. code-block:: console
1309 translation hash buckets 1024
1311 translation hash memory <n>
1312 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1314 Sets the allocated memory size (in bytes) for each of the two in/out NAT
1315 bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
1317 If the NAT is indicated to be endpoint dependent, which can be set with the
1318 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets the
1319 allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
1322 .. code-block:: console
1324 translation hash memory 134217728
1326 user hash buckets <n>
1327 ^^^^^^^^^^^^^^^^^^^^^
1329 Sets the number of hash buckets in the user bi-hash lookup table
1330 (src address lookup for a user.) Defaults to 128 buckets.
1332 .. code-block:: console
1334 user hash buckets 128
1336 user hash memory <n>
1337 ^^^^^^^^^^^^^^^^^^^^
1339 Sets the allocated memory size (in bytes) for the user bi-hash lookup table
1340 (src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
1341 which is roughly 64 MB.
1343 .. code-block:: console
1345 user hash memory 67108864
1347 max translations per user <n>
1348 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1350 Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
1351 Defaults to 100. When this limit is reached, the least recently used translation
1354 .. code-block:: console
1356 max translations per user 50
1361 Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
1362 meaning the NAT is not deterministic.
1364 .. code-block:: console
1368 nat64 bib hash buckets <n>
1369 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1371 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
1372 tables. Defaults to 1024 buckets.
1374 .. code-block:: console
1376 nat64 bib hash buckets 1024
1378 nat64 bib hash memory <n>
1379 ^^^^^^^^^^^^^^^^^^^^^^^^^
1381 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
1382 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
1383 which is roughly 128 MB.
1385 .. code-block:: console
1387 nat64 bib hash memory 134217728
1389 nat64 st hash buckets <n>
1390 ^^^^^^^^^^^^^^^^^^^^^^^^^
1392 Sets the number of hash buckets in each of the two in/out NAT64 session table
1393 bi-hash tables. Defaults to 2048 buckets.
1395 .. code-block:: console
1397 nat64 st hash buckets 2048
1399 nat64 st hash memory <n>
1400 ^^^^^^^^^^^^^^^^^^^^^^^^
1402 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
1403 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
1406 .. code-block:: console
1408 nat64 st hash memory 268435456
1415 Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
1416 Defaults to 0, meaning the NAT is not endpoint dependent.
1418 .. code-block:: console
1425 OAM configuration controls the (ip4-icmp) interval, and number of misses
1426 allowed before reporting an oam target down to any registered listener.
1431 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1432 Default is 2.04 seconds.
1434 .. code-block:: console
1441 Configuration parameters used to specify base address and maximum size of
1442 the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
1443 growable physical memory allocator. pmalloc allocates memory for the DPDK
1449 Specify the base address for pmalloc memory space.
1451 .. code-block:: console
1453 base-addr 0xfffe00000000
1455 max-size <n>G | <n>M | <n>K | <n>
1456 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1458 Set the memory size for pmalloc memory space. The default is 16G.
1460 .. code-block:: console
1467 Configuration parameters for TAPCLI (dynamic tap interface hookup.)
1472 Sets interface MTU (maximum transmission unit) size in bytes. This size
1473 is also related to the number of MTU buffers. Defaults to 1500 bytes.
1475 .. code-block:: console
1482 Disables TAPCLI. Default is that TAPCLI is enabled.
1484 .. code-block:: console
1492 Configuration parameters for TCP host stack utilities. The following
1493 preallocation parameters are related to the initialization of fixed-size,
1494 preallocation pools.
1496 preallocated-connections <n>
1497 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1499 Sets the number of preallocated TCP connections. Defaults to 0.
1500 The preallocated connections per thread is related to this value,
1501 equal to (preallocated_connections / (num_threads - 1)).
1503 .. code-block:: console
1505 preallocated-connections 5
1507 preallocated-half-open-connections <n>
1508 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1510 Sets the number of preallocated TCP half-open connections. Defaults to 0.
1512 .. code-block:: console
1514 preallocated-half-open-connections 5
1516 buffer-fail-fraction <n.n>
1517 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1519 Sets the TCP buffer fail fraction (a float) used for fault-injection
1520 when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
1523 .. code-block:: console
1525 buffer-fail-fraction 0.0
1531 Configures TLS parameters, such as enabling the use of test certificates.
1532 These parameters affect the tlsmbedtls and tlsopenssl plugins.
1537 Sets a boolean value to 1 to indicate during the initialization of a
1538 TLS CA chain to attempt to parse and add test certificates to the chain.
1539 Defaults to 0, meaning test certificates are not used.
1541 .. code-block:: console
1545 ca-cert-path <filename>
1546 ^^^^^^^^^^^^^^^^^^^^^^^
1548 Sets the filename path of the location of TLS CA certificates, used when
1549 initializing and loading TLS CA certificates during the initialization
1550 of a TLS CA chain. If not set, the default filename path is
1551 */etc/ssl/certs/ca-certificates.crt*.
1553 .. code-block:: console
1555 ca-cert-path /etc/ssl/certs/ca-certificates.crt
1561 The "tuntap" driver configures a point-to-point interface between the vpp
1562 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1563 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1564 is currently disabled by default. To [dynamically] create TAP interfaces - the
1565 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1566 "vnet" interface needs to manually configure, and VLAN and other settings if
1573 Enable or disable the tun/tap driver.
1575 .. code-block:: console
1582 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1583 tunnel). The two keywords are aliases for the same function.
1585 .. code-block:: console
1589 have-normal-interface|have-normal
1590 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1592 Treat the host Linux stack as a routing peer instead of programming VPP
1593 interface L3 addresses onto the tun/tap devices. The two keywords are
1594 aliases for the same function.
1596 .. code-block:: console
1598 have-normal-interface
1603 Assign name to the tun/tap device.
1605 .. code-block:: console
1613 Vhost-user configuration parameters control the vhost-user driver.
1618 Subject to deadline-timer expiration - see next item - attempt to transmit
1619 at least <n> packet frames. Default is 32 frames.
1621 .. code-block:: console
1625 coalesce-time <seconds>
1626 ^^^^^^^^^^^^^^^^^^^^^^^
1628 Hold packets no longer than (floating-point) seconds before transmitting
1629 them. Default is 0.001 seconds
1631 .. code-block:: console
1638 vhost-user shared-memory segments can add up to a large amount of memory, so
1639 it's handy to avoid adding them to corefiles when using a significant number
1642 .. code-block:: console
1650 These parameters configure VLIB, such as allowing you to choose whether to
1651 enable memory traceback or a post-mortem elog dump.
1656 Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
1659 .. code-block:: console
1666 Sets the number of elements/events (the size) of the event ring
1667 (a circular buffer of events.) This number rounds to a power of 2.
1668 Defaults to 131072 (128 << 10) elements.
1670 .. code-block:: console
1674 elog-post-mortem-dump
1675 ^^^^^^^^^^^^^^^^^^^^^
1677 Enables the attempt of a post-mortem elog dump to
1678 */tmp/elog_post_mortem.<PID_OF_CALLING_PROCESS>* if os_panic or
1681 .. code-block:: console
1683 elog-post-mortem-dump