Access the Versa CLI
For supported software information, click here.
The Versa CLI is a text-based interface that allows you to modify settings and configurations on Director and Analytics nodes, and on Versa Operating SystemTM (VOSTM) devices such as controllers and branches. You access the CLI from the shell on the device.
You can access the shell using the following methods:
- For Analytics and Director nodes, you can login to the shell using the SSH utility.
- For VOS devices, you can access the shell using Shell In a Box, a web-based terminal emulator, which is accessible from the Director GUI.
Login to a Shell Account on a Director or Analytics Node
You can login to a shell account on a Director or Analytics node using the SSH utility. For example, to access the admin shell account on an Analytics node with IP address 10.20.30.17, you can issue the following command from the built-in Terminal tool on a MacOS device.
user@MacOSDevice$ ssh 10.20.30.17 -l admin admin@Analytics$
Login to a Shell Account on a VOS Device
You can open a shell window to a VOS device from Director using Shell In a Box, and then login to a shell account from this window.. It is recommended that you use one of the following browsers:
- Chrome, Versa 71 or later
- Firefox, Version 60 or later
To open a shell window to a VOS device:
- In Director view, select the Administration tab in the top menu bar.
- Select Appliances in the left menu bar. The following screen displays.
- In the main pane, click the checkbox to the left of the VOS device name. The icons in the top panel become active.
- Click the Appliance Shell
icon. A shell window displays.
Access the Versa CLI
To access the Versa CLI:
- Login to a shell account on the Director node, Analytics node, or VOS device. Director nodes, Analytics nodes, and VOS devices come with a default shell account, named admin. For information about this account, contact Versa Networks customer support.
- To start the CLI, issue the cli command at the shell prompt. The prompt changes to > to indicate you are in the CLI.
admin@Branch1$ cli
.---.,
( ``.
_ \ ) __ ________ _____ _____
( `. \ / \ \ / / ____| __ \ / ____| /\
\ `. ) / \ \ / /| |__ | |__) | (___ / \
\ | / \ \/ / | __| | _ / \___ \ / /\ \
\ | / \ / | |____| | \ \ ____) / ____ \
\ | / \/ |______|_| \_\_____/_/ \_\
\ | /
\_|/ _ _ ___ _______ _____ ___ _ _____
| \| | __|_ _\ \ / / _ \| _ \ |/ / __|
| .` | _| | | \ \/\/ / (_) | / ' <\__ \
|_|\_|___| |_| \_/\_/ \___/|_|_\_|\_\___/
admin connected from 10.200.1.4 using ssh on Branch1
admin@Branch1>
- At any CLI prompt, you can type in a question mark to display a list of available commands. The available CLI commands vary, depending on whether you are on a Director node, Analytics node, or VOS device, and which CLI mode you are in.
admin@Branch1> ? Possible completions: clear - Clear parameter commit - Confirm a pending commit compare - Compare running configuration to another configuration or a file configure - Manipulate software configuration information describe - Display transparent command information diff-config - Generate 'set/delete' commands to change one config to another exit - Exit the management session file - Perform file operations help - Provide help information id - Show user id information monitor - Real-time debugging mtr - Trace a host with ping functionality ping - Ping a IPv4/IPv6 host quit - Exit the management session request - Make system-level requests scp - Securely copy a file to host script - Script actions set - Set CLI properties set-path - Set relative show path shell - Go to linux shell show - Show information about the system source - File to source ssh - Secure shell connection to remote host tcpdump - tcpdump for interfaces top - Exit to top level and optionally run command traceroute - Trace a host up - Exit one level of configuration wget - Download file from Web/Host in a non-interactive way xpath - Evaluate xpath expression
- To switch to configuration mode, enter the configure command. The prompt changes to %. You can issue configuration and show commands from this prompt.
admin@Branch1> configure admin@Branch1(config)%
- Enter CLI configuration commands in configuration mode. The following example configures a routing instance on a branch device.
admin@Branch1(config)% set routing-instances WAN1-Transport-VR interfaces [ tvi-0/3001.0 tvi-0/3002.0 ]
- When you are done entering configuration commands, enter the commit command to save your changes.
admin@Branch1(config)% commit
- Issue the exit command to return to the > prompt.
admin@Branch1(config)% exit admin@Branch1>
- Issue the exit command again to return to the shell.
admin@Branch1> exit admin@Branch1$
Supported Software Information
Releases 20.2 and later support all content described in this article.