grout - Man Page

Grout is a software router based on DPDK rte_graph.

grout [-M ADDR:PORT] [-S] [-V] [-h] [-m PERMISSIONS] [-o USER:GROUP] [-p] [-s PATH] [-t] [-u MTU] [-v] [-x] [-- EAL ARGS...]

-h,  --help

Display usage help.

-M,  --metrics [tcp:]ADDR:PORT | unix:PATH

Set the listen address and port or unix socket where openmetrics will be exported via HTTP GET in a dedicated thread. To disable, use -M :0.

Default: [::]:9111

-m,  --socket-mode PERMISSIONS

Change the API socket file permissions after creating it. Only octal values are supported.

Default: 0660.

-o,  --socket-owner USER:GROUP

Change the owner of the API socket file after creating it. Symbolic names and numeric IDs are supported.

Default: current user and current group.

-p,  --poll-mode

Disable automatic micro-sleep.

-a,  --adaptive-irq

Make idle workers block on their RX queue interrupts instead of busy-polling, so the CPU can idle during quiet periods. An incoming packet raises the interrupt and the worker resumes polling. It requires PMD support for RX queue interrupts; without it a worker falls back to the micro-sleep ramp, unless --poll-mode is also given.

-S,  --syslog

Redirect logs to syslog.

-s,  --socket PATH

Path the control plane API socket.

Default: GROUT_SOCK_PATH from environment or /run/grout.sock.

-t,  --test-mode

Run in test mode (no huge pages).

-u,  --max-mtu MTU

Maximum Transmission Unit.

Default: 1800.

-v,  --verbose

Increase verbosity. Can be specified multiple times.

-V,  --version

Print version and exit.

-x,  --trace-packets

Print all ingress/egress packets (for debugging purposes).

GROUT_SOCK_PATH

Path to the control plane API socket. See -s.

GROUT_OVERRIDE_DEFAULT_ROUTE

When set to 1, true, on, or yes (case insensitive), override the existing default route in the main routing table with metric 0. This is required when running in a network namespace or a container where another default route (e.g. from Kubernetes) takes priority over grout's own default route.

GROUT_OVERRIDE_RP_FILTER

When set to 1, true, on, or yes (case insensitive), set loose reverse path filtering (rp_filter=2) on control plane TAP interfaces. This prevents the kernel from dropping packets delivered by grout when strict reverse path filtering (rp_filter=1) is enabled globally. This is required when net.ipv4.conf.all.rp_filter is set to 1 (strict) in the network namespace where grout is running.

Any DPDK EAL argument can be specified after an optional --. This is an advanced debugging/development feature that can break things. Use with great care.

grcli(1)

Created and maintained by Robin Jarry.

grcli(1), grout-frr(7).