Ubiquiti ES-24-250W Installation manual

CLI for PoE Switches
Models: ES-24-250W, ES-24-500W,
ES-48-500W, ES-48-750W CLI Command Reference

ii
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
Table of Contents
About This Document ............................................25
Purpose and Audience.............................................................26
Document Organization ...........................................................26
Products and Models ..............................................................26
Related Documents ...............................................................26
Typographical Conventions........................................................27
Chapter 1: Using the Command Line Interface......................28
Command Syntax .................................................................29
Command Conventions ...........................................................29
Common Parameter Values ........................................................29
slot/port Naming Convention......................................................30
Using the“no” Form of a Command ................................................30
Executing “show” Commands ......................................................31
CLI Output Filtering ...............................................................31
EdgeSwitch Modules ..............................................................32
Command Modes .................................................................32
Command Completion and Abbreviation ..........................................34
CLI Error Messages ................................................................34
CLI Line-Editing Conventions ......................................................35
Using CLI Help ....................................................................35
Accessing the CLI..................................................................36
Chapter 2: Management Commands ...............................37
Network Interface Commands .....................................................38
enable (Privileged EXEC access).................................................38
do (Privileged EXEC commands) ................................................38
network parms.................................................................38
network protocol ..............................................................38
network protocol dhcp .........................................................39
network mac-address ..........................................................39
network mac-type .............................................................39
network javamode .............................................................39
show network..................................................................40
Telnet Commands .................................................................42
ip telnet server enable..........................................................42
transport input telnet ..........................................................42
telnetcon maxsessions .........................................................42
telnetcon timeout..............................................................43
show telnetcon ................................................................43

iii
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
Secure Shell Commands ...........................................................44
ip ssh ..........................................................................44
ip ssh protocol .................................................................44
ip ssh server enable ............................................................44
sshcon maxsessions ............................................................44
sshcon timeout ................................................................45
show ip ssh ....................................................................45
Management Security Commands .................................................46
crypto certificate generate .....................................................46
crypto key generate rsa ........................................................46
crypto key generate dsa ........................................................46
Hypertext Transfer Protocol Commands ............................................47
ip http accounting exec, ip https accounting exec ...............................47
ip http authentication ..........................................................47
ip https authentication .........................................................48
ip http server ..................................................................48
ip http secure-server ...........................................................48
ip http session hard-timeout....................................................49
ip http session maxsessions ....................................................49
ip http session soft-timeout ....................................................49
ip http secure-session hard-timeout ............................................50
ip http secure-session maxsessions .............................................50
ip http secure-session soft-timeout .............................................50
ip http secure-port .............................................................50
ip http secure-protocol.........................................................51
show ip http ...................................................................51
Access Commands ................................................................52
disconnect.....................................................................52
show loginsession..............................................................52
show loginsession long.........................................................52
User Account Commands..........................................................53
aaa authentication login........................................................53
aaa authentication enable......................................................53
aaa authorization ..............................................................55
show authorization methods ...................................................55
enable authentication..........................................................56
username (Global Config) ......................................................56
username name nopassword ...................................................57
username name unlock ........................................................57
show users.....................................................................58
show users long................................................................58
show users accounts ...........................................................58
show users login-history [long] .................................................59

iv
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
show users login-history [username]............................................59
login authentication ...........................................................59
password ......................................................................60
password (Line Configuration)..................................................60
password (User EXEC) ..........................................................61
password (aaa IAS User Config) .................................................61
enable password (Privileged EXEC) .............................................61
passwords min-length..........................................................62
passwords history ..............................................................62
passwords aging ...............................................................62
passwords lock-out ............................................................63
passwords strength-check......................................................63
passwords strength maximum consecutive-characters ..........................63
passwords strength maximum repeated-characters .............................63
passwords strength minimum uppercase-letters ................................64
passwords strength minimum lowercase-letters.................................64
passwords strength minimum numeric-characters ..............................64
passwords strength minimum special-characters................................64
passwords strength minimum character-classes.................................65
passwords strength exclude-keyword...........................................65
show passwords configuration .................................................65
show passwords result .........................................................66
write memory..................................................................66
aaa ias-user username..........................................................66
aaa session-id ..................................................................67
aaa accounting.................................................................67
password (AAA IAS User Configuration) .........................................68
clear aaa ias-users ..............................................................69
show aaa ias-users .............................................................69
accounting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
show accounting...............................................................70
show accounting methods .....................................................70
clear accounting statistics ......................................................71
SNMP Commands .................................................................72
snmp-server ...................................................................72
snmp-server community .......................................................72
snmp-server community-group ................................................72
snmp-server enable traps violation .............................................73
snmp-server enable traps ......................................................73
snmp trap link-status...........................................................73
snmp trap link-status all ........................................................73
snmp-server enable traps linkmode ............................................74
snmp-server enable traps multiusers............................................74

v
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
snmp-server enable traps stpmode .............................................74
snmp-server engineID local ....................................................75
snmp-server filter ..............................................................75
snmp-server group.............................................................75
snmp-server host ..............................................................76
snmp-server user ..............................................................77
snmp-server view ..............................................................77
snmp-server v3-host ...........................................................78
snmptrap source-interface .....................................................78
show snmp ....................................................................79
show snmp engineID ..........................................................79
show snmp filters ..............................................................79
show snmp group..............................................................80
show snmp source-interface....................................................80
show snmp user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
show snmp views ..............................................................80
show trapflags .................................................................81
RADIUS Commands ...............................................................82
radius accounting mode........................................................82
radius server attribute 4 ........................................................82
radius server host ..............................................................82
radius server key ...............................................................83
radius server msgauth..........................................................84
radius server primary...........................................................84
radius server retransmit ........................................................84
radius source-interface .........................................................85
radius server timeout...........................................................85
show radius....................................................................86
show radius servers ............................................................86
show radius accounting ........................................................88
show radius accounting statistics ...............................................88
show radius source-interface ...................................................90
show radius statistics...........................................................90
TACACS+ Commands..............................................................92
tacacs-server host ..............................................................92
tacacs-server key...............................................................92
tacacs-server keystring .........................................................93
tacacs-server source-interface ..................................................93
tacacs-server timeout ..........................................................93
key ............................................................................94
keystring.......................................................................94
port ...........................................................................94
priority (TACACS Config)........................................................94

vi
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
timeout........................................................................95
show tacacs....................................................................95
show tacacs source-interface ...................................................95
Configuration Scripting Commands................................................96
script apply ....................................................................96
script delete ...................................................................96
script list .......................................................................97
script show ....................................................................97
script validate ..................................................................97
Prelogin Banner, System Prompt, and Host Name Commands .......................98
copy (pre-login banner) ........................................................98
set prompt.....................................................................98
hostname......................................................................98
show clibanner.................................................................98
set clibanner ...................................................................99
Chapter 3: Utility Commands .....................................100
AutoInstall Commands ...........................................................101
boot autoinstall ...............................................................101
boot host retrycount ..........................................................101
boot host dhcp ...............................................................101
boot host autosave............................................................102
boot host autoreboot .........................................................102
erase startup-config...........................................................102
erase factory-defaults .........................................................102
show autoinstall ..............................................................103
CLI Output Filtering Commands ..................................................104
show xxx | include "string".....................................................104
show xxx | include "string" exclude "string2" ...................................104
show xxx | exclude "string" ....................................................104
show xxx | begin "string" ......................................................105
show xxx | section "string" .....................................................105
show xxx | section "string" "string2" ............................................105
show xxx | section "string" include "string2" ....................................105
Dual Image Commands...........................................................106
delete ........................................................................106
boot system ..................................................................106
show bootvar .................................................................106
filedescr ......................................................................106
update bootcode .............................................................106
System Information and Statistics Commands .....................................107
show arp switch...............................................................107
show eventlog ................................................................107

vii
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
show hardware ...............................................................107
show version..................................................................108
show platform vpd ............................................................108
show interface ................................................................108
show interfaces status.........................................................109
show interfaces traffic .........................................................109
show interface counters .......................................................110
show interface ethernet .......................................................111
show interface ethernet switchport............................................114
show interface lag.............................................................114
show fiber-ports optical-transceiver ...........................................114
show fiber-ports optical-transceiver-info .......................................115
show mac-addr-table..........................................................116
process cpu threshold .........................................................117
show process app-list .........................................................117
show process app-resource-list ................................................118
show process cpu .............................................................118
show process proc-list.........................................................118
show running-config ..........................................................119
show running-config interface.................................................120
show .........................................................................120
dir ............................................................................122
show sysinfo ..................................................................123
show tech-support ............................................................123
length ........................................................................123
terminal length ...............................................................124
show terminal length .........................................................124
memory free low-watermark processor ........................................124
Box Services Commands..........................................................125
show version bootloader ......................................................125
environment temprange ......................................................125
environment trap .............................................................125
Logging Commands..............................................................126
logging buffered ..............................................................126
logging buffered wrap ........................................................126
logging cli-command .........................................................126
logging host ..................................................................126
logging host reconfigure ......................................................127
logging host remove ..........................................................127
logging port ..................................................................127
logging syslog ................................................................127
logging syslog port ...........................................................128
logging syslog source-interface................................................128

viii
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
show logging .................................................................128
show logging buffered ........................................................129
show logging hosts ...........................................................129
show logging persistent.......................................................130
show logging traplogs ........................................................130
clear logging buffered.........................................................130
Email Alerting and Mail Server Commands ........................................131
logging email .................................................................131
logging email urgent..........................................................131
logging email message-type to-addr ..........................................131
logging email from-addr ......................................................132
logging email message-type subject...........................................132
logging email logtime.........................................................132
logging traps .................................................................132
logging email test message-type ..............................................133
show logging email config ....................................................133
show logging email statistics ..................................................133
clear logging email statistics...................................................133
mail-server....................................................................134
security .......................................................................134
port ..........................................................................134
username (Mail Server Config) .................................................134
password .....................................................................134
show mail-server config .......................................................134
System Utility and Clear Commands ..............................................136
traceroute ....................................................................136
clear config ...................................................................138
clear counters.................................................................138
clear igmpsnooping ..........................................................138
clear pass .....................................................................138
clear traplog ..................................................................138
clear vlan .....................................................................138
logout ........................................................................139
ping ..........................................................................139
quit...........................................................................140
reload ........................................................................140
copy ..........................................................................140
file verify......................................................................143
Simple Network Time Protocol Commands ........................................144
sntp broadcast client poll-interval .............................................144
sntp client mode ..............................................................144
sntp client port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
sntp unicast client poll-interval ................................................144

ix
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
sntp unicast client poll-timeout................................................145
sntp unicast client poll-retry ...................................................145
sntp server....................................................................145
sntp source-interface..........................................................146
show sntp ....................................................................146
show sntp client ..............................................................146
show sntp server ..............................................................147
show sntp source-interface ....................................................147
Time Zone Commands ...........................................................148
clock set ......................................................................148
clock summer-time date.......................................................148
clock summer-time recurring ..................................................149
clock timezone................................................................149
show clock ...................................................................150
show clock detail..............................................................150
DHCP Server Commands .........................................................151
ip dhcp pool ..................................................................151
client-identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
client-name ...................................................................151
default-router.................................................................152
dns-server ....................................................................152
hardware-address.............................................................152
host ..........................................................................152
lease..........................................................................153
network (DHCP Pool Config)...................................................153
bootfile .......................................................................153
domain-name.................................................................153
domain-name enable .........................................................154
netbios-name-server ..........................................................154
netbios-node-type ............................................................154
next-server ...................................................................155
option ........................................................................155
ip dhcp excluded-address .....................................................155
ip dhcp ping packets ..........................................................156
service dhcp ..................................................................156
ip dhcp bootp automatic ......................................................156
ip dhcp conflict logging .......................................................156
clear ip dhcp binding..........................................................157
clear ip dhcp server statistics ..................................................157
clear ip dhcp conflict ..........................................................157
show ip dhcp binding .........................................................157
show ip dhcp global configuration.............................................157
show ip dhcp pool configuration ..............................................158

x
Table of ContentsEdgeSwitch CLI Command Reference
Ubiquiti Networks, Inc.
show ip dhcp server statistics..................................................158
show ip dhcp conflict .........................................................159
DNS Client Commands ...........................................................160
ip domain lookup .............................................................160
ip domain name ..............................................................160
ip domain list .................................................................160
ip name-server................................................................161
ip name source-interface ......................................................161
ip host ........................................................................161
ipv6 host......................................................................162
ip domain retry ...............................................................162
ip domain timeout ............................................................162
clear host .....................................................................162
show hosts....................................................................163
show ip name source-interface ................................................163
IP Address Conflict Commands ...................................................164
ip address-conflict-detect run .................................................164
show ip address-conflict.......................................................164
clear ip address-conflict-detect ................................................164
Serviceability Packet Tracing Commands ..........................................165
capture start ..................................................................165
capture stop ..................................................................165
capture file|remote|line........................................................165
capture remote port...........................................................166
capture file size ...............................................................166
capture line wrap .............................................................166
show capture packets .........................................................166
debug aaa accounting ........................................................166
debug aaa authorization ......................................................166
debug arp ....................................................................167
debug authentication .........................................................167
debug auto-voip ..............................................................167
debug clear ...................................................................168
debug crashlog ...............................................................168
debug debug-config ..........................................................168
debug dhcp packet ...........................................................169
debug dot1x packet...........................................................169
debug igmpsnooping packet..................................................169
debug igmpsnooping packet transmit .........................................169
debug igmpsnooping packet receive ..........................................170
debug ip acl ..................................................................171
debug ipv6 dhcp..............................................................171
debug lacp packet ............................................................171