[ { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show configuration", "cmd": "show configuration", "desc": "Troubleshooting — View the current active configuration, also known as the running configuration, from the operational mode." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show configuration commands", "cmd": "show configuration commands", "desc": "Troubleshooting — Get a collection of all the set commands required which led to the running configuration." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show configuration json", "cmd": "show configuration json", "desc": "Troubleshooting — View the current active configuration in JSON format. :::{code-block} none {\"interfaces\": {\"ethernet\": {\"eth0\": {\"address\": [\"192.0.2.11/24\", \"192.0.2.35/24\"], \"hw-id\": \"52:54:00:48:a0:c6\"}, \"eth1\": {\"address\": [\"203.0.…" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show configuration json pretty", "cmd": "show configuration json pretty", "desc": "Troubleshooting — View the current active configuration in readable JSON format. :::{code-block} none { \"interfaces\": { \"ethernet\": { \"eth0\": { \"address\": [ \"192.0.2.11/24\", \"192.0.2.35/24\" ], \"hw-id\": \"52:54:00:48:a0:c6\" }, \"eth1\": { \"a…" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show", "cmd": "show", "desc": "Troubleshooting · docs" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "set", "cmd": "set", "desc": "System — Use this command to set the value of a parameter or to create a new element." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "delete", "cmd": "delete", "desc": "System — To delete a configuration entry use the delete command, this also deletes all sub-levels under the current level you\\'ve specified in the delete command." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "commit", "cmd": "commit", "desc": "System — Any change you do on the configuration, will not take effect until committed using the commit command in configuration mode." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "save", "cmd": "save", "desc": "System — Use this command to preserve configuration changes upon reboot. By default it is stored at */config/config.boot*." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "exit \\[discard\\]", "cmd": "exit \\[discard\\]", "desc": "System — Configuration mode can not be exited while uncommitted changes exist. To exit configuration mode without applying changes, the exit discard command must be used." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "commit-confirm ", "cmd": "commit-confirm ", "desc": "System — Use this command to temporarily commit your changes and set the number of minutes available for confirmation." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "copy", "cmd": "copy", "desc": "System — Copy a configuration element. You can copy and remove configuration subtrees." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "rename", "cmd": "rename", "desc": "System — Rename a configuration element. You can also rename config subtrees: :::{code-block} none vyos@router# rename rule 10 to rule 5 [edit firewall name FromWorld] vyos@router# commit [edit firewall name FromWorld] ::: Note…" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "comment \"comment text\"", "cmd": "comment \"comment text\"", "desc": "System — Add comment as an annotation to a configuration node. The comment command allows you to insert a comment above the configuration section." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "run", "cmd": "run", "desc": "System — Access to these commands are possible through the use of the run [command] command." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show system commit", "cmd": "show system commit", "desc": "Troubleshooting — View all existing revisions on the local system. :::{code-block} none vyos@vyos:~$ show system commit 0 2015-03-30 08:53:03 by vyos via cli 1 2015-03-30 08:52:20 by vyos via cli 2 2015-03-26 21:26:01 by root via boot-co…" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "set system config-management commit-revisions ", "cmd": "set system config-management commit-revisions ", "desc": "System — You can specify the number of revisions stored on disk. N can be in the range of 0 - 65535." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "compare ", "cmd": "compare ", "desc": "System — Use this command to spot what the differences are between different configurations." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show system commit diff ", "cmd": "show system commit diff ", "desc": "Troubleshooting — Show commit revision difference." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "rollback ", "cmd": "rollback ", "desc": "System — Rollback to revision N (currently requires reboot) :::{code-block} none vyos@vyos# compare 1 [edit system] >host-name vyos-1 [edit] vyos@vyos# rollback 1 Proceed with reboot?" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "set system config-management commit-archive location ", "cmd": "set system config-management commit-archive location ", "desc": "System — Specify remote location of commit archive as any of the below URI (Uniform Resource Identifier) - http://:@:/ - https://:@:/ - ftp://:@/ - sftp:…" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "set system config-management commit-archive vrf ", "cmd": "set system config-management commit-archive vrf ", "desc": "System — Specify name of the VRF (Virtual Routing and Forwarding) instance used to upload the configuration to the remote system." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "load ", "cmd": "load ", "desc": "System — Use this command to load a configuration which will replace the running configuration." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Routing", "title": "protocols static arp hwaddr ", "cmd": "protocols static arp hwaddr ", "desc": "Routing — This will configure a static ARP entry, always resolving 192.0.2.100 to 00:53:27:de:23:aa." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "set system conntrack table-size <1-50000000>", "cmd": "set system conntrack table-size <1-50000000>", "desc": "System — :defaultvalue: The connection tracking table contains one entry for each connection being tracked by the system." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show protocols static arp", "cmd": "show protocols static arp", "desc": "Troubleshooting — Display all known ARP table entries spanning across all interfaces" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "DHCP", "title": "set interfaces {{ var0 }} address
address
Configure interface with one or more interface addresses. * **address** can be specified multiple times as IPv4 and/or IPv6 address, e.g." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "list}", "cmd": "list}", "desc": "System — :show-coverage:" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "delete raid member ", "cmd": "delete raid member ", "desc": "System · general" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "format disk like ", "cmd": "format disk like ", "desc": "System · general" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "add raid member ", "cmd": "add raid member ", "desc": "System · general" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show raid ", "cmd": "show raid ", "desc": "Troubleshooting — shows output for show raid md0 as sdb1 is being added to the RAID 1 set and is in the process of being resynchronized." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show disk sda format", "cmd": "show disk sda format", "desc": "Troubleshooting — Use this command to display the formatting of a hard disk. :::{code-block} none vyos@vyos:~$ show disk sda format Disk /dev/sda: 1073 MB, 1073741824 bytes 85 heads, 9 sectors/track, 2741 cylinders Units = cylinders of 7…" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show hardware usb", "cmd": "show hardware usb", "desc": "Troubleshooting — Retrieve a tree-like representation of all connected USB devices. :::{note} If a device is unplugged and plugged in again, it is assigned a new Port, Dev, and If." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show hardware usb serial", "cmd": "show hardware usb serial", "desc": "Troubleshooting — Retrieve a list and description of all connected USB serial devices. The device name displayed, (for example usb0b2.4p1.0), can be used directly when accessing the serial console as console-server device." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show version", "cmd": "show version", "desc": "Troubleshooting — Return the currently running VyOS version and build information. This includes the name of the release train, e.g., sagitta on VyOS 1.4, and circinus on VyOS 1.5." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show version kernel", "cmd": "show version kernel", "desc": "Troubleshooting — Return the version number of the currently running Linux kernel. :::{code-block} none vyos@vyos:~$ show version kernel 5.10.46-amd64-vyos :::" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "Troubleshooting", "title": "show version frr", "cmd": "show version frr", "desc": "Troubleshooting — Return the version number of FRR (Free Range Routing - ) used in this release." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "System", "title": "set system option reboot-on-upgrade-failure [timeout ]", "cmd": "set system option reboot-on-upgrade-failure [timeout ]", "desc": "System · system" }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp authentication mode ", "cmd": "set vpn sstp authentication mode ", "desc": "VPN — Set authentication backend. The configured authentication backend is used for all queries." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp authentication local-users username password ", "cmd": "set vpn sstp authentication local-users username password ", "desc": "VPN — Create for local authentication on this system. The users password will be set to ." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp client-ip-pool range ", "cmd": "set vpn sstp client-ip-pool range ", "desc": "VPN — Use this command to define the first IP address of a pool of addresses to be given to SSTP clients." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp default-pool ", "cmd": "set vpn sstp default-pool ", "desc": "VPN — Use this command to define default address pool name." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp gateway-address ", "cmd": "set vpn sstp gateway-address ", "desc": "VPN — Specifies single IP address to be used as local address of PPP interfaces." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp ssl ca-certificate ", "cmd": "set vpn sstp ssl ca-certificate ", "desc": "VPN — Name of installed certificate authority certificate." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp ssl certificate ", "cmd": "set vpn sstp ssl certificate ", "desc": "VPN — Name of installed server certificate." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp authentication radius server key ", "cmd": "set vpn sstp authentication radius server key ", "desc": "VPN — Configure RADIUS and its required shared for communicating with the RADIUS server." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp authentication radius source-address
", "cmd": "set vpn sstp authentication radius source-address
", "desc": "VPN — Source IPv4 address used in all RADIUS server queries." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp authentication radius server port ", "cmd": "set vpn sstp authentication radius server port ", "desc": "VPN — Configure RADIUS and its required port for authentication requests." }, { "os": "vyos", "role": "router", "vendor": "VyOS", "cat": "VPN", "title": "set vpn sstp authentication radius server fail-time