OS Manuals

/usr/bin/vtysh

The FRRouting Protocol Suite

From frr-10.2 10.2.6-r5 (enterprise-packages), captured 2026-11-08 by running vtysh --help (exit 0). permalink

Usage : vtysh [OPTION...]

Integrated shell for FRR (version 10.2.6).
Configured with:
    '--host=x86_64-pc-linux-gnu' '--build=x86_64-pc-linux-gnu' '--prefix=/usr' '--libdir=/usr/lib' '--sbindir=/usr/lib/frr' '--localstatedir=/var' '--sysconfdir=/etc' '--mandir=/usr/share/man' '--infodir=/usr/share/info' '--enable-rpki' '--enable-vtysh' '--enable-multipath=64' '--enable-vty-group=frrvty' '--enable-user=frr' '--enable-group=frr' '--enable-pcre2posix' '--enable-scripting' '--with-crypto=openssl' 'build_alias=x86_64-pc-linux-gnu' 'host_alias=x86_64-pc-linux-gnu'

-b, --boot               Execute boot startup configuration
-c, --command            Execute argument as command
-d, --daemon             Connect only to the specified daemon
-f, --inputfile          Execute commands from specific file and exit
-E, --echo               Echo prompt and command in -c mode
-C, --dryrun             Check configuration for validity and exit
-m, --markfile           Mark input file with context end
    --vty_socket         Override vty socket path
    --config_dir         Override config directory path
-N  --pathspace          Insert prefix into config & socket paths
-u  --user               Run as an unprivileged user
-w, --writeconfig        Write integrated config (frr.conf) and exit
-H, --histfile           Override history file
-t, --timestamp          Print a timestamp before going to shell or reading the configuration
    --no-fork            Don't fork clients to handle daemons (slower for large configs)
-h, --help               Display this help and exit

Note that multiple commands may be executed from the command
line by passing multiple -c args, or by embedding linefeed
characters in one or more of the commands.

Report bugs to https://github.com/frrouting/frr/issues
Options (16)
OptionDescriptionSource
-b, --bootExecute boot startup configurationhelp
-c, --commandExecute argument as commandhelp
-d, --daemonConnect only to the specified daemonhelp
-f, --inputfileExecute commands from specific file and exithelp
-E, --echoEcho prompt and command in -c modehelp
-C, --dryrunCheck configuration for validity and exithelp
-m, --markfileMark input file with context endhelp
--vty_socketOverride vty socket pathhelp
--config_dirOverride config directory pathhelp
-N--pathspace Insert prefix into config & socket pathshelp
-u--user Run as an unprivileged userhelp
-w, --writeconfigWrite integrated config (frr.conf) and exithelp
-H, --histfileOverride history filehelp
-t, --timestampPrint a timestamp before going to shell or reading the configurationhelp
--no-forkDon't fork clients to handle daemons (slower for large configs)help
-h, --helpDisplay this help and exithelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.