Appendix B: Command Line Instructions¶
Help Command¶
You can access help instructions anytime in the console by entering help
or the ?
key. The ?
key can be used during any stage of command input to retrieve guidance on the current command or its parameters. When there’s only one possible command or parameter, the system can automatically complete it for you.
Help¶
Command: Help [cmd]
Function: Retrieve command assistance.
Applicable Views: All views
Parameters:
cmd
: Name of the command for which help is needed.
Examples:
Input
help
to display a list of all available commands.Input
help show
to see all options for the ‘show’ command, including detailed usage instructions.
View Switchover Command¶
Enable¶
[Command] Enable [15 [password
]]
[Function] Switches to privileged user level.
[View] Ordinary user view.
[Parameter]
15
: User right limit level, currently supports only level 15 for super users.password
: Optional. Corresponds to the privileged user level. If omitted, a prompt for password entry will appear.
[Example]
From ordinary user view, enter:
enable 123456
Switches to super user status using the password ‘123456’.
Disable¶
[Command] Disable
[Function] Exits the privileged user level.
[View] Super user view, configuration view.
[Parameter] None
[Example]
From super user view, enter:
disable
Returns to the ordinary user view.
End¶
[Command] End or !
[Function] Exits the current view and returns to the previous view.
[View] Configuration view.
[Parameter] None
[Example]
From configuration view, enter:
end
Returns to the super user view.
Exit¶
[Command] Exit
[Function] Exits the current view and returns to the previous view. In the ordinary user view, it exits the console.
[View] All views.
[Parameter] None
[Example]
From configuration view, enter:
exit
Returns to the super user view.
From ordinary user view, enter:
exit
Exits the console.
System State Commands¶
Show Version¶
[Command] Show version
[Function] Displays the router’s software type and version.
[View] All views
[Parameter] None
[Example]
Enter:
show version
Output includes:
Type: Displays the current factory type of equipment
Serial number: Displays the current factory serial number
Description: Displays the router type
Current version: Displays the software version
Bootloader version: Displays the bootloader version
Show System¶
[Command] Show system
[Function] Displays the router system’s information.
[View] All views
[Parameter] None
[Example]
Enter:
show system
Output includes system uptime, load average.
Show Clock¶
[Command] Show clock
[Function] Displays the system time of the router.
[View] All views
[Parameter] None
[Example]
Enter:
show clock
Output example: Sat Jan 1 00:01:28 UTC 2000
Show Modem¶
[Command] Show modem
[Function] Displays the state of the router’s modem.
[View] All views
[Parameter] None
[Example]
Enter:
show modem
Output includes modem type, state, manufacturer, product name, signal level, registration state, IMSI number, network type.
Show Log¶
[Command] Show log [lines n
]
[Function] Displays the system log of the router. Defaults to the latest 100 log entries.
[View] All views
[Parameter]
Lines
n
: Limits the number of displayed log entries. Positive values show the latest logs, negative values show the earliest logs, zero displays all logs.
[Example]
Enter:
show log
Displays the latest 100 log records.
Show Users¶
[Command] Show users
[Function] Displays the list of users logged into the router.
[View] All views
[Parameter] None
[Example]
Enter:
show users
Output includes a list of system users, with super users marked by an asterisk.
Show Startup-config¶
[Command] Show startup-config
[Function] Displays the router’s startup configuration.
[View] Super user view and configuration view
[Parameter] None
[Example]
Enter:
show startup-config
Displays the system’s startup configuration settings.
Show Running-config¶
[Command] Show running-config
[Function] Displays the router’s operational configuration.
[View] Super user view and configuration view
[Parameter] None
[Example]
Enter:
show running-config
Displays the operational configuration settings of the system.
Network Status Commands¶
Show Interface¶
[Command] Show interface
[Function] Displays information about the router’s port statuses.
[View] All views
[Parameter] None
[Example]
Enter:
show interface
Displays the status of all ports.
Show IP¶
[Command] Show ip
[Function] Displays the IP configuration of the router.
[View] All views
[Parameter] None
[Example]
Enter:
show ip
Shows the system’s IP status.
Show Route¶
[Command] Show route
[Function] Displays the router’s routing table.
[View] All views
[Parameter] None
[Example]
Enter:
show route
Shows the routing table of the system.
Show ARP¶
[Command] Show arp
[Function] Displays the ARP table of the router.
[View] All views
[Parameter] None
[Example]
Enter:
show arp
Displays the ARP table of the system.
Internet Testing Commands¶
Ping¶
[Command] Ping hostname
[count n
] [size n
] [source ip
]
[Function] Conducts an ICMP test on the specified host.
[View] All views
[Parameter]
hostname
: Address or domain name to test.count
: Number of ICMP echo requests to send.size
: Size of the ping packet in bytes.source
: Source IP address for the ping.
[Example]
Enter:
ping www.example.com
Tests connectivity to
www.example.com
and displays the results.
Telnet¶
[Command] Telnet hostname
[port
] [source ip
]
[Function] Connects to a specified host via Telnet.
[View] All views
[Parameter]
hostname
: Address or domain name of the host.port
: Port number to connect to.source
: Source IP address for the connection.
[Example]
Enter:
telnet 192.168.2.2
Logs into the host at 192.168.2.2 via Telnet.
Traceroute¶
[Command] Traceroute hostname
[maxhops n
] [timeout n
]
[Function] Traces the route packets take to a specified host.
[View] All views
[Parameter]
hostname
: Address or domain name of the destination.maxhops
: Maximum number of hops before stopping.timeout
: Timeout for each probe.
[Example]
Enter:
traceroute www.example.com
Displays the route to
www.example.com
and the results of the trace.
Configuration Command¶
Configure Terminal¶
[Command] Configure terminal
[Function] Switches to configuration view to manage settings from the terminal.
[View] Super user view
[Parameter] None
[Example]
Enter in super user view:
configure terminal
Switches to configuration view.
Hostname¶
[Command] Hostname [hostname
]
[Function] Sets or displays the router’s hostname.
[View] Configuration view.
[Parameter]
hostname
: New hostname for the router.
[Example]
To display the current hostname:
hostname
To set a new hostname:
hostname MyRouter
To reset to the default hostname:
default hostname
Clock Timezone¶
[Command] Clock timezone timezone
n
[Function] Sets the router’s time zone.
[View] Configuration view.
[Parameter]
timezone
: Time zone abbreviation.n
: Time zone offset from UTC.
[Example]
Set timezone to CST with an offset of -8:
clock timezone CST -8
Reset timezone to the default setting:
default clock timezone
NTP Server¶
[Command] Ntp server hostname
[Function] Configures the router to synchronize time with an NTP server.
[View] Configuration view.
[Parameter]
hostname
: IP address or domain name of the NTP server.
[Example]
Set the NTP server:
ntp server pool.ntp.org
Remove the NTP server setting:
no ntp server
Reset to the default NTP server:
default ntp server
Config Export¶
[Command] Config export
[Function] Exports the current configuration settings.
[View] Configuration view.
[Parameter] None
[Example]
Export the current configuration:
config export
Config Import¶
[Command] Config import
[Function] Imports configuration settings.
[View] Configuration view.
[Parameter] None
[Example]
Import configuration:
config import
System Management Commands¶
Reboot¶
[Command] Reboot
[Function] Restarts the system.
[View] Super user view and configuration view
[Parameter] None
[Example]
reboot
Initiates a system restart.
Enable Username¶
[Command] Enable username [name
]
[Function] Changes the super user’s username.
[View] Configuration view.
[Parameter]
name
: New super user username.
[Example]
enable username admin
Changes the super user’s username to admin.
Enable Password¶
[Command] Enable password [password
]
[Function] Changes the super user’s password.
[View] Configuration view.
[Parameter]
password
: New super user password.
[Example]
enable password newpassword
Updates the super user’s password to “newpassword”.
Username¶
[Command] Username name
[password [password
]]
[Function] Manages user credentials.
[View] Configure view.
[Parameter]
name
: Username to add or modify.password
: Password for the username.
[Example]
To add or update a user:
username abc password 123
Adds or updates the user “abc” with the password “123”.
To remove a user:
no username abc
Removes the user “abc”.
To reset to default settings:
default username
Resets all user settings to default, removing custom configurations.