Access the CLI on a VOS Device

For supported software information, click here.

You can access the CLI on a Versa Operating System^TM (VOS^TM) device from the Director GUI. You first open a shell window to the device from the Director GUI, and then start the CLI interface from the shell.

You can also access the CLI from a secure shell using SSH. For information about SSH access and default account information, see Configure Local Authentication.

Note that to open a shell window from a Director node, it is recommended that you use one of the following browsers:

• Chrome, Versa 71 or later
• Firefox, Version 60 or later

To access the CLI on a VOS device from a Director node:

1. In Director view, select the Administration tab in the top menu bar.
2. Select Appliances in the left menu bar. The following screen displays.
   
   
    
3. In the main pane, click the checkbox to the left of the branch name. The icons in the top panel become active.
   
   
    
4. Click the Appliance Shell  icon. A shell window displays.
   
   
5. Log in to the branch.
6. To start the CLI, issue the cli command at the shell prompt. The prompt changes to > to indicate you are in the CLI. You can change the CLI configuration and issue CLI show commands from this prompt.

[admin@Azure-WestUS-VGW-01: ~] $ cli                                                         

             .---.,
            (      ``.
       _     \        )    __      ________ _____   _____
      (  `.   \      /     \ \    / /  ____|  __ \ / ____|  /\
       \    `. )    /       \ \  / /| |__  | |__) | (___   /  \
        \     |    /         \ \/ / |  __| |  _  / \___ \ / /\ \
         \    |   /           \  /  | |____| | \ \ ____) / ____ \
          \   |  /             \/   |______|_|  \_\_____/_/    \_\
           \  | /
            \_|/                   _  _ ___ _______      _____  ___ _  _____
                                  | \| | __|_   _\ \    / / _ \| _ \ |/ / __|
                                  | .` | _|  | |  \ \/\/ / (_) |   / ' <\__ \
                                  |_|\_|___| |_|   \_/\_/ \___/|_|_\_|\_\___/


admin connected from 10.200.1.4 using ssh on Azure-WestUS-VGW-01
admin@Azure-WestUS-VGW-01-cli> 

7. At any CLI prompt, you can type in a question mark to display a list of valid commands.

admin@Azure-WestUS-VGW-01-cli> ?
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   

8. To switch to configuration mode, enter the configuration command. The prompt changes to %. You can issue VOS device configuration and VOS device show commands from this prompt.

admin@Azure-WestUS-VGW-01-cli> configure
Entering configuration mode private
[ok][2024-08-14 16:12:09]

[edit]
admin@Azure-WestUS-VGW-01-cli(config)% 

9. Issue the exit command to return to the > prompt.

admin@Azure-WestUS-VGW-01-cli(config)% exit
admin@Azure-WestUS-VGW-01-cli>

10. Issue the exit command to return to the shell.

admin@Azure-WestUS-VGW-01-cli> exit
[admin@Azure-WestUS-VGW-01: ~] $