1 .. _configuration_reference:
3 Configuration Reference
4 =======================
6 Below is the list of some section names and their associated parameters.
7 This is not an exhaustive list, but should give you an idea of how VPP can be configured.
9 For all of the configuration parameters search the source code for instances of
10 **VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION**.
12 For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
13 cause the function *'foo_config'* to receive all parameters given in a
14 parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
19 Configures VPP startup and behavior type attributes, as well and any OS based
22 .. code-block:: console
26 log /var/log/vpp/vpp.log
28 cli-listen /run/vpp/cli.sock
35 Do not fork / background the vpp process. Typical when invoking VPP
36 applications from a process monitor. Set by default in the default
37 *'startup.conf'* file.
39 .. code-block:: console
46 Disable syslog and log errors to stderr instead. Typical when invoking
47 VPP applications from a process monitor like runit or daemontools that
48 pipe service's output to a dedicated log service, which will typically
49 attach a timestamp and rotate the logs as necessary.
51 .. code-block:: console
58 Attach CLI to stdin/out and provide a debugging command line interface.
60 .. code-block:: console
67 Logs the startup configuration and all subsequent CLI commands in filename.
68 Very useful in situations where folks don't remember or can't be bothered
69 to include CLI commands in bug reports. The default *'startup.conf'* file
70 is to write to *'/var/log/vpp/vpp.log'*.
72 In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
73 to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
74 However, if SELinux is enabled, then the new location is required for the file
75 to be properly labeled. Check your local *'startup.conf'* file for the log file
76 location on your system.
78 .. code-block:: console
80 log /var/log/vpp/vpp-debug.log
82 exec | startup-config <filename>
83 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
85 Read startup operational configuration from filename. The contents of the file
86 will be performed as though entered at the CLI. The two keywords are aliases
87 for the same function; if both are specified, only the last will have an effect.
89 A file of CLI commands might look like:
91 .. code-block:: console
93 $ cat /usr/share/vpp/scripts/interface-up.txt
94 set interface state TenGigabitEthernet1/0/0 up
95 set interface state TenGigabitEthernet1/0/1 up
99 .. code-block:: console
101 startup-config /usr/share/vpp/scripts/interface-up.txt
106 Sets the effective group ID to the input group ID or group name of the calling
109 .. code-block:: console
116 Ask the Linux kernel to dump all memory-mapped address regions, instead of
119 .. code-block:: console
123 coredump-size unlimited | <n>G | <n>M | <n>K | <n>
124 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
126 Set the maximum size of the coredump file. The input value can be set in
127 GB, MB, KB or bytes, or set to *'unlimited'*.
129 .. code-block:: console
131 coredump-size unlimited
133 cli-listen <ipaddress:port> | <socket-path>
134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
136 Bind the CLI to listen at address localhost on TCP port 5002. This will
137 accept an ipaddress:port pair or a filesystem path; in the latter case a
138 local Unix socket is opened instead. The default *'startup.conf'* file
139 is to open the socket *'/run/vpp/cli.sock'*.
141 .. code-block:: console
143 cli-listen localhost:5002
144 cli-listen /run/vpp/cli.sock
149 Disable character-by-character I/O on stdin. Useful when combined with,
150 for example, emacs M-x gud-gdb.
152 .. code-block:: console
159 Configure the CLI prompt to be string.
161 .. code-block:: console
165 cli-history-limit <n>
166 ^^^^^^^^^^^^^^^^^^^^^
168 Limit command history to <n> lines. A value of 0 disables command history.
171 .. code-block:: console
173 cli-history-limit 100
178 Disable the login banner on stdin and Telnet connections.
180 .. code-block:: console
187 Disable the output pager.
189 .. code-block:: console
193 cli-pager-buffer-limit <n>
194 ^^^^^^^^^^^^^^^^^^^^^^^^^^
196 Limit pager buffer to <n> lines of output. A value of 0 disables the
197 pager. Default value: 100000
199 .. code-block:: console
201 cli-pager-buffer-limit 5000
206 Set the runtime directory, which is the default location for certain
207 files, like socket files. Default is based on User ID used to start VPP.
208 Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
209 defaults to *'/run/user/<uid>/vpp/'*.
211 .. code-block:: console
218 Add a fixed-sleep between main loop poll. Default is 0, which is not to
221 .. code-block:: console
228 Writes the pid of the main thread in the given filename.
230 .. code-block:: console
232 pidfile /run/vpp/vpp1.pid
235 The api-trace Section
236 ---------------------
238 The ability to trace, dump, and replay control-plane API traces makes all the
239 difference in the world when trying to understand what the control-plane has
240 tried to ask the forwarding-plane to do.
242 Typically, one simply enables the API message trace scheme:
244 .. code-block:: console
253 Enable API trace capture from the beginning of time, and arrange for a
254 post-mortem dump of the API trace if the application terminates abnormally.
255 By default, the (circular) trace buffer will be configured to capture
256 256K traces. The default *'startup.conf'* file has trace enabled by default,
257 and unless there is a very strong reason, it should remain enabled.
259 .. code-block:: console
266 Configure the circular trace buffer to contain the last <n> entries. By
267 default, the trace buffer captures the last 256K API messages received.
269 .. code-block:: console
273 save-api-table <filename>
274 ^^^^^^^^^^^^^^^^^^^^^^^^^
276 Dumps the API message table to /tmp/<filename>.
278 .. code-block:: console
280 save-api-table apiTrace-07-04.txt
283 The api-segment Section
284 -----------------------
286 These values control various aspects of the binary API interface to VPP.
288 The default looks like the following:
290 .. code-block:: console
300 Sets the prefix prepended to the name used for shared memory (SHM)
301 segments. The default is empty, meaning shared memory segments are created
302 directly in the SHM directory *'/dev/shm'*. It is worth noting that on
303 many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
304 system; Ubuntu links it to *'/run/shm'*.
306 .. code-block:: console
313 Sets the user ID or name that should be used to set the ownership of the
314 shared memory segments. Defaults to the same user that VPP is started
317 .. code-block:: console
324 Sets the group ID or name that should be used to set the ownership of the
325 shared memory segments. Defaults to the same group that VPP is started
328 .. code-block:: console
332 **The following parameters should only be set by those that are familiar with the
333 interworkings of VPP.**
338 Set the base address for SVM global region. If not set, on AArch64, the
339 code will try to determine the base address. All other default to
342 .. code-block:: console
346 global-size <n>G | <n>M | <n>
347 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
349 Set the global memory size, memory shared across all router instances,
350 packet buffers, etc. If not set, defaults to 64M. The input value can be
351 set in GB, MB or bytes.
353 .. code-block:: console
357 global-pvt-heap-size <n>M | size <n>
358 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
360 Set the size of the global VM private mheap. If not set, defaults to 128k.
361 The input value can be set in MB or bytes.
363 .. code-block:: console
365 global-pvt-heap-size size 262144
367 api-pvt-heap-size <n>M | size <n>
368 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
370 Set the size of the api private mheap. If not set, defaults to 128k.
371 The input value can be set in MB or bytes.
373 .. code-block:: console
377 api-size <n>M | <n>G | <n>
378 ^^^^^^^^^^^^^^^^^^^^^^^^^^
380 Set the size of the API region. If not set, defaults to 16M. The input
381 value can be set in GB, MB or bytes.
383 .. code-block:: console
390 Enables a Unix domain socket which processes binary API messages. See
391 .../vlibmemory/socket_api.c. If this parameter is not set, vpp
392 won't process binary API messages over sockets.
394 .. code-block:: console
397 # Explicitly name a socket file
398 socket-name /run/vpp/api.sock
400 # Use defaults as described below
404 The "default" keyword instructs vpp to use /run/vpp/api.sock when
405 running as root, otherwise to use /run/user/<uid>/api.sock.
410 In the VPP there is one main thread and optionally the user can create worker(s)
411 The main thread and worker thread(s) can be pinned to CPU core(s) manually or automatically
413 .. code-block:: console
417 corelist-workers 2-3,18-19
421 Manual pinning of thread(s) to CPU core(s)
422 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
427 Set logical CPU core where main thread runs, if main core is not set VPP will use
430 .. code-block:: console
437 Set logical CPU core(s) where worker threads are running
439 .. code-block:: console
441 corelist-workers 2-3,18-19
443 Automatic pinning of thread(s) to CPU core(s)
444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
449 Sets number of CPU core(s) to be skipped (1 ... N-1), Skipped CPU core(s) are
450 not used for pinning main thread and working thread(s).
452 The main thread is automatically pinned to the first available CPU core and worker(s)
453 are pinned to next free CPU core(s) after core assigned to main thread
455 .. code-block:: console
462 Specify a number of workers to be created Workers are pinned to N consecutive
463 CPU cores while skipping "skip-cores" CPU core(s) and main thread's CPU core
465 .. code-block:: console
469 scheduler-policy other | batch | idle | fifo | rr
470 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
472 Set scheduling policy and priority of main and worker threads
474 Scheduling policy options are: other (SCHED_OTHER), batch (SCHED_BATCH)
475 idle (SCHED_IDLE), fifo (SCHED_FIFO), rr (SCHED_RR)
477 .. code-block:: console
479 scheduler-policy fifo
481 scheduler-priority number
482 ^^^^^^^^^^^^^^^^^^^^^^^^^
484 Scheduling priority is used only for "real-time policies (fifo and rr),
485 and has to be in the range of priorities supported for a particular policy
487 .. code-block:: console
489 scheduler-priority 50
494 .. code-block:: console
497 buffers-per-numa 128000
498 default data-size 2048
499 page-size default-hugepage
502 buffers-per-numa number
503 ^^^^^^^^^^^^^^^^^^^^^^^
505 Increase number of buffers allocated, needed only in scenarios with
506 large number of interfaces and worker threads. Value is per numa node.
507 Default is 16384 (8192 if running unprivileged)
509 .. code-block:: console
511 buffers-per-numa 128000
513 default data-size number
514 ^^^^^^^^^^^^^^^^^^^^^^^^
516 Size of buffer data area, default is 2048
518 .. code-block:: console
520 default data-size 2048
525 Set the page size for buffer allocation
527 .. code-block:: console
533 page-size default-hugepage
539 .. code-block:: console
553 dev <pci-dev> | default { .. }
554 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
556 White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
557 string of the form "DDDD:BB:SS.F" where:
564 If the keyword **default** is used the values will apply to all the devices.
566 This is the same format used in the linux sysfs tree (i.e./sys/bus/pci/devices)
567 for PCI device directory names.
569 .. code-block:: console
580 Whitelist specific interface by specifying PCI address. When whitelisting specific
581 interfaces by specifying PCI address, additional custom parameters can also be
582 specified. Valid options include:
584 .. code-block:: console
592 Blacklist specific device type by specifying PCI vendor:device Whitelist entries
595 .. code-block:: console
604 .. code-block:: console
613 Number of receive queues. Also enables RSS. Default value is 1.
615 .. code-block:: console
624 Number of transmit queues. Default is equal to number of worker threads
625 or 1 if no workers treads.
627 .. code-block:: console
636 Number of descriptors in receive ring. Increasing or reducing number
637 can impact performance. Default is 1024.
639 .. code-block:: console
645 vlan-strip-offload on | off
646 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
648 VLAN strip offload mode for interface. VLAN stripping is off by default
649 for all NICs except VICs, using ENIC driver, which has VLAN stripping on
652 .. code-block:: console
655 vlan-strip-offload on|off
658 uio-driver driver-name
659 ^^^^^^^^^^^^^^^^^^^^^^
661 Change UIO driver used by VPP, Options are: igb_uio, vfio-pci, uio_pci_generic
665 .. code-block:: console
672 Disable multi-segment buffers, improves performance but disables Jumbo MTU support
674 .. code-block:: console
681 Change hugepages allocation per-socket, needed only if there is need for
682 larger number of mbufs. Default is 256M on each detected CPU socket
684 .. code-block:: console
688 no-tx-checksum-offload
689 ^^^^^^^^^^^^^^^^^^^^^^
691 Disables UDP / TCP TX checksum offload. Typically needed for use faster
692 vector PMDs (together with no-multi-seg)
694 .. code-block:: console
696 no-tx-checksum-offload
698 enable-tcp-udp-checksum
699 ^^^^^^^^^^^^^^^^^^^^^^^
701 Enable UDP / TCP TX checksum offload This is the reversed option of
702 'no-tx-checksum-offload'
704 .. code-block:: console
706 enable-tcp-udp-checksum
711 Configure VPP plugins.
713 .. code-block:: console
716 path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
717 plugin dpdk_plugin.so enable
723 Adjust the plugin path depending on where the VPP plugins are.
725 .. code-block:: console
727 path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
729 plugin plugin-name | default enable | disable
730 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
732 Disable all plugins by default and then selectively enable specific plugins
734 .. code-block:: console
736 plugin default disable
737 plugin dpdk_plugin.so enable
738 plugin acl_plugin.so enable
740 Enable all plugins by default and then selectively disable specific plugins
742 .. code-block:: console
744 plugin dpdk_plugin.so disable
745 plugin acl_plugin.so disable
750 .. code-block:: console
756 socket-name <filename>
757 ^^^^^^^^^^^^^^^^^^^^^^
759 Name of the stats segment socket defaults to /run/vpp/stats.sock.
761 .. code-block:: console
763 socket-name /run/vpp/stats.sock
768 The size of the stats segment, defaults to 32mb
770 .. code-block:: console
774 per-node-counters on | off
775 ^^^^^^^^^^^^^^^^^^^^^^^^^^
779 .. code-block:: console
783 update-interval <f64-seconds>
784 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
786 Sets the segment scrape / update interval
788 .. code-block:: console
793 Some Advanced Parameters:
794 -------------------------
800 These parameters change the configuration of the ACL (access control list) plugin,
801 such as how the ACL bi-hash tables are initialized.
803 They should only be set by those that are familiar with the interworkings of VPP
806 The first three parameters, *connection hash buckets*, *connection hash memory*,
807 and *connection count max*, set the **connection table per-interface parameters**
808 for modifying how the two bounded-index extensible hash tables for
809 IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
810 (16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
813 connection hash buckets <n>
814 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
816 Sets the number of hash buckets (rounded up to a power of 2) in each
817 of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
819 .. code-block:: console
821 connection hash buckets 65536
823 connection hash memory <n>
824 ^^^^^^^^^^^^^^^^^^^^^^^^^^
826 Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
827 Defaults to 1073741824 bytes.
829 .. code-block:: console
831 connection hash memory 1073741824
833 connection count max <n>
834 ^^^^^^^^^^^^^^^^^^^^^^^^
836 Sets the maximum number of pool elements when allocating each per-worker
837 pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
839 .. code-block:: console
841 connection count max 500000
843 main heap size <n>G | <n>M | <n>K | <n>
844 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
846 Sets the size of the main memory heap that holds all the ACL module related
847 allocations (other than hash.) Default size is 0, but during
848 ACL heap initialization is equal to
849 *per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
850 Note that these variables are partially based on the
851 **connection table per-interface parameters** mentioned above.
853 .. code-block:: console
857 The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
858 and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
859 table used by the ACL plugin. This table is initialized when attempting to apply
860 an ACL to the existing vector of ACLs looked up during packet processing
861 (but it is found that the table does not exist / has not been initialized yet.)
863 hash lookup heap size <n>G | <n>M | <n> K | <n>
864 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
866 Sets the size of the memory heap that holds all the miscellaneous allocations
867 related to hash-based lookups. Default size is 67108864 bytes.
869 .. code-block:: console
871 hash lookup heap size 70M
873 hash lookup hash buckets <n>
874 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
876 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
877 lookup table. Defaults to 65536 hash buckets.
879 .. code-block:: console
881 hash lookup hash buckets 65536
883 hash lookup hash memory <n>
884 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
886 Sets the allocated memory size (in bytes) for the bi-hash lookup table.
887 Defaults to 67108864 bytes.
889 .. code-block:: console
891 hash lookup hash memory 67108864
896 Sets a boolean value indicating whether or not to use TupleMerge
897 for hash ACL's. Defaults to 1 (true), meaning the default implementation
898 of hashing ACL's does use TupleMerge.
900 .. code-block:: console
904 tuple merge split threshold <n>
905 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
907 Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
908 lookup table before the table is split into two new tables. Splitting ensures
909 less rule collisions by hashing colliding rules based on their common tuple
910 (usually their maximum common tuple.) Splitting occurs when the
911 *length of the colliding rules vector* is greater than this threshold amount.
912 Defaults to a maximum of 39 rule collisions per table.
914 .. code-block:: console
916 tuple merge split threshold 30
918 reclassify sessions <n>
919 ^^^^^^^^^^^^^^^^^^^^^^^
921 Sets a boolean value indicating whether or not to take the epoch of the session
922 into account when dealing with re-applying ACL's or changing already applied ACL's.
923 Defaults to 0 (false), meaning the default implementation does NOT take the
924 epoch of the session into account.
926 .. code-block:: console
928 reclassify sessions 1
938 Sets the api queue length. Minimum valid queue length is 1024, which is
941 .. code-block:: console
950 The circular journal (CJ) thread-safe circular log buffer scheme is
951 occasionally useful when chasing bugs. Calls to it should not be checked in.
952 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
953 When enabled, the number of records must be provided, there is no default
959 Configure the number of circular journal records in the circular buffer.
960 The number of records should be a power of 2.
962 .. code-block:: console
969 Turns on logging at the earliest possible moment.
971 .. code-block:: console
981 Set the maximum number of active elements allowed in the pool of
982 dns cache entries. When resolving an expired entry or adding a new
983 static entry and the max number of active entries is reached,
984 a random, non-static entry is deleted. Defaults to 65535 entries.
986 .. code-block:: console
997 Specifies the default MTU size for Ethernet interfaces. Must be in
998 the range of 64-9000. The default is 9000.
1000 .. code-block:: console
1007 Heapsize configuration controls the size of the main heap. The heap size is
1008 configured very early in the boot sequence, before loading plug-ins or doing
1009 much of anything else.
1011 heapsize <n>M | <n>G
1012 ^^^^^^^^^^^^^^^^^^^^
1014 Specifies the size of the heap in MB or GB. The default is 1GB.
1016 .. code-block:: console
1023 IPv4 heap configuration. he heap size is configured very early in the boot
1024 sequence, before loading plug-ins or doing much of anything else.
1026 heap-size <n>G | <n>M | <n>K | <n>
1027 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1029 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
1030 the destination IP lookup table. The input value can be set in GB, MB, KB
1031 or bytes. The default value is 32MB.
1033 .. code-block:: console
1040 IPv6 heap configuration. he heap size is configured very early in the boot
1041 sequence, before loading plug-ins or doing much of anything else.
1044 heap-size <n>G | <n>M | <n>K | <n>
1045 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1047 Set the IPv6 forwarding table heap size. The input value can be set in GB,
1048 MB, KB or bytes. The default value is 32MB.
1050 .. code-block:: console
1057 Set the number of IPv6 forwarding table hash buckets. The default value is
1060 .. code-block:: console
1067 Configure Layer 2 MAC Address learning parameters.
1072 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
1073 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
1074 4M entries (4194304).
1076 .. code-block:: console
1083 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
1084 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
1085 are mutually exclusive:
1090 Lookup tunnel by IPv6 source address.
1092 .. code-block:: console
1099 Lookup tunnel by IPv6 destination address.
1101 .. code-block:: console
1108 Lookup tunnel by L2TPv3 session identifier.
1110 .. code-block:: console
1120 Number of entries in the global logging buffer. Defaults to 512.
1122 .. code-block:: console
1129 Set the global value for the time to wait (in seconds) before resuming
1130 logging of a log subclass that exceeded the per-subclass message-per-second
1131 threshold. Defaults to 3.
1133 .. code-block:: console
1137 default-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
1138 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1140 Set the default logging level of the system log. Defaults to notice.
1142 .. code-block:: console
1144 default-log-level notice
1146 default-syslog-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
1147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1149 Set the default logging level of the syslog target. Defaults to warning.
1151 .. code-block:: console
1153 default-syslog-log-level warning
1158 lookup-table-buckets <n>
1159 ^^^^^^^^^^^^^^^^^^^^^^^^
1161 Sets the number of hash buckets in the mactime bi-hash lookup table.
1162 Defaults to 128 buckets.
1164 .. code-block:: console
1166 lookup-table-buckets 128
1168 lookup-table-memory <n>G | <n>M | <n>K | <n>
1169 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1171 Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
1172 The input value can be set in GB, MB, KB or bytes. The default value is 262144
1173 (256 << 10) bytes or roughly 256KB.
1175 .. code-block:: console
1177 lookup-table-memory 300K
1182 Sets the timezone offset from UTC. Defaults to an offset of -5 hours
1183 from UTC (US EST / EDT.)
1185 .. code-block:: console
1193 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1195 Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
1196 router. The boolean defaults to false, meaning the MAP node is not treated
1199 .. code-block:: console
1206 These parameters change the configuration of the NAT (Network address translation)
1207 plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
1208 endpoint dependent, or if the NAT is deterministic.
1210 For each NAT per thread data, the following 4 parameters change how certain
1211 bi-hash tables are initialized.
1213 translation hash buckets <n>
1214 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1216 Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
1217 tables. Defaults to 1024 buckets.
1219 If the NAT is indicated to be endpoint dependent, which can be set with the
1220 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets
1221 the number of hash buckets in each of the two endpoint dependent sessions
1222 NAT bi-hash lookup tables.
1224 .. code-block:: console
1226 translation hash buckets 1024
1228 translation hash memory <n>
1229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1231 Sets the allocated memory size (in bytes) for each of the two in/out NAT
1232 bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
1234 If the NAT is indicated to be endpoint dependent, which can be set with the
1235 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets the
1236 allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
1239 .. code-block:: console
1241 translation hash memory 134217728
1243 user hash buckets <n>
1244 ^^^^^^^^^^^^^^^^^^^^^
1246 Sets the number of hash buckets in the user bi-hash lookup table
1247 (src address lookup for a user.) Defaults to 128 buckets.
1249 .. code-block:: console
1251 user hash buckets 128
1253 user hash memory <n>
1254 ^^^^^^^^^^^^^^^^^^^^
1256 Sets the allocated memory size (in bytes) for the user bi-hash lookup table
1257 (src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
1258 which is roughly 64 MB.
1260 .. code-block:: console
1262 user hash memory 67108864
1264 max translations per user <n>
1265 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1267 Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
1268 Defaults to 100. When this limit is reached, the least recently used translation
1271 .. code-block:: console
1273 max translations per user 50
1278 Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
1279 meaning the NAT is not deterministic.
1281 .. code-block:: console
1285 nat64 bib hash buckets <n>
1286 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1288 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
1289 tables. Defaults to 1024 buckets.
1291 .. code-block:: console
1293 nat64 bib hash buckets 1024
1295 nat64 bib hash memory <n>
1296 ^^^^^^^^^^^^^^^^^^^^^^^^^
1298 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
1299 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
1300 which is roughly 128 MB.
1302 .. code-block:: console
1304 nat64 bib hash memory 134217728
1306 nat64 st hash buckets <n>
1307 ^^^^^^^^^^^^^^^^^^^^^^^^^
1309 Sets the number of hash buckets in each of the two in/out NAT64 session table
1310 bi-hash tables. Defaults to 2048 buckets.
1312 .. code-block:: console
1314 nat64 st hash buckets 2048
1316 nat64 st hash memory <n>
1317 ^^^^^^^^^^^^^^^^^^^^^^^^
1319 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
1320 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
1323 .. code-block:: console
1325 nat64 st hash memory 268435456
1332 Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
1333 Defaults to 0, meaning the NAT is not endpoint dependent.
1335 .. code-block:: console
1342 OAM configuration controls the (ip4-icmp) interval, and number of misses
1343 allowed before reporting an oam target down to any registered listener.
1348 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1349 Default is 2.04 seconds.
1351 .. code-block:: console
1358 Configuration parameters used to specify base address and maximum size of
1359 the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
1360 growable physical memory allocator. pmalloc allocates memory for the DPDK
1366 Specify the base address for pmalloc memory space.
1368 .. code-block:: console
1370 base-addr 0xfffe00000000
1372 max-size <n>G | <n>M | <n>K | <n>
1373 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1375 Set the memory size for pmalloc memory space. The default is 16G.
1377 .. code-block:: console
1384 Configuration parameters for TAPCLI (dynamic tap interface hookup.)
1389 Sets interface MTU (maximum transmission unit) size in bytes. This size
1390 is also related to the number of MTU buffers. Defaults to 1500 bytes.
1392 .. code-block:: console
1399 Disables TAPCLI. Default is that TAPCLI is enabled.
1401 .. code-block:: console
1409 Configuration parameters for TCP host stack utilities. The following
1410 preallocation parameters are related to the initialization of fixed-size,
1411 preallocation pools.
1413 preallocated-connections <n>
1414 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1416 Sets the number of preallocated TCP connections. Defaults to 0.
1417 The preallocated connections per thread is related to this value,
1418 equal to (preallocated_connections / (num_threads - 1)).
1420 .. code-block:: console
1422 preallocated-connections 5
1424 preallocated-half-open-connections <n>
1425 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1427 Sets the number of preallocated TCP half-open connections. Defaults to 0.
1429 .. code-block:: console
1431 preallocated-half-open-connections 5
1433 buffer-fail-fraction <n.n>
1434 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1436 Sets the TCP buffer fail fraction (a float) used for fault-injection
1437 when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
1440 .. code-block:: console
1442 buffer-fail-fraction 0.0
1448 Configures TLS parameters, such as enabling the use of test certificates.
1449 These parameters affect the tlsmbedtls and tlsopenssl plugins.
1454 Sets a boolean value to 1 to indicate during the initialization of a
1455 TLS CA chain to attempt to parse and add test certificates to the chain.
1456 Defaults to 0, meaning test certificates are not used.
1458 .. code-block:: console
1462 ca-cert-path <filename>
1463 ^^^^^^^^^^^^^^^^^^^^^^^
1465 Sets the filename path of the location of TLS CA certificates, used when
1466 initializing and loading TLS CA certificates during the initialization
1467 of a TLS CA chain. If not set, the default filename path is
1468 */etc/ssl/certs/ca-certificates.crt*.
1470 .. code-block:: console
1472 ca-cert-path /etc/ssl/certs/ca-certificates.crt
1478 The "tuntap" driver configures a point-to-point interface between the vpp
1479 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1480 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1481 is currently disabled by default. To [dynamically] create TAP interfaces - the
1482 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1483 "vnet" interface needs to manually configure, and VLAN and other settings if
1490 Enable or disable the tun/tap driver.
1492 .. code-block:: console
1499 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1500 tunnel). The two keywords are aliases for the same function.
1502 .. code-block:: console
1506 have-normal-interface|have-normal
1507 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1509 Treat the host Linux stack as a routing peer instead of programming VPP
1510 interface L3 addresses onto the tun/tap devices. The two keywords are
1511 aliases for the same function.
1513 .. code-block:: console
1515 have-normal-interface
1520 Assign name to the tun/tap device.
1522 .. code-block:: console
1530 Vhost-user configuration parameters control the vhost-user driver.
1535 Subject to deadline-timer expiration - see next item - attempt to transmit
1536 at least <n> packet frames. Default is 32 frames.
1538 .. code-block:: console
1542 coalesce-time <seconds>
1543 ^^^^^^^^^^^^^^^^^^^^^^^
1545 Hold packets no longer than (floating-point) seconds before transmitting
1546 them. Default is 0.001 seconds
1548 .. code-block:: console
1555 vhost-user shared-memory segments can add up to a large amount of memory, so
1556 it's handy to avoid adding them to corefiles when using a significant number
1559 .. code-block:: console
1567 These parameters configure VLIB, such as allowing you to choose whether to
1568 enable memory traceback or a post-mortem elog dump.
1573 Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
1576 .. code-block:: console
1583 Sets the number of elements/events (the size) of the event ring
1584 (a circular buffer of events.) This number rounds to a power of 2.
1585 Defaults to 131072 (128 << 10) elements.
1587 .. code-block:: console
1591 elog-post-mortem-dump
1592 ^^^^^^^^^^^^^^^^^^^^^
1594 Enables the attempt of a post-mortem elog dump to
1595 */tmp/elog_post_mortem.<PID_OF_CALLING_PROCESS>* if os_panic or
1598 .. code-block:: console
1600 elog-post-mortem-dump