.. _commandtree_operationmode: Operational mode ---------------- Operational mode allows for commands to perform operational system tasks and view system and service status. After this is the first view after the login. Please see :ref:`cli` for navigation in the CLI .. code-block:: sh vyos@vyos:~$ [tab] Possible completions: add Add an object to a service clear Clear system information clone Clone an object configure Enter configure mode connect Establish a connection copy Copy an object delete Delete an object disconnect Take down a connection force Force an operation format Format a device generate Generate an object install Install a new system monitor Monitor system information ping Send IPv4 or IPv6 ICMP (Internet Control Message Protocol) echo requests poweroff Poweroff the system reboot Reboot the system release Release specified variable rename Rename an object renew Renew specified variable reset Reset a service restart Restart a service set Set operational options show Show system information telnet Telnet to a node traceroute Track network path to node update Update data for a service Add ^^^ .. code-block:: sh raid Add a RAID set element system Add an item to a system facility Clear ^^^^^ .. code-block:: sh console Clear screen firewall Clear firewall statistics flow-accounting Clear flow accounting interfaces Clear interface information ip Clear Internet Protocol (IP) statistics or status ipv6 Clear Internet Protocol (IPv6) statistics or status nat Clear network address translation (NAT) tables policy Clear policy statistics Clone ^^^^^ The ``clone`` command allows you to clone a configuration from a system image to another one, or from the running config to another system image. To clone the running config to a system image: .. code-block:: sh clone system config from running To clone from system image A to system image B: .. code-block:: sh clone system config from Configure ^^^^^^^^^ The ``configure`` command allows you to enter configuration mode. .. code-block:: sh vyos@vyos:~$ configure [edit] vyos@vyos# Connect ^^^^^^^ The ``connect`` command allows you to bring up a connection oriented interface, like a pppoe interface. .. code-block:: sh connect interface Copy ^^^^ The ``copy`` command allows you to copy a file to your running config or over images. It can look like this example: .. code-block:: sh vyos@vyos:~$ copy file [tab] Possible completions: http://:@/ Copy files from specified source scp://:@/ ftp://:@/ tftp:/// 1.2.0://config/ 1.2.0-rolling+201902251818://config/ 1.2.0-rolling+201902201040://config/ 1.2.0-rolling+201902080337://config/ 1.2.0-H4://config/ running://config/ To copy from file A to file B: .. code-block:: sh copy to Delete ^^^^^^ .. code-block:: sh conntrack Delete Conntrack entries file Delete files in a particular image log Delete a log file raid Remove a RAID set element system Delete system objects Disconnect ^^^^^^^^^^ The ``disconnect`` command allows you to take down a connection oriented interface, like a pppoe interface. .. code-block:: sh disconnect interface Force ^^^^^ .. code-block:: sh arp Send gratuitous ARP request or reply cluster Force a cluster state transition Format ^^^^^^ The ``format`` command allows you to format a disk the same way as another one. .. code-block:: sh format disk like Generate ^^^^^^^^ .. code-block:: sh openvpn OpenVPN key generation tool ssh-server-key Regenerate the host SSH keys and restart the SSH server tech-support Generate tech-support archive vpn VPN key generation utility wireguard wireguard key generation utility Install ^^^^^^^ The ``install`` command allows you to install the system image on the disk. .. code-block:: sh install image Monitor ^^^^^^^ ``monitor`` can be used to continually view what is happening on the router. .. code-block:: sh bandwidth Monitor interface bandwidth in real time bandwidth-test Initiate or wait for bandwidth test cluster Monitor clustering service command Monitor an operational mode command (refreshes every 2 seconds) conntrack-sync Monitor conntrack-sync content-inspection Monitor Content-Inspection dhcp Monitor Dynamic Host Control Protocol (DHCP) dns Monitor a Domain Name Service (DNS) daemon firewall Monitor Firewall https Monitor the Secure Hypertext Transfer Protocol (HTTPS) service lldp Monitor Link Layer Discovery Protocol (LLDP) daemon log Monitor last lines of messages file nat Monitor network address translation (NAT) openvpn Monitor OpenVPN protocol Monitor routing protocols snmp Monitor Simple Network Management Protocol (SNMP) daemon stop-all Stop all current background monitoring processes traceroute Monitor the path to a destination in realtime traffic Monitor traffic dumps vpn Monitor VPN vrrp Monitor Virtual Router Redundancy Protocol (VRRP) webproxy Monitor Webproxy service Ping ^^^^ The ``ping`` command allows you to send an ICMP-EchoRequest packet and display the ICMP-EchoReply received. .. code-block:: sh Send Internet Control Message Protocol (ICMP) echo request Poweroff ^^^^^^^^ The ``poweroff`` command allows you to properly shut down the VyOS instance. Without any modifier, the command is executed immediately. .. code-block:: sh Execute the current command at Poweroff at a specific time cancel Cancel a pending poweroff in Poweroff in X minutes now Poweroff the system without confirmation Reboot ^^^^^^ The ``reboot`` command allows you to properly restart the VyOS instance. Without any modifier, the command is executed immediately. .. code-block:: sh Execute the current command at Poweroff at a specific time cancel Cancel a pending poweroff in Poweroff in X minutes now Poweroff the system without confirmation Release ^^^^^^^ The ``release`` command allows you to release a DHCP or DHCPv6 lease. .. code-block:: sh vyos@vyos:~$ release dhcp interface vyos@vyos:~$ release dhcpv6 interface Rename ^^^^^^ The ``rename`` command allows you to rename a system image. .. code-block:: sh rename system image Renew ^^^^^ The ``renew`` command allows you to renew a DHCP or DHCPv6 lease. .. code-block:: sh vyos@vyos:~$ renew dhcp interface vyos@vyos:~$ renew dhcpv6 interface Reset ^^^^^ .. code-block:: sh conntrack Reset all currently tracked connections conntrack-sync Reset connection syncing parameters dns Reset a DNS service state firewall reset a firewall group ip Reset Internet Protocol (IP) parameters ipv6 Reset Internet Protocol version 6 (IPv6) parameters nhrp Clear/Purge NHRP entries openvpn Reset OpenVPN terminal Reset terminal vpn Reset Virtual Private Network (VPN) information Restart ^^^^^^^ .. code-block:: sh cluster Restart cluster node conntrack-sync Restart connection tracking synchronization service dhcp Restart DHCP processes dhcpv6 Restart DHCPv6 processes dns Restart a DNS service flow-accounting Restart flow-accounting service https Restart https server vpn Restart IPsec VPN vrrp Restart the VRRP (Virtual Router Redundancy Protocol) process wan-load-balance Restart WAN load balancing webproxy Restart webproxy service Set ^^^ .. code-block:: sh