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
670 ^^^^^^^^^^^^^^^^^^^^^^
672 Force VPP to rebind the interface(s) to the selected UIO driver, even if the
673 interface is up in Linux.
674 By default, VPP will refuse to bind an interface if it is up in Linux,
675 in case it is in active use.
677 .. code-block:: console
684 Disable multi-segment buffers, improves performance but disables Jumbo MTU support
686 .. code-block:: console
693 Change hugepages allocation per-socket, needed only if there is need for
694 larger number of mbufs. Default is 256M on each detected CPU socket
696 .. code-block:: console
700 no-tx-checksum-offload
701 ^^^^^^^^^^^^^^^^^^^^^^
703 Disables UDP / TCP TX checksum offload. Typically needed for use faster
704 vector PMDs (together with no-multi-seg)
706 .. code-block:: console
708 no-tx-checksum-offload
710 enable-tcp-udp-checksum
711 ^^^^^^^^^^^^^^^^^^^^^^^
713 Enable UDP / TCP TX checksum offload This is the reversed option of
714 'no-tx-checksum-offload'
716 .. code-block:: console
718 enable-tcp-udp-checksum
723 Configure VPP plugins.
725 .. code-block:: console
728 path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
729 plugin dpdk_plugin.so enable
735 Adjust the plugin path depending on where the VPP plugins are.
737 .. code-block:: console
739 path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
741 plugin plugin-name | default enable | disable
742 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
744 Disable all plugins by default and then selectively enable specific plugins
746 .. code-block:: console
748 plugin default disable
749 plugin dpdk_plugin.so enable
750 plugin acl_plugin.so enable
752 Enable all plugins by default and then selectively disable specific plugins
754 .. code-block:: console
756 plugin dpdk_plugin.so disable
757 plugin acl_plugin.so disable
762 .. code-block:: console
768 socket-name <filename>
769 ^^^^^^^^^^^^^^^^^^^^^^
771 Name of the stats segment socket defaults to /run/vpp/stats.sock.
773 .. code-block:: console
775 socket-name /run/vpp/stats.sock
780 The size of the stats segment, defaults to 32mb
782 .. code-block:: console
786 per-node-counters on | off
787 ^^^^^^^^^^^^^^^^^^^^^^^^^^
791 .. code-block:: console
795 update-interval <f64-seconds>
796 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
798 Sets the segment scrape / update interval
800 .. code-block:: console
805 Some Advanced Parameters:
806 -------------------------
812 These parameters change the configuration of the ACL (access control list) plugin,
813 such as how the ACL bi-hash tables are initialized.
815 They should only be set by those that are familiar with the interworkings of VPP
818 The first three parameters, *connection hash buckets*, *connection hash memory*,
819 and *connection count max*, set the **connection table per-interface parameters**
820 for modifying how the two bounded-index extensible hash tables for
821 IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
822 (16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
825 connection hash buckets <n>
826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
828 Sets the number of hash buckets (rounded up to a power of 2) in each
829 of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
831 .. code-block:: console
833 connection hash buckets 65536
835 connection hash memory <n>
836 ^^^^^^^^^^^^^^^^^^^^^^^^^^
838 Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
839 Defaults to 1073741824 bytes.
841 .. code-block:: console
843 connection hash memory 1073741824
845 connection count max <n>
846 ^^^^^^^^^^^^^^^^^^^^^^^^
848 Sets the maximum number of pool elements when allocating each per-worker
849 pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
851 .. code-block:: console
853 connection count max 500000
855 main heap size <n>G | <n>M | <n>K | <n>
856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
858 Sets the size of the main memory heap that holds all the ACL module related
859 allocations (other than hash.) Default size is 0, but during
860 ACL heap initialization is equal to
861 *per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
862 Note that these variables are partially based on the
863 **connection table per-interface parameters** mentioned above.
865 .. code-block:: console
869 The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
870 and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
871 table used by the ACL plugin. This table is initialized when attempting to apply
872 an ACL to the existing vector of ACLs looked up during packet processing
873 (but it is found that the table does not exist / has not been initialized yet.)
875 hash lookup heap size <n>G | <n>M | <n> K | <n>
876 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
878 Sets the size of the memory heap that holds all the miscellaneous allocations
879 related to hash-based lookups. Default size is 67108864 bytes.
881 .. code-block:: console
883 hash lookup heap size 70M
885 hash lookup hash buckets <n>
886 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
888 Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
889 lookup table. Defaults to 65536 hash buckets.
891 .. code-block:: console
893 hash lookup hash buckets 65536
895 hash lookup hash memory <n>
896 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
898 Sets the allocated memory size (in bytes) for the bi-hash lookup table.
899 Defaults to 67108864 bytes.
901 .. code-block:: console
903 hash lookup hash memory 67108864
908 Sets a boolean value indicating whether or not to use TupleMerge
909 for hash ACL's. Defaults to 1 (true), meaning the default implementation
910 of hashing ACL's does use TupleMerge.
912 .. code-block:: console
916 tuple merge split threshold <n>
917 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
919 Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
920 lookup table before the table is split into two new tables. Splitting ensures
921 less rule collisions by hashing colliding rules based on their common tuple
922 (usually their maximum common tuple.) Splitting occurs when the
923 *length of the colliding rules vector* is greater than this threshold amount.
924 Defaults to a maximum of 39 rule collisions per table.
926 .. code-block:: console
928 tuple merge split threshold 30
930 reclassify sessions <n>
931 ^^^^^^^^^^^^^^^^^^^^^^^
933 Sets a boolean value indicating whether or not to take the epoch of the session
934 into account when dealing with re-applying ACL's or changing already applied ACL's.
935 Defaults to 0 (false), meaning the default implementation does NOT take the
936 epoch of the session into account.
938 .. code-block:: console
940 reclassify sessions 1
950 Sets the api queue length. Minimum valid queue length is 1024, which is
953 .. code-block:: console
962 The circular journal (CJ) thread-safe circular log buffer scheme is
963 occasionally useful when chasing bugs. Calls to it should not be checked in.
964 See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
965 When enabled, the number of records must be provided, there is no default
971 Configure the number of circular journal records in the circular buffer.
972 The number of records should be a power of 2.
974 .. code-block:: console
981 Turns on logging at the earliest possible moment.
983 .. code-block:: console
993 Set the maximum number of active elements allowed in the pool of
994 dns cache entries. When resolving an expired entry or adding a new
995 static entry and the max number of active entries is reached,
996 a random, non-static entry is deleted. Defaults to 65535 entries.
998 .. code-block:: console
1000 max-cache-size 65535
1009 Specifies the default MTU size for Ethernet interfaces. Must be in
1010 the range of 64-9000. The default is 9000.
1012 .. code-block:: console
1019 Heapsize configuration controls the size of the main heap. The heap size is
1020 configured very early in the boot sequence, before loading plug-ins or doing
1021 much of anything else.
1023 heapsize <n>M | <n>G
1024 ^^^^^^^^^^^^^^^^^^^^
1026 Specifies the size of the heap in MB or GB. The default is 1GB.
1028 .. code-block:: console
1035 IPv4 heap configuration. he heap size is configured very early in the boot
1036 sequence, before loading plug-ins or doing much of anything else.
1038 heap-size <n>G | <n>M | <n>K | <n>
1039 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1041 Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
1042 the destination IP lookup table. The input value can be set in GB, MB, KB
1043 or bytes. The default value is 32MB.
1045 .. code-block:: console
1052 IPv6 heap configuration. he heap size is configured very early in the boot
1053 sequence, before loading plug-ins or doing much of anything else.
1056 heap-size <n>G | <n>M | <n>K | <n>
1057 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1059 Set the IPv6 forwarding table heap size. The input value can be set in GB,
1060 MB, KB or bytes. The default value is 32MB.
1062 .. code-block:: console
1069 Set the number of IPv6 forwarding table hash buckets. The default value is
1072 .. code-block:: console
1079 Configure Layer 2 MAC Address learning parameters.
1084 Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
1085 which limits the size of the L2 FIB to <n> concurrent entries. Defaults to
1086 4M entries (4194304).
1088 .. code-block:: console
1095 IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
1096 the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
1097 are mutually exclusive:
1102 Lookup tunnel by IPv6 source address.
1104 .. code-block:: console
1111 Lookup tunnel by IPv6 destination address.
1113 .. code-block:: console
1120 Lookup tunnel by L2TPv3 session identifier.
1122 .. code-block:: console
1132 Number of entries in the global logging buffer. Defaults to 512.
1134 .. code-block:: console
1141 Set the global value for the time to wait (in seconds) before resuming
1142 logging of a log subclass that exceeded the per-subclass message-per-second
1143 threshold. Defaults to 3.
1145 .. code-block:: console
1149 default-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
1150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1152 Set the default logging level of the system log. Defaults to notice.
1154 .. code-block:: console
1156 default-log-level notice
1158 default-syslog-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
1159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1161 Set the default logging level of the syslog target. Defaults to warning.
1163 .. code-block:: console
1165 default-syslog-log-level warning
1170 lookup-table-buckets <n>
1171 ^^^^^^^^^^^^^^^^^^^^^^^^
1173 Sets the number of hash buckets in the mactime bi-hash lookup table.
1174 Defaults to 128 buckets.
1176 .. code-block:: console
1178 lookup-table-buckets 128
1180 lookup-table-memory <n>G | <n>M | <n>K | <n>
1181 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1183 Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
1184 The input value can be set in GB, MB, KB or bytes. The default value is 262144
1185 (256 << 10) bytes or roughly 256KB.
1187 .. code-block:: console
1189 lookup-table-memory 300K
1194 Sets the timezone offset from UTC. Defaults to an offset of -5 hours
1195 from UTC (US EST / EDT.)
1197 .. code-block:: console
1205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1207 Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
1208 router. The boolean defaults to false, meaning the MAP node is not treated
1211 .. code-block:: console
1218 These parameters change the configuration of the NAT (Network address translation)
1219 plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
1220 endpoint dependent, or if the NAT is deterministic.
1222 For each NAT per thread data, the following 4 parameters change how certain
1223 bi-hash tables are initialized.
1225 translation hash buckets <n>
1226 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1228 Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
1229 tables. Defaults to 1024 buckets.
1231 If the NAT is indicated to be endpoint dependent, which can be set with the
1232 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets
1233 the number of hash buckets in each of the two endpoint dependent sessions
1234 NAT bi-hash lookup tables.
1236 .. code-block:: console
1238 translation hash buckets 1024
1240 translation hash memory <n>
1241 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1243 Sets the allocated memory size (in bytes) for each of the two in/out NAT
1244 bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
1246 If the NAT is indicated to be endpoint dependent, which can be set with the
1247 :ref:`endpoint-dependent parameter <endpointLabel>`, then this parameter sets the
1248 allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
1251 .. code-block:: console
1253 translation hash memory 134217728
1255 user hash buckets <n>
1256 ^^^^^^^^^^^^^^^^^^^^^
1258 Sets the number of hash buckets in the user bi-hash lookup table
1259 (src address lookup for a user.) Defaults to 128 buckets.
1261 .. code-block:: console
1263 user hash buckets 128
1265 user hash memory <n>
1266 ^^^^^^^^^^^^^^^^^^^^
1268 Sets the allocated memory size (in bytes) for the user bi-hash lookup table
1269 (src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
1270 which is roughly 64 MB.
1272 .. code-block:: console
1274 user hash memory 67108864
1276 max translations per user <n>
1277 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1279 Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
1280 Defaults to 100. When this limit is reached, the least recently used translation
1283 .. code-block:: console
1285 max translations per user 50
1290 Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
1291 meaning the NAT is not deterministic.
1293 .. code-block:: console
1297 nat64 bib hash buckets <n>
1298 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1300 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
1301 tables. Defaults to 1024 buckets.
1303 .. code-block:: console
1305 nat64 bib hash buckets 1024
1307 nat64 bib hash memory <n>
1308 ^^^^^^^^^^^^^^^^^^^^^^^^^
1310 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
1311 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
1312 which is roughly 128 MB.
1314 .. code-block:: console
1316 nat64 bib hash memory 134217728
1318 nat64 st hash buckets <n>
1319 ^^^^^^^^^^^^^^^^^^^^^^^^^
1321 Sets the number of hash buckets in each of the two in/out NAT64 session table
1322 bi-hash tables. Defaults to 2048 buckets.
1324 .. code-block:: console
1326 nat64 st hash buckets 2048
1328 nat64 st hash memory <n>
1329 ^^^^^^^^^^^^^^^^^^^^^^^^
1331 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
1332 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
1335 .. code-block:: console
1337 nat64 st hash memory 268435456
1344 Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
1345 Defaults to 0, meaning the NAT is not endpoint dependent.
1347 .. code-block:: console
1354 OAM configuration controls the (ip4-icmp) interval, and number of misses
1355 allowed before reporting an oam target down to any registered listener.
1360 Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
1361 Default is 2.04 seconds.
1363 .. code-block:: console
1370 Configuration parameters used to specify base address and maximum size of
1371 the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
1372 growable physical memory allocator. pmalloc allocates memory for the DPDK
1378 Specify the base address for pmalloc memory space.
1380 .. code-block:: console
1382 base-addr 0xfffe00000000
1384 max-size <n>G | <n>M | <n>K | <n>
1385 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1387 Set the memory size for pmalloc memory space. The default is 16G.
1389 .. code-block:: console
1396 Configuration parameters for TAPCLI (dynamic tap interface hookup.)
1401 Sets interface MTU (maximum transmission unit) size in bytes. This size
1402 is also related to the number of MTU buffers. Defaults to 1500 bytes.
1404 .. code-block:: console
1411 Disables TAPCLI. Default is that TAPCLI is enabled.
1413 .. code-block:: console
1421 Configuration parameters for TCP host stack utilities. The following
1422 preallocation parameters are related to the initialization of fixed-size,
1423 preallocation pools.
1425 preallocated-connections <n>
1426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1428 Sets the number of preallocated TCP connections. Defaults to 0.
1429 The preallocated connections per thread is related to this value,
1430 equal to (preallocated_connections / (num_threads - 1)).
1432 .. code-block:: console
1434 preallocated-connections 5
1436 preallocated-half-open-connections <n>
1437 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1439 Sets the number of preallocated TCP half-open connections. Defaults to 0.
1441 .. code-block:: console
1443 preallocated-half-open-connections 5
1445 buffer-fail-fraction <n.n>
1446 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1448 Sets the TCP buffer fail fraction (a float) used for fault-injection
1449 when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
1452 .. code-block:: console
1454 buffer-fail-fraction 0.0
1460 Configures TLS parameters, such as enabling the use of test certificates.
1461 These parameters affect the tlsmbedtls and tlsopenssl plugins.
1466 Sets a boolean value to 1 to indicate during the initialization of a
1467 TLS CA chain to attempt to parse and add test certificates to the chain.
1468 Defaults to 0, meaning test certificates are not used.
1470 .. code-block:: console
1474 ca-cert-path <filename>
1475 ^^^^^^^^^^^^^^^^^^^^^^^
1477 Sets the filename path of the location of TLS CA certificates, used when
1478 initializing and loading TLS CA certificates during the initialization
1479 of a TLS CA chain. If not set, the default filename path is
1480 */etc/ssl/certs/ca-certificates.crt*.
1482 .. code-block:: console
1484 ca-cert-path /etc/ssl/certs/ca-certificates.crt
1490 The "tuntap" driver configures a point-to-point interface between the vpp
1491 engine and the local Linux kernel stack. This allows e.g. users to ssh to the
1492 host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
1493 is currently disabled by default. To [dynamically] create TAP interfaces - the
1494 preferred scheme - see the "tap_connect" binary API. The Linux network stack
1495 "vnet" interface needs to manually configure, and VLAN and other settings if
1502 Enable or disable the tun/tap driver.
1504 .. code-block:: console
1511 Create a tap device (ethernet MAC) instead of a tun device (point-to-point
1512 tunnel). The two keywords are aliases for the same function.
1514 .. code-block:: console
1518 have-normal-interface|have-normal
1519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1521 Treat the host Linux stack as a routing peer instead of programming VPP
1522 interface L3 addresses onto the tun/tap devices. The two keywords are
1523 aliases for the same function.
1525 .. code-block:: console
1527 have-normal-interface
1532 Assign name to the tun/tap device.
1534 .. code-block:: console
1542 Vhost-user configuration parameters control the vhost-user driver.
1547 Subject to deadline-timer expiration - see next item - attempt to transmit
1548 at least <n> packet frames. Default is 32 frames.
1550 .. code-block:: console
1554 coalesce-time <seconds>
1555 ^^^^^^^^^^^^^^^^^^^^^^^
1557 Hold packets no longer than (floating-point) seconds before transmitting
1558 them. Default is 0.001 seconds
1560 .. code-block:: console
1567 vhost-user shared-memory segments can add up to a large amount of memory, so
1568 it's handy to avoid adding them to corefiles when using a significant number
1571 .. code-block:: console
1579 These parameters configure VLIB, such as allowing you to choose whether to
1580 enable memory traceback or a post-mortem elog dump.
1585 Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
1588 .. code-block:: console
1595 Sets the number of elements/events (the size) of the event ring
1596 (a circular buffer of events.) This number rounds to a power of 2.
1597 Defaults to 131072 (128 << 10) elements.
1599 .. code-block:: console
1603 elog-post-mortem-dump
1604 ^^^^^^^^^^^^^^^^^^^^^
1606 Enables the attempt of a post-mortem elog dump to
1607 */tmp/elog_post_mortem.<PID_OF_CALLING_PROCESS>* if os_panic or
1610 .. code-block:: console
1612 elog-post-mortem-dump