CLI Reference Guide

cmd>config
Commands:
show	Show configuration and status information
show commands	Show cli configuration commands
show running	Show running configuration
show initial	Show initial configuration
show diff	Show initial configuration
save	Save the running config to initial config
status config	Show configfuration status

cmd>diag
Commands:
show	Show configuration and status information
show commands.	Show cli configuration commands
status files list	List files
files remove <filename>	Remove the file with the specified name
files copy <filename> <destination>	Copy the specified files to a remote location
host <host>	Resolve DNS names
ping <host> [proto <proto>] [count <count>] [ttl <ttl>] [deadline <deadline>] [size <size>]	Ping a host
traceroute <host> [proto <proto>]	Trace the route to a host
tcpdump tofile interface <interface> [time <time>] [filter <filter>]	Capture network packets to a file
speedtest [json] [bytes]	Perform a speed to speedtest.net

cmd>dns
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
domain set <value>	Set the system domain name
domain clear	Clear the system domain name
search add <value> [at <position>]	Add hostname to the search domains
search delete <value>	Delete hostname from the search domains
search clear	Clear the search domains
search set [<value> ...]	Replace all hostnames in the search domains
search show	Show the search domains
server1 set <value>	Set the primary DNS server
server1 clear	Clear the primary DNS server
server2 set <value>	Set the secondary DNS server
server2 clear	Clear the secondary DNS server
server3 set <value>	Set the tertiary DNS server
server3 clear	Clear the tertiary DNS server
status dns	Show details of system dns settings

cmd>hostname
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
sources add <value> [at <position>]	Add a preferred source to the preferred source
sources delete <value>	Delete a preferred source from the preferred source
sources clear	Clear the preferred source
sources set [<value> ...]	Replace all a preferred sources in the preferred source
sources reset	Reset the preferred source back to default
sources show	Show the preferred source
hostname set <value>	Set the system hostname
hostname clear	Clear the system hostname
status hostname	Show details of system hostname settings

cmd>interface
Commands:
show	Show configuration and status information
show commands	Show cli configuration commands
status all	Show all the interfaces in the system
status show [bridges] [groups] [vlans] [vxlans] [ethernets] [all]	Show interface of the specified type(s)
status monitor	Show the monitoring state of each interface
add <type> <name>	Create an interface (bridge, vlan, group)
add vxlan <name> vni <vni> [dstport <dstport>] [interface <interface>]	Create a VXLAN interface

cmd>interface.eth0
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
status statistics [detailed]	Show interface statistics
status device	Show the device driver details
status sfp	Show the SFP details
identify [duration <duration>] [cancel]	Identify the interface by flashing the lights (if possible)

cmd>interface.eth0.addr
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
add <value> [at <position>]	Add an IP address or subnet to the IP addresses
delete <value>	Delete an IP address or subnet from the IP addresses
clear	Clear the IP addresses
set [<value> ...]	Replace all an IP address or subnets in the IP addresses
addr show	Show the IP addresses
status dhcp	Show the dhcp addresses present on this interface
status system	Show the interface addresses present in the system
status addresses	Show the interface address

cmd>interface.eth0.dhcp
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
enable	Enable the DHCP client
disable	Disable the DHCP client
routes enable	Enable the use of DHCP static routes
routes disable	Disable the use of DHCP static routes
status state	Show the state of the dhcp client process
status details	Show details of the DHCP configuration

cmd>interface.eth0.link
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
admin set <value>	Set the administrative state
admin clear	Clear the administrative state
mtu set <value>	Set the mtu
mtu clear	Clear the mtu
txqueuelen set <value>	Set the tx queue length
txqueuelen clear	Clear the tx queue length
allmulticast set <value>	Set reception of all multicast traffic
allmulticast clear	Clear reception of all multicast traffic
promisc set <value>	Set reception of all traffic
promisc clear	Clear reception of all traffic
status all	Show the IP link state

cmd> interface.eth0.monitor
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
enable	Enable monitoring of this interface
disable	Disable monitoring of this interface
merge-vlans enable	Enable merging of VLANs on this interface
merge-vlans disable	Disable merging of VLANs on this interface

cmd>interface.eth0.monitor.direction
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
direction set <value>	Set the default SPAN traffic direction
direction clear	Clear the default SPAN traffic direction

cmd>interface.eth0.phys
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
autoneg enable	Enable the auto negotiation behaviour
autoneg disable	Disable the auto negotiation behaviour
speed set <value>	Set the speed
speed clear	Clear the speed
duplex set <value>	Set the duplex mode
duplex clear	Clear the duplex mode
pause autoneg enable	Enable the auto negotiation behaviour
pause autoneg disable	Disable the auto negotiation behaviour
pause tx enable	Enable the sending of TX pause frames
pause tx disable	Disable the sending of TX pause frames
pause tx disable	Clear the sending of TX pause frames
pause rx enable	Enable the processing of RX pause frames
pause rx disable	Disable the processing of RX pause frames
pause rx disable	Clear the processing of RX pause frames
status link	Show the link information
status pause	Show the pause information

cmd>jobs
Commands:
show	Show configuration and status information
show commands	Show cli configuration commands
list [system] [user] [completed] [running] [all]	List jobs
view <id> [summary]	View details of a job
remove all	Remove all completed jobs
remove <id>	Remove a completed job
stop <id>	Stop a running job
kill <id>	Kill a running job

cmd>netflow
Commands:
show commands	Show cli configuration commands
show	Show the bridges/interfaces capturing traffic
capture <interface>	Capture traffic on bridge/interface
no capture <interface>	Stop capturing traffic on bridge/interface

cmd>ntp
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
servers add <value> [at <position>]	Add hostname or ip address to the ntp servers
servers delete <value>	Delete hostname or ip address from the ntp servers
servers clear	Clear the ntp servers
servers set [<value> ...]	Replace all hostname or ip addresss in the ntp servers
servers reset	Reset the ntp servers back to default
servers show	Show the ntp servers
type set <value>	Set the type of time synchronisation to use
type clear	Clear the type of time synchronisation to use
sync	Synchronise time now
status daemon	Show the status of the NTP and SNTP daemons
status ntpd	Show the NTPD status
status sinefa time	Show the status of the SINEFA time

cmd>proxy
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
enable	Enable the proxy for upstream connections
disable	Disable the proxy for upstream connections
port set <value>	Set the proxy port
port clear	Clear the proxy port
hostname set <value>	Set the proxy hostname or IP
hostname clear	Clear the proxy hostname or IP
username set <value>	Set the proxy username
username clear	Clear the proxy username
password set <value>	Set the proxy password
password clear	Clear the proxy password

cmd>proxyserver
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
enable	Enable the proxy server service
disable	Disable the proxy server service
listen set <value>	Set the IP address to listen for connections on
listen clear	Clear the IP address to listen for connections on
port set <value>	Set the Port to listen for connections on
port clear	Clear the Port to listen for connections on
bind set <value>	Set the IP address to bind outgoing connection to
bind clear	Clear the IP address to bind outgoing connection to
allow add <value> [at <position>]	Add an IP address or subnet to the allowed clients
allow delete <value>	Delete an IP address or subnet from the allowed clients
allow clear	Clear the allowed clients
allow set [<value> ...]	Replace all an IP address or subnets in the allowed clients
allow reset	Reset the allowed clients back to default
allow show	Show the allowed clients
deny add <value> [at <position>]	Add an IP address or subnet to the denied clients
deny delete <value>	Delete an IP address or subnet from the denied clients
deny clear	Clear the denied clients
deny set [<value> ...]	Replace all an IP address or subnets in the denied clients
deny show	Show the denied clients
filter add <value> [at <position>]	Add a domain name to the allowed server domains
filter delete <value>	Delete a domain name from the allowed server domains
filter clear	Clear the allowed server domains
filter set [<value> ...]	Replace all a domain names in the allowed server domains
filter reset	Reset the allowed server domains back to default
filter show	Show the allowed server domains
connectport add <value> [at <position>]	Add a port number to the allowed server ports
connectport delete <value>	Delete a port number from the allowed server ports
connectport clear	Clear the allowed server ports
connectport set [<value> ...]	Replace all a port numbers in the allowed server ports
connectport reset	Reset the allowed server ports back to default
connectport show	Show the allowed server ports
status daemon	Show the status of the proxy server daemon

cmd>route
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
add <target> via <gateway> [type <type>]	Add a route
delete <target> via <gateway> [type <type>]	Delete a route
replace <target> via <gateway> [type <type>]	Replace (or add) the the gateway for a route
status routes	Show the system routing table
status default gateway	Show the system default gateways

cmd>snmpd
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
enable	Enable the SNMP service
disable	Disable the SNMP service
syslocation set <value>	Set the system location
syslocation clear	Clear the system location
syscontact set <value>	Set the system contact information
syscontact clear	Clear the system contact information
rocommunity set <value>	Set the read only community
rocommunity clear	Clear the read only community
rwcommunity set <value>	Set the read/write community
rwcommunity clear	Clear the read/write community
status daemon	Show the status of the snmp daemon

cmd>system
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
timezone set <value>	Set the system timezone
timezone clear	Clear the system timezone
debug add <value> [at <position>]	Add component name to the debug components list
debug delete <value>	Delete component name from the debug components list
debug clear	Clear the debug components list
debug set [<value> ...]	Replace all component names in the debug components list
debug show	Show the debug components list
preferred_ips add <value> [at <position>]	Add ip address to the preferred primary ips list
preferred_ips delete <value>	Delete ip address from the preferred primary ips list
preferred_ips clear	Clear the preferred primary ips list
preferred_ips set [<value> ...]	Replace all ip addresss in the preferred primary ips list
preferred_ips show	Show the preferred primary ips list
remote_sources add <value> [at <position>]	Add a preferred source to the preferred source
remote_sources delete <value>	Delete a preferred source from the preferred source
remote_sources clear	Clear the preferred source
remote_sources set [<value> ...]	Replace all a preferred sources in the preferred source
remote_sources reset	Reset the preferred source back to default
remote_sources show	Show the preferred source
remote_ipv4 set <value>	Set the remote IPv4 address
remote_ipv4 clear	Clear the remote IPv4 address
remote_ipv6 set <value>	Set the remote IPv6 address
remote_ipv6 clear	Clear the remote IPv6 address
auto_update set <value>	Set automatic update policy
auto_update clear	Clear automatic update policy
status timezones	Show the available timezones
status platform	Show the system platform details
status memory	Show details of system memory
status swap	Show details of system swap
status cpu	Show details of system cpu
status load_avg	Show details of system load averages
status uptime	Show details of system uptime
status disk	Show details of system disks
status firmware	Show the system firmware details
status primary ip	Show the systems primary IP addresses
status server config	Show the server side config
reboot [force]	Reboot this system
factory defaults	Reset to factory defaults
factory defaults keep network	Reset to factory defaults. Keep network settings
factory defaults keep network no reboot	Reset to factory defaults. Keep network settings. Don't reboot
password set <password> [username <username>]	Set the system admin login password
update check	Check for software updates
update install	Install software updates
purge logs	Purge logs files from the system

cmd>system.recovery
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
status files list	List files
files remove <filename>	Remove the file with the specified name
files copy <filename> <destination>	Copy the specified files to a remote location
image url set <value>	Set the image url
image url clear	Clear the image url
image list	List the available recovery images
image update index	Update the list of available images
image fetch [version <version>] [latest] [current]	Fetch a recovery image
image purge [except] [version <version>] [latest] [current]	Purge downloaded images
partition install [version <version>] [latest] [current]	Replace the recovery image
reimage restore reboot	Reimage the system with the recovery image

cmd>system.registration
Commands:
show	Show configuration and status information
show commands	Show cli configuration commands
status registration	Show registration information
key set <key>	Set the registration key
register	Force an attempt to register

cmd>system.upstream
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
url set <value>	Set the upstream cloud url
url clear	Clear the upstream cloud url
redirected_url clear	Clear the redirected (region specific) url
status upstream	Show upstream information

cmd>watchdog
Commands:
show	Show configuration and status information
show config	Show configuration
show commands	Show cli configuration commands
timeout set <value>	Set the system watchdog timeout
timeout clear	Clear the system watchdog timeout
enable	Enable rebooting the system on watchdog timeout
disable	Disable rebooting the system on watchdog timeout

Articles in this section

Comments

Articles in this section

Related articles