Ruckus Smart Zone 100 And Virtual Essentials Command Reference For SmartZone 3.6 Guide (SZ100/v SZ E) SZ100VSZE 36 CLIReference Rev A 20171110

User Manual: Ruckus SmartZone 3.6 Command Reference Guide (SZ100/vSZ-E)

Open the PDF directly: View PDF .
Page Count: 434

Download
Open PDF In Browser	View PDF

COMMAND REFERENCE GUIDE

Ruckus Smart Zone 100
and Virtual Smart Zone Essentials
Command Reference
Supporting SmartZone 3.6

Part Number: 800-71567-001 Rev A
Publication Date: November 2017

Copyright Notice and Proprietary Information
Copyright 2017 Brocade Communications Systems, Inc. All rights reserved.
No part of this documentation may be used, reproduced, transmitted, or translated, in any form or by any means, electronic, mechanical,
manual, optical, or otherwise, without prior written permission of or as expressly provided by under license from Brocade.

Destination Control Statement
Technical data contained in this publication may be subject to the export control laws of the United States of America. Disclosure to
nationals of other countries contrary to United States law is prohibited. It is the reader’s responsibility to determine the applicable regulations
and to comply with them.

Disclaimer
THIS DOCUMENTATION AND ALL INFORMATION CONTAINED HEREIN (“MATERIAL”) IS PROVIDED FOR GENERAL INFORMATION
PURPOSES ONLY. BROCADE and RUCKUS WIRELESS, INC. AND THEIR LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, WITH REGARD TO THE MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE MATERIAL IS ERROR-FREE,
ACCURATE OR RELIABLE. BROCADE and RUCKUS RESERVE THE RIGHT TO MAKE CHANGES OR UPDATES TO THE MATERIAL AT
ANY TIME.

Limitation of Liability
IN NO EVENT SHALL BROCADE or RUCKUS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL
DAMAGES, OR DAMAGES FOR LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY YOU OR ANY THIRD PARTY, WHETHER
IN AN ACTION IN CONTRACT OR TORT, ARISING FROM YOUR ACCESS TO, OR USE OF, THE MATERIAL.

Trademarks
Ruckus Wireless, Ruckus, the bark logo, BeamFlex, ChannelFly, Dynamic PSK, FlexMaster, Simply Better Wireless, SmartCell, SmartMesh,
SmartZone, Unleashed, ZoneDirector and ZoneFlex are trademarks of Ruckus Wireless, Inc. in the United States and in other countries.
Brocade, the B-wing symbol, MyBrocade, and ICX are trademarks of Brocade Communications Systems, Inc. in the United States and in
other countries. Other trademarks may belong to third parties.

2

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Contents
Preface........................................................................................................................................................................................................11
Document Conventions........................................................................................................................................................................11
Notes, Cautions, and Warnings.....................................................................................................................................................11
Command Syntax Conventions............................................................................................................................................................ 11
Document Feedback............................................................................................................................................................................12
Ruckus Product Documentation Resources......................................................................................................................................... 12
Online Training Resources.................................................................................................................................................................... 12
Contacting Ruckus Customer Services and Support............................................................................................................................13
What Support Do I Need?.............................................................................................................................................................13
Open a Case.................................................................................................................................................................................13
Self-Service Resources................................................................................................................................................................. 13
About This Guide........................................................................................................................................................................................ 15
Introduction..........................................................................................................................................................................................15
Introduction to the Controller Command Line Interface................................................................................................................................ 17
Overview of the Controller Command Line Interface............................................................................................................................. 17
Accessing the Command Line Interface............................................................................................................................................... 17
What You Will Need..............................................................................................................................................................................17
Connect the Administrative Computer to the Controller........................................................................................................................ 17
Start and Configure the SSH Client............................................................................................................................................... 18
Using SSH Connection........................................................................................................................................................................ 18
Using Serial Connection....................................................................................................................................................................... 19
Log On to CLI............................................................................................................................................................................... 23
Configuration Commands A - D.................................................................................................................................................................. 27
config...................................................................................................................................................................................................27
ad-service............................................................................................................................................................................................ 28
admin...................................................................................................................................................................................................30
admin-radius........................................................................................................................................................................................ 32
ap........................................................................................................................................................................................................ 34
ap-auto-approve.................................................................................................................................................................................. 43
ap-auto-tagging................................................................................................................................................................................... 44
ap-cert-check...................................................................................................................................................................................... 46
ap-cert-expired-check..........................................................................................................................................................................47
ap-certificate-reset............................................................................................................................................................................... 48
ap-control-mgmt-tos............................................................................................................................................................................49
ap-heartbeat........................................................................................................................................................................................ 50
ap-internal-subnet................................................................................................................................................................................51
app-denial-policy................................................................................................................................................................................. 52
app-port-mapping................................................................................................................................................................................54
cert-store............................................................................................................................................................................................. 55
changepassword................................................................................................................................................................................. 58
clock.................................................................................................................................................................................................... 59
cluster-ip-list.........................................................................................................................................................................................60
cluster-name........................................................................................................................................................................................ 61
dns-server-service................................................................................................................................................................................62
do........................................................................................................................................................................................................ 64

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

3

dp-group..............................................................................................................................................................................................65
Configuration Commands E - R...................................................................................................................................................................67
encrypt-mac-ip.................................................................................................................................................................................... 69
encrypt-zone-name..............................................................................................................................................................................70
end...................................................................................................................................................................................................... 71
eth-port-validate-one-trunk.................................................................................................................................................................. 72
event....................................................................................................................................................................................................73
event db-persistence........................................................................................................................................................................... 75
event email...........................................................................................................................................................................................76
event-email.......................................................................................................................................................................................... 77
event snmp-notification........................................................................................................................................................................ 78
event-threshold.................................................................................................................................................................................... 79
exit.......................................................................................................................................................................................................80
flexiVpn................................................................................................................................................................................................ 81
ftp-server............................................................................................................................................................................................. 82
ftp-test................................................................................................................................................................................................. 84
guest-access....................................................................................................................................................................................... 85
hccd.................................................................................................................................................................................................... 87
help......................................................................................................................................................................................................88
hostname.............................................................................................................................................................................................89
hotspot................................................................................................................................................................................................ 90
identity-provider................................................................................................................................................................................... 92
interface............................................................................................................................................................................................. 101
ip....................................................................................................................................................................................................... 104
ip control-nat......................................................................................................................................................................................105
ip internal-subnet............................................................................................................................................................................... 106
ip name-server................................................................................................................................................................................... 107
ip name-server-ipv6 .......................................................................................................................................................................... 108
ip route.............................................................................................................................................................................................. 109
ip route-ipv6.......................................................................................................................................................................................110
ipsec-profile....................................................................................................................................................................................... 111
lbs-service..........................................................................................................................................................................................115
ldap-service....................................................................................................................................................................................... 117
license................................................................................................................................................................................................119
license cloud...................................................................................................................................................................................... 120
license export.....................................................................................................................................................................................121
license import.....................................................................................................................................................................................122
license local....................................................................................................................................................................................... 123
license sync-now............................................................................................................................................................................... 124
lineman.............................................................................................................................................................................................. 125
localdb-service...................................................................................................................................................................................126
logging console..................................................................................................................................................................................127
lwapp2scg......................................................................................................................................................................................... 129
mgmt-acl........................................................................................................................................................................................... 131
no ad-service..................................................................................................................................................................................... 132
no admin............................................................................................................................................................................................133
no admin-radius................................................................................................................................................................................. 134
no ap................................................................................................................................................................................................. 135
no ap auto-approve........................................................................................................................................................................... 136
no ap auto-tagging.............................................................................................................................................................................137

4

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

no ap-cert-check............................................................................................................................................................................... 138
no ap-control-mgmt-tos.....................................................................................................................................................................139
no ap-group....................................................................................................................................................................................... 140
no block-client................................................................................................................................................................................... 141
no bonjour-fencing............................................................................................................................................................................. 142
no bonjour-fencing-policy................................................................................................................................................................... 143
no bonjour-gateway........................................................................................................................................................................... 144
no bonjour-policy............................................................................................................................................................................... 145
no cert-store...................................................................................................................................................................................... 146
no control-plane................................................................................................................................................................................. 147
no data-plane.....................................................................................................................................................................................148
no device-policy................................................................................................................................................................................. 149
no diffserv.......................................................................................................................................................................................... 150
no dns-server-service.........................................................................................................................................................................151
no dp-group.......................................................................................................................................................................................152
no encrypt-mac-ip............................................................................................................................................................................. 153
no event.............................................................................................................................................................................................154
no ethernet-port-profile...................................................................................................................................................................... 155
no ftp-server...................................................................................................................................................................................... 156
no guest-access................................................................................................................................................................................ 157
no hotspot......................................................................................................................................................................................... 158
no hotspot20-venue-profile................................................................................................................................................................ 159
no hotspot20-wlan-profile.................................................................................................................................................................. 160
no identity-provider............................................................................................................................................................................ 161
no interface........................................................................................................................................................................................ 162
no ip.................................................................................................................................................................................................. 163
no ipsec-profile.................................................................................................................................................................................. 165
no lbs-service.....................................................................................................................................................................................166
no ldap-service.................................................................................................................................................................................. 167
no lineman......................................................................................................................................................................................... 168
no logging.......................................................................................................................................................................................... 169
no oauth-service................................................................................................................................................................................ 170
no operator-profile..............................................................................................................................................................................171
no osu-portal-profile...........................................................................................................................................................................172
no outbound firewall...........................................................................................................................................................................173
no proxy-aaa......................................................................................................................................................................................174
no report............................................................................................................................................................................................ 175
no role................................................................................................................................................................................................176
no snmp-v2-community..................................................................................................................................................................... 177
no snmp-v3-user............................................................................................................................................................................... 178
no user-agent-blacklist....................................................................................................................................................................... 179
no user-role........................................................................................................................................................................................180
no user-traffic-profile.......................................................................................................................................................................... 181
no vlan-pooling.................................................................................................................................................................................. 182
no web-authentication........................................................................................................................................................................183
no wlan.............................................................................................................................................................................................. 184
no wlan-group....................................................................................................................................................................................185
no wlan-scheduler..............................................................................................................................................................................186
non-proxy-aaa................................................................................................................................................................................... 187
northbound-authtype......................................................................................................................................................................... 190

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

5

northbound-portal.............................................................................................................................................................................. 191
ntp-server.......................................................................................................................................................................................... 192
oauth-service..................................................................................................................................................................................... 193
operator-profile...................................................................................................................................................................................195
outbound-firewall............................................................................................................................................................................... 197
proxy-aaa...........................................................................................................................................................................................199
rebalance-aps.................................................................................................................................................................................... 202
report................................................................................................................................................................................................. 203
role.....................................................................................................................................................................................................206
Configuration Commands S - W................................................................................................................................................................209
sci-profile........................................................................................................................................................................................... 209
sci-setting.......................................................................................................................................................................................... 211
sms-server......................................................................................................................................................................................... 212
smtp-server........................................................................................................................................................................................214
snmp-notification............................................................................................................................................................................... 216
snmp-v2-community.......................................................................................................................................................................... 217
snmp-v3-user.................................................................................................................................................................................... 219
soft-gre.............................................................................................................................................................................................. 221
subpackages..................................................................................................................................................................................... 223
support-admin................................................................................................................................................................................... 224
syslog-server......................................................................................................................................................................................225
user-agent-blacklist............................................................................................................................................................................ 227
user-group......................................................................................................................................................................................... 229
user-role.............................................................................................................................................................................................230
user-traffic-profile............................................................................................................................................................................... 232
vlan-pooling....................................................................................................................................................................................... 235
zone...................................................................................................................................................................................................237
zone-template.................................................................................................................................................................................... 277
Debug Commands.................................................................................................................................................................................... 279
debug................................................................................................................................................................................................ 279
all-log-level......................................................................................................................................................................................... 280
ap-subnet-discovery.......................................................................................................................................................................... 281
apcli................................................................................................................................................................................................... 282
dataplane........................................................................................................................................................................................... 283
diagnostic.......................................................................................................................................................................................... 284
do...................................................................................................................................................................................................... 286
dpcli...................................................................................................................................................................................................287
dp-customized-config........................................................................................................................................................................ 288
end.................................................................................................................................................................................................... 289
exit.....................................................................................................................................................................................................290
export log...........................................................................................................................................................................................291
help....................................................................................................................................................................................................292
no all-log-level.................................................................................................................................................................................... 293
no ap-subnet-discovery..................................................................................................................................................................... 294
no dp-customized-config................................................................................................................................................................... 295
no output-format................................................................................................................................................................................296
no save.............................................................................................................................................................................................. 297
no schedule....................................................................................................................................................................................... 298
no screen-pagination......................................................................................................................................................................... 299

6

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

no sha1..............................................................................................................................................................................................300
no strict-wfa-compliance....................................................................................................................................................................301
no tlsv1.............................................................................................................................................................................................. 302
output-format.....................................................................................................................................................................................303
reindex-elasticsearch-all..................................................................................................................................................................... 304
save................................................................................................................................................................................................... 305
screen-pagination.............................................................................................................................................................................. 306
sha1...................................................................................................................................................................................................307
show ap-subnet-discovery-status...................................................................................................................................................... 308
show dp-customized-config...............................................................................................................................................................309
show sha1-state................................................................................................................................................................................ 310
show strict-wfa-compliance-state...................................................................................................................................................... 311
show tlsv1-state.................................................................................................................................................................................312
strict-wfa-compliance-state................................................................................................................................................................313
tlsv1................................................................................................................................................................................................... 314
Setup Commands..................................................................................................................................................................................... 315
rbd..................................................................................................................................................................................................... 315
rbddump............................................................................................................................................................................................316
setup................................................................................................................................................................................................. 317
Show Commands..................................................................................................................................................................................... 319
show admin-activity........................................................................................................................................................................... 320
show alarm........................................................................................................................................................................................ 322
show ap............................................................................................................................................................................................. 323
show ap-certificate-status.................................................................................................................................................................. 324
show ap-stats.................................................................................................................................................................................... 325
show backup..................................................................................................................................................................................... 330
Show backup-config.......................................................................................................................................................................... 331
show backup-config-state..................................................................................................................................................................332
show backup-network....................................................................................................................................................................... 333
show backup-schedule...................................................................................................................................................................... 334
show backup-state............................................................................................................................................................................ 335
show backup-upgrade-state.............................................................................................................................................................. 336
show client.........................................................................................................................................................................................337
show clock.........................................................................................................................................................................................338
show cluster.......................................................................................................................................................................................339
show cluster-node..............................................................................................................................................................................340
show cluster-state..............................................................................................................................................................................341
show control-plane-stats....................................................................................................................................................................342
show counter..................................................................................................................................................................................... 345
show cpuinfo..................................................................................................................................................................................... 346
show dhcp-relay-stats........................................................................................................................................................................347
show diskinfo..................................................................................................................................................................................... 348
show event........................................................................................................................................................................................ 349
show history.......................................................................................................................................................................................350
show interface....................................................................................................................................................................................351
show internal-subnet..........................................................................................................................................................................352
show license...................................................................................................................................................................................... 353
show ip.............................................................................................................................................................................................. 354
show logs-filter...................................................................................................................................................................................355

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

7

show md-stats................................................................................................................................................................................... 356
show meminfo................................................................................................................................................................................... 358
show ntp............................................................................................................................................................................................359
show radius-proxy-stats.....................................................................................................................................................................360
show radshm-stats............................................................................................................................................................................ 361
show report-result.............................................................................................................................................................................. 362
show rogue-aps................................................................................................................................................................................. 363
show running-config...........................................................................................................................................................................365
show service...................................................................................................................................................................................... 371
show upgrade-history........................................................................................................................................................................ 372
show upgrade-state........................................................................................................................................................................... 373
show version......................................................................................................................................................................................374
show wired- client.............................................................................................................................................................................. 375
show zone......................................................................................................................................................................................... 376
System Commands...................................................................................................................................................................................379
?........................................................................................................................................................................................................ 380
backup...............................................................................................................................................................................................381
backup config.................................................................................................................................................................................... 382
backup network................................................................................................................................................................................. 383
backup schedule................................................................................................................................................................................384
backup-upgrade................................................................................................................................................................................ 386
cluster in-service................................................................................................................................................................................ 387
config.................................................................................................................................................................................................388
copy...................................................................................................................................................................................................389
copy ap-certificate-request................................................................................................................................................................ 391
copy backup...................................................................................................................................................................................... 392
copy backup-config........................................................................................................................................................................... 393
copy backup-network........................................................................................................................................................................ 394
copy client......................................................................................................................................................................................... 395
copy report-result...............................................................................................................................................................................396
copy ftp-url........................................................................................................................................................................................ 397
delete backup.................................................................................................................................................................................... 398
delete backup-config......................................................................................................................................................................... 399
delete backup-network...................................................................................................................................................................... 400
delete client........................................................................................................................................................................................401
diagnostic.......................................................................................................................................................................................... 402
enable................................................................................................................................................................................................ 404
enable new password........................................................................................................................................................................ 405
exit.....................................................................................................................................................................................................406
help....................................................................................................................................................................................................407
log-diagnostic.................................................................................................................................................................................... 408
logout................................................................................................................................................................................................ 409
no service.......................................................................................................................................................................................... 410
patches..............................................................................................................................................................................................411
ping................................................................................................................................................................................................... 413
ping6................................................................................................................................................................................................. 414
reload.................................................................................................................................................................................................415
reload ap............................................................................................................................................................................................416
reload now......................................................................................................................................................................................... 417
remote ap-cli......................................................................................................................................................................................418

8

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

restore............................................................................................................................................................................................... 419
restore config..................................................................................................................................................................................... 420
restore local....................................................................................................................................................................................... 421
restore network.................................................................................................................................................................................. 422
service restart.....................................................................................................................................................................................423
service start....................................................................................................................................................................................... 424
set-factory..........................................................................................................................................................................................425
shutdown...........................................................................................................................................................................................426
shutdown now................................................................................................................................................................................... 427
traceroute.......................................................................................................................................................................................... 428
traceroute6........................................................................................................................................................................................ 431
upgrade............................................................................................................................................................................................. 432
upload ap-certificate-status................................................................................................................................................................433

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

9

10

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Preface
•
•
•
•
•
•

Document Conventions........................................................................................................................................... 11
Command Syntax Conventions............................................................................................................................... 11
Document Feedback............................................................................................................................................... 12
Ruckus Product Documentation Resources............................................................................................................ 12
Online Training Resources....................................................................................................................................... 12
Contacting Ruckus Customer Services and Support............................................................................................... 13

Document Conventions
The following tables list the text and notice conventions that are used throughout this guide.
TABLE 1 Text conventions
Convention

Description

monospace

Example

Identifies command syntax
examples.

bold

User interface (UI) components such
as screen or page names, keyboard
keys, software buttons, and field
names

On the Start menu, click All Programs.

italics

Publication titles

Refer to the Ruckus Small Cell Release Notes for more information

device(config)# interface ethernet 1/1/6

Notes, Cautions, and Warnings
Notes, cautions, and warning statements may be used in this document. They are listed in the order of increasing severity of potential
hazards.
NOTE
A NOTE provides a tip, guidance, or advice, emphasizes important information, or provides a reference to related information.
CAUTION
A CAUTION statement alerts you to situations that can be potentially hazardous to you or cause damage to hardware, firmware,
software, or data.
DANGER

A DANGER statement indicates conditions or situations that can be potentially lethal or extremely hazardous to you. Safety labels
are also attached directly to products to warn of these conditions or situations.

Command Syntax Conventions
Bold and italic text identify command syntax components. Delimiters and operators define groupings of parameters and their logical
relationships.
Convention

Description

bold text

Identifies command names, keywords, and command options.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

11

Preface
Document Feedback

Convention

Description

italic text

Identifies a variable.

[]

Syntax components displayed within square brackets are optional.
Default responses to system prompts are enclosed in square brackets.

{x|y|z}

A choice of required parameters is enclosed in curly brackets separated by vertical bars. You must select
one of the options.

x|y

A vertical bar separates mutually exclusive elements.

<>

Nonprinting characters, for example, passwords, are enclosed in angle brackets.

...

Repeat the previous element, for example, member[member...].

\

Indicates a “soft” line break in command examples. If a backslash separates two lines of a command input,
enter the entire command at the prompt without the backslash.

Document Feedback
Ruckus is interested in improving its documentation and welcomes your comments and suggestions.
You can email your comments to Ruckus at: docs@ruckuswireless.com
When contacting us, please include the following information:
•

Document title and release number

•

Document part number (on the cover page)

•

Page number (if appropriate)

•

For example:
–
–
–

Ruckus Small Cell Alarms Guide SC Release 1.3
Part number: 800-71306-001
Page 88

Ruckus Product Documentation Resources
Visit the Ruckus website to locate related documentation for your product and additional Ruckus resources.
Release Notes and other user documentation are available at https://support.ruckuswireless.com/documents. You can locate
documentation by product or perform a text search. Access to Release Notes requires an active support contract and Ruckus Support
Portal user account. Other technical documentation content is available without logging into the Ruckus Support Portal.
White papers, data sheets, and other product documentation are available at https://www.ruckuswireless.com.

Online Training Resources
To access a variety of online Ruckus training modules, including free introductory courses to wireless networking essentials, site surveys,
and Ruckus products, visit the Ruckus Training Portal at https://training.ruckuswireless.com.

12

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Preface
Contacting Ruckus Customer Services and Support

Contacting Ruckus Customer Services and Support
The Customer Services and Support (CSS) organization is available to provide assistance to customers with active warranties on their
Ruckus Networks products, and customers and partners with active support contracts.
For product support information and details on contacting the Support Team, go directly to the Support Portal using https://
support.ruckuswireless.com, or go to https://www.ruckuswireless.com and select Support.

What Support Do I Need?
Technical issues are usually described in terms of priority (or severity). To determine if you need to call and open a case or access the selfservice resources use the following criteria:
•

Priority 1 (P1)—Critical. Network or service is down and business is impacted. No known workaround. Go to the Open a Case
section.

•

Priority 2 (P2)—High. Network or service is impacted, but not down. Business impact may be high. Workaround may be available.
Go to the Open a Case section.

•

Priority 3 (P3)—Medium. Network or service is moderately impacted, but most business remains functional. Go to the Self-Service
Resources section.

•

Priority 4 (P4)—Low. Request for information, product documentation, or product enhancements. Go to the Self-Service
Resources section.

Open a Case
When your entire network is down (P1), or severely impacted (P2), call the appropriate telephone number listed below to get help:
•

Continental United States: 1-855-782-5871

•

Canada: 1-855-782-5871

•

Europe, Middle East, Africa, and Asia Pacific, toll-free numbers are available at https://support.ruckuswireless.com/contact-us and
Live Chat is also available.

Self-Service Resources
The Support Portal at https://support.ruckuswireless.com/contact-us offers a number of tools to help you to research and resolve problems
with your Ruckus products, including:
•

Technical Documentation—https://support.ruckuswireless.com/documents

•

Community Forums—https://forums.ruckuswireless.com/ruckuswireless/categories

•

Knowledge Base Articles—https://support.ruckuswireless.com/answers

•

Software Downloads and Release Notes—https://support.ruckuswireless.com/software

•

Security Bulletins—https://support.ruckuswireless.com/security

Using these resources will help you to resolve some issues, and will provide TAC with additional data from your troubleshooting analysis if
you still require assistance through a support case or RMA. If you still require help, open and manage your case at https://
support.ruckuswireless.com/case_management

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

13

14

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

About This Guide
•

Introduction............................................................................................................................................................. 15

Introduction
This SmartZone™ (SZ) 100 and Virtual SmartZone Essentials (vSZ-E) Command Line Interface Reference Guide contains the syntaxes and
commands for configuring and managing the SZ100/vSZ-E (collectively referred to as “the controller” throughout this guide) from the
command line interface.
This guide is written for service operators and system administrators who are responsible for managing, configuring, and troubleshooting
Ruckus Wireless devices. Consequently, it assumes a basic working knowledge of local area networks, wireless networking, and wireless
devices.
NOTE
If release notes are shipped with your product and the information there differs from the information in this guide, follow the
instructions in the release notes.
Most user guides and release notes are available in Adobe Acrobat Reader Portable Document Format (PDF) or HTML on the Ruckus
Wireless Support Web site at https://support.ruckuswireless.com/contact-us.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

15

16

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Introduction to the Controller Command
Line Interface
•
•
•
•
•
•

Overview of the Controller Command Line Interface................................................................................................ 17
Accessing the Command Line Interface.................................................................................................................. 17
What You Will Need.................................................................................................................................................17
Connect the Administrative Computer to the Controller........................................................................................... 17
Using SSH Connection............................................................................................................................................18
Using Serial Connection.......................................................................................................................................... 19

Overview of the Controller Command Line Interface
The Controller command line interface (CLI) is a software tool that enables you to configure and manage the controller. Using the command
line interface, you can issue commands from an operating system prompt, such as the Microsoft Windows command prompt or a Linux
operating system terminal. Each command performs a specific action for configuring device settings or returning information about the
status of a specific device feature.

Accessing the Command Line Interface
The controller has a built-in command line interface (CLI) that you can use to configure controller settings and manage access points. This
section describes the requirements and the procedure for accessing the controller’s CLI.

What You Will Need
To access the controller CLI, you will need the following:
1.

A computer that you want to designate as administrative computer

2.

A network connection to the controller (if you want to use an SSH connection) or an RS-232 serial to RJ45 cable (if you want to
use a serial connection)

3.

An SSH (secure shell) client

Connect the Administrative Computer to the
Controller
Connect the administrative computer to the controller either through the network or directly using an RS-232 serial to RJ45 cable.
1.

If you want to use an SSH connection, connect the administrative computer to the same subnet or broadcast domain as the
Management (Web) interface of the controller.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

17

Introduction to the Controller Command Line Interface
Using SSH Connection

2.

If you want to use a serial connection, make sure that both the administrative computer and the controller are both powered on.
And then, do the following:
•

Connect the RJ45 end of the cable to the port labeled |O|O| (console port) on the controller. See the figure below for the
location of the console port.

•

Connect the RS-232 end of the cable to a COM port on the administrative computer.

FIGURE 1 Location of console port

Start and Configure the SSH Client
Before starting this procedure, make sure that the SSH client is already installed on the administrative computer.
NOTE
The following procedure describes how to use PuTTY, a free and open source telnet/SSH client, to access the controller CLI. If
you are using a different SSH client, the procedure may be slightly different (although the connection settings should be the same).
For more information on PuTTY, visit www.putty.org.
See the following sections depending on your connection method:
•

Using SSH Connection on page 18

•

Using Serial Connection on page 19

Using SSH Connection
If you have connected the administrative computer to the same subnet or broadcast domain as the Management (Web) interface of the
controller, follow these steps to start and configure the SSH client.
1.

18

Start PuTTY. The PuTTY configuration dialog box appears, showing the Session screen as seen in Figure 2.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Introduction to the Controller Command Line Interface
Using Serial Connection

2.

In Connection type, select SSH.
If you have connected the administrative computer to the same subnet or broadcast domain as the Management (Web) interface
of the controller, follow these steps to start and configure the SSH client.
FIGURE 2 Selecting SSH as a connection type

3.

Enter the IP address of the Management (Web) interface of the controller in the Host Name (or IP address) field as seen in Figure
2.

4.

Click Open. The PuTTY console appears and displays the login prompt. See Figure 6 on page 23.

Using Serial Connection
If you have connected the administrative computer to the console port on the controller using an RS-232 serial to RJ45 cable, follow these
steps to start and configure the SSH client.
1.

Start PuTTY. The PuTTY Configuration dialog box appears, showing the Session screen as seen in Figure 3.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

19

Introduction to the Controller Command Line Interface
Using Serial Connection

2.

In Connection type, select Serial if you are connecting via serial cable.
FIGURE 3 Selecting serial as a connection type

20

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Introduction to the Controller Command Line Interface
Using Serial Connection

3.

Under Category, click Connection > Serial. The serial connection options appear on the right side of the dialog box, displaying
PuTTY’s default serial connection settings. See Figure 4.
FIGURE 4 PuTTy’s default serial connection setting

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

21

Introduction to the Controller Command Line Interface
Using Serial Connection

4.

Configure the serial connection settings as follows. See Figure 5.
•

Serial line to connect to: Type the COM port name to which you connected the RS-232 cable.

•

Bits per second: 115200

•

Data bits: 8

•

Stop bits: 1

•

Parity: None

•

Flow control: None

FIGURE 5 PuTTY’s serial connection settings for connecting to the controller

5.

22

Click Open. The PuTTY console appears and displays the login prompt as seen in Figure 6.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Introduction to the Controller Command Line Interface
Using Serial Connection

FIGURE 6 PuTTY console displaying the login prompt

You have completed configuring the SSH client to connect to the controller CLI.

Log On to CLI
The following describes the process for log on to the CLI.
•

Log on to the controller using putty/Xssh (any other application) using the user credentials of login name and password as given.
NOTE
You cannot use 'admin' as a password, which is used during the controller installation procedure.

•

The Ruckus Wireless controller CLI welcome message appears with the CLI prompt as seen in the following figure.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

23

Introduction to the Controller Command Line Interface
Using Serial Connection

FIGURE 7 Welcome to SmartZone

•

You are now logged into the controller CLI as a user with limited privileges by looking at the CLI prompt. If you are in limited mode,
the prompt appears as ruckus> (with a greater than sign). To view a list of commands that are available at the root level or user
mode, enter help or ? as seen in Figure 7 and Figure 8.
NOTE
To change the CLI prompt to a privileged mode, see step 5.

24

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Introduction to the Controller Command Line Interface
Using Serial Connection

FIGURE 8 Using Show Commands

•

As a user with limited privileges, you can view a history of commands that were previously executed and ping a device as seen in
Figure 9.
FIGURE 9 Using the Ping command

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

25

Introduction to the Controller Command Line Interface
Using Serial Connection

•

If you want to run more commands, you need to switch to privileged mode by entering enable and the password at the root
prompt as seen in Figure 10. The prompt changes from ruckus> to ruckus# (with a pound sign) as seen in Figure 10 . Refer to
enable on page 404 command for details.
FIGURE 10 Changing to privileged mode

26

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

config...................................................................................................................................................................... 27
ad-service............................................................................................................................................................... 28
admin......................................................................................................................................................................30
admin-radius........................................................................................................................................................... 32
ap........................................................................................................................................................................... 34
ap-auto-approve..................................................................................................................................................... 43
ap-auto-tagging...................................................................................................................................................... 44
ap-cert-check..........................................................................................................................................................46
ap-cert-expired-check.............................................................................................................................................47
ap-certificate-reset.................................................................................................................................................. 48
ap-control-mgmt-tos............................................................................................................................................... 49
ap-heartbeat........................................................................................................................................................... 50
ap-internal-subnet................................................................................................................................................... 51
app-denial-policy.....................................................................................................................................................52
app-port-mapping...................................................................................................................................................54
cert-store................................................................................................................................................................ 55
changepassword.....................................................................................................................................................58
clock....................................................................................................................................................................... 59
cluster-ip-list............................................................................................................................................................60
cluster-name........................................................................................................................................................... 61
dns-server-service................................................................................................................................................... 62
do........................................................................................................................................................................... 64
dp-group.................................................................................................................................................................65

config
To execute commands in configuration mode, you need to change the mode to:
ruckus(config)#

Example
SZ100-Node1#
SZ100-Node1# config
SZ100-Node1(config)#

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

27

Configuration Commands A - D
ad-service

ad-service
To create or update the active directory service configuration, use the following command:
ruckus(config)# ad-service name
Once you enter the config-admin context, you can configure the rest of the administrator’s profile (see example below).

Syntax Description
This command uses the following syntax:

name
Active service directory name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ad-service ads
SZ100-Node1(config-ad-service)#

Related Commands
The following table lists the related ad-service configuration commands.
TABLE 2 Commands related to ruckus(config-ad-service)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ad-service)# admin-domainname

domain-name

Sets the administrator domain name. This field
is applicable on executing the group attribute
command.

password

Sets the administrator domain password. This
field is applicable on executing the group
attribute command.

text

Sets the description

Type: Privileged
ruckus(config-ad-service)# admin-password
Type: Privileged
ruckus(config-ad-service)# description
Type: Privileged
ruckus(config-ad-service)# do

Executes the do command.

Type: Privileged
ruckus(config-ad-service)# email

email

Sets the user’s email details.

Type: Privileged
ruckus(config-ad-service)# end
Type: Privileged

28

Ends the current configuration session and
returns to privileged EXEC mode.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ad-service

TABLE 2 Commands related to ruckus(config-ad-service) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-ad-service)# exit

Description
Exits from the EXEC.

Type: Privileged

friendly-name

Sets friendly name for the active service
directory.

friendly-name

Enables the global catalog support

ruckus(config-ad-service)# group-attrs

attr-value: Group attribute value

Sets the user traffic profile mapping.

Type: Privileged

user-role: User Role

ruckus(config-ad-service)# friendly-name
Type: Privileged
ruckus(config-ad-service)# global-catalog
Type: Privileged

ruckus(config-ad-service)# help

Displays the help.

Type: Privileged

ip - Sets the primary server IP address

Sets the primary service IP address.

name

Sets the active directory service name.

ruckus(config-ad-service)# no

global-catalog

Disables the commands.

Type: Privileged

group-attrs attr-value

ruckus(config-ad-service)# port

port

Sets the primary server port.

domain-name Example: dc=domain,
dc=ruckuswireless, dc=com

Sets the windows domain name

text

Sets the user’s job title.

ruckus(config-ad-service)# ip-address
Type: Privileged
ruckus(config-ad-service)# name
Type: Privileged

Type: Privileged
ruckus(config-ad-service)# windows-domainname
Type: Privileged
ruckus(config-ad-service)# title
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

29

Configuration Commands A - D
admin

admin
To create or update the administrator’s profile (including the email address, login ID and password), use the following command:
ruckus(config)# admin name
Once you enter the config-admin context, you can configure the rest of the administrator’s profile (see example below).

Syntax Description
This command uses the following syntax:

name
Administrator user name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# admin joe
SZ100-Node1(config-admin)# email joe@company.com
SZ100-Node1(config-admin)# password admin!234
SZ100-Node1(config-admin)# phone 22870001
SZ100-Node1(config-admin)# real-name "Joe Admin"
SZ100-Node1(config-admin)# title CTO
SZ100-Node1(config-admin)# radius radius-1
SZ100-Node1(config-admin-radius)# ip 1.1.1.1
SZ100-Node1(config-admin-radius)# port 1813
SZ100-Node1(config-admin-radius)# realm tw1
SZ100-Node1(config-admin-radius)# shared-secret 11
Retype: **
SZ100-Node1(config-admin-radius)# exit
SZ100-Node1(config-admin)# exit
SZ100-Node1(config)#

Related Commands
The following table lists the related admin configuration commands.
TABLE 3 Commands related to ruckus(config-admin)
Syntax and Type

Parameters (if any)

ruckus(config-admin)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-admin)# email

email

Sets the user’s email details.

Type: Privileged

30

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
admin

TABLE 3 Commands related to ruckus(config-admin) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-admin)# end

Description
Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-admin)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-admin)# help

Displays the help.

Type: Privileged
ruckus(config-admin)# name

name

Sets the account name.

password

Sets the password for user.

phone

Sets the phone number of the user.

name

Sets the real name.

name

Sets the user role.

text

Sets the user’s job title.

Type: Privileged
ruckus(config-admin)# password
Type: Privileged
ruckus(config-admin)# phone
Type: Privileged
ruckus(config-admin)# real-name
Type: Privileged
ruckus(config-admin)# role
Type: Privileged
ruckus(config-admin)# title
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

31

Configuration Commands A - D
admin-radius

admin-radius
To configure the RADIUS server for administrators use the following command:
ruckus(config)# admin-radius

Syntax Description
This command uses the following syntax:

name
RADIUS server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config-admin)# radius
SZ100-Node1(config-admin-radius)#
SZ100-Node1(config-admin-radius)#
SZ100-Node1(config-admin-radius)#
SZ100-Node1(config-admin-radius)#
Retype: **
SZ100-Node1(config-admin-radius)#

radius-1
ip 1.1.1.1
port 1813
realm tw1
shared-secret 11
exit

Related Commands
The following table lists the related admin-radius-service configuration commands.
TABLE 4 Commands related to ruckus(config-radius-service)
Syntax and Type

Parameters (if any)

Description

ruckus(config-admin-radius)# backup

ip ip: Sets the IP address of secondary
RADIUS server

Enables backup of RADIUS server.

Type: Privileged

port port: Sets the port of secondary RADIUS
server
shared-secret: Sets the shared secret of
secondary RADIUS server
request-timeout seconds: Sets the request
timeout seconds for failover policy
max-retry number: Sets the maximum number
of retries for failover policy
retry-prilnvl minutes: Sets the reconnect
primary minutes for failover policy
ruckus(config-admin-radius)# do

32

Executes the do command.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
admin-radius

TABLE 4 Commands related to ruckus(config-radius-service) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus(config-admin-radius)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-admin-radius)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-admin-radius)# help

Displays the help.

Type: Privileged
ruckus(config-admin-radius)# ip

ip

Sets the IP addresses of the primary RADIUS
server.

name

Sets the RADIUS server name.

backup

Disables the backup RADIUS support.

port

Sets the port addresses of the primary
RADIUS server.

realms Multiple realms supported. Use a
comma (,) to separate realms
(example:home1,home2)

Sets the realms.

services: Multiple services supported. Use a
comma (,) to separate services
(example:home1,home2)

Sets the services.

shared-secret Shared secret between 1 and
255.

Sets the shared secret of the primary RADIUS
server.

username password [CHAP | PAP]

Tests the RADIUS server based on the user
credentials.

[ radius | tacacs ]]

Sets the admin authentication type,

Type: Privileged
ruckus(config-admin-radius)# name
Type: Privileged
ruckus(config-admin-radius)# no
Type: Privileged
ruckus(config-admin-radius)# port
Type: Privileged
ruckus(config-admin-radius)# realm
Type: Privileged
ruckus(config-admin-radius)# service
Type: Privileged
ruckus(config-admin-radius)# shared-secret
Type: Privileged
ruckus(config-admin-radius)# test
Type: Privileged
ruckus(config-admin-radius)# type
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

33

Configuration Commands A - D
ap

ap
To update the AP configuration, use the following commands:
ruckus(config)# ap mac
ruckus(config)# ap pre-prov import ftp-url export ftp-url
ruckus(config)# ap swap import ftp-url export ftp-url

Syntax Description
This command uses the following syntax:

mac lock
mac
AP MAC address
lock
Lock AP

mac pre-prov
mac
AP MAC address
pre-prov
Update Pre-provision configuration

mac swap
mac
AP MAC address
swap
Update Swap configuration

mac trigger-swap
mac
AP MAC address
trigger-swap
Trigger swap action

mac approve
mac
AP MAC address
approve
Approve AP to go ahead registration process

Default
This command has no default settings.

34

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap

Command Mode
Config

Example
ruckus(config)# ap mac
SZ100-Node1(config)# ap A1:87:45:34:56:FE
ruckus(config)# ap pre-prov >
SZ100-Node1(config)# ap pre-prov import ftp://ruckus:ruckus1!@172.19.7.100/backup/AP_ad8745345
ruckus(config)# ap swap >
SZ100-Node1(config)# ap swap export ftp://ruckus:ruckus1!@172.19.7.100

Related Commands
•

Table 5 lists the related config ap profile configuration commands.

•

Table 6 lists the related config-ap-model configuration commands.

•

Table 7 lists the related config-ap-mode-lan1l configuration commands.

The following table lists the related congig ap profile configuration commands.
TABLE 5 Commands related to ruckus(config-ap).
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# admin

logon password

Sets the administrative logon credentials.

locked unlocked

Sets the administrative mode to either locked
or unlocked.

logon-id

Sets the access point administration login
credentials.

ap-model

Sets the model specification (overrides the
zone configuration).

password

Sets the access point administrative
password.

areacode

Sets the user location information of LAC or
TAC.

Type: Privileged
ruckus(config-ap)# admin-mode
Type: Privileged
ruckus(config-ap)# ap-logon
Type: Privileged
ruckus(config-ap)# ap-model
Type: Privileged
ruckus(config-ap)# ap-password
Type: Privileged
ruckus(config-ap)# area-code
Type: Privileged
ruckus(config-ap)# ap-snmp-options

Sets the AP SNMP options.

Type: Privileged
ruckus(config-ap)# bonjour-gateway

Enables the bonjour gateway.

Type: Privileged
ruckus(config-ap)# bonjour-policy

Enables the bonjour policy.

Type: Privileged

seconds:The interval value (Range: 60-3600
sec)

Sets the channel evaluation interval.

ruckus(config-ap)# channel-select-mode

2.4g ${value}: 2.4GHz radio

Type: Privileged

5g ${value}: 5GHz radio

Sets a mode to automatically adjust AP
channels.

ruckus(config-ap)# channel-evaluation-interval
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

35

Configuration Commands A - D
ap

TABLE 5 Commands related to ruckus(config-ap). (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# channelfly-mtbc

2.4g number2.4GHz radio

Set MTBC value of ChannelFly

Type: Privileged

number: MTBC value (Range:100~1440)
5g number: 5GHz radio

ruckus(config-ap)# client-admission-control

2.4g

Type: Privileged

5g

Enables the client admission control.

2.4g minClientCount minClientCount : Min
Client Count (Default: 10)
2.4g maxRadioLoad maxRadioLoad Max
Radio Load (Default: 75%)
2.4g minClientThroughput
minClientThroughput: Min Client Throughput
(Default: 0.0Mbps)
5g minClientCount minClientCount : Min
Client Count (Default: 20)
5g maxRadioLoad maxRadioLoad : Max
Radio Load (Default: 75%)
5g minClientThroughput
minClientThroughput : Min Client Throughput
(Default: 0.0Mbps)
ruckus(config-ap)# description

description

Sets the model specification (overrides the
zone configuration).

[ ipv6 | ipv4 ]

Sets the device IP mode.

Type: Privileged
ruckus(config-ap)# device-ip-mode
Type: Privileged
ruckus(config-ap)# do

Executes the do command.

Type: Privileged
ruckus(config-ap)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-ap)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ap)# gps

latitude longitude

Sets the GPS coordinates to latitude and
longitude values.

gps-latitude

Sets the GPS coordination latitude.

gps-longitude

Sets the GPS coordination longitude.

Type: Privileged
ruckus(config-ap)# gps-latitude
Type: Privileged
ruckus(config-ap)# gps-longitude
Type: Privileged
ruckus(config-ap)# help

Displays the help.

Type: Privileged
ruckus(config-ap)# hotspot20
Type: Privileged

name [ swe | cze | spa | eng | chi | ger | fre |
jpn | dan | tur ]

Sets the hotspot 2.0 settings.

name: Name
swe: Swedish
cze: Czech

36

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap

TABLE 5 Commands related to ruckus(config-ap). (continued)
Syntax and Type

Parameters (if any)

Description

spa: Spanish
eng: English
chi: Chinese
ger: German
fre: French
jpn: Japanese
dan: Danish
tur: Turkish
ruckus(config-ap)# ip

address ip network-mask gateway

Type: Privileged

name-server dns-server secondary

ruckus(config-ap)# ip6

[ keep | auto ]: Retains the AP settings

Type: Privileged

static ipv6 gateway primaryDNS
secondaryDNS : Static IPv6 address with the
primary and secondary server details.

ruckus(config-ap)# location

location

Sets the location.

text

Sets the additional information for location.

[ disable | mesh | root | auto ]

Sets the mesh mode to either:

Sets the IP address and primary and
secondary DNS servers.
Sets the AP IPv6 address.

Type: Privileged
ruckus(config-ap)# location-additional-info
Type: Privileged
ruckus(config-ap)# mesh
Type: Privileged

disable: Disable
mesh: Mesh AP
root: Root AP
auto: Auto

ruckus(config-ap)# model

Sets the model specifications. It overrides the
zone configuration.

Type: Privileged

name

Sets the AP name.

ruckus(config-ap)# no

admin

Disables the configuration.

Type: Privileged

bonjour-gateway

...................................continued

ruckus(config-ap)# name
Type: Privileged

channel-evaluation-interval
channel-select-mode
client-admission-control
description
gps
hotspot20
ip address name-server secondary
ip6 address name-server secondary
location
location-additional-info

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

37

Configuration Commands A - D
ap

TABLE 5 Commands related to ruckus(config-ap). (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# no

model

Disables the configuration.

Type: Privileged

override-ap-mgmt-vlan
channel-select-mode
override-client-admission-control
override-smart-mon
override-syslog-opt
override-zone-location
override-zone-location-additional-info
no protection-mode
radio
smart-mon
swap-in-ap
syslog
uplink-ap
venue-profile

ruckus(config-ap)# override-ap-mgmt-vlan

vlanTag

Override AP Management VLAN.

2.4g : 2.4 GHz radio

Overrides the auto channel selection mode
and channelFly MTBC.

Type: Privileged
ruckus(config-ap)# override-channel-selectmode

5g : 5 GHz radio

Type: Privileged
ruckus(config-ap)# override-client-admissioncontrol

2.4g 5g

Overrides the client admission control.

Type: Privileged
ruckus(config-ap)# override-smart-mon

Overrides the smart monitor.

Type: Privileged
ruckus(config-ap)# override-syslog-opt

Override Syslog options

Type: Privileged
ruckus(config-ap)# override-zone-location

Overrides the zone location settings.

Type: Privileged
ruckus(config-ap)# override-zone-locationadditional-info

Overrides the zone’s additional information
setting on location.

Type: Privileged
ruckus(config-ap)# protection-mode

2.4g ${value}

Overrides the protection mode on 2.4 GHz
radio

ruckus(config-ap)# radio

2.4g channel channel

Sets the radio channels.

Type: Privileged

5g channel channel

Type: Privileged

2.4g channelization channelization
5g channelization channelization
2.4g tx-power tx-power

38

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap

TABLE 5 Commands related to ruckus(config-ap). (continued)
Syntax and Type

Parameters (if any)

Description

5g tx-power tx-power
2.4g wlan-service
5g wlan-service
2.4g wlan-group name
5g wlan-group name
2.4g roam [ enable | disable ]
5g roam [ enable | disable ]
ruckus(config-ap)# smart-mon

interval between 5-60

Type: Privileged

threshold between 1-10

ruckus(config-ap)# swap-in-ap

mac

Sets the AP Mac IP address for swap-in.

ruckus(config-ap)# syslog

enable ip port:Enable the syslog server

Sets the syslog server.

Type: Privileged

enable ip port [ Local2 | Keep Origina l |
Local1 | Local5 | Local6 | Local0 | Local7 |
Local3 | Local4 ] [ Error | Critical | Warning | All
| Alert | Notice | Info | Emergency ]

Enables the smart monitor.

Type: Privileged

disable - Disables the syslog server
ruckus(config-ap)# uplink

[ smart | manual ]

Type: Privileged
ruckus(config-ap)# uplink-ap

Sets the uplink selection to either smart or
manual.
Sets the uplink to manual access point.

Type: Privileged
ruckus(config-ap)# venue-profile

name

Sets the venue profile

name

Moves the access point to another zone.

Type: Privileged
ruckus(config-ap)# zone
Type: Privileged

The following table lists the related ap model configuration commands.
TABLE 6 Commands related to ruckus(config-ap-model)
Syntax and Type

Parameters (if any)

ruckus(config-ap-model)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-ap-model)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-ap-model)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ap-model)# ext-ant

2.4g number - 2.4 with DBI number

Type: Privileged

2.4gg number [ 3 | 2 ] - 3/2 antennas

Enables the external antenna.

5g number - 5g with DBI number
5gg number [ 2 | 3 ] - 5gg with 2/3 antennas

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

39

Configuration Commands A - D
ap

TABLE 6 Commands related to ruckus(config-ap-model) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-ap-model)# help

Description
Displays the help.

Type: Privileged
ruckus(config-ap-model)# internal-heater

Enables the internal heater.

Type: Privileged
ruckus(config-ap-model)# lan1

Sets the LAN configurations from 1 to 5.

ruckus(config-ap-model)# lan2
ruckus(config-ap-model)# lan3
ruckus(config-ap-model)# lan4
ruckus(config-ap-model)# lan5
Type: Privileged
ruckus(config-ap-model)# led

Enables the status of LEDs.

Type: Privileged
ruckus(config-ap-model)# led-mode

Sets the LED mode.

Type: Privileged
ruckus(config-ap-model)# lldp

Enables link layer discovery protocol.

Type: Privileged
ruckus(config-ap-model)# lldp-ad-interval

seconds

Sets the LLDP advertise interval.

seconds

Sets the LLDP hold time.

Type: Privileged
ruckus(config-ap-model)# lldp-hold-time
Type: Privileged
ruckus(config-ap-model)# lldp-mgmt

Enables LLDP management IP TLV.

Type: Privileged
ruckus(config-ap-model)# no

ext-ant

Type: Privileged

internal-heater

Disables or deletes the settings that have
been configured.

lan1
lan2
lan3
lan4
lan5
led
lldp
lldp-mgmt
poe-operating-mode
poe-out-port
radio-band
usb
usb-software
ruckus(config-ap-model)# poe-operatingmode

40

Switches the PoE mode.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap

TABLE 6 Commands related to ruckus(config-ap-model) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus(config-ap-model)# poe-out-port

Enables the PoE out port.

Type: Privileged
ruckus(config-ap-model)# radio-band

${value}

Switches the radio band.

ap-model [ enable | disable]

Sets the USB port for a specific AP model.

value

Sets the AP USB software package.

Type: Privileged
ruckus(config-ap-model)# usb
Type: Privileged
ruckus(config-ap-model)# usb-software
Type: Privileged

The following table lists the related to ap-model-lan1 configuration commands.
TABLE 7 Commands related to ruckus(config-ap-model-lan1)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap-model-lan1)# 8021x

802.1x-type

Sets 802.1x.

acct-service

Sets the authentication service configurations.

auth-service

Sets the authentication service configurations.

Type: Privileged
ruckus(config-ap-model-lan1)# acct-service
Type: Privileged
ruckus(config-ap-model-lan1)# auth-service
Type: Privileged
ruckus(config-ap-model-lan1)# do

Executes the do command.

Type: Privileged
ruckus(config-ap-model-lan1)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-ap-model-lan1)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ap-model-lan1)# help

Displays the help.

Type: Privileged
ruckus(config-ap-model-lan1)# no

overwrite

Does not permit overwriting.

Type: Privileged
ruckus(config-ap-model-lan1)# mac-bypass

Sets the MAC bypass.

Type: Privileged

members

Sets the AP model configurations.

ruckus(config-ap-model-lan1)# no

acct-service

Type: User

mac-bypass

Disables or deletes the settings that have
been configured.

ruckus(config-ap-model-lan1)# profile

profile : Ethernet port profile.

Sets the Ethernet port profile.

mac

Sets the supplicant.

ruckus(config-ap-model-lan1)# members
Type: Privileged

Type: Privileged
ruckus(config-ap-model-lan1)# supplicant

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

41

Configuration Commands A - D
ap

TABLE 7 Commands related to ruckus(config-ap-model-lan1) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged

custom username password

ruckus(config-ap-model-lan1)# type

[trunk-port | access-port | general-port]

Sets the port type.

vlan-untag-id

Sets the VLAN untag ID.

members: VLAN members

Sets the VLAN members.

Type: Privileged
ruckus(config-ap-model-lan1)# vlan-untag-id
Type: Privileged
ruckus(config-ap-model-lan1)# vlan-members
Type: Privileged

42

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap-auto-approve

ap-auto-approve
To enable auto approve, use the following command:
ruckus(config)# ap-auto-approve

Syntax Description
This command has no arguments or keywords

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ap-auto-approve
Successful operation

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

43

Configuration Commands A - D
ap-auto-tagging

ap-auto-tagging
To setup critical access point auto tagging rules or to enable auto tagging critical access points, use the following command:
ruckus(config)# ap-auto-tagging

Syntax Description
This command has no arguments or keywords

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ap-auto-tagging
SZ100-Node1(config-ap-auto-tagging)#

Related Commands
The following table lists the related to ap-auto-tagging configuration commands.
TABLE 8 Commands related to ruckus(config-ap-auto-tagging)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap-auto-tagging)# do

Executes the do command.

Type: Privileged
ruckus(config-ap-auto-tagging)# enable

Enables the auto tagging for critical APs.

Type: Privileged
ruckus(config-ap-auto-tagging)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-ap-auto-tagging)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ap-auto-tagging)# help

Displays the help.

Type: Privileged
ruckus(config-ap-auto-tagging)# no

enable

Disables the auto tagging for critical APs.

daily-threshold - Traffic bytes exceeds
threshold rule

Selects the auto tagging rule. To view this
command the ap-auto-tagging should be
enabled.

Type: Privileged
ruckus(config-ap-auto-tagging)# rule
Type: Privileged

44

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap-auto-tagging

TABLE 8 Commands related to ruckus(config-ap-auto-tagging) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap-auto-tagging)# threshold

daily-

Disables the auto tagging for critical APs. To
view this command the ap-auto-tagging
should be enabled.

[m|g]

Sets the unit to either mega bytes or giga
bytes.

Type: Privileged
ruckus(config-ap-auto-tagging)# unit
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

45

Configuration Commands A - D
ap-cert-check

ap-cert-check
To enable the access point certificate check, use the following command:
ruckus(config)# ap-cert-check

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ap-cert-check
Successful operation

46

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap-cert-expired-check

ap-cert-expired-check
To enable checking of AP expired certificate use the following command:

Syntax
ruckus(config)# ap-cert-expired-check

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
ruckus(config)# ap-cert-expired-check

Related Command
ruckus(config)#no ap-cert-expired-check
Disables the checking of AP expired certificates.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

47

Configuration Commands A - D
ap-certificate-reset

ap-certificate-reset
To the AP certificate request which failed to update the certificate, use the following command:
ruckus(config)# ap-certificate-reset

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ap-certificate-reset

48

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap-control-mgmt-tos

ap-control-mgmt-tos
To enable the access control and management traffic type of service and values, use the following command:
ruckus(config)# ap-control-mgmt-tos value

Syntax Description
This command has no arguments or keywords.

Default
This command uses the following syntax:
value: TOS value

Command Mode
Config

Example
SZ100-Node1(config)# ap-control-mgmt-tos 10

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

49

Configuration Commands A - D
ap-heartbeat

ap-heartbeat
To setup the access point heartbeat, use the following command:
ruckus(config)# ap-heartbeat seconds

Syntax Description
This command uses the following syntax:

seconds
Interval in seconds, which the AP sends the heartbeat to the controller such as: 30, 60, 150 and 300

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ap-heartbeat 30

50

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
ap-internal-subnet

ap-internal-subnet
To set the tunnel internal subnet use the following command:

Syntax
ruckus(config)# ap-internal-subnet < ip >

Syntax Description
This command has the below arguments or keywords:
ip : IP address of the subnet in the format 10.X.0.0

Default
This command has no default settings.

Command Mode
Config

Example
ruckus(config)# ap-internal-subnet 10.0.0.0

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

51

Configuration Commands A - D
app-denial-policy

app-denial-policy
To create or update an Application Denial Policy, use the following command:
ruckus(config)# app-denial-policy name

Syntax Description
This command has the following parameter:

name
application name

Default
This command has no default settings.

Command Mode
Privileged

Example
SZ100-Node1(config)# app-denial-policy xyz

Related Commands
The following table lists the related app-denial-policy configuration commands.
TABLE 9 Commands related to ruckus(config-app-denial-policy)
Syntax and Type

Parameters (if any)

Description

ruckus(config-app-denial-policy)# description

text

Sets the description.

Type: Privileged
ruckus(config-app-denial-policy)# rule

Creates/Updates Application Denial Policy rule

Type: Privileged
ruckus(config-app-denial-policy)# no

rule

Removes Application Denial Policy rule.

Type: Privileged

app-denial-policy lists the related app-denial-policy-rule configuration commands.
TABLE 10 Commands related to ruckus(config-app-denial-policy-rule)
Syntax and Type

Parameters (if any)

Description

ruckus(config-app-denial-policy-rule)#
applicationtype

[ port | http-domain-name ]

Sets the application type.

Type: Privileged

52

port: Port
http-domain-name: HTTP
domain name

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
app-denial-policy

TABLE 10 Commands related to ruckus(config-app-denial-policy-rule) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-app-denial-policy-rule)#
content

content

Sets the content.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

53

Configuration Commands A - D
app-port-mapping

app-port-mapping
To create or update application port mapping, use the following command:
ruckus(config)# app-port-mapping name

Syntax Description
This command has the following parameter:

name
application name

Default
This command has no default settings.

Command Mode
Privileged

Example
SZ100-Node1(config)# app-port-mapping abc

Related Commands
The following table lists the related app-port-mapping configuration commands.
TABLE 11 Commands related to ruckus(config-app-port-mapping)
Syntax and Type

Parameters (if any)

Description

ruckus(config-app-port-mapping)# port

port: Port

Sets the port.

[tcp | udp]

Sets the protocol

Type: Privileged
ruckus(config-app-port-mapping)# protocol
Type: Privileged

54

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
cert-store

cert-store
To create or update certificate configurations, use the following command:
ruckus(config)# cert-store ap-cert name
ruckus(config)# cert-store cert name
ruckus(config)# cert-store csr name
ruckus(config)# cert-store hotspot-cert name
ruckus(config)# cert-store web-cert name

Syntax Description
This command uses the following syntax:
ap-cert name
Create / updates the AP port certificate
cert name
Create / updates the certificate configuration
csr name
Create / updates CSR (Certificate Signing Request) configuration
hotspot-cert name
Sets the hotspot certificate
web-cert name
Sets the management web certificate

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# cert-store cert apcert
SZ100-Node1(config-cert)#

Related Commands
The following table lists the related cert-store configuration commands.
TABLE 12 Commands related to ruckus(config-cert-store) configuration
Syntax and Type

Parameters (if any)

Description

ruckus(config-cert-store)# cert

ftp-url

Uploads the certificate file.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

55

Configuration Commands A - D
cert-store

TABLE 12 Commands related to ruckus(config-cert-store) configuration (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged

ftp-url append

ruckus(config-cert-store)# city

city

Sets the city

domain-name

Sets the domain name

country

Sets the country.

text

Sets the description

Type: Privileged
ruckus(config-cert-store)# common-name
Type: Privileged
ruckus(config-cert-store)# country
Type: Privileged
ruckus(config-cert-store)# description
Type: Privileged
ruckus(config-cert-store# do

Executes the do command.

Type: Privileged
ruckus(config-cert-store)# email

email

Sets the email address.

Type: Privileged
ruckus(config-cert-store)# end

Ends the current configuration session and
return to privileged EXEC mode.

Type: Privileged
ruckus(config-cert-store)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-cert-store)# help

Displays the help.

Type: Privileged
ruckus(config-cert-store)#inter-cert

ftp-url:FTP URL

Type: Privileged

format: ftp://username:password@ftp-host/

Upload intermediate CA certificate.

file-path
ruckus(config-cert-store)# no

inter-cert

Disables all commands.

Type: Privileged

root-cert

ruckus(config-cert-store)# organization

org

Sets the organization.

passphrase

Sets the key passphrase.

ruckus(config-cert-store)# private-key

upload ftp-url

Sets the private key.

Type: Privileged

csr csr-name

ruckus(config-cert-store)# root-cert

ftp-url:FTP URL

Type: Privileged

format: ftp://username:password@ftp-host/

Type: Privileged
ruckus(config-cert-store)# passphrase
Type: Privileged

Select the root certificate.

file-path
ruckus(config-cert-store)# root-cert-type

Sets the certificate type to trusted root
certificate.

Type: Privileged
ruckus(config-cert-store)# server-cert

ftp-url:FTP URL

Type: Privileged

format: ftp://username:password@ftp-host/
file-path

ruckus(config-cert-store)# state

state

Upload server certificates.

Sets the state

Type: Privileged

56

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
cert-store

TABLE 12 Commands related to ruckus(config-cert-store) configuration (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-cert-store)# unit

org-unit

Sets the organization unit.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

57

Configuration Commands A - D
changepassword

changepassword
To change the administrative password, use the following command:
ruckus(config)# changepassword

old password
new password

Syntax Description
This command uses the following syntax:

old password
Existing password
new password
Changed password.
The password must contain at least eight characters with at least one number, one letter, and one special character (~ !
@ # $ % ^ & * ( ) - _ = + [ ] { } \ | ; : ' " , . < > / ?) except ` or $(.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# changepassword
Old Password: *******
New Password: *******

58

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
clock

clock
To update the system clock or the timezone configuration, use the following command:
ruckus(config)# clock timezone timezone

Syntax Description
This command uses the following syntax:
timezone
Sets the system clock timezone

timezone
Timezone name of the domain

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# clock timezone Africa/Nairobi

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

59

Configuration Commands A - D
cluster-ip-list

cluster-ip-list
To update the node IP address mapping list of the cluster configuration, use the following command:
ruckus(config)# cluster-ip-list ip-mappings

Syntax Description
This command uses the following syntax:

ip-mappings
Node IP mapping list, which is space separated.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# cluster-ip-list : :
SZ100-Node1(config)# cluster-ip-list 172.19.18.96:172.19.13.56 172.19.15.67:172.19.10.07

60

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
cluster-name

cluster-name
To change the cluster name, use the following command:
ruckus(config)# cluster-name cluster-name

Syntax Description
This command uses the following syntax:

cluster-name
Change the cluster name.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# cluster-name cls1

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

61

Configuration Commands A - D
dns-server-service

dns-server-service
To create or update DNS server services, use the following command.
ruckus(config)# dns-server-service

Syntax Description
This command has the following keywords:

name
DNS server service name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# dns-server-service xy

Related Commands
The following table lists the related dns-server-service configuration commands.
TABLE 13 Commands related to ruckus(config-dns-server-service)
Syntax and Type

Description

ruckus(config-dns-server-service)# description
Type: Privileged

Sets description.

ruckus(config-dns-server-service)# do
Type: Privileged

Executes the do command.

ruckus(config-dns-server-service)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-dns-server-service)# end
Type: Privileged

Ends the current configuration session and returns
to the privileged EXEC mode.

ruckus(config-dns-server-service)# help
Type: Privileged

Displays help.

ruckus(config-dns-server-service)# name
Type: Privileged

62

Parameters (if any)



Sets the DNS server services name.

ruckus(config- dns-server - service) ## no
Type: Privileged

Disable and delete commands.

ruckus(config-dns-server-service) # primary-ip
Type: Privileged

Sets the primary IP address.

ruckus(config- dns-server - service) ## secondary-ip
Type: Privileged

Sets the secondary IP address.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
dns-server-service

TABLE 13 Commands related to ruckus(config-dns-server-service) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-dns-server-service) # no description
Type: Privileged

Delete the description.

ruckus(config- dns-server-service) # no primary-ip
Type: Privileged

Deletes the primary IP address.

ruckus(config-dns-server-service) ## no secondaryip
Type: Privileged

Deletes the secondary IP address.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

63

Configuration Commands A - D
do

do
To setup the do command, use the following command.
ruckus(config)# do

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# do

64

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands A - D
dp-group

dp-group
To enable and sets the data plane grouping, use the following command.
ruckus(config)# dp-group dp-mac-group

Syntax Description
This command uses the following syntax:

dp-mac-group
Dataplane groups, which is comma separated DP MAC addresses in a group. For example, 3 DP value is seen as “,”.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# dp-group dp1-172.19.7.100 dp2-172.19.8.120

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

65

66

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

encrypt-mac-ip........................................................................................................................................................69
encrypt-zone-name................................................................................................................................................. 70
end......................................................................................................................................................................... 71
eth-port-validate-one-trunk......................................................................................................................................72
event....................................................................................................................................................................... 73
event db-persistence...............................................................................................................................................75
event email.............................................................................................................................................................. 76
event-email..............................................................................................................................................................77
event snmp-notification........................................................................................................................................... 78
event-threshold....................................................................................................................................................... 79
exit.......................................................................................................................................................................... 80
flexiVpn................................................................................................................................................................... 81
ftp-server.................................................................................................................................................................82
ftp-test.................................................................................................................................................................... 84
guest-access...........................................................................................................................................................85
hccd........................................................................................................................................................................87
help.........................................................................................................................................................................88
hostname................................................................................................................................................................ 89
hotspot....................................................................................................................................................................90
identity-provider.......................................................................................................................................................92
interface................................................................................................................................................................ 101
ip...........................................................................................................................................................................104
ip control-nat.........................................................................................................................................................105
ip internal-subnet...................................................................................................................................................106
ip name-server...................................................................................................................................................... 107
ip name-server-ipv6 ..............................................................................................................................................108
ip route..................................................................................................................................................................109
ip route-ipv6.......................................................................................................................................................... 110
ipsec-profile...........................................................................................................................................................111
lbs-service.............................................................................................................................................................115
ldap-service...........................................................................................................................................................117
license...................................................................................................................................................................119
license cloud......................................................................................................................................................... 120
license export........................................................................................................................................................ 121
license import........................................................................................................................................................122
license local...........................................................................................................................................................123
license sync-now...................................................................................................................................................124
lineman................................................................................................................................................................. 125
localdb-service...................................................................................................................................................... 126
logging console..................................................................................................................................................... 127
lwapp2scg............................................................................................................................................................ 129
mgmt-acl...............................................................................................................................................................131
no ad-service........................................................................................................................................................ 132
no admin............................................................................................................................................................... 133
no admin-radius.................................................................................................................................................... 134
no ap.................................................................................................................................................................... 135
no ap auto-approve...............................................................................................................................................136
no ap auto-tagging................................................................................................................................................137

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

67

Configuration Commands E - R

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

68

no ap-cert-check...................................................................................................................................................138
no ap-control-mgmt-tos........................................................................................................................................ 139
no ap-group.......................................................................................................................................................... 140
no block-client.......................................................................................................................................................141
no bonjour-fencing................................................................................................................................................ 142
no bonjour-fencing-policy...................................................................................................................................... 143
no bonjour-gateway...............................................................................................................................................144
no bonjour-policy...................................................................................................................................................145
no cert-store......................................................................................................................................................... 146
no control-plane.................................................................................................................................................... 147
no data-plane........................................................................................................................................................148
no device-policy.................................................................................................................................................... 149
no diffserv..............................................................................................................................................................150
no dns-server-service............................................................................................................................................ 151
no dp-group.......................................................................................................................................................... 152
no encrypt-mac-ip.................................................................................................................................................153
no event................................................................................................................................................................ 154
no ethernet-port-profile......................................................................................................................................... 155
no ftp-server..........................................................................................................................................................156
no guest-access....................................................................................................................................................157
no hotspot.............................................................................................................................................................158
no hotspot20-venue-profile................................................................................................................................... 159
no hotspot20-wlan-profile......................................................................................................................................160
no identity-provider................................................................................................................................................161
no interface........................................................................................................................................................... 162
no ip......................................................................................................................................................................163
no ipsec-profile......................................................................................................................................................165
no lbs-service........................................................................................................................................................166
no ldap-service......................................................................................................................................................167
no lineman.............................................................................................................................................................168
no logging............................................................................................................................................................. 169
no oauth-service....................................................................................................................................................170
no operator-profile................................................................................................................................................. 171
no osu-portal-profile.............................................................................................................................................. 172
no outbound firewall.............................................................................................................................................. 173
no proxy-aaa......................................................................................................................................................... 174
no report............................................................................................................................................................... 175
no role...................................................................................................................................................................176
no snmp-v2-community........................................................................................................................................ 177
no snmp-v3-user...................................................................................................................................................178
no user-agent-blacklist.......................................................................................................................................... 179
no user-role........................................................................................................................................................... 180
no user-traffic-profile..............................................................................................................................................181
no vlan-pooling......................................................................................................................................................182
no web-authentication...........................................................................................................................................183
no wlan................................................................................................................................................................. 184
no wlan-group....................................................................................................................................................... 185
no wlan-scheduler................................................................................................................................................. 186
non-proxy-aaa.......................................................................................................................................................187
northbound-authtype.............................................................................................................................................190
northbound-portal................................................................................................................................................. 191
ntp-server..............................................................................................................................................................192

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
encrypt-mac-ip

•
•
•
•
•
•
•

oauth-service........................................................................................................................................................ 193
operator-profile......................................................................................................................................................195
outbound-firewall...................................................................................................................................................197
proxy-aaa.............................................................................................................................................................. 199
rebalance-aps....................................................................................................................................................... 202
report.................................................................................................................................................................... 203
role........................................................................................................................................................................206

encrypt-mac-ip
To enable encryption of MAC and IP address for WISPr enriched URL, use the following command.
ruckus(config)# encrypt-mac-ip

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# encrypt-mac-ip
Successful operation

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

69

Configuration Commands E - R
encrypt-zone-name

encrypt-zone-name
To enable AP Zone name encryption for Wireless Internet Service Provider roaming (WISPr) enriched URL, use the following
command.
ruckus(config)# encrypt-zone-name

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# encrypt-zone-name
Successful operation

70

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
end

end
To end the current session and returns to privileged EXEC mode, use the following command.
ruckus(config)# end

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# end

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

71

Configuration Commands E - R
eth-port-validate-one-trunk

eth-port-validate-one-trunk
To update the validator for an AP with at least one trunk port, use the following command.
ruckus(config)# eth-port-validate-one-trunk

Syntax Description
This command has the following keywords:
disable
Disable the validator for the AP with at least one trunk port
enable
Enable the validator for the AP with at least one trunk port

Default
This command has no default settings.

Command Mode
Config

Example
ruckus(config)# eth-port-validate-one-trunk

72

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
event

event
To update the event notification configuration, use the following command.
ruckus(config)# event eventCode

Syntax Description
This command uses the following syntax:

eventCode
Single configuration event notification

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# event 1002

Related Commands
The following table lists the related config-event configuration commands.
TABLE 14 Commands related to ruckus(config-event)
Syntax and Type

Parameters (if any)

ruckus(config-event)# db-persistence

Description
Enables the data blade persistence for the
event.

Type: Privileged
ruckus(config-event)# do

Executes the do command.

Type: Privileged
ruckus(config-event)# email

Enables the email notification.

Type: Privileged
ruckus(config-event)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-event)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-event)# help

Displays the help.

Type: Privileged
ruckus(config-event)# no

db-persistence

Type: Privileged

email

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Enables the SNMP trap.

73

Configuration Commands E - R
event

TABLE 14 Commands related to ruckus(config-event) (continued)
Syntax and Type

Parameters (if any)

Description

snmp-trap
ruckus(config-event)# snmp-trap

Enables the SNMP trap.

Type: Privileged

74

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
event db-persistence

event db-persistence
To enable data base persistence for the event, use the following command.
ruckus(config)# event db-persistence

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# event db-persistence
No.
Event Code Category Type Description Severity SNMP Email
DB Persistence
----- ----------- ------------------------ ---------------------1
103
AP Communication
AP managed
This event occurs when AP
is approved by the SmartZone. Informational Disabled
Disabled
Enabled
2
105
AP Communication
AP rejected
This event occurs when AP
is rejected by the SmartZone.Minor
Enabled
Disabled
Enabled
3
106
AP Communication
AP firmware updated
This event occurs when AP
successfully updates its firmware. Informational Disabled
Disabled
Enabled

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

75

Configuration Commands E - R
event email

event email
To enable event triggers for selected email notification, use the following command.
ruckus(config)# event email eventCode

Syntax Description
This command has no arguments or keywords.

Command Mode
Config

Example
SZ100-Node1(config)# event email
No.
Event Code Category Type Description Severity SNMP Email
DB Persistence
----- ----------- ------------------------ ---------------------1
103
AP Communication
AP managed This event occurs when AP is approved by the
SmartZone Informational Enabled
Enabled
Enabled .
2
105
AP Communication
AP rejected
This event occurs when AP
is rejected by SmartZone Minor
Enabled
Enabled
Enabled
3
106
AP Communication
AP firmware updated
This event occurs when AP
successfully updates its firmware
Informational Enabled
Enabled
Enabled
Please choose Event Codes (separated by ',') to enable Event to trigger Email:

Related Commands
The following lists the related event-email configuration commands.
TABLE 15 Commands related to ruckus(config-event-email)
Syntax and Type

Parameters (if any)

ruckus(config-event-email)# enable

Description
Enables notification email for events.

Type: Privileged
ruckus(config-event-email)# mail-to

email email address

Email address configuration.

Type: Privileged
ruckus(config-event-email)# no enable

Disables the email notification for events.

Type: Privileged
ruckus(config-event-email)# no mail-to

Disables email address configuration.

Type: Privileged

76

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
event-email

event-email
To setup the event to email services, use the following command.
ruckus(config)# event-email eventCode

Syntax Description
This command has no arguments or keywords.

Command Mode
Config

Example
SZ100-Node1(config)# event-email
SZ100-Node1(config-event-email)#

Related Commands
The following tab;le lists the related event-email configuration commands.
TABLE 16 Commands related to ruckus(config-event-email)
Syntax and Type

Parameters (if any)

ruckus(config-event-email)# do

Description
Enables the do command.

Type: Privileged
ruckus(config-event-email)# enable

Enables the email notifications for events.

Type: Privileged
ruckus(config-event-email)# end: Privileged

End the current configuration session and
returns to the privileged EXEC mode.

ruckus(config-event-email)# exit Privileged

Exit from the EXEC.

ruckus(config-event-email)# help Privileged

Display the help message.

email

Sets the email address configuration.

ruckus(config-event)# no

enable

Disables various options.

Type: Privileged

mail-to

ruckus(config-event)# mail-to
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

77

Configuration Commands E - R
event snmp-notification

event snmp-notification
To enable selected SNMP notification, use the following command.
ruckus(config)# event snmp-notification eventCode

Syntax Description
This command has no arguments or keywords.

Default
Command Mode
Config

Example
SZ100-Node1(config)# event snmp-notification
No.
Event Code Category Type Description Severity SNMP Email DB Persistence
----- ----------- ------------------------ ---------------------1
103
AP Communication
AP managed This event occurs when AP is approved by the SmartZone
Informational Enabled Enabled
Enabled .

78

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
event-threshold

event-threshold
To update the event threshold configuration, use the following command.
ruckus(config)# event-threshold threshold

Syntax Description
This command has no arguments or keywords.

Command Mode
Config

Example
SZ100-Node1(config)# event-threshold thres
SZ100-Node1(config-event-threshold)#

Related Commands
The following table lists the related event-threshold configuration commands.
TABLE 17 Commands related to ruckus(config-event-threshold)
Syntax and Type
ruckus(config-event-threshold)# do

Parameters (if any)

Description
Enables the do command.

Type: Privileged
ruckus(config-event-threshold)# end:
Privileged

End the current configuration session and
returns to the privileged EXEC mode.

ruckus(config-event-threshold)# exit

Exit from the EXEC.

Type: Privileged
ruckus(config-event-threshold)# help

Display the help message.

Type: Privileged
ruckus(config-threshold)# unit

Sets the threshold unit.

Type: Privileged
ruckus(config-threshold)# value

Sets the threshold value.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

79

Configuration Commands E - R
exit

exit
To exit from the EXEC, use the following command.
ruckus(config)# exit

Syntax Description
This command has no arguments or keywords.

Command Mode
Config

Example
SZ100-Node1(config)# exit

80

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
flexiVpn

flexiVpn
To create or update flexi vpn roaming profile configuration, use the following command.
NOTE
NOTE: This command is applicable to vSZ-E.
ruckus(config)# flexiVpn

Syntax Description
This command has no arguments or keywords

Default
This command has no default settings.

Command Mode
config

Example
ruckus(config)# flexiVpn ruckus (config-flexiVpn)

Related Commands
The following table lists the related flexiVpn configuration commands.
TABLE 18 Commands related to ruckus(config-flexiVpn)#)
Syntax and Type

Parameters (if any)

Description

ruckus(config-flexiVpn)# do
Type: Privileged

Executes the do command.

ruckus(config-flexiVpn)# enable
Type: Privileged

Enables flexi vpn global settings.

ruckus(config-flexiVpn)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXEC mode.

ruckus(config-flexiVpn)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-flexiVpn)# help
Type: Privileged

Displays the help.

ruckus(config-flexiVpn)# no
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A



Disables the flexi vpn settings.

81

Configuration Commands E - R
ftp-server

ftp-server
To update the FTP server for uploading reports configuration, use the following command.
ruckus(config)# ftp-server name
Once you enter the config-ftp-server context, you can configure the rest of the FTP server settings (see example below).

Syntax Description
This command has no arguments or keywords

Default
This command has no default settings.

Command Mode
config

Example
SZ100-Node1(config)# ftp-server
SZ100-Node1(config-ftp-server)#
SZ100-Node1(config-ftp-server)#
SZ100-Node1(config-ftp-server)#
SZ100-Node1(config-ftp-server)#
SZ100-Node1(config-ftp-server)#
Password: ****
Retype: ****
SZ100-Node1(config-ftp-server)#
SZ100-Node1(config)#

f1
host 1.1.1.1
port 21
username test
password
exit

Related Commands
The following table lists the related ftp-server commands.
TABLE 19 Commands related to ruckus(config-ftp-server)
Syntax and Type

Parameters (if any)

ruckus(config-ftp-server)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-ftp-server)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-ftp-server)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ftp-server)# help

Displays the help.

Type: Privileged
ruckus(config-ftp-server)# host

ip

Sets the FTP server IP address.

Type: Privileged

82

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ftp-server

TABLE 19 Commands related to ruckus(config-ftp-server) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ftp-server)# password

password

Sets the FTP password.

port

Sets the FTP server port.

Type: Privileged
ruckus(config-ftp-server)# port
Type: Privileged
ruckus(config-ftp-server)# protocol

Sets the protocol.

Type: Privileged
ruckus(config-ftp-server)# remote-directory

directory

Sets the FTP remote directory.

Type: Privileged
ruckus(config-ftp-server)# test

Test the FTP settings.

Type: Privileged
ruckus(config-ftp-server)# username

username

Sets the user name.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

83

Configuration Commands E - R
ftp-test

ftp-test
To test the FTP server connection, use the following command.
ruckus(config)# ftp-test name

Syntax Description
This command uses the following syntax:

name
FTP server name

Default
This command has no default settings.

Command Mode
config

Example
SZ100-Node1(config)# ftp-test FTP-SERVER
Fail to connection to FTP server

84

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
guest-access

guest-access
To create or update the guest access configuration, use the following command.
ruckus(config)# guest-access name

Syntax Description
This command uses the following syntax:

name
Name of the guest

Default
This command has no default settings.

Command Mode
config

Example
SZ100-Node1(config)# guest-access dominic
SZ100-Node1(config-guest-access)#

Related Commands
The following table lists the related guest-access configuration commands.
TABLE 20 Commands related to ruckus (config-guest-access)
Syntax and Type

Parameters (if any)

Description

ruckus(config-guest-access)# description

text

Sets the description.

Type: Privileged
ruckus(config-guest-access)# do

Executes the do command.

Type: Privileged
ruckus(config-guest-access)# enable-termsand-conditions

Enables the web portal terms and conditions.

Type: Privileged
ruckus(config-guest-access)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-guest-access)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-guest-access)# grace-period

minutes

Sets the grace period.

Type: Privileged
ruckus(config-guest-access)# help

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Displays the help.

85

Configuration Commands E - R
guest-access

TABLE 20 Commands related to ruckus (config-guest-access) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus(config-guest-access)# language

Sets the language.

Type: Privileged

ftp-url: FTP URL, format: ftp://
username:password@ip/file-path

Sets the logo.

name

Sets the guess access service name.

ruckus(config-guest-access)# no

enable-terms-and-conditions

Disables the web portal terms and conditions.

Type: Privileged

sms-gateway

ruckus(config-guest-access)# logo
Type: Privileged
ruckus(config-guest-access)# name
Type: Privileged

terms-and-conditions

minutes

Sets the session timeout as per the specified
minutes.

disabled

Sets the guest pass for the SMS gateway.

ruckus(config-guest-access)# start-page

original

Sets the start page.

Type: Privileged

redirect start-url

ruckus(config-guest-access)# session-timeout
Type: Privileged
ruckus(config-guest-access)# sms-gateway
Type: Privileged

ruckus(config-guest-access)# terms-andconditions

Sets the web portal terms and conditions.

Type: Privileged
ruckus(config-guest-access)# title

Sets the title for the web portal.

Type: Privileged

86

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
hccd

hccd
To enable historical client connection diagnostic (hccd).
ruckus(config)# hccd

Syntax Description
This command has no arguments or keywords

Default
This command has no default settings.

Command Mode
config

Example
ruckus(config)# hccd

Related Command
ruckus(config)#no hccd
Disables the historical client connection diagnostic .

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

87

Configuration Commands E - R
help

help
To display the help message, use the following command.
ruckus(config)# help

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# help
admin Create/Update Administrator account configuration
admin-radius Create/Update RADIUS server for Administrators
ap-auto-approve Enable AP auto approve

88

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
hostname

hostname
To change the hostname, use the following command.
ruckus(config)# hostname hostname

Syntax Description
This command uses the following syntax:

hostname
Changed hostname

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# hostname

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

89

Configuration Commands E - R
hotspot

hotspot
To create or update the hotspot (WISPr) configuration, use the following command.
ruckus(config)# hotspot profile name

Syntax Description
This command uses the following syntax:

name
Name of the WISPr hotspot profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# hotspot hsp1
SZ100-Node1(config-hotspot)#

Related Commands
The following table lists the related hotspot configuration commands.
TABLE 21 Commands related to ruckus(config-hotspot)
Syntax and Type

Parameters (if any)

Description

ruckus(config-hotspot)# description

text

Sets the description.

Type: Privileged
ruckus(config-hotspot)# do

Executes the do command.

Type: Privileged
ruckus(config-hotspot)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-hotspot)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-hotspot)# grace-period

minutes

Sets the EAP-SIM MAP version.

Type: Privileged
ruckus(config-hotspot)# help

Displays the help.

Type: Privileged
ruckus(config-hotspot)# language

Sets the portal language.

Type: Privileged

90

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
hotspot

TABLE 21 Commands related to ruckus(config-hotspot) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-hotspot)# location-id

location-id

Sets the location ID.

location-name

Sets the location name.

ftp-url

Sets the logo.

ruckus(config-hotspot)# logon-url

internal

Sets the logon model.

Type: Privileged

external logon-url

Type: Privileged
ruckus(config-hotspot)# location-name
Type: Privileged
ruckus(config-hotspot)# logo
Type: Privileged

logon-url : Redirects unauthenticated user to
the URL for authentication
ruckus(config-hotspot)# mac-address-format

Set MAC address format.

Type: Privileged
ruckus(config-hotspot)# name

Renames the hotspot profile.

Type: Privileged
ruckus(config-hotspot)# no

show-terms-conditions

Type: Privileged

walled-garden-list

ruckus(config-hotspot)# session-timeout

minutes

Disables the commands.

Sets the session timeout. Defined in minutes.

Type: Privileged
ruckus(config-hotspot)# show-termsconditions

Shows the terms and conditions.

Type: Privileged
ruckus(config-hotspot)# smart-client-support

enable

Type: Privileged

none

Sets the smart client support.

only instructions: Only smart client allowed
with instructions for enabling users to log on
using the smart client application
ruckus(config-hotspot)# start-page

original

Type: Privileged

redirect start-url

Sets the start page.

start-url: Redirects to the defined URL
ruckus(config-hotspot)# terms-conditions

terms

Sets the terms and conditions.

title

Sets the title.

walled-garden-list

Enables walled garden. Allows unauthorized
destinations. Comma-separated IP, IP range,
CIDR and regular expression domain name
list.

Type: Privileged
ruckus(config-hotspot)# title
Type: Privileged
ruckus(config-hotspot)# walled-garden
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

91

Configuration Commands E - R
identity-provider

identity-provider
To create or update identity provider configuration, use the following command.
ruckus(config)# identity-provider name

Syntax Description
This command uses the following syntax:

name
Name of the identity provider

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# identity-provider idwlan
SZ100-Node1(config-identity-provider)#

Related Commands
•

Table 22 lists the related identity-provider configuration commands.

•

Table 23 lists the related identity-provider-acct-profile configuration commands.

•

Table 24 lists the related identity-provider-acct-profile-realm configuration commands.

•

Table 25 lists the related identity-provider-auth-profile configuration commands

•

Table 26 lists the related identity-provider-auth-profile-realm configuration commands.

•

Table 27 lists the related identity-provider-osu-enable configuration commands.
identity-provider-osu-enable

•

Table 28 lists the related identity-provider-realms configuration commands.

•

Table 29lists the related identity-provider-realms-eaps configuration commands.

•

Table 30 lists the related identity-provider-realms-eaps-auth configuration commands

The following table lists the related identity-provider configuration commands.
TABLE 22 Commands related to ruckus(config-identity-provider)
Syntax and Type
ruckus(config-identity-provider)# acct-enable

Parameters (if any)

Description
Enables accounting.

Type: Privileged
ruckus(config-identity-provider)# acct-profile

92

Sets the accounting profile.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
identity-provider

TABLE 22 Commands related to ruckus(config-identity-provider) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus(config-identity-provider)# auth-profile

Sets the authentication profile.

Type: Privileged
ruckus(config-identity-provider)# description

text

Sets the description.

Type: Privileged
ruckus(config-identity-provider)# do

Executes the do command.

Type: Privileged
ruckus(config-identity-provider)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-identity-provider)# help

Displays the help.

Type: Privileged
ruckus(config-identity-provider)# home-ois

name 5-hex id1id2id3id4hex-value

Type: Privileged

name 3-hex id1id2id3

ruckus(config-identity-provider)# name

name

Sets the identity provider name.

ruckus(config-identity-provider)# no

acct-enable

Disables the commands.

Type: Privileged

home-ois

Sets the Home OIs.

Type: Privileged

osu-enable
plmns
realms
ruckus(config-identity-provider)# osu-enable

Enables the online signup and provisioning.

Type: Privileged
ruckus(config-identity-provider)# plmns

mcc mnc

Sets the PLMNs.

name

Sets the realms

Type: Privileged
ruckus(config-identity-provider)# realms
Type: Privileged

The following table lists the related identity-provider-acct-profile configuration commands.
TABLE 23 Commands related to ruckus(config-identity-provider-acct-profile)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-acct-profile)#
default

no-match-realm acct name

Sets the default service.

no-realm acct name

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
description

text

Sets the description

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

93

Configuration Commands E - R
identity-provider

TABLE 23 Commands related to ruckus(config-identity-provider-acct-profile) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-identity-provider-acct-profile)#
do

Description
Executes the do command.

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
exit

Exits from the EXEC.

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
help

Displays the help.

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
no

realm name

Disables the realm command.

realm

Sets the accounting service realm.

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
realm
Type: Privileged

The following table lists the related identity-provider-acct-profile-realm configuration commands.
TABLE 24 Commands related to ruckus(config-identity-provider-acct-profile-realm)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-acct-profilerealm)# acct-service

name

Sets the accounting service.

name

Sets the authentication service.

name

Sets the authentication method.



Sets the dynamic VLAN identifier.

Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# auth-service
Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# auth-method
Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# dynamic-vlan
Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# do

Executes the do command.

Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# exit

Exits from the EXEC.

Type: Privileged

94

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
identity-provider

TABLE 24 Commands related to ruckus(config-identity-provider-acct-profile-realm) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-identity-provider-acct-profilerealm)# help

Description
Displays the help.

Type: Privileged
ruckus(config-identity-provider-acct-profilerealm)# name

name

Sets the realm name.

realm

Sets the accounting service realm.

Type: Privileged
ruckus(config-identity-provider-acct-profile)#
realm
Type: Privileged

The following table lists the related identity-provider-auth-profile configuration commands.
TABLE 25 Commands related to ruckus(config-identity-provider-auth-profile)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-auth-profile)#
aaa-interim-acct-interval

seconds

Sets the accounting interim interval for the
hosted AAA server.

seconds

Sets the idle session timeout for the hosted
AAA server.

seconds

Sets the session timeout for the hosted AAA
server.

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
aaa-session-idle-timeout
Type: Privileged
ruckus(config-identity-provider-auth-profile)#
aaa-session-timeout
Type: Privileged
ruckus(config-identity-provider-auth-profile)#
aaa-support

Enables the hosted AAA server support.

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
default
Type: Privileged

no-match-realm acct name: Set to either
RADIUS, local-database, na (request rejected)
or radius. Set the authentication service
name.

Sets the default service.

no-realm acct name: Sets the default
authentication service.
ruckus(config-identity-provider-auth-profile)#
description

text

Sets the description

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
do

Executes the do command.

Type: Privileged
ruckus(config-identity-provider-auth- profile)#
end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
exit

Exits from the EXEC.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

95

Configuration Commands E - R
identity-provider

TABLE 25 Commands related to ruckus(config-identity-provider-auth-profile) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-auth-profile)#
help

Displays the help.

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
gpp-support

Sets the PLMN identifier.

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
no
Type: Privileged
ruckus(config-identity-provider-auth-profile)#
realm

aaa-support

Disables the commands.

gpp-support
realm

realm

Sets the authentication service realm.

mcc

Sets the mobile country code.

mnc

Sets the mobile network code.

Type: Privileged
ruckus(config-identity-provider-auth-profile)#
sgsn-mcc
Type: Privileged
ruckus(config-identity-provider-auth-profile)#
sgsn-mnc
Type: Privileged

The following table lists the related identity-provider-auth-profile-realm configuration commands.
TABLE 26 Commands related to ruckus(config-identity-provider-auth-profile-realm)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-auth-profilerealm)# auth-method

Sets the authorization method.

Type: Privileged
ruckus(config-identity-provider-auth-profilerealm)# auth-service
Type: Privileged

name: Set to either RADIUS, local-database,
na (request rejected) or radius. Set the
authentication service name.

ruckus(config-identity-provider-auth-profilerealm)# do

Sets the authentication service.

Executes the do command.

Type: Privileged
ruckus(config-identity-provider-auth-profilerealm)# dynamic-vlan

vlan-id

Sets the dynamic VLAN ID.

Type: Privileged
ruckus(config-identity-provider-auth- profilerealm)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-auth-profilerealm)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-identity-provider-auth-profilerealm)# help

Displays the help.

Type: Privileged

96

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
identity-provider

TABLE 26 Commands related to ruckus(config-identity-provider-auth-profile-realm) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-auth-profilerealm)# name

name

Sets the authentication service name.

Type: Privileged

The following table lists the related identity-provider-osu-enable configuration commands.
TABLE 27 Commands related to ruckus(config-identity-provider-osu-enable)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-osu-enable)#
common-icon

ftp-url

Sets the common language icon.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
do

Executes the do command.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
exit

Exits from the EXEC.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
help

Displays the help.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
no
Type: Privileged

osu-auth-services

Disables the commands

service-descr
whitelisted-domains

ruckus(config-identity-provider-osu-enable)#
osu-auth-services

service-name local realm service-name:
Authentication services name

Type: Privileged

local: Local database

Sets the OSU authentication services.

realm: Realm server
service-name remote realm
remote: Supports only RADIUS service

service-name local realm never
service-name local realm hour expirationvalue : Local credential expiration, between 1
and 175200
service-name local realm day expiration-value:
Local credential expiration, between 1 and
7300
service-name local realm week expirationvalue: Local credential expiration, between 1
and 1040
ruckus(config-identity-provider-osu-enable)#
osu-auth-services

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

service-name local realm month expirationvalue : Local credential expiration - between 1
and 240

Sets the OSU authentication services.

97

Configuration Commands E - R
identity-provider

TABLE 27 Commands related to ruckus(config-identity-provider-osu-enable) (continued)
Syntax and Type

Parameters (if any)

Description

${cert}

Sets the OSU certificates.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
osu-cert
Type: Privileged
ruckus(config-identity-provider-osu-enable)#
osu-nai-realm

Sets the OSU NAI realm.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
osu-portal

internal osu-portal-profile

Sets the OSU portal.

external portal-url

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
provisioning-format
Type: Privileged
ruckus(config-identity-provider-osu-enable)#
provisioning-protocol
Type: Privileged
ruckus(config-identity-provider-osu-enable)#
provisioning-service-url

r2-r1-zeroit

Sets the provisioning format.

r2-r1-zeroit: Hotspot 2.0 R2, Hotspot 2.0 R1
r2-zeroit
all

Sets the provisioning protocol.

oma-dm
soap-xml

url

Sets the provisioning service URL.

home-only

Sets the provisioning update.

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
provisioning-update-at
Type: Privileged
ruckus(config-identity-provider-osu-enable)#
service-descr

home-roaming
any

language name icon-ftp-url

Sets the subscription description

language name description icon-ftp-url

Type: Privileged
ruckus(config-identity-provider-osu-enable)#
whitelisted-domains

domain-name

Sets the whitelisted domains.

Type: Privileged

identity-provider lists the related identity-provider-realms configuration commands.
TABLE 28 Commands related to ruckus(config-identity-provider-realms)
Syntax and Type

Parameters (if any)

ruckus(config-identity-provider-realms)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-identity-provider-realms)# eaps

[ #4 | #2 | #3 | #1 ]

Type: Privileged

#4: EAP method ID

Creates or updates the EAP configuration.

#2: EAP method ID
#3: EAP method ID
#1: EAP method ID
ruckus(config-identity-provider-realms)#
encoding

98

[ rfc-4282 | utf-8 ]

Sets the encoding type.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
identity-provider

TABLE 28 Commands related to ruckus(config-identity-provider-realms) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus(config-identity-provider-realms)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-realms)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-identity-provider-realms)# help

Displays the help.

Type: Privileged
ruckus(config-identity-provider-realms)# name

name

Sets the realm name.

eaps

Disables the command.

Type: Privileged
ruckus(config-identity-provider-realms)# no
Type: Privileged

The following table lists the related identity-provider-realms-eaps configuration commands.
TABLE 29 Commands related to ruckus(config-identity-provider-realms-eaps)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-realms-eaps)#
auth

[4|1|2|3]

Creates or updates the authentication
information based on the index.

Type: Privileged

4: Authentication index
1: Authentication index
2: Authentication index
3: Authentication index

ruckus(config-identity-provider-realms-eaps)#
do

Executes the do command.

Type: Privileged
ruckus(config-identity-provider-realms-eaps)#
end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-identity-provider-realms-eaps)#
exit

Exits from the EXEC.

Type: Privileged
ruckus(config-identity-provider-realms-eaps)#
help

Displays the help.

Type: Privileged
ruckus(config-identity-provider-realms-eaps)#
method
Type: Privileged

[ eap-aka-23 | eap-tls | eap-mschap-v2 | na |
eap-aka-50 | md5 | eap-ttls | reserved | eapsim | eap-cisco | peap ]

Sets the EAP method.

eap-aka-23: EAP-AKA
eap-tls: EAP-Transport Layer Security (EAPTLS)
eap-mschap-v2: EAP-MSCHAP-V2
na: N/A

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

99

Configuration Commands E - R
identity-provider

TABLE 29 Commands related to ruckus(config-identity-provider-realms-eaps) (continued)
Syntax and Type

Parameters (if any)

Description

eap-aka-50: EAP-AKA
md5: MD5-Challenge
eap-ttls: EAP-Tunneled Transport Layer
Security (EAP-TTLS)
reserved: Reserved for the Expanded Type
eap-sim: EAP for GSM Subscriber Identity
Module (EAP-SIM)
eap-cisco: EAP-Cisco
peap: Protected Extensible Authentication
Protocol (PEAP)
ruckus(config-identity-provider-realms-eaps)#
no

auth

Disables the command.

Type: Privileged

The following table lists the related identity-provider-realms-eaps-auth configuration commands.
TABLE 30 Commands related to ruckus(config-identity-provider-realms-eaps-auth)
Syntax and Type

Parameters (if any)

Description

ruckus(config-identity-provider-realms-eapsauth)# info

tunneled | credential | non-eap-inner | expandinner-eap | inner-auth-eap | expand-eap ]

Sets the authentication parameter type.

Type: Privileged

tunneled: Tunneled EAP method credential
type
credential: Credential type
non-eap-inner: Non EAP inner authentication
type
expand-inner-eap: Expanded inner EAP
method
inner-auth-eap: Inner authentication EAP
method type
expand-eap:

ruckus(config-identity-provider-realms-eapsauth)# type

Expanded EAP method

type

Sets the authentication type.

vendor-id

Sets the vendor ID.

vendor-type

Sets the vendor type.

Type: Privileged
ruckus(config-identity-provider-realms-eapsauth)# vendor-id
Type: Privileged
ruckus(config-identity-provider-realms-eapsauth)# vendor-type
Type: Privileged

100

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
interface

interface
To setup the interface configuration, use the following command.
ruckus(config)# interface ap-tunnel-data
ruckus(config)# interface mgmt-and-ap-control
ruckus(config)# interface user-defined name

Syntax Description
This command has no arguments or keywords.

Default
cluster
cluster: Cluster interface
control
control: Control interface
management
management: Management interface
mgmt-and-ap-control
mgmt-and-ap-control: Management & AP Control
ap-tunnel-data
ap-tunnel-data: AP Tunnel Data
mgmt-or-ap-tunnel
mgmt-or-ap-tunnel: Management/AP Tunnel Traffic
user-defined name
user-defined: User defined interface

name: User defined interface name.

Command Mode
Config

Example
SZ100-Node1(config)# interface
ap-tunnel-data
AP Tunnel Data
mgmt-and-ap-control
Management & AP Control
user-defined
User defined interface
SZ100-Node1(config)# interface ap-tunnel-data
SZ100-Node1(config-if)#
data-plane
Update Data Plane configuration
do Do command

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

101

Configuration Commands E - R
interface

end End the current configuration session and return to privileged EXEC mode
exit Exit from the EXEC
help Display this help message
ip Update IP configuration
no Disable and delete commands ned UD1

Related Commands
•

Table 31 lists the related interface-ap-tunnel-data and mgmt-and-ap-control configuration commands.

•

Table 32 lists the related interface-user-defined configuration commands.

The following table lists the related interface-ap-tunnel-data and mgmt-and-ap-control configuration commands.
TABLE 31 Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-ap-control)
Syntax and Type

Parameters (if any)

Description

ruckus(config-interface)# data-plane

name forward-stp

Updates the data plane configuration

Type: Privileged

name: Data plane name
forward-stp: Disables the STP package bridge

ruckus(config-interface)# do

Executes the do command.

Type: Privileged
ruckus(config-interface)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-interface)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-interface)# help

Displays the help.

Type: Privileged
ruckus(config-interface)# interface

Sets the physical interface.

Type: Privileged
Sets the IP address.

ruckus(config-interface)# ip

address dhcp

Type: Privileged

address: Sets IP address of interface
dhcp: IP address negotiated by DHCP
ipv6-address auto
ipv6-address: Sets the IPv6 address with
prefix lengths of interface
auto: IPv6 address negotiated by auto
address ip mask gateway
address: Sets IP address of interface

ip: Static IP address
mask: IP Subnet mask
gateway: Gateway
ipv6-address ip gateway
ipv6-address: Sets IPv6 address of interface

ip: Static IPv6 address
gateway: Gateway

102

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
interface

TABLE 31 Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-ap-control) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-interface)# no data-plane

name

Disables the data-plane

Type: Privileged
ruckus(config-interface)# service

Sets the service.

Type: Privileged
ruckus(config-interface)# vlan

vlan-id VLAN ID

Sets the VLAN ID.

Type: Privileged

The following table lists the related interface-user-defined configuration commands.
TABLE 32 Commands related to ruckus(config-interface-user-defined)
Syntax and Type

Parameters (if any)

ruckus(config-interface-user-defined)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-interface-user-defined)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-interface-user-defined)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-interface-user-defined)# help

Displays the help.

Type: Privileged
ruckus(config-interface-user-defined)#
interface

[ control | management ]

Type: Privileged
ruckus(config-interface-user-defined)# name

Sets the physical interface such as control
and management interface. Executed in
conjunction with user defined sub command.
Renames the user-define interface.

Type: Privileged

address

Sets the IP address for the user defined
interface.

ruckus(config-interface-user-defined)# service

any

Sets the service.

Type: Privileged

hotspot

ruckus(config-interface-user-defined)# vlan

vlan-id

ruckus(config-interface-user-defined)# ip
Type: Privileged

Sets the VLAN ID for the interface.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

103

Configuration Commands E - R
ip

ip
To setup the IP address, use the following command.
ruckus(config)# ip

Syntax Description
This command uses the following syntax:

name-server
Set name server
route
Set static routes

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ip
name-server
Set name server
route
Set static routes

104

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ip control-nat

ip control-nat
To set the Control NAT IP address, use the following command.
ruckus(config)# ip control-nat ip

Syntax Description
This command uses the following syntax:

ip
Control NAT IP

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ip control-nat

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

105

Configuration Commands E - R
ip internal-subnet

ip internal-subnet
To setup the IP address internal subnet, use the following command.
ruckus(config)# ip internal-subnet prefix

Syntax Description
This command uses the following syntax:

prefix
Subnet prefix

Default
This command has no default settings.

Command Mode
Config

Example
ruckus(config)# ip internal-subnet prefix
This command will reboot internal interface, data planes and SMF service. Do you want to continue?

106

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ip name-server

ip name-server
To setup the name server configuration, use the following command.
ruckus(config)# ip name-server ip

Syntax Description
This command uses the following syntax:

ip
Primary DNS server

ip
Secondary DNS server

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ip name-server ip 172.19.13.56
Successful operation

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

107

Configuration Commands E - R
ip name-server-ipv6

ip name-server-ipv6
To setup the IPv6 server configuration, use the following command.
ruckus(config)# ip name-server ipv6-address

Syntax Description
This command uses the following syntax:

ipv6-address
Primary DNS server
ipv6-address
Secondary DNS server

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ip name-server-ipv6 172.19.13.56
Successful operation

108

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ip route

ip route
To setup the static rule configuration, use the following command.
ruckus(config)# ip route ip mask ip interface metric

Syntax Description
This command uses the following syntax:

ip
Destination network IP address

mask
Destination network mask

ip
Next hop IP address

interface
Interface

metric
Distance metric for this route

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ip route ip 193.12.30.10 255.255.255 10.9.0.254 management

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

109

Configuration Commands E - R
ip route-ipv6

ip route-ipv6
To setup the IPv6 static rule configuration, use the following command.
ruckus(config)# ip route ip ip interface metric

Syntax Description
This command uses the following syntax:

ip
Destination network IPv6 address with prefix length

ip
Next hop IPv6 address

interface
Interface

metric
Distance metric for this route

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ip route-ipv6 193.12.30.10 193.12.30.20

110

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ipsec-profile

ipsec-profile
To create or update IPsec profile configuration, use the following command.
ruckus(config)# ipsec-profile name

Syntax Description
This command has the following syntax:

name
IPsec profile name.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ipsec-profile

Related Commands
The following table lists the related ipsec-profile configuration commands
TABLE 33 Commands related to ruckus(config-ipsec-profile).
Syntax and Type
ruckus(config-ipsec-profile)# auth-type

Parameters (if any)

Description
Sets the authentication type

Type: Privileged
rruckus(config-ipsec-profile)# cara-server
Type: Privileged
ruckus(config-ipsec-profile)# cara-server-path
Type: Privileged
ruckus(config-ipsec-profile)# cara-subjectname

Sets Certificate Management Protocol CA/RA
address.
Sets Certificate Management Protocol Server
path.
Sets the Certificate Management Protocol
subject name of CA/RA

Type: Privileged
ruckus(config-ipsec-profile)# cmp-dhcpopt43-subcode
Type: Privileged
ruckus(config-ipsec-profile)# cmp-subjectname-dhcp-opt43-subcode
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Sets the Certificate Management Protocol
DHCP option 43 sub code for the CA/RA
address
Sets the Certificate Management Protocol
DHCP option 43 sub code for subject name
of CA/RA

111

Configuration Commands E - R
ipsec-profile

TABLE 33 Commands related to ruckus(config-ipsec-profile). (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ipsec-profile)# description

Sets the description.

Type: Privileged
ruckus(config-ipsec-profile)# dhcp-opt43subcode

Sets the DHCP option 43 sub code for
Security Gateway.

Type: Privileged
ruckus(config-ipsec-profile)# do

Executes the do command.

Type: Privileged
rruckus(config-ipsec-profile)# dpd-delay

Sets the Dead Peer Detection.

Type: Privileged
ruckus(config-ipsec-profile)# end

End the current configuration session and
return to privileged EXEC mode

Type: Privileged
ruckus(config-ipsec-profile)# esp-proposal
Type: Privileged

[3des | aes256 | aes192 | aes128 | none ]
[ md5 | sha512 | sha384 | sha1 | sha256 |
aesxcbc ][ modp8192 |modp6144 |
modp1024 | none | modp3072 | modp2048 |
modp1536 | modp768 | modp4096]

Add ESP proposal.

3des: 3DES
aes256: AES256
aes192: AES192
aes128: AES128
none: NONE
md5: MD5
sha512: SHA512
sha384: SHA384
sha1: SHA1
sha256: SHA256
aesxcbc: AES-XCBC
modp8192: MODP8192
modp6144: MODP6144
modp1024: MODP1024
modp3072: MODP3072
modp2048: MODP2048
modp1536: MODP1536
modp768: MODP768
modp4096: MODP4096
ruckus(config-ipsec-profile)# esp-rekeytime

Sets the ESP Rekey time.

Type: Privileged
ruckus(config-ipsec-profile)# esp-type

Set ESP Proposal Type

Type: Privileged
ruckus(config-ipsec-profile)# exit

112

Exits from the EXEC mode.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ipsec-profile

TABLE 33 Commands related to ruckus(config-ipsec-profile). (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus(config-ipsec-profile)# failover-checkinterval

Sets the Fail Over Checking Interval

Type: Privileged
ruckus(config-ipsec-profile)# failover-retryinterval

Sets the Fail Over Retry Interval

Type: Privileged
ruckus(config-ipsec-profile)# failover-retrymode

Sets the Fail Over Retry mode.

Type: Privileged
ruckus(config-ipsec-profile)# failover-retryperiod

Sets the Fail Over Retry period.

Type: Privileged
ruckus(config-ipsec-profile)# help

Displays the help.

Type: Privileged
ruckus(config-ipsec-profile)# ike-proposal
Type: Privileged

[ 3des | aes256 | aes192 | aes128 ][ sha1 |
md5 | aesxcbc | sha512 | sha384 | sha256 ]
[ prfsha1 | prfmd5 |prfsha256 | prfaescmac |
prfaesxcbc | prfsha384 | prfsha512 | useintegrity-alg ][ modp1024 | modp8192 |
modp6144 | modp768 | modp4096 |
modp3072 | modp1536 | modp2048 ]

ruckus(config-ipsec-profile)# ike-rekeytime

Add IKE proposal.

Sets the IKE Rekey time.

Type: Privileged
ruckus(config-ipsec-profile)# ike-type

Sets the IKE Proposal type.

Type: Privileged
ruckus(config-ipsec-profile)# ip-compression

Enables IP compression.

Type: Privileged
ruckus(config-ipsec-profile)# ipmode

Sets the IP mode.

Type: Privileged
ruckus(config-ipsec-profile)# keep-aliveinterval

Sets the NAT-T Keep Alive interval.

Type: Privileged
ruckus(config-ipsec-profile)# name

Sets the IPsec profile name.

Type: Privileged
ruckus(config-ipsec-profile)# nat-traversal

Enables force NAT-T.

Type: Privileged
ruckus(config-ipsec-profile)# no

cara-server

Type: Privileged

cara-server-path

Disables and deletes commands.

cara-subject-name
dpd-delay
esp-proposal

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

113

Configuration Commands E - R
ipsec-profile

TABLE 33 Commands related to ruckus(config-ipsec-profile). (continued)
Syntax and Type

Parameters (if any)

Description

esp-rekeytime’
ike-proposal
ike-rekeytime
ip-compression
keep-alive-interval
nat-traversal
replay-window
retry-limit
security-gateway
ruckus(config-ipsec-profile)# replay-window

Sets the Replay window.

Type: Privileged
ruckus(config-ipsec-profile)# retry-limit

Sets the Retry limit.

Type: Privileged
ruckus(config-ipsec-profile)# security-gateway

Sets the Security gateway.

Type: Privileged

114

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
lbs-service

lbs-service
To create and update the Location Based Service (LBS) configuration, use the following command.
ruckus(config)# lbs-service

Syntax Description
This command uses the following syntax:

name
LBS venue name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# lbs-service

LBS venue name
SZ100-Node1(config)# lbs-service n3

Related Commands
The following table lists the related lbs-service configuration command
.
TABLE 34 Commands related to ruckus(config-lbs-service)
Syntax and Type

Parameters (if any)

ruckus(config-lbs-service)# do

Description
Sets the do command.

Type: Privileged
ruckus(config-lbs-service)# end

Ends the current configuration session and
returns to the privileged EXEC mode.

Type: Privileged
ruckus(config-lbs-service)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-lbs-service)# help

Displays the help message.

Type: Privileged
ruckus(config-lbs-service)# host

host - Server IP address

Sets the server address.

password

Sets the password.

Type: Privileged
ruckus(config-lbs-service)# password
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

115

Configuration Commands E - R
lbs-service

TABLE 34 Commands related to ruckus(config-lbs-service) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-lbs-service)# port

port

Sets the port number.

venue

Sets the LBS venue.

Type: Privileged
ruckus(config-lbs-service)# venue
Type: Privileged

116

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
ldap-service

ldap-service
To create and update the LDAP service configuration, use the following command.
ruckus(config)# ldap-service name

Syntax Description
This command uses the following syntax:

name
LDAP service name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ldap-service
SZ100-Node1(config-ldap-service)#

Related Commands
The following table lists the related ldap-service configuration commands.
TABLE 35 Commands related to ruckus(config-ldap-service)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ldap-service)# admin-domainname

domain-name: LDAP admin domain name, To
query multiple organizational units, enter an
admin domain name and password with full
search and read privileges. For example:
uid=admin,dc=ldap,dc=com

Sets the LDAP administrator domain name.

password : LDAP server admin password. For
example: uid.

Sets the LDAP administrator password.

domain-name : LDAP base domain name. For
example: dc=ldap,dc=com

Sets the LDAP base domain name.

text

Sets the description.

Type: Privileged
ruckus(config-ldap-service)# admin-password
Type: Privileged
ruckus(config-ldap-service)# base-domainname
Type: Privileged
ruckus(config-ldap-service)# description
Type: Privileged
ruckus(config-ldap-service)# do

Sets the do command.

Type: Privileged
ruckus(config-ldap-service)# end
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Ends the current configuration session and
returns to the privileged EXEC mode.

117

Configuration Commands E - R
ldap-service

TABLE 35 Commands related to ruckus(config-ldap-service) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-ldap-service)# exit

Exits from the EXEC.

Type: Privileged

friendly-name

Sets the LDAP service name as seen by the
user.

ruckus(config-ldap-service)# group-attrs

attr-value user-role

Sets the user traffic profile mapping.

Type: Privileged

attr-value: : Group attribute value

ruckus(config-ldap-service)# friendly-name
Type: Privileged

user-role: User role
ruckus(config-ldap-service)# help

Displays the help message.

Type: Privileged

ip

Sets the IP address for LDAP server.

attr-value :

Sets the key attribute for LDAP server.

group-attrs

Disables the command.

port

Sets the port number for LDAP server.

ruckus(config-ldap-service)# search-filter

filter

Sets the search filter for LDAP server.

Type: Privileged

For example: (objectClass=Person, show
more...)

ruckus(config-ldap-service)# test

username password

ruckus(config-ldap-service)# ip-address
Type: Privileged
ruckus(config-ldap-service)# key-attr
Type: Privileged
ruckus(config-ldap-service)# no
Type: Privileged
ruckus(config-ldap-service)# port
Type: Privileged

Test AAA server.

Type: Privileged

118

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
license

license
To enable the cloud license server, use the following command.
ruckus(config)# license cloud
ruckus(config)# license import
ruckus(config)# license export
ruckus(config)# license local
ruckus(config)# license sync-now

Syntax Description
This command uses the following syntax:
enable
Enables the cloud license server

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# license
cloud Enable Cloud License Server
export Export Licenses
import Import Licenses
local Enable Local License Server, Format:  
sync-now Sync License with Server

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

119

Configuration Commands E - R
license cloud

license cloud
To enable the cloud license server, use the following command.
ruckus(config)# license cloud enable

Syntax Description
This command uses the following syntax:
enable
Enables the cloud license server

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# license cloud enable
Are you sure you want to change the license server configuration? All current license data will be wipe
out!! (or input 'no' to cancel)? [yes/no]

120

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
license export

license export
To setup the export licenses, use the following command.
ruckus(config)# license export ftp-url | ftp-url name

Syntax Description
This command uses the following syntax:
ftp-url
License file. FTP URL format is, ftp://username:password@ipfile-path

name
Sets the control plane

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# license export ftp://dm:ruckus1!@172.19.7.100

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

121

Configuration Commands E - R
license import

license import
To setup the import licenses, use the following command.
ruckus(config)# license import ftp-url | ftp-url name

Syntax Description
This command uses the following syntax:
ftp-url
License file. FTP URL format is, ftp://username:password@ipfile-path

name
Sets the control plane

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# license import ftp://dm:ruckus1!@172.19.7.100

122

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
license local

license local
To enable the local license server, use the following command.
ruckus(config)# license local local-server port

Syntax Description
This command uses the following syntax:

local-server
Sets the local license server IP address or the domain name
port
Sets the local license server port number

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# license local 172.19.7.100 80

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

123

Configuration Commands E - R
license sync-now

license sync-now
To synchronize licenses, use the following command.
ruckus(config)# license sync-now

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# license sync-now

124

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
lineman

lineman
To setup the workflow URL, use the following command.
ruckus(config)# lineman workflow-file | workflow-url

Syntax Description
This command uses the following syntax:

workflow-file
Uploads the workflow file
workflow-url
Set the workflow URL

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# lineman workflow-file ftp://dm:ruckus1!@172.19.7.100

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

125

Configuration Commands E - R
localdb-service

localdb-service
To create or update the local database service configuration, use the following command.
ruckus(config)# localdb-service

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# localdb-service
SZ100-Node1(config-localdb-service)#

Related Commands
The following table lists the related localdb-service configuration command
.
TABLE 36 Commands related to ruckus(config-localdb-service).
Syntax and Type

Parameters (if any)

Description

ruckus(config-localdb-service)# description

text

Sets the description.

Type: Privileged
ruckus(config-localdb-service)# do

Sets the do command

Type: Privileged
ruckus(config-localdb-service)# end

Ends the current configuration session and
returns to the privileged EXEC mode.

Type: Privileged
ruckus(config-localdb-service)# exit

Exits from the EXEC.

Type: Privileged

friendly-name

Displays the local database server name as
seen by the user.

ruckus(config-localdb-service)# group-attrs

attr-value user-role

Sets the user traffic profile mapping.

Type: Privileged

attr-value: Group attribute value

ruckus(config-localdb-service)# friendly-name
Type: Privileged

user-role : User role
ruckus(config-localdb-service)# help

Displays the help message.

Type: Privileged

126

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
logging console

logging console
To enable service logging on the console, use the following command.
ruckus(config)# logging console cli [ error | info ] | cli debug | name

Syntax Description
This command uses the following syntax:
cli [ error | info ]
cli [ error | info ]
cli
Enables CLI logging
error
Error level
info
Information level
cli debug
cli
Enables CLI logging
debug
Debug level

name
System service name. Enables logging for a system service.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# cli
2014-11-14 11:17:11,932 wsg.cli[main] INFO c.r.w.c.g.ShellRunner[-1] - Read line:
SZ100-Node1(config)# logging console
2014-11-14 11:17:24,683 wsg.cli[CliSessionTimeout] INFO c.r.w.c.Context[-1] - sleep interrupted
2014-11-14 11:17:24,684 wsg.cli[main] INFO c.r.w.c.g.Shell[-1] - Input command: help logging console
2014-11-14 11:17:24,684 wsg.cli[main] INFO c.r.w.c.g.Shell[-1] - Executing command (help):
com.ruckuswireless.wsg.cli.command.HelpCommand; options: [logging, console]
2014-11-14 11:17:24,687 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-1] - Starting to cache
validation status
2014-11-14 11:17:24,689 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-1] - Finished to cache
validation status
2014-11-14 11:17:24,690 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-1] - Starting to cache
validation status

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

127

Configuration Commands E - R
logging console

2014-11-14 11:17:24,700 wsg.cli[main] INFO
validation status

128

c.r.w.c.c.CommandOptionsMixin[-1] - Finished to cache

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
lwapp2scg

lwapp2scg
To update the LWAPP to controller configurations, use the following command.
ruckus(config)# lwapp2scg

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# lwapp2scg

Related Commands
The following table lists the related lwapp2scg configuration command.
TABLE 37 Commands related to ruckus(config-lwapp2scg).
Syntax and Type

Parameters (if any)

Description

ruckus(config-lwapp2scg)# acl-ap

mac ApMac: Sets the AP MAC address. Use
commas to separate the addresses. For
example: 1a:2b:3c:4d:5f:
60,11:22:33:44:55:66

Sets the ACL AP.

Type: Privileged

serial SerialNumber: Sets the serial number.
Use commas to separate the serial numbers.
For example: 123456789012,987654321021
ruckus(config-lwapp2scg)# do

Sets the do command

Type: Privileged
ruckus(config-lwapp2scg)# end

Ends the current configuration session and
returns to the privileged EXEC mode.

Type: Privileged
ruckus(config-lwapp2scg)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-lwapp2scg)# help

Displays the help message.

Type: Privileged
ruckus(config-lwapp2scg)# natIpTranslation

NAT IP translation in FTP passive mode.

Type: Privileged
ruckus(config-lwapp2scg)# no

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

acl-ap

Disables the commands.

129

Configuration Commands E - R
lwapp2scg

TABLE 37 Commands related to ruckus(config-lwapp2scg). (continued)
Syntax and Type

Parameters (if any)

Type: Privileged

natIpTranslation

ruckus(config-lwapp2scg)# pasv-port

Description

port port : Sets it to minimum and maximum
port.

Set the dynamic data transmission port range
to minimum and maximum.

ruckus(config-lwapp2scg)# policy

accept : Accept by ACL AP list

Sets the ACL policy.

Type: Privileged

accept-all : Accept all

Type: Privileged

deny : Deny by ACL AP list
deny-all : Deny all

130

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
mgmt-acl

mgmt-acl
To update the Management interface Access Control List (ACL) configuration, use the following command.
ruckus(config)# mgmt-acl

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# mgmt-acl

Related Commands
The following table lists the related config-mgmt-acl configuration commands.
TABLE 38 Commands related to ruckus(config-event-email)
Syntax and Type

Parameters (if any)

ruckus(config-mgmt-acl)# enable

Enables access control of management
interface.

Type: Privileged
ruckus(config-mgmt-acl)# no

enable

Type: Privileged

rule

ruckus(config-mgmt-acl)# rule

name : ACL rule name

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Description

Disables the commands.

Create/update management interface ACL
rule configuration.

131

Configuration Commands E - R
no ad-service

no ad-service
To delete the all active service directories, use the following command.
ruckus(config)# no ad-service name

Syntax Description
This command uses the following syntax:
name
Name of the active service directory to be deleted

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ad-service active-orange

132

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no admin

no admin
To delete the administrator, use the following command.
ruckus(config)# no admin username

Syntax Description
This command uses the following syntax:

username
Name of the administrator to be deleted

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no admin adam

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

133

Configuration Commands E - R
no admin-radius

no admin-radius
To delete RADIUS servers configurations for administrators, use the following command.
ruckus(config)# no admin-radius name

Syntax Description
This command uses the following syntax:

name
AAA server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no admin-radius aaa1

134

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ap

no ap
To delete the lock or unlock the access point, use the following command.
ruckus(config)# no ap mac lock

Syntax Description
This command uses the following syntax:
mac
AP MAC address
lock
Unlock AP

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ap 50:A7:33:24:EA:00

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

135

Configuration Commands E - R
no ap auto-approve

no ap auto-approve
To disable AP auto approve, use the following command.
ruckus(config)# no ap auto-approve

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ap-auto-approve

136

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ap auto-tagging

no ap auto-tagging
To disable auto tagging of critical access points, use the following command.
ruckus(config)# no ap auto-tagging enable

Syntax Description
This command uses the following syntax:
enable
Disable the auto tagging for critical access point.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ap-auto-tagging enable

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

137

Configuration Commands E - R
no ap-cert-check

no ap-cert-check
To disable the access point certificate check, use the following command.
ruckus(config)# no ap-cert-check

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ap-cert-check

138

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ap-control-mgmt-tos

no ap-control-mgmt-tos
To disable the access point control management traffic type of service, use the following command.
ruckus(config)# no ap-control-mgmt-tos

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ap-control-mgmt-tos

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

139

Configuration Commands E - R
no ap-group

no ap-group
To disable or delete the AP group, use the following command.
ruckus(config)# no ap-group ${apGroupName} | name

Syntax Description
This command uses the following syntax:
ap-group ${apGroupName}?
ap-group
${apGroupName}?

name
AP Group name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ap-group ap3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

140

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no block-client

no block-client
To delete all blocked clients profiles, use the following command.
ruckus(config)# no block-client ${value} mac

Syntax Description
This command uses the following syntax:
${value}

mac
blocked client MAC

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no block-client 84:18:3A:39:C8:50

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

141

Configuration Commands E - R
no bonjour-fencing

no bonjour-fencing
To delete bonjour fencing settings, use the following command.
ruckus(config)# no bonjour-fencing

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no bonjour-fencing

142

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no bonjour-fencing-policy

no bonjour-fencing-policy
To delete bonjour fencing policy settings, use the following command.
ruckus(config)# no bonjour-fencing-policy

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no bonjour-fencing-policy

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

143

Configuration Commands E - R
no bonjour-gateway

no bonjour-gateway
To disable the bonjour gateway configuration, use the following command.
ruckus(config)# no bonjour-gateway

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no bonjour-gateway

144

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no bonjour-policy

no bonjour-policy
To delete the bonjour policy configuration, use the following command.
ruckus(config)# no bonjour-policy name

Syntax Description
This command uses the following syntax:

name
Name of the bonjour policy to be deleted.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no bonjour-policy n1
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

145

Configuration Commands E - R
no cert-store

no cert-store
To delete all OSU (Online SignUp) portal profile configuration, use the following command.
ruckus(config)# no cert-store name
ruckus(config)# no csr name

Syntax Description
This command uses the following syntax:
cert name
Deletes certificate
csr name
Deletes Certificates Signing Request (CSR)

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no cert-store cert certpool
Do you want to continue to delete (or input 'n

146

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no control-plane

no control-plane
To remove the control plane from the cluster configuration, use the following command.
ruckus(config)# no control-plane name

Syntax Description
This command uses the following syntax:

name
Control plane name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no control-plane cp1

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

147

Configuration Commands E - R
no data-plane

no data-plane
To disable the STP package bridge of the local data plane configuration, use the following command.
ruckus(config)# no data-plane name forward-stp

Syntax Description
This command uses the following syntax:

name
Dataplane name

forward-stp
Disables the STP package bridge

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no data-plane name indus7-d1

148

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no device-policy

no device-policy
To delete the device policy configuration, use the following command:
ruckus(config)# device-policy name

Syntax Description
This command uses the following syntax:

name
Name of the device policy

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no device-policy dp1

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

149

Configuration Commands E - R
no diffserv

no diffserv
To delete diffserv configuration, use the following command:
ruckus(config)# diffserv name disable

Syntax Description
This command uses the following syntax:

name
Name of the differential server to disable
disable
Disables the all differential servers

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no diffserv disable

150

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no dns-server-service

no dns-server-service
To delete all DNS server services, use the following command.
ruckus(config)# no dns-server-service name

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no dp-group

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

151

Configuration Commands E - R
no dp-group

no dp-group
To disable the data plane grouping, use the following command.
ruckus(config)# no dp-group

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no dp-group

152

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no encrypt-mac-ip

no encrypt-mac-ip
To disable the encryption of MAC and IP address, use the following command.
ruckus(config)# no encrypt-mac-ip

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no encrypt-mac-ip
Do you want to continue to disable (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

153

Configuration Commands E - R
no event

no event
To disable the trigger to SNMP trap/email configuration, use the following command.
ruckus(config)# no event snmp-trap email db-persistence

Syntax Description
This command uses the following syntax:

snmp-trap
Disables the trigger to SNMP trap
email
Disables the to trigger email
db-persistence
Disables DB persistence for the event

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no event email 305, 214, 11

154

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ethernet-port-profile

no ethernet-port-profile
To disable the ethernet port profile, use the following command.
ruckus(config)# no ethernet-port-profile name

Syntax Description
This command uses the following syntax:

name
Ethernet Port Profile name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ethernet-port-profile abcd

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

155

Configuration Commands E - R
no ftp-server

no ftp-server
To delete FTP server, use the following command.
ruckus(config)# no ftp-server FTPname

Syntax Description
This command uses the following syntax:

FTPname
Name of the FTP server

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ftp-server ftp1

156

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no guest-access

no guest-access
To delete the guest access configuration, use the following command.
ruckus(config)# guest-access ${guestAccessName}? | name

Syntax Description
This command uses the following syntax:

name
Name of the guest
guest-access ${guestAccessName}?

Default
This command has no default settings.

Command Mode
config

Example
SZ100-Node1(config)# no guest-access dominic

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

157

Configuration Commands E - R
no hotspot

no hotspot
To delete the hotspot (WISPr) configuration, use the following command.
ruckus(config)# no hotspot ${hotspotName}? | name

Syntax Description
This command uses the following syntax:
hotspot ${hotspotName}?
name
Name of the WISPr hotspot profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no hotspot htsp1

158

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no hotspot20-venue-profile

no hotspot20-venue-profile
To delete all hotspot 2.0 venue profile, use the following command.
ruckus(config)# no hotspot20-venue-profile ${name}? | name

Syntax Description
This command uses the following syntax:
$name?

name
Name of hotspot 2.0 venue profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no hotspot20-venue-profile htsp2vp
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

159

Configuration Commands E - R
no hotspot20-wlan-profile

no hotspot20-wlan-profile
To delete all hotspot 2.0 WLAN profile, use the following command.
ruckus(config)# no hotspot20-wlan-profile ${name}? | name

Syntax Description
This command uses the following syntax:
$name?
| name
Name of hotspot 2.0 WLAN profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no hotspot20-wlan-profile htsp2wl
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

160

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no identity-provider

no identity-provider
To delete all identity provider profile, use the following command.
ruckus(config)# no identity-provider identity-provider ${name}? | name

Syntax Description
This command uses the following syntax:
$name?

name
Name of identity provider

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no identity-provider ip2wl
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

161

Configuration Commands E - R
no interface

no interface
To disable an interface configuration, use the following command.
ruckus(config)# no interface user-defined name

Syntax Description
This command uses the following syntax:
user-defined
User defined interface

name
User defined interface name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no interface user-defined UD1

162

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ip

no ip
To remove all IP address static routes, use the following command.
ruckus(config)# no ip route | route ip mask ip interface | route-ipv6 ip ip interface | name-server secondary | separate-accesscore enable

Syntax Description
This command uses the following syntax:
route
Deletes static routes
route ip mask ip interface
route
Deletes static routes

ip
Destination network IP address

mask
Destination network mask

ip
Next hop IP address

interface
Interface
route-ipv6 ip ip interface
route-ipv6
Delete IPv6 static routes

ip
Destination network IPv6 address

ip
Next hop IPv6 address

interface
Interface
name-server secondary
name-server
Deletes all name servers
secondary
Deletes secondary name server
separate-access-core enable
separate-access-core
Separates the access and core gateway

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

163

Configuration Commands E - R
no ip

enable
Disables the access and core gateway

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ip route ip 193.12.30.10 255.255.255 10.9.0.254 management

164

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ipsec-profile

no ipsec-profile
To delete all IPsec profiles, use the following command.
ruckus(config)# no ipsec-profile name

Syntax Description
This command uses the following syntax:

name
IPsec profile name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ipsec-profile xyz

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

165

Configuration Commands E - R
no lbs-service

no lbs-service
To disables the load balance server configuration, use the following command.
ruckus(config)# no lbs-service name

Syntax Description
This command uses the following syntax:

name
Set the LBS venue name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no lbs-service lbsruckus
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

166

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no ldap-service

no ldap-service
To delete all LDAP service, use the following command.
ruckus(config)# no ldap-service name

Syntax Description
This command uses the following syntax:

name
LDAP server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no ldap-service ldapser
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

167

Configuration Commands E - R
no lineman

no lineman
To disables the lineman application configuration, use the following command.
ruckus(config)# no lineman workflow-url

Syntax Description
This command uses the following syntax:

workflow-url
Workflow URL

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no lineman workflow-url ftp://dm:ruckus1!@172.19.7.100

168

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no logging

no logging
To disable service logging settings, use the following command.
ruckus(config)# no logging console cli

Syntax Description
This command uses the following syntax:
console
Disables all services that logon to the console and reverts to default settings.
cli
Disables the CLI logging on the console and changes the default log level

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no logging console cli

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

169

Configuration Commands E - R
no oauth-service

no oauth-service
To disable the all OAuth servers, use the following command.
ruckus(config)# no oauth-service name

Syntax Description
This command uses the following syntax:

name
OAuth server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no oauth-service nam3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

170

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no operator-profile

no operator-profile
To disable all WiFi operator profile settings, use the following command.
ruckus(config)# no operator-profile operator-profile ${name}? | name

Syntax Description
This command uses the following syntax:
operator-profile ${name}?

name
Operator name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no operator-profile ops2
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

171

Configuration Commands E - R
no osu-portal-profile

no osu-portal-profile
To disable all OSU portal profile settings, use the following command.
ruckus(config)# no osu-portal osu-portal-profile ${name}? | name

Syntax Description
This command uses the following syntax:
osu-portal ${name}?

name
OSU profile name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no osu-portal-profile ops3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

172

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no outbound firewall

no outbound firewall
To disable the outbound firewall, use the following command.
ruckus(config)# no outbound firewall

Syntax Description
This command has no keywords or arguments.

Default
This command has no default settings.

Command Mode
Privileged

Example
SZ100-Node1(config)# no outbound firewall

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

173

Configuration Commands E - R
no proxy-aaa

no proxy-aaa
To disable the proxy AAA server settings, use the following command.
ruckus(config)# no proxy-aaa name

Syntax Description
This command uses the following syntax:

name
Proxy AAA server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no proxy-aaa
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

174

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no report

no report
To delete reports, use the following command.
ruckus(config)# no report report-title

Syntax Description
This command uses the following syntax:

report-title
Report to be deleted

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no report dns-report

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

175

Configuration Commands E - R
no role

no role
To delete all administrator roles except the default administrator role, use the following command.
ruckus(config)# no role name

Syntax Description
This command uses the following syntax:

name
Name of the role to be deleted

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no role rm34
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

176

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no snmp-v2-community

no snmp-v2-community
To delete SNMPv2 community, use the following command.
ruckus(config)# no snmp-v2-community community

Syntax Description
This command uses the following syntax:

community
Community name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)#snmpno snmp-v2-community cm2
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

177

Configuration Commands E - R
no snmp-v3-user

no snmp-v3-user
To delete SNMPv3 user configuration, use the following command.
ruckus(config)# no snmp-v3-user user

Syntax Description
This command uses the following syntax:

user
User name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no snmp-v3-user ud11
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

178

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no user-agent-blacklist

no user-agent-blacklist
To delete the user agent blacklisted, use the following command.
ruckus(config)# no user-agent-blacklist name

Syntax Description
This command uses the following syntax:

name
Name of the user agent which is blacklisted

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no user-agent-blacklist userb1
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

179

Configuration Commands E - R
no user-role

no user-role
To delete all users except the default user, use the following command.
ruckus(config)# no user-role name

Syntax Description
This command uses the following syntax:

name
Name of the user role

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no user-role userr1
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

180

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no user-traffic-profile

no user-traffic-profile
To delete all users traffic profiles, use the following command.
ruckus(config)# no user-traffic-profile name

Syntax Description
This command uses the following syntax:

name
Name of the user traffic profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no user-traffic-profile userp1
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

181

Configuration Commands E - R
no vlan-pooling

no vlan-pooling
To delete all VLAN pooling profiles, use the following command.
ruckus(config)# no vlan-pooling vlan-pooling ${vlanPoolingName}? | name

Syntax Description
This command uses the following syntax:
vlan-pooling ${vlanPoolingName}?

name
Name of the VLAN pooling profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no vlan-pooling vlanservice1
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

182

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no web-authentication

no web-authentication
To delete all web authentication, use the following command.
ruckus(config)# no web-authentication ${webAuthenticationName}? |name

Syntax Description
This command uses the following syntax:
web-authentication ${webAuthenticationName}?

name
Name of the user traffic profile

Default
This command has no default settings

Command Mode
Config

Example
SZ100-Node1(config)# no web-authentication
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

183

Configuration Commands E - R
no wlan

no wlan
To delete all WLAN, use the following command.
ruckus(config)# no wlan ${wlanName}? |name

Syntax Description
This command uses the following syntax:

name
WLAN name
wlan ${wlanName}?

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no wlan
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

184

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
no wlan-group

no wlan-group
To delete all WLAN group, use the following command.
ruckus(config)# no wlan-group ${wlanGroupName}? |name

Syntax Description
This command uses the following syntax:

name
WLAN name
wlan-group ${wlanGroupName}?

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no wlan-group
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

185

Configuration Commands E - R
no wlan-scheduler

no wlan-scheduler
To delete all WLAN group, use the following command.
ruckus(config)# no wlan-scheduler ${wlanSchedulerName}?

Syntax Description
This command uses the following syntax:
wlan-scheduler ${wlanSchedulerName}?

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# no wlan-scheduler
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]

186

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
non-proxy-aaa

non-proxy-aaa
To create or update the non-proxy AAA server configuration settings, use the following command.
ruckus(config)# non-proxy-aaa name

Syntax Description
This command uses the following syntax:

name
Proxy AAA server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# non-proxy-aaa
SZ100-Node1(config-non-proxy-aaa)#

Related Commands
The following table lists the related non-proxy-aaa configuration commands.
TABLE 39 Commands related ruckus(config-non-proxy-aaa)
Syntax and Type

Parameters (if any)

ruckus(config-non-proxy-aaa)# admin-domain

Description
Sets the admin domain.

Type: Privileged
ruckus(config-non-proxy-aaa)# admindomain-name

admin-domain

Creates or updates the admin domain name.

admin-password

Creates or updates the admin password.

ip ip: Sets the IP address of secondary
RADIUS server

Enables backup of the RADIUS support.

Type: Privileged
ruckus(config-non-proxy-aaa)# adminpassword
Type: Privileged
ruckus(config-non-proxy-aaa)# backup
Type: Privileged

port port: Sets the port of secondary RADIUS
server
shared-secret: Sets the shared secret of
secondary RADIUS server
ruckus(config-non-proxy-aaa)# base-domain

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

base-domain

Sets the base domain.

187

Configuration Commands E - R
non-proxy-aaa

TABLE 39 Commands related ruckus(config-non-proxy-aaa) (continued)
Syntax and Type

Parameters (if any)

Description

description

Sets the description.

Type: Privileged
ruckus(config-non-proxy-aaa)# description
Type: Privileged
ruckus(config-non-proxy-aaa)# do

Executes the do command.

Type: Privileged
ruckus(config-non-proxy-aaa)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-non-proxy-aaa)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-non-proxy-aaa)# help

Displays the help.

Type: Privileged
ruckus(config-non-proxy-aaa)# global-catalog

Enables the global catalog support.

Type: Privileged
ruckus(config-non-proxy-aaa)# ip

ip

Sets the IP addresses of the primary RADIUS
server.

ipv6

Sets the IPv6 address of the primary RADIUS
server.

key-attribute

Sets the key attributes for the primary RADIUS
server.

Type: Privileged
ruckus(config-non-proxy-aaa)# ip6
Type: Privileged
ruckus(config-non-proxy-aaa)# key-attribute
Type: Privileged
ruckus(config-non-proxy-aaa)# name

Sets the RADIUS server name.

Type: Privileged
ruckus(config-non-proxy-aaa)# no

backup

Sets the RADIUS server name.

Type: Privileged

global-catalog

ruckus(config-non-proxy-aaa)# password

password

Sets the password.

port

Sets the port number of the primary RADIUS
server.

search-filter

Sets the search filter.

Type: Privileged
ruckus(config-non-proxy-aaa)# port
Type: Privileged
ruckus(config-non-proxy-aaa)# search-filter
Type: Privileged
ruckus(config-non-proxy-aaa)# shared-secret

Sets the shared secret of the primary RADIUS
server.

Type: Privileged

username password [ PAP | CHAP]

Sets the test AAA server.

ruckus(config-non-proxy-aaa)# type

[ radius | radius-acct | ldap | ad ]

Sets the RADIUS type.

Type: Privileged

radius: RADIUS type

ruckus(config-non-proxy-aaa)# test
Type: Privileged

radius-acct: RADIUS accounting type
ldap: LDAP
ad: Active Directory

188

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
non-proxy-aaa

TABLE 39 Commands related ruckus(config-non-proxy-aaa) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-non-proxy-aaa)# windowsdomain

windows-domain

Sets the windows domain.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

189

Configuration Commands E - R
northbound-authtype

northbound-authtype
Sets the RADIUS authentication type to northbound portal interface, use the following command.
ruckus(config)# northbound-authtype PAP | CHAP

Syntax Description
This command uses the following syntax:

PAP
Password authentication protocol

CHAP
Challenge handshake authentication protocol

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# northbound-authtype PAP
SZ100-Node1(config)# northbound-authtype CHAP

190

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
northbound-portal

northbound-portal
To enable the northbound portal interface and set the password, use the following command.
ruckus(config)# northbound-portal password

Syntax Description
This command uses the following syntax:

password
Password for the northbound portal interface

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# northbound-portal ruckus1!

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

191

Configuration Commands E - R
ntp-server

ntp-server
To update the NTP server configuration, use the following command.
ruckus(config)# ntp-server ntp-server

Syntax Description
This command uses the following syntax:

ntp-server
NTP server IP/domain name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# ntp-server host 172.19.13.53

192

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
oauth-service

oauth-service
To create or update OAuth service configuration, use the following command.
ruckus(config)# oauth-service name

Syntax Description
This command uses the following syntax:

name
OAuth service name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# oauth-service osuauth
SZ100-Node1(config-oauth-service)#

Related Commands
The following table lists the related oauth-service configuration commands.
TABLE 40 Commands related ruckus(config-oauth-service)
Syntax and Type

Parameters (if any)

Description

ruckus(config-oauth-service)# app-id

app-id

Sets the application ID.

app-secret

Sets the application secret name.

Type: Privileged
ruckus(config-oauth-service)# app-secret
Type: Privileged
ruckus(config-oauth-service)# collect-email

Enables collecting email addresses.

Type: Privileged
ruckus(config-oauth-service)# description

text

Sets the description.

Type: Privileged
ruckus(config-oauth-service)# do

Executes the do command.

Type: Privileged
ruckus(config-oauth-service)# end
Type: Privileged
ruckus(config-oauth-service)# exit

Ends the current configuration session and
returns to privileged EXEC mode.
Exits from the EXEC.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

193

Configuration Commands E - R
oauth-service

TABLE 40 Commands related ruckus(config-oauth-service) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-oauth-service)# group-attrs

user-role

Sets the user traffic profile mapping.

Type: Privileged
ruckus(config-oauth-service)# help

Displays the help.

Type: Privileged

name

Sets the OAuth service name.

ruckus(config-oauth-service)# no

collect-email

Disables commands.

Type: Privileged

whitelisted-domain

ruckus(config-oauth-service)# type

[ linkedin | facebook | google ]

Sets the OAuth provider type.

domain

Sets the whitelisted domains.

ruckus(config-oauth-service)# name
Type: Privileged

Type: Privileged
ruckus(config-oauth-service)# whitelisteddomains
Type: Privileged

194

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
operator-profile

operator-profile
To create or update WiFi operator profile configuration, use the following command.
ruckus(config)# operator-profile name

Syntax Description
This command uses the following syntax:

name
Operator profile name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# operator-profile orangewifi
SZ100-Node1(config-operator-profile)#

Related Commands
The following table lists the related operator-profile configuration commands.
TABLE 41 Commands related ruckus(config-operator-profile)
Syntax and Type

Parameters (if any)

Description

ruckus(config-operator-profile)# description

text

Sets the description.

Type: Privileged
ruckus(config-operator-profile)# do

Executes the do command.

Type: Privileged
ruckus(config-operator-profile)# domainnames

domain-name

Sets the domain name.

Type: Privileged
ruckus(config-operator-profile)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-operator-profile)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-operator-profile)# friendlynames

language names

Sets the friendly name as seen by the end
user.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

195

Configuration Commands E - R
operator-profile

TABLE 41 Commands related ruckus(config-operator-profile) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-operator-profile)# help

Description
Displays the help.

Type: Privileged

name

Sets the WiFi operator profile name.

ruckus(config-operator-profile)# no

domain-names

Disables commands.

Type: Privileged

friendly-names

ruckus(config-operator-profile)# osen-cert

${cert}

ruckus(config-operator-profile)# name
Type: Privileged

signup-security
Uploads the operator certificate.

Type: Privileged
ruckus(config-operator-profile)# signupsecurity

Enables OSEN (Support for Anonymous
Authentication)

Type: Privileged

196

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
outbound-firewall

outbound-firewall
To update the outbound firewall configuration settings, use the following command.
ruckus(config)# outbound-firewall

Syntax Description
This command has no keywords or arguments.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# outbound firewall

Related Commands
The following table lists the related outbound-firewall configuration commands.
TABLE 42 Commands related ruckus(config-outbound-firewall)
Syntax and Type

Parameters (if any)

ruckus(config-outbound-firewall)# enable

Description
Allow the outbound traffic.

Type: Privileged
ruckus(config-outbound-firewall)# ip-rule
Type: Privileged

profileName out [ udp | sctp | tcp ] [ dport |

Allow IP tables profile.

sport ] port

profileName: profile name out: Output traffic
udp: UDP
sctp: SCTP
tcp: TCP
dport: Destination port sport: Source port

port: port
profileName out [ udp | sctp | tcp ] [ sport |
dport ] port [ src | dst ] ipaddress
profileName: profile name out: Output traffic
udp: UDP
sctp: SCTP
tcp: TCP

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

197

Configuration Commands E - R
outbound-firewall

TABLE 42 Commands related ruckus(config-outbound-firewall) (continued)
Syntax and Type

Parameters (if any)

Description

sport: Source port dport: Destination
port port: port
src: Source
dst: Destination

ipaddress: IP address
ruckus(config-outbound-firewall)# no ip-rule

profileName : Profile Name

Remove IP rule.

Type: Privileged

198

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
proxy-aaa

proxy-aaa
To create or update the proxy AAA server configuration settings, use the following command.
ruckus(config)# proxy-aaa name

Syntax Description
This command uses the following syntax:

name
Proxy AAA server name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# proxy-aaa
SZ100-Node1(config-proxy-aaa)#

Related Commands
The following table lists the related proxy-aaa configuration commands.
TABLE 43 Commands related ruckus(config-proxy-aaa)
Syntax and Type

Parameters (if any)

ruckus(config-proxy-aaa)# auto-fallbackdisable

Description
Disables the auto fallback.

Type: Privileged
ruckus(config-proxy-aaa)# backup
Type: Privileged

ip ip: Sets the IP address of secondary
RADIUS server

Enables backup of the RADIUS support.

port port: Sets the port of secondary RADIUS
server
shared-secret: Sets the shared secret of
secondary RADIUS server
ruckus(config-proxy-aaa)# description

text

Sets the description.

Type: Privileged
ruckus(config-proxy-aaa)# do

Executes the do command.

Type: Privileged
ruckus(config-proxy-aaa)# end
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Ends the current configuration session and
returns to privileged EXEC mode.

199

Configuration Commands E - R
proxy-aaa

TABLE 43 Commands related ruckus(config-proxy-aaa) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-proxy-aaa)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-proxy-aaa)# friendly-name

friendly-name

Sets the RADIUS server friendly name.

attr-value user-role

Sets the user traffic profile mapping.

Type: Privileged
ruckus(config-proxy-aaa)# group-attrs
Type: Privileged
ruckus(config-proxy-aaa)# help

Displays the help.

Type: Privileged

ip

Sets the IP addresses of the primary RADIUS
server.

[ 0 or 10-4096]: Maximum outstanding
requests per server

Sets the maximum outstanding requests per
server.

ruckus(config-proxy-aaa)# no

auto-fallback-disable

Disables various commands.

Type: Privileged

backup

ruckus(config-proxy-aaa)# ip
Type: Privileged
ruckus(config-proxy-aaa)# mor
Type: Privileged

no group-attrs
no-response-fail
out-of-band
ruckus(config-proxy-aaa)# out-of-band

Enables RFC5580 out of band location
delivery for Ruckus AP.

Type: Privileged
ruckus(config-proxy-aaa)# name

Sets the RADIUS server name.

Type: Privileged
ruckus(config-aaa)# port

port

Sets the port number of the primary RADIUS
server.

seconds

Sets the response window.

seconds

Sets the revive interval.

seconds

Sets the sanity timer.

Type: Privileged
ruckus(config-proxy-aaa)# response-window
Type: Privileged
ruckus(config-proxy-aaa)# revive-interval
Type: Privileged
ruckus(config-proxy-aaa)# sanity-timer
Type: Privileged
ruckus(config-proxy-aaa)# shared-secret

Sets the shared secret of the primary RADIUS
server.

Type: Privileged

username password [PAP | CHAP]

Sets the RADIUS server using login
credentials.

[ 10-90 % ]:Percentage of maximum number
of outstanding requests.

Sets the percentage of maximum number of
outstanding requests.

ruckus(config-proxy-aaa# type

[ radius | radius-acct | LDAP | AD ]

Sets the RADIUS type.

Type: Privileged

radius: RADIUS type

ruckus(config-proxy-aaa)# test
Type: Privileged
ruckus(config-proxy-aaa)# threshold
Type: Privileged

radius-acct: RADIUS accounting type
LDAP: LDAP

200

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
proxy-aaa

TABLE 43 Commands related ruckus(config-proxy-aaa) (continued)
Syntax and Type

Parameters (if any)

Description

AD: Active Directory
ruckus(config-proxy-aaa)# zombie-period

seconds

Sets the zombie period.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

201

Configuration Commands E - R
rebalance-aps

rebalance-aps
To execute control plane and data plane loading and rebalancing, use the following command.
ruckus(config)# rebalance-aps

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# rebalance-aps

202

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
report

report
To create or update the report configurations, use the following command.
ruckus(config)# report title

Syntax Description
This command uses the following syntax:

title
Name of the report

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# report rep01

Related Commands
The following table lists the related report configuration command.
TABLE 44 Commands related to ruckus(config-report)
Syntax and Type

Parameters (if any)

ruckus(config-report)# csv-format

Description
Sets the output of the report in CSV format.

Type: Privileged
ruckus(config-report)# description

text

Sets the description.

Type: Privileged
ruckus(config-report)# do

Executes the do command.

Type: Privileged
ruckus(config-report)# email

email

Sets the email notification.

Type: Privileged
ruckus(config-report)# enable-export
Type: Privileged
ruckus(config-report)# end
Type: Privileged
ruckus(config-report)# exit

Enables the export report results to the FTP
server.
Ends the current configuration session and
returns to privileged EXEC mode.
Exits from the EXEC.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

203

Configuration Commands E - R
report

TABLE 44 Commands related to ruckus(config-report) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-report)# export

ftp-url: FTP URL format is: ftp://
username:password@ftp-host[/dir-path]

Sets the export report results to FTP server.

Type: Privileged
ruckus(config-report)# export-test

Tests the FTP server.

Type: Privileged
ruckus(config-report)# help

Displays the help.

Type: Privileged
ruckus(config-report)# no

csv-format

Type: Privileged

email

Disables and deletes commands.

enable export
export
pdf-format
resource-filter
schedule
ruckus(config-report)# pdf-format

Sets the outputs of the report in a PDF format.

Type: Privileged
ruckus(config-report)# resource-filter

ggsn ggsn-ip

Type: Privileged

ssid ssid

Sets the resource filter criteria.

radio ${value}
device plane name
device domain name
device zone name
device ap name
ruckus(config-report)# schedule
Type: Privileged

monthly date-of-month hour hour minute

Sets the schedule.

minute
weekly date-of-week hour hour minute minute
daily hour minute minute
hourly minute

ruckus(config-report)# time-filter

monthly months months

Type: Privileged

daily days days

Sets the time filter.

hourly days days
hourly hours hours
15min hours hours
5min hours hours
time-period hours hours

title

Sets the report title.

ruckus(config-report)# type

client-number

Sets the report type.

Type: Privileged

client-number-vs-air-time

ruckus(config-report)# title
Type: Privileged

continuously-disconnected-aps

204

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
report

TABLE 44 Commands related to ruckus(config-report) (continued)
Syntax and Type

Parameters (if any)

Description

failed-client-associations
new-client-associations
system-resource-utilization
tx-rx-bytes

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

205

Configuration Commands E - R
role

role
To create or update the role configuration, use the following command.
ruckus(config)# role name

Syntax Description
This command uses the following syntax:

name
Define the role name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# role admin01

Related Commands
The following table lists the related role configuration commands.
TABLE 45 Commands related to ruckus(config-role)
Syntax and Type

Parameters (if any)

Description

ruckus(config-role)# capabilities

administration

Sets the capabilities details.

Type: Privileged

configuration
device
monitor
reports

capabilities-depth-1
ruckus(config-role)# description

text

Sets the description for the assigned role.

Type: Privileged
ruckus(config-role)# do

Executes the do command.

Type: Privileged
ruckus(config-role)# end
Type: Privileged
ruckus(config-role)# exit

Ends the current configuration session and
returns to privileged EXEC mode.
Exits from the EXEC.

Type: Privileged

206

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands E - R
role

TABLE 45 Commands related to ruckus(config-role) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-role)# help

Description
Displays the help.

Type: Privileged
ruckus(config-role)# no

administration

Type: Privileged

configuration

Disables the capabilities assigned.

device
monitor
reports

capabilities-depth-1

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

207

208

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

sci-profile...............................................................................................................................................................209
sci-setting............................................................................................................................................................. 211
sms-server............................................................................................................................................................ 212
smtp-server...........................................................................................................................................................214
snmp-notification...................................................................................................................................................216
snmp-v2-community............................................................................................................................................. 217
snmp-v3-user........................................................................................................................................................219
soft-gre................................................................................................................................................................. 221
subpackages.........................................................................................................................................................223
support-admin.......................................................................................................................................................224
syslog-server.........................................................................................................................................................225
user-agent-blacklist............................................................................................................................................... 227
user-group............................................................................................................................................................ 229
user-role................................................................................................................................................................ 230
user-traffic-profile...................................................................................................................................................232
vlan-pooling...........................................................................................................................................................235
zone...................................................................................................................................................................... 237
zone-template....................................................................................................................................................... 277

sci-profile
To configure an SCI profile, use the following command.
ruckus(config)# sci-profile

Syntax Description
This command has the following syntax:

name
The SCI profile name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# sci-profile

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

209

Configuration Commands S - W
sci-profile

Related Commands
The following table lists the related sci-profile configuration commands.
TABLE 46 Commands related to ruckus(config-sci-profile)
Syntax and Type

210

Parameters (if any)

Description

ruckus(config-sci-profile)# do
Type: Privileged

Enables the do command.

ruckus(config-sci-profile)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXEC mode.

ruckus(config-sci-profile)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-sci-profile)# help
Type: Privileged

Display this help message.

ruckus(config-sci-profile)# host
Type: Privileged



Sets the host.

ruckus(config-sci-profile)# name
Type: Privileged



Sets the SCI profile name.

ruckus(config-sci-profile)# password
Type: Privileged



Sets password.

ruckus(config-sci-profile)# port
Type: Privileged



Sets the port.

ruckus(config-sci-profile)# system-id
Type: Privileged



Sets the system ID.

ruckus(config-sci-profile)# user
Type: Privileged



Sets user.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
sci-setting

sci-setting
To enable SCI settings, use the following command.
ruckus(config)# sci-setting

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
ruckus(config)# sci-setting
ruckus(config-sci-setting)#

Related Commands
The following table lists the related sci-setting configuration commands.
TABLE 47 Commands related to ruckus(config-sci-setting)
Syntax and Type

Parameters (if any)

Description

ruckus(config-sci-setting)# do
Type: Privileged

Enables the do command.

ruckus(config-sci-setting)# enable
Type: Privileged

Enables the SCI server.

ruckus(config-sci-setting)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXEC mode.

ruckus(config-sci-setting)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-sci-setting)# help
Type: Privileged

Displays this help message.

ruckus(config-sci-setting)# no
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A



Disables SCI server commands.

211

Configuration Commands S - W
sms-server

sms-server
To enable SMS server configurations, use the following command.
ruckus(config)# sms-server personalname

Syntax Description
This command has the following syntax:

personalname
Set personal name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# sms-server

Related Commands
The following table lists the related sms-server configuration commands.
TABLE 48 Commands related to ruckus(config-sms-server)
Syntax and Type

Parameters (if any)

Description

ruckus(config-sms-server)# account-sid

sid

Sets the account SID, which is a 34 character
string that uniquely identifies this account. The
enable commands set this command.

token

Sets the authorization token identifier. The
enable commands set this command.

Type: Privileged
ruckus(config-sms-server)# auth-token
Type: Privileged
ruckus(config-sms-server)# do

Executes the do command.

Type: Privileged
ruckus(config-sms-server)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-sms-server)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-sms-server)# enable

Enables the SMS server.

Type: Privileged
ruckus(config-sms-server)# from

from

Sets the sender’s mail address.

Type: Privileged

212

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
sms-server

TABLE 48 Commands related to ruckus(config-sms-server) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-sms-server)# help

Description
Displays the help.

Type: Privileged
ruckus(config-sms-server)# no enable

Disables the SMS server.

Type: Privileged
ruckus(config-sms-server)# server-name

server-name

Sets the server name.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

213

Configuration Commands S - W
smtp-server

smtp-server
To update the SMTP server configurations, use the following command.
ruckus(config)# smtp-server

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100(config)# smtp-server

Related Commands
The following table lists the related smtp-server configuration commands.
TABLE 49 Commands related to ruckus(config-smtp-server)
Syntax and Type

Parameters (if any)

ruckus(config-smtp-server)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-smtp-server)# enable

Enables the SMTP server.

Type: Privileged
ruckus(config-smtp-server)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(diagnostic)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-smtp-server)# from

mail

Sets the sender’s mail address.

Type: Privileged
ruckus(config-smtp-server)# help

Displays the help.

Type: Privileged

host

Sets the SMTP server IP address or domain
name.

ruckus(config-smtp-server)# no

enable: Disables SMTP Server

Type: Privileged

password: Removes password

Disables TLS or STARTTLS encryption
commands.

ruckus(config-smtp-server)# host
Type: Privileged

214

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
smtp-server

TABLE 49 Commands related to ruckus(config-smtp-server) (continued)
Syntax and Type

Parameters (if any)

Description

start-tls: Disables STARTTLS encryption
tls: Disables TLS encryption
username: Removes the username
ruckus(config-smtp-server)# password

password

Sets the password.

personalname

Sets the name from the display name.

port

Sets the port number.

Type: Privileged
ruckus(config-smtp-server)# personalname
Type: Privileged
ruckus(config-smtp-server)# port
Type: Privileged
ruckus(config-smtp-server)# start-tls

Enables STARTTLS encryption. The TLS
commands set this command.

Type: Privileged
ruckus(config-smtp-server)# test

Tests the SMTP settings. The TLS commands
set this command.

Type: Privileged
ruckus(config-smtp-server)# tls

Enables TLS encryption.

Type: Privileged
ruckus(config-smtp-server)# to

mail

Sets the receiver’s email address.

username

Sets the logon name.

Type: Privileged
ruckus(config-smtp-server)# username
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

215

Configuration Commands S - W
snmp-notification

snmp-notification
To enable SNMP notification, use the following command.
ruckus(config)# snmp-notification

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# snmp-notification

216

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
snmp-v2-community

snmp-v2-community
Sets the SNMPv2 community, use the following command.
ruckus(config)# snmp-v2-community community

Syntax Description
This command uses the following syntax:

community
Community name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# snmp-v2-community comm3

Related Commands
The following table lists the related snmp-v2-community configuration commands.
.
TABLE 50 Commands related to ruckus(config-snmp-v2-community)
Syntax and Type

Parameters (if any)

ruckus(config-snmp-v2-community)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-snmp-v2-community)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-snmp-v2-community)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-snmp-v2-community)# help

Displays the help.

Type: Privileged
ruckus(config-snmp-v2-community)# no

read: Disables read privilege

Type: Privileged

trap: Disables trap privilege

Disables various options.

trap-target ip port: Deletes trap target IP
address and port
write: Disables write privilege

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

217

Configuration Commands S - W
snmp-v2-community

TABLE 50 Commands related to ruckus(config-snmp-v2-community) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-snmp-v2-community)# read

Description
Enables the read privileges.

Type: Privileged
ruckus(config-snmp-v2-community)# trap

Enables trap privileges.

Type: Privileged
ruckus(config-snmp-v2-community)# traptarget
Type: Privileged
ruckus(config-snmp-v2-community)# write

ip port

Enables trap target by setting the IP address
and port. The trap command sets this
command.
Enables the write privileges.

Type: Privileged

218

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
snmp-v3-user

snmp-v3-user
Sets the SNMPv3 user configuration, use the following command.
ruckus(config)# snmp-v3-user user

Syntax Description
This command uses the following syntax:
user
User name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# snmp-v3-user user
SZ100-Node1(config-snmp-v3-user)#

Related Commands
The following table lists the related snmp-v3-user configuration commands.
TABLE 51 Commands related to ruckus(config-snmp-v3-user)
Syntax and Type

Parameters (if any)

Description

ruckus(config-snmp-v3-user)# auth

md5 auth-password

Sets SNMPv3 user authentication.

Type: Privileged

none
sha auth-password

ruckus(config-snmp-v3-user)# do

Executes the do command.

Type: Privileged
ruckus(config-snmp-v3-user)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-snmp-v3-user)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-snmp-v3-user)# help

Displays the help.

Type: Privileged
ruckus(config-snmp-v3-user)# no

read: Disables read privilege

Type: Privileged

trap: Disables trap privilege

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Disables various options.

219

Configuration Commands S - W
snmp-v3-user

TABLE 51 Commands related to ruckus(config-snmp-v3-user) (continued)
Syntax and Type

Parameters (if any)

Description

trap-target ip port: Deletes trap target IP
address and port
write: Disables write privilege
ruckus(config-snmp-v3-user)# privacy

none: Set to none

Type: Privileged

des privacy-phrase: DES privacy phrase

Sets the user privacy. The auth-md5
command sets this command.

aes privacy-phrase: AES privacy phrase
ruckus(config-snmp-v3-user)# read

Enables read privileges.

Type: Privileged
ruckus(config-snmp-v3-user)# trap

Enables trap privileges.

Type: Privileged
ruckus(config-snmp-v3-user)# trap-target

ip port

Type: Privileged

Enables trap target by setting the IP address
and port. The trap command sets this
command.

ruckus(config-snmp-v3-user)# write

Enables write privileges.

Type: Privileged

220

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
soft-gre

soft-gre
To configure soft GRE, use the following command.
ruckus# soft-gre

Syntax Description
This command has the following syntax:

name
soft GRE name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# soft-gre

Related Commands
The following table lists the related soft-gre configuration commands.
TABLE 52 Commands related to ruckus (config-soft-gre)
Syntax and Type

Parameters (if any)

Description

ruckus(config-soft-gre)# description
Type: Privileged

Sets the description.

ruckus(config-soft-gre)# device-ip-mode
Type: Privileged

Sets Gateway IP mode.

ruckus(config-soft-gre)# do
Type: Privileged

Executes the do command.

ruckus(config-soft-gre)# end
Type: Privileged

End the current configuration session and
return to privileged EXEC mode.

ruckus(config-soft-gre)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-soft-gre)# force-disassociateclient
Type: Privileged

Forces Disassociate clients.

ruckus(config-soft-gre)# gateway
Type: Privileged

Sets the gateway address.

ruckus(config-soft-gre)# gateway-mtu
Type: Privileged

Sets the gateway path MTU.

ruckus(config-soft-gre)# help

Displays this help message.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

221

Configuration Commands S - W
soft-gre

TABLE 52 Commands related to ruckus (config-soft-gre) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged

222

ruckus(config-soft-gre)# icmp-period
Type: Privileged

Sets the ICMP keepalive period.

ruckus(config-soft-gre)# icmp-retry
Type: Privileged

Sets the ICMP keepalive retry.

ruckus(config-soft-gre)# name
Type: Privileged

Sets the soft GRE name.

ruckus(config-soft-gre)# no
Type: Privileged

Disables the softGRE settings.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
subpackages

subpackages
To create and update the configuration of subscription packages, use the following command.
ruckus(config)# subpackages name

Syntax Description
This command has the following keywords:

name
Package Name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# subpackages abcd12

Related Commands
The following table lists the related event-email configuration commands.
TABLE 53 Commands related to ruckus(config-subpackages)
Syntax and Type

Parameters (if any)

Description

ruckus(config-subpackages)# description

description

Sets the description.

[ week | hour | year | never | month | day]

Sets the expiration interval.

Type: Privileged
ruckus(config-subpackages)# expirationinterval
Type: Privileged

week: Set Week
hour: Set Hour
year: Set Year
never: Never
month: Set Month
day: Set Day

ruckus(config-subpackages)# expiration-value

expiration-value

Sets the expiration value.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

223

Configuration Commands S - W
support-admin

support-admin
To support administrator configuration, use the following command.
ruckus(config)# support-admin

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# support-admin

Related Commands
The following table lists the related support-admin configuration commands.
TABLE 54 Commands related to ruckus(config-support-admin)
Syntax and Type

Description

ruckus(config-support-admin)#
changepassword
Type: Privileged

Change the password.

ruckus(config-support-admin)# do
Type: Privileged

Executes the do command.

ruckus(config-support-admin)# enable
Type: Privileged

Unlocks the support administrator.

ruckus(config-support-admin)# end
Type: Privileged

Ends the current configuration session and
returns to privileged EXEC mode.

ruckus(config-support-admin)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-support-admin)# help
Type: Privileged

Displays the help.

ruckus(config-support-admin)# no
Type: Privileged

224

Parameters (if any)

enable

Disables the support administrator.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
syslog-server

syslog-server
To update the syslog server configurations, use the following command.
ruckus(config)# syslog-server

Syntax Description
This command has no arguments or keywords.

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# user-agent-blacklist name
SZ100-Node1(config-user-agent-blacklist)#

Related Commands
The following table lists the relate syslog-server configuration commands.
TABLE 55 Commands related to ruckus(config-syslog-server)
Syntax and Type

Parameters (if any)

Description

ruckus(config-syslog-server)# appfacility

[ Local2 | Local7 | Local0 | Local6 | Local4 |
Local5 | Local3 | Local1 ]

Remote syslog server to send the application
log files.

[ Local6 | Local4 | Local2 | Local3 | Local0 |
Local5 | Local7 | Local1 ]

Remote syslog server to send the audit log
files.

Type: Privileged
ruckus(config-syslog-server)# auditfaciility
Type: Privileged
ruckus(config-syslog-server)# do

Executes the do command.

Type: Privileged
ruckus(config-syslog-server)# enable

Enables sending events to the remote syslog
server.

Type: Privileged
ruckus(config-syslog-server)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-syslog-server)# eventfacility
Type: Privileged

[ Local7 | Local6 | Local3 | Local4 | Local0 |
Local2 | Local1 | Local5 ]

ruckus(config-syslog-server)# exit

Remote syslog server to send the event log
files.
Exits from the EXEC.

Type: Privileged
ruckus(config-syslog-server)# filter

[ severity | exclude-client | all ]

Type: Privileged

severity: All events above a severity

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Sets the settings for filtering events.

225

Configuration Commands S - W
syslog-server

TABLE 55 Commands related to ruckus(config-syslog-server) (continued)
Syntax and Type

Parameters (if any)

Description

exclude-client: All events except client
associate/disassociate events
all: All events
ruckus(config-syslog-server)# filter-severity
Type: Privileged

[ Critical | Warning | Major | Info | Debug |
Minor ]

ruckus(config-syslog-server)# help

Sets the event severity filter settings.

Displays the help.

Type: Privileged

ip

Sets the syslog server IP address.

ruckus(config-syslog-server)# no

enable

Disables the settings and commands.

Type: Privileged

secondary-host

ruckus(config-syslog-server)# host
Type: Privileged

ruckus(config-syslog-server)# ping

Pings the syslog server.

Type: Privileged
ruckus(config-syslog-server)# pingsecondary

Pings the secondary syslog server.

Type: Privileged

port

Sets the syslog server port.

[ Minor | Critical | Debug | Info | Warning |
Major ][ Debug | Warning | Info | Error ]

Sets the priority for events. The event severity
and syslog-severity is based on priority.

ruckus(config-syslog-server)# protocol

[ udp | tcp ]

Sets the protocol for the primary syslog server

Type: Privileged

udp: UDP protocol

ruckus(config-syslog-server)# port
Type: Privileged
ruckus(config-syslog-server)# priority
Type: Privileged

tcp: TCP protocol
ruckus(config-syslog-server)# redundancymode

[Primary/Backup | Active/Active]

Set forwarding syslog server mode.

ip IP address

Sets the secondary syslog server IP.

port

Sets the secondary syslog server port.

[ tcp | udp ]

Sets the protocol for the secondary syslog
server.

Type: Privileged
ruckus(config-syslog-server)# secondary-host
Type: Privileged
ruckus(config-syslog-server)# secondary-port
Type: Privileged
ruckus(config-syslog-server)# secondaryprotocol
Type: Privileged

226

tcp: TCP protocol
udp: UDP protocol

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
user-agent-blacklist

user-agent-blacklist
To create and update the user agent blacklisted configuration, use the following command.
ruckus(config)# user-agent-blacklist name

Syntax Description
This command uses the following syntax:

name
Name of the user agent blacklisted

Default
This command has no default settings.

Command Mode
Config

Example
SZ100(config)# user-agent-blacklist user-agent-blacklist
SZ100(config-user-agent-blacklist)#

Related Commands
The following table lists the related user-agent-blacklist configuration commands.
TABLE 56 Commands related to ruckus(config-user-agent-blacklist)
Syntax and Type

Parameters (if any)

ruckus(config-user-agent-blacklist)# do

Description
Sets the do command.

Type: Privileged
ruckus(config-user-agent-blacklist)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-user-agent-blacklist)# error

error

Sets the error code between 400 and 599.

error message

Sets the error message.

Type: Privileged
ruckus(config-user-agent-blacklist)# errormessage
Type: Privileged
ruckus(config-user-agent-blacklist)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-user-agent-blacklist)# help

Displays the help.

Type: Privileged
ruckus(config-user-agent-blacklist)# name

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

name

Sets the user agent name who is blacklisted.

227

Configuration Commands S - W
user-agent-blacklist

TABLE 56 Commands related to ruckus(config-user-agent-blacklist) (continued)
Syntax and Type

Parameters (if any)

Description

pattern

Sets the user agent pattern

Type: Privileged
ruckus(config-user-agent-blacklist)# pattern
Type: Privileged

228

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
user-group

user-group
To create and update the user group, use the following command.
ruckus(config)# user-group name

Syntax Description
This command uses the following syntax:

name
User group name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100(config)# user-group ag1
SZ100(config-user-group)#

Related Commands
The following table lists the related user-group configuration commands.
Syntax and Type

Parameters (if any)

Description

ruckus(config-user-group)#
Type: Privileged



Sets the user group name.

ruckus(config-user-group)# do
Type: Privileged

Executes the do command.

ruckus(config-user-group)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXEC mode.

ruckus(config-user-group)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-user-group)# help
Type: Privileged

Displays help.

ruckus(config-user-group)# name
Type: Privileged

Sets user group name.

ruckus(config-user-group)# no
Type: Privileged



Deletes the user.

ruckus(config-user-group)# permission
Type: Privileged

Sets permission.

ruckus(config-user-group)# user
Type: Privileged

Sets user.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

229

Configuration Commands S - W
user-role

user-role
To create and update the user role configuration, use the following command.
ruckus(config)# user-role name

Syntax Description
This command uses the following syntax:

name
Name of the user role

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# user-role user-adam
SZ100-Node1(config-user-role)#

Related Commands
The following table lists the related user-role configuration commands.
TABLE 57 Commands related to ruckus(config-user-role)
Syntax and Type

Parameters (if any)

Description

ruckus(config-user-role)# allow-wlan-type

all: Allows Zero IT access to all WLANs

Sets the allowed resources.

Type: Privileged

zones - Allows Zero IT access to all WLANs in
the selected zones

wlans: Allows Zero IT access to selected
WLANs
ruckus(config-user-role)# description

description

Sets the description.

Type: Privileged
ruckus(config-user-role)# do

Sets the do command.

Type: Privileged
ruckus(config-user-role)# dpsk-expire-unit

Day

Type: Privileged

Week

Sets the DPSK expiration unit.

Month
Year
Never

230

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
user-role

TABLE 57 Commands related to ruckus(config-user-role) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-user-role)# dpsk-expire-value

dpsk-expire-value

Enable DPSK expiration value.

Type: Privileged
ruckus(config-user-role)# enable-dpsk-autoremoval

Enables DPSK auto removal.

Type: Privileged
ruckus(config-user-role)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-user-role)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-user-role)# help

Displays the help.

Type: Privileged
ruckus(config-user-role)# max-devices

number: Allows max devices value

Type: Privileged

unlimited: Unlimited devices value

ruckus(config-user-role)# no

description

Type: Privileged

enable-dpsk-auto-removal

Sets the number for maximum devices
allowed (1-10).
Disables the override on the specified
settings.

user-traffic-profile
wlan
ruckus(config-user-role)# user-traffic-profile

user-traffic-profile

Sets the user traffic profile.

name

Adds the WLAN server.

Type: Privileged
ruckus(config-user-role)# wlan
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

231

Configuration Commands S - W
user-traffic-profile

user-traffic-profile
To create and update the user traffic profile configuration, use the following command.
ruckus(config)# user-traffic-profile name

Syntax Description
This command uses the following syntax:

name
Name of the user traffic profile

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config-user-traffic-profile)#
SZ100-Node1(config-user-traffic-profile)#

Related Commands
•

Table 58 lists the related user-traffic-profile configuration commands.

•

Table 59 lists the related user-traffic-profile-acl configuration commands.

The following table lists the related user-traffic-profile configuration commands.
TABLE 58 Commands related to (config-user-traffic-profile)
Syntax and Type

Parameters (if any)

Description

ruckus(config-user-traffic-profile)# acl

${value}

Sets the network access control list.

default-action

Sets the default action.

description

Sets the description.

Type: Privileged
ruckus(config-user-traffic-profile)# defaultaction
Type: Privileged
ruckus(config-user-traffic-profile)# description
Type: Privileged
ruckus(config-user-traffic-profile)# do

Sets the do command.

Type: Privileged
ruckus(config-user-traffic-profile)# downlink

Sets the downlink rate limit in mbps.

Type: Privileged

232

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
user-traffic-profile

TABLE 58 Commands related to (config-user-traffic-profile) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-user-traffic-profile)# end

Description
Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-user-traffic-profile)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-user-traffic-profile)# help

Displays the help.

Type: Privileged

name

Sets the number for maximum devices
allowed.

ruckus(config-user-traffic-profile)# no

acl

Disables various commands.

Type: Privileged

downlink

ruckus(config-user-traffic-profile)# name
Type: Privileged

uplink
ruckus(config-user-traffic-profile)# uplink

Sets the uplink rate limit in mbps.

Type: Privileged

The following table lists the related user-traffic-profile-acl configuration commands.
TABLE 59 Commands related to ruckus(config-user-traffic-profile-acl)
Syntax and Type

Parameters (if any)

Description

ruckus(config-user-traffic-profile-acl)# action

${value}

Sets the handling action.

description

Sets the description.

ruckus(config-user-traffic-profile-acl)#
destination-ip

network [ Network Address ] subnet-mask
subnet-mask: Sets the destination subnet

Sets the destination IP address.

Type: Privileged

host [ Host IP Address ]: Sets the destination
host

ruckus(config-user-traffic-profile-acl)#
destination-port

[ Port Number ]: Sets the destination port
number

Type: Privileged

range [ Port Number ] [ Port Number ]: Sets
the destination port range

ruckus(config-user-traffic-profile-acl)# direction

${value}

Type: Privileged
ruckus(config-user-traffic-profile-acl)#
description
Type: Privileged

Sets the destination port number.

Sets the traffic direction.

Type: Privileged
ruckus(config-user-traffic-profile-acl)# do

Sets the do command.

Type: Privileged
ruckus(config-user-traffic-profile-acl)# end
Type: Privileged
ruckus(config-user-traffic-profile-acl)# exit

Ends the current configuration session and
returns to privileged EXEC mode.
Exits from the EXEC.

Type: Privileged
ruckus(config-user-traffic-profile-acl)# help

Displays the help.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

233

Configuration Commands S - W
user-traffic-profile

TABLE 59 Commands related to ruckus(config-user-traffic-profile-acl) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-user-traffic-profile-acl)# protocol

protocol number : Value should be in the
range of 1 to 255

Sets the protocol.

ruckus(config-user-traffic-profile-acl)# sourceip

network [ Network Address ] subnet-mask
subnet-mask: Sets the source subnet

Sets the matching source IP address.

Type: Privileged

host [ Host IP Address ] :Sets the source host

ruckus(config-user-traffic-profile-acl)# sourceport

[ Port Number ]: Sets the destination port
number

Type: Privileged

range [ Port Number ] [ Port Number]range:
Sets the destination port range

Type: Privileged

234

Sets the source port number.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
vlan-pooling

vlan-pooling
To create or update the VLAN pooling profile configurations, use the following command.
ruckus(config)# vlan-pooling name

Syntax Description
This command uses the following syntax:

name
Web authentication name

Default
This command has no default settings.

Command Mode
Config

Example
SZ100-Node1(config)# vlan-pooling vlanorange
SZ100-Node1(config-vlan-pooling)#

Related Commands
The following table lists the related vlan-pooling configuration commands.
TABLE 60 Commands related to ruckus (config-vlan-pooling)
Syntax and Type

Parameters (if any)

Description

ruckus(config-vlan-pooling)# algo

mac-hash

Sets the algorithm,

text

Sets the description.

Type: Privileged
ruckus(config-vlan-pooling)# description
Type: Privileged
ruckus(config-vlan-pooling)# do

Sets the do command.

Type: Privileged
ruckus(config-vlan-pooling)# end

Ends the current configuration session and
returns to privileged EXEC mode.

Type: Privileged
ruckus(config-vlan-pooling# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-vlan-pooling)# help

Displays the help.

Type: Privileged
ruckus(config-vlan-pooling)# name

name

Sets the VLAN pooling name.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

235

Configuration Commands S - W
vlan-pooling

TABLE 60 Commands related to ruckus (config-vlan-pooling) (continued)

236

Syntax and Type

Parameters (if any)

Description

ruckus(config-vlan-pooling)# no

description

Disables the commands.

Type: Privileged

pooling

ruckus(config-vlan-pooling)# pooling

range start-value end-value

Type: Privileged

single value

Adds the VLAN pooling.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

zone
To create or update the AP zone configurations, use the following command.
ruckus(config)# zone

Syntax Description
name
AP zone name

nametemplate name
name
AP zone name
template
Creates a AP zone from the template

name
Name of the zone template

nameclone name
name
AP zone name
clone
Creates a clone AP zone from an existing AP zone

name
Name of the zone template

nameap-firmware ap-firmware
name
AP zone name
ap-firmware
Changes the AP firmware

ap-firmware
Version of the AP firmware
namecluster-switch-over name
name
AP zone name
cluster-switch-over
Enables the cluster switchover

name
Cluster redundancy name

nametemplate-apply name
name
AP zone name

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

237

Configuration Commands S - W
zone

template-apply
Apply the zone template

name
Zone template name

nametrigger-prefer-node
name
AP zone name
trigger-prefer-node
Apply the trigger preference for the node

Default
This command has no default settings.

Command Mode
Config

Example
ruckus(config)# zone indus3-ap3

Related Commands
The following table lists the related zone configuration commands.
TABLE 61 Commands related to ruckus(config-zone)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone)# aaa
Type: Privileged



Creates or updates the AAA server
configuration.

ruckus(config-zone)# adj-threshold
Type: Privileged

2.4g ${value}
5g ${value}

Sets the adjacent radio threshold of the client
load balancing.

Value minimum = 1 and
maximum = 100

238

ruckus(config-zone)# ap-firmware
Type: Privileged



Sets the AP firmware version.

ruckus(config-zone)# ap-group
Type: Privileged



Creates or updates the AP group
configuration.

ruckus(config-zone)# ap-ip-mode
Type: Privileged

[ ipv4 | ipv6 | dual]

Sets the AP IP mode to either IPv4 or IPv6
version.

ruckus(config-zone)# ap-logon
Type: Privileged



Sets the login ID for the AP administrator.

ruckus(config-zone)# ap-mgmt-vlan
Type: Privileged

: VLAN Tag (1-4094); enter 'keep'
to keep APs setting

Sets AP management VLAN.

ruckus(config-zone)# ap-model
Type: Privileged



Sets the AP model name.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 61 Commands related to ruckus(config-zone) (continued)
Syntax and Type

Parameters (if any)

ruckus(config-zone)# ap-password
Type: Privileged
ruckus(config-zone)# ap-re boot-timeout
Type: Privileged

Description
Sets the password for the AP administrator.

default-gateway [  ]
default-gateway: Sets the default gateway
timeout in hours and minutes.

Sets the AP reboot timeout.

control-interface  Sets the control
interface timeout in hours.
ruckus(config-zone)# ap-registration-rule
Type: Privileged



Creates or updates the AP registration rule
configuration.

ruckus(config-zone)# ap-snmp-options
Type: Privileged

Sets the AP SNMP options.

ruckus(config-zone)# background-scan
Type: Privileged

2.4g 
5g 

Sets the background scanning.

ruckus(config-zone)# band-balancing
Type: Privileged

2.4g  2.4g
2.4G band

Sets the band balance.

: Percentage of clients on 2.4G band
ruckus(config-zone)# block-client
Type: Privileged



Sets to block the client by specifying the MAC
address.

ruckus(config-zone)# bonjour-fencing
Type: Privileged

: Bonjour fencing policy name to
apply

Enables bonjour fencing policy.

ruckus(config-zone)# bonjour-fencing-policy
Type: Privileged

: Bonjour fencing policy name

Creates or updates the bonjour fencing policy.

ruckus(config-zone)# bonjour-gateway
Type: Privileged

Enables the bonjour gateway.

ruckus(config-zone)# bonjour-policy
Type: Privileged



Creates or updates the bonjour policy.

ruckus(config-zone)# channel
Type: Privileged

2.4g 
5g indoor 

Sets the channel.

5g outdoor 
ruckus(config-zone)# channel-evaluationinterval
Type: Privileged
ruckus(config-zone)# channel-range
Type: Privileged

Sets the channel evaluation interval.

•
2.4g [  ]
2.4g: 2.4 GHz radio

Sets the channel range.

: Channels (ex: 1,2,3,4,5 or all)
•

5g indoor [  ]

5g: 5 GHz radio
indoor: indoor
: Channels (ex: 36,40,44 or all)
•

5g outdoor [  ]

5g: 5 GHz radio
outdoor: outdoor
: Channels (ex: 149,153,161
or all)
ruckus(config-zone)# channel-select-mode
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Selects the channel.

239

Configuration Commands S - W
zone

TABLE 61 Commands related to ruckus(config-zone) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone)# channelfly-mtbc
Type: Privileged

•
2.4g 
2.4g: 2.4 GHz radio

Sets MTBC value of ChannelFly.

: MTBC value (Range: 100~1440)
•

5g 

5g: 5 GHz radio
:MTBC value (Range: 100~1440)
ruckus(config-zone)# channelization
Type: Privileged

2.4g [ 20 | 40 ] 5g [ 40 | 20 ]

Sets the channelization.

ruckus(config-zone)# client-admission-control
Type: Privileged

2.4g
5g

Enables the client admission control.

2.4g minClientCount 
2.4g maxRadioLoad 
2.4g minClientThroughput

5g minClientCount 
5g maxRadioLoad 
5g minClientThroughput

ruckus(config-zone)# client-isolation-whitelist
Type: Privileged

: Client isolation whitelist name

Creates or updates the client isolation
whitelist.

ruckus(config-zone)# country-code
Type: Privileged



Sets the country code.

ruckus(config-zone)# description
Type: Privileged



Sets the description,

ruckus(config-zone)# device-policy
Type: Privileged



Sets the device policy.

ruckus(config-zone)# dfs-channel
Type: Privileged
ruckus(config-zone)# diffserv
Type: Privileged

Sets the DFS channels for the US country
code.


Creates or updates the diff server profile.

ruckus(config-zone)# do
Type: Privileged
ruckus(config-zone)# dos-protection
Type: Privileged

Executes the do command.
: DoS protection period
: DoS protection
threshold

Enables DoS (Denial-of-service) protection.

: DoS protection
checkperiod

240

ruckus(config-zone)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXEC mode.

ruckus(config-zone)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone)# ethernet-port-profile
Type: Privileged

: Ethernet Port Profile name

Sets the Ethernet Port profile.

ruckus(config-zone)# gps
Type: Privileged

 

Sets the GPS coordinates.

ruckus(config-zone)# gps-altitude

 [ floor | meters ]

Sets the GPS altitude.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 61 Commands related to ruckus(config-zone) (continued)
Syntax and Type

Parameters (if any)

Type: Privileged

altitude value

Description

floor
meters
ruckus(config-zone)# guest-access
Type: Privileged



ruckus(config-zone)# help
Type: Privileged
ruckus(config-zone)# headroom

Sets the guest access.
Displays the help.

2.4g 
5g 
2.4g: 2.4 GHz radio

Sets the headroom (# of clients) of client load
balancing.
You need to access the load-balancing submenu first for this command to work.

5g: 5 GHz radio
: Number of clients
ruckus(config-zone)# hotspot
Type: Privileged



Creates or updates the hotspot (WISPr)
configuration.

ruckus(config-zone)# hotspot20-venue-profile
Type: Privileged



Creates or updates the venue profilefor
hotspot release 2 configuration.

ruckus(config-zone)# hotspot20-wlan-profile
Type: Privileged



Creates or updates the WLAN profilefor
hotspot release 2 configuration.

ruckus(config-zone)# indoor-channel
Type: Privileged

Enables the indoor channels.

ruckus(config-zone)# ipsec-tunnel-profile
Type: Privileged

$

Sets the IPsec Tunnel profile.

ruckus(config-zone)# l2-acl
Type: Privileged



Sets the layer 2 access control list.

ruckus(config-zone)# lbs
Type: Privileged

Enables the location based service.

ruckus(config-zone)# lbs-service
Type: Privileged

Sets the location based service.

ruckus(config-zone)# location Type: Privileged

Sets the location.

ruckus(config-zone)# location-additional-info
Type: Privileged



ruckus(config-zone)# mesh
Type: Privileged

Sets the additional information location.
Enables mesh networking.

ruckus(config-zone)# mesh-name
Type: Privileged



Sets the mesh name (ESSID).

ruckus(config-zone)# mesh-passphrase
Type: Privileged



Sets the mesh passphrase.

ruckus(config-zone)# move Type:
Privileged

domain 

Moves the zone to another domain.

ruckus(config-zone)# name
Type: Privileged



Sets the AP zone name.

ruckus(config-zone)# no
Type: Privileged

aaa 
ap-group 

Disables and deletes command configuration.

ap-registration-rule 
ap-snmp-options background-scan <2.4g>
<5g>

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

241

Configuration Commands S - W
zone

TABLE 61 Commands related to ruckus(config-zone) (continued)
Syntax and Type

Parameters (if any)

Description

band-balancing
block-client
bonjour-fencing
bonjour-fencing-policy
bonjour-gateway
bonjour-policy
channel-select-mode
client-admission-control
client-isolation-whitelist
description
device-policy
diffserv
dos-protection
dfs-channel
ethernet-port-profile
gps
gps-altitude
guest-access
hotspot 
hotspot20-venue-profile 
hotspot20-wlan-profile 
indoor-channel l2-acl lbs load-balancing
location
location-additional-info
mesh
roam
smart-mon
smart-roam-disconnect-event
syslog-enabled
timezone-dst
venue-code
venue-profile
vlan-overlapping
web-authentication
wechat
wlan 
wlan-group 

242

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 61 Commands related to ruckus(config-zone) (continued)
Syntax and Type

Parameters (if any)

Description

wlan-scheduler 
ruckus(config-ap)# protection-mode

2.4g ${value}

Overrides the protection mode on 2.4 GHz
radio

ruckus(config-zone)# roam
Type: Privileged

2.4g
5g

Sets the smart roam

ruckus(config-zone)# rogue-ap-detection
Type: Privileged

[enable | disable ]: Enables or disables
malicious rogue devices which have same
network
report-all [ disable | enable ]: Sets to report all
rogue devices

Sets the report rogue access point

Type: Privileged

report-only-malicious [ enable | disable ]:
Reports only malicious rogue device type.
report-ssid-spoofing [ disable | enable ]:
Reports only malicious rogue devices of SSID
spoofing.
report-same-network [ enable | disable ]:
Reports only malicious rogue devices of the
same network.
report-mac-spoofing [ disable | enable ]:
Enables or disables malicious rogue devices
which have MAC IP address spoofing
protect-from-malicious [ disable | enable ]:
Enables or disables the network from
malicious rogue access points
ruckus(config-zone)# smart-mon
Type: Privileged

interval 
threshold 

Sets the syslog server IP address.

ruckus(config-zone)# syslog-ip6
Type: Privileged



Sets the IPv6 address for the syslog server.

ruckus(config-zone)# syslog-port
Type: Privileged



Sets the syslog server port.

ruckus(config-zone)# syslog-priority
Type: Privileged

[ Alert | Info | Critical | Warning | Notice |
Emergency | All | Error ]

Sets the syslog server priority.

ruckus(config-zone)# timezone
Type: Privileged

System-Follows the controller time zone
setting
System [  ] Select the time zone
from system database

Sets the timezone for zone.

User-defined [  ] User
defined time zone Time zone
abbreviation(example: GMT,CST, EST)
ruckus(config-zone)# timezone-dst
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

[  ]  
 

Sets the user defined timezone for daylight
savings.

243

Configuration Commands S - W
zone

TABLE 61 Commands related to ruckus(config-zone) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone)# timezone-gmt-offset
Type: Privileged

[ ] For example, 8,-7:45

Sets the user defined timezone for GMT
offset.

ruckus(config-zone)# tunnel-profile Type:
Privileged



Sets the AP GRE tunnel profile.

ruckus(config-zone)# tunnel-type
Type: Privileged

[ gre | gre-udp ]

Sets the tunnel type.

ruckus(config-zone)# tx-power
Type: Privileged

2.4g ${value}
5g ${value}

Sets the TX power adjustment.

Value minimum = 1 and maximum = 100
ruckus(config-zone)# venue-code
Type: Privileged



Sets the venue code.

ruckus(config-zone)# venue-profile
Type: Privileged



Sets the venue profile.

ruckus(config-zone)# vlan-overlapping
Type: Privileged
ruckus(config-zone)# weak-bypass
Type: Privileged

Enables the overlapping of VLAN pooling.
2.4g ${threshold}
5g ${threshold}

Sets the weak bypass threshold of the client
load balancing.

Value minimum = 1 and maximum = 100
ruckus(config-zone)# web-authentication
Type: Privileged



Sets the web authentication.

ruckus(config-zone)# wechat
Type: Privileged

: WeChat name

Creates/updates WeChat configuration.

ruckus(config-zone)# wlan
Type: Privileged



Creates or updates the WLAN configuration.

ruckus(config-zone)# wlan-group
Type: Privileged



Creates or updates the WLAN group
configuration.

ruckus(config-zone)# wlan-scheduler
Type: Privileged



Creates or updates the WLAN scheduler
configuration.

The following table lists the related zone-aaa configuration commands.
TABLE 62 Commands related ruckus(config-zone-aaa)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-aaa)# admin-domain
Type: Privileged

: Admin domain name,
example: admin@domain.ruckuswireless.com

Enables the admin domain name.

ruckus(config-zone-aaa)# admin-domainname
Type: Privileged

: Admin domain name.
To query multiple organizational units, enter an
admin domain name and-password with full
search and read privileges.
(example:uid=admin, dc=ldap, dc=com)

Creates or updates the admin domain.

ruckus(config-zone-aaa)# admin-password
Type: Privileged



Creates or updates the admin password.

ruckus(config-zone-aaa)# backup
Type: Privileged

ip 

Enables backup of RADIUS support and set
related settings.

ipv6 
port 
shared-secret 

ruckus(config-zone-aaa)# base-domain

244



Set the base domain.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 62 Commands related ruckus(config-zone-aaa) (continued)
Syntax and Type

Parameters (if any)

Description



Sets the description.

Type: Privileged
ruckus(config-zone-aaa)# description
Type: Privileged
ruckus(config-zone-aaa)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-aaa)# end
Type: Privileged

Ends the current configuration session and
returns to privileged EXECmode.

ruckus(config-zone-aaa)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-aaa)# global-catalog
Type: Privileged

Enables the global catalog support.

ruckus(config-zone-aaa)# help
Type: Privileged

Displays the help.

ruckus(config-zone-aaa)# ip
Type: Privileged



Set IP addresses of primary RADIUS server.

ruckus(config-zone-aaa)# ip6
Type: Privileged



Set IPv6 addresses of primary RADIUS server.

ruckus(config-zone-aaa)# key-attribute
Type: Privileged



Sets the key attributes for the primary RADIUS
Server.

ruckus(config-zone-aaa)# no
Type: Privileged

backup global-catalog

Disables or deletes configuration settings.

ruckus(config-zone-aaa)# password
Type: Privileged



Sets the password for the primary RADIUS
server.

ruckus(config-zone-aaa)# port
Type: Privileged



Sets the port number of the primary RADIUS
Server.

ruckus(config-zone-aaa)# search-filter
Type: Privileged



Sets the search filter.

ruckus(config-zone-aaa)# shared-secret
Type: Privileged



Sets the shared secret of the primary RADIUS
Server.

ruckus(config-zone-aaa)# test
Type: Privileged

  [PAP | CHAP]

Tests the connectivity of the AAA server using
protocol settings.

ruckus(config-zone-aaa)# test-acct
Type: Privileged

Tests the accounting server.

ruckus(config-zone-aaa)# type
Type: Privileged

[ radius | radius-acct | LDAP | AD ]

Sets the RADIUS type.

ruckus(config-zone-aaa)# windows-domain
Type: Privileged



Sets the windows domain name.

The following table lists the related zone-ap-group configuration commands.
TABLE 63 Commands related to ruckus(config-zone-ap-group)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-group)# ani-ofdm-level
Type: Privileged

: AP model name

Sets the AP adaptive noise immunity level for
specific AP model.

ruckus(config-zone-ap-group)# ap-snmpoptions
Type: Privileged
ruckus(config-zone-ap-group)# channel

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Enables AP SNMP options.

2.4g ${value}

Sets the channel.

245

Configuration Commands S - W
zone

TABLE 63 Commands related to ruckus(config-zone-ap-group) (continued)
Syntax and Type

Parameters (if any)

Type: Privileged

5g indoor ${value}

Description

5g outdoor ${value}
ruckus(config-zone-ap-group)# channelevaluation-interval
Type: Privileged

 The interval value (Range:
60~3600 secs)

Sets the channel evaluation interval.

ruckus(config-zone-ap-group)# channel-range
Type: Privileged

•
2.4g [  ]
2.4g: 2.4 GHz radio
: Channels (ex: 1,2,3,4,5 or all)

Sets the channel range.

•

5g indoor [  ]

5g: 5 GHz radio
indoor:indoor
: Channels (ex: 36,40,44 or all)
•

5g outdoor [  ]

5g: 5 GHz radio
outdoor: outdoor
: Channels (ex: 149,153,161
or all)
ruckus(config-zone-ap-group)# channelselect-mode
Type: Privileged
ruckus(config-zone-ap-group)# channelflymtbc Type: Privileged

Selects the channel.

Sets MTBC value of ChannelFly.

•
2.4g 
2.4g: 2.4 GHz radio
:MTBC value (Range: 100~1440)
•
5g 
5g: 5 GHz radio
:MTBC value (Range: 100~1440)

ruckus(config-zone-ap-group)# channelization
Type: Privileged

2.4g [ 20 | 40 ] 5g [ 40 | 20 ]

Sets the channelization.

ruckus(config-zone-ap-group)# clientadmission-control

2.4g

Enables the client admission control.

Type: Privileged

5g
2.4g minClientCount

Min Client Count (Default: 10)
2.4g maxRadioLoad

Max Radio Load (Default: 75%)
2.4gminClientThroughput
:
Min Client Throughput (Default: 0.0Mbps)
5g minClientCount

Min Client Count (Default: 20)

246

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 63 Commands related to ruckus(config-zone-ap-group) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-group)# clientadmission-control
Type: Privileged

5g maxRadioLoad 
Max Radio Load(Default:75%) 5g
minClientThroughput 

Enables the client admission control.

Min Client Throughput(Default: 0.0Mbps)
ruckus(config-zone-ap-group)# description
Type: Privileged



Sets the description.

ruckus(config-zone-ap-group)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-ap-group)# end
Type: Privileged

Ends the current configuration session and
returns to privileged EXEC mode.

ruckus(config-zone-ap-group)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-ap-group)# externalantenna
Type: Privileged

 5g [ disable | enable ]
 5g gain 

Sets the external antenna for specific AP
model.

 2.4g gain 
 2.4g [ enable | disable ]
 gain 
 [ disable | enable ]
 2.4g [ 3-antennas | 2-antennas ]
 5g [ 3-antennas | 2-antennas ]

ruckus(config-zone-ap-group)# gps
Type: Privileged

 

Sets GPS coordinates.

ruckus(config-zone-ap-group)# gps-altitude
Type: Privileged

 [ floor | meters ]

Sets the GPS altitude.

ruckus(config-zone-ap-group)# help
Type: Privileged
ruckus(config-zone-ap-group)# internal-heater
Type: Privileged

Displays the help.
 [ enable | disable ]

Sets the internal heater for specific AP model.

ruckus(config-zone-ap-group)# lbs
Type: Privileged

Enables the location based service.

ruckus(config-zone-ap-group)# lbs-service
Type: Privileged

Sets the location based service.

ruckus(config-zone-ap-group)# led-mode
Type: Privileged



Sets the LED mode for specific AP model.

ruckus(config-zone-ap-group)# lldp
Type: Privileged

 [ enable | disable ]

Sets the LLDP for a specific AP model.

ruckus(config-zone-ap-group)# location
Type: Privileged

Sets the location.

ruckus(config-zone-ap-group)# locationadditional-info
Type: Privileged



Sets the additional information location.

ruckus(config-zone-ap-group)# member
Type: Privileged

add 
move-to  

Sets the AP group member. It adds a new
access point to current AP group.
The AP Mac address removes the access
point from the current AP group and moves it
to other AP group.

remove 
ruckus(config-zone-ap-group)# no Type:
Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

ani-ofdm-level

Disables / deletes the configuration settings.

247

Configuration Commands S - W
zone

TABLE 63 Commands related to ruckus(config-zone-ap-group) (continued)
Syntax and Type

Parameters (if any)

Description

channel 2.4g
channel 5g indoor
channel 5g outdoor
channel-evaluation-interval
channel-range channel-select-mode
client-admission-control
channelization 2.4g
channelization 5g
client-admission-control description
external-antenna  5g
external-antenna  2.4g
gps
gps-altitude
internal heater
lbs
led-mode
lldp
location
location-additional-info
override-ap-mgmt-vlan
override-ap-snmp-options
override-channel-select-mode
override-client-admission-control
override-lbs
override-venue-code
override-zone-location
override-zone-location-additional-info
poe-operating-mode
poe-out
protection-mode <2.4g>
radio-band
secondary-channel
status-leds
tx-power 2.4g
tx-power 5g
usb-port
usb-software

248

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 63 Commands related to ruckus(config-zone-ap-group) (continued)
Syntax and Type

Parameters (if any)

Description

venue-profile
wlan-group 2.4g
wlan-group 5g
ruckus(config-zone-ap-group)#override-apmgmt-vlan
Type: Privileged

 : VLAN tag

ruckus(config-zone-ap-group)#override-apsnmp-options
Type: Privileged

Overrides the AP Management VLAN.

Overrides the AP SNMP options.

ruckus(config-zone-ap-group)# overridechannel-select-mode
Type: Privileged

2.4g
5g

overrides auto channel selection mode and
ChannelFly MTBC.

ruckus(config-zone-ap-group)# overrideclient-admission-control
Type: Privileged

2.4g
5g

Overrides the client admission control
settings.

ruckus(config-zone-ap-group)#override-lbs
Type: Privileged

Overrides the location based service to zone
settings.

ruckus(config-zone-ap-group)#overridevenue-code
Type: Privileged

Overrides the venue code.

ruckus(config-zone-ap-group)#override-zonelocation
Type: Privileged

Overrides the zone location setting.

ruckus(config-zone-ap-group)# override-zonelocation-additional-info
Type: Privileged

Overrides the zone location additional
information setting

ruckus(config-zone-ap-group)# poeoperating-mode
Type: Privileged

: AP model name

Switch the PoE Operating Mode for a specific
AP model.

ruckus(config-zone-ap-group)# poe-out
Type: Privileged

 [ enable | disable ]

Sets the PoE out port for a specific AP model.

ruckus(config-zone-ap-group)# port-setting
Type: Privileged



Sets the port settings for specific AP model.

ruckus(config-zone-ap-group)# protectionmode

2.4g ${value}

Overrides the protection mode on 2.4 GHz
radio

ruckus(config-zone-ap-group)# radio-b an d
Type:
Privileged

 [ 2.4g | 5g ]

Switches the radio band for a specific AP
model.

ruckus(config-zone-ap-group)# secondarychannel
Type: Privileged

5g indoor [  ]
5g outdoor [  ]

Sets the secondary channel.

ruckus(config-zone-ap-group)# status-leds
Type: Privileged

 [ enable | disable ]

Sets the status LED for specific AP model.

ruckus(config-zone-ap-group)# tx-power
Type: Privileged

2.4g ${value}
5g ${value}

Sets the TX power adjustment.

ruckus(config-zone-ap-group)# usb-port
Type: Privileged

 [ enable | disable ]

Enables USB port.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

249

Configuration Commands S - W
zone

TABLE 63 Commands related to ruckus(config-zone-ap-group) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-group)# usb-soft ware
Type: Privileged

 

Sets the AP USB software package for a
specific AP model.

ruckus(config-zone-ap-group)# venue-code
Type: Privileged

Sets the venue code.

ruckus(config-zone-ap-group)# venue-pr o file
Type: Privileged



Sets the venue profile

ruckus(config-zone-ap-group)# wlan-group
Type: Privileged

2.4g
5g

Sets the WLAN group configurations.

The following table lists the related zone-ap-group-lldp configuration commands.
TABLE 64 Commands related to ruckus(config-zone-ap-group-lldp) configuration
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-group-lldp)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-ap-group-lldp)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXECmode.

ruckus(config-zone-ap-group-lldp)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-ap-group-ll dp)# help
Type: Privileged

Displays the help.

ruckus(config-zone-ap-group-lldp) # ll dp-adinter val
Type: Privileged



Sets the LLDP advertise interval in seconds
from the range 1 to 300.

ruckus(config-zone-ap-group-lld p )# lldphold-time
Type: Privileged



Sets the LLDP hold time in seconds from the
range 60 to 1200.

ruckus(config-zone-ap-group-lldp)# ll dpmgmt
Type: Privileged

Enables the LLDP management IP TL V .

The following table lists the related zone-ap-group-snmp-options configuration commands.
TABLE 65 Commands related to ruckus (zone-ap-group-ap-snmp-options) configuration
Syntax and Type

Parameters (if any)

ruckus(config-zone-ap-group-ap-snmpoptions )# ap-snmp
Type: Privileged
ruckus(config-zone-ap-group-ap-snmpoptions )# no
Type: Privileged

Description
Enables AP SNMP.

snmp-v2-community snmp-v3-u ser

Disables and deletes commands.

ruckus(config-zone-ap-group-ap-snmpoptions )# snmp-v2-community
Type: Privileged

Adds or update AP SNMPv2 community.

ruckus(config-zone-ap-group-ap-snmpoptions )# snmp-v3-user
Type: Privileged

Adds or updates AP SNMPv3 users.

The following table lists the related zone-ap-group-port-setting configuration commands.

250

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 66 Commands related to ruckus(config-zone-ap-group-port-setting)
Syntax and Type

Parameters (if any)

ruckus(config-zone-ap-group-port-setting)#
do
Type: Privileged
ruckus(config-zone-ap-group-port-setting)#
dot1x
Type: Privileged

Description
Executes the do command.

authsvr [  ]
accsvr 

Sets the 802.1x role

mac-auth-bypass [ true | false ]
supplicant user-name [ password  supplicant mac

ruckus(config-zone-ap-group-port-setting)#
end
Type: Privileged

Ends the current configuration session and
return to privilegedEXEC mode.

ruckus(config-zone-ap-group-port-setting)#
exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-ap-group-port-setting)#
help
Type: Privileged

Displays the help.

ruckus(config-zone-ap-group-port-setting)#
lan
Type: Privileged


 uplink [ general | access | trunk ]

Enables or disables specific port.

 untag   memb er 
 dot1x [ auth-mac-based | disabled |
auth-port-based | supplicant ]

ruckus(config-zone-ap-group-port-setting)#
no
Type: Privileged

dot1x acc svr
lan 

Disables or deletes the configuration settings.

The following table lists the commands related zone-ap-model configuration commands.
TABLE 67 Commands related to ruckus(config-zone-ap-model) configuration commands
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-model)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-ap-model)# end
Type: Privileged

Ends the current configuration session and
return to privileged EXEC mode.

ruckus(config-zone-ap-model)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-ap-model)# ext-ant
Type: Privileged

2.4g 
2.4gg  [ 3 | 2 ] 5g 

Sets the external antenna.

5gg  [ 2 | 3 ]
ruckus(config-zone-ap-model)# help
Type: Privileged

Displays the help.

ruckus(config-zone-ap-model)# internalheater
Type: Privileged

Enables international heater.

ruckus(config-zone-ap-model)# lan1
ruckus(config-zone-ap-model)# lan2

Sets the LAN configurations from 1 to 5.

ruckus(config-zone-ap-model)# lan3

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

251

Configuration Commands S - W
zone

TABLE 67 Commands related to ruckus(config-zone-ap-model) configuration commands (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-model)# lan4
ruckus(config-zone-ap-model)# lan5
Type: Privileged
ruckus(config-zone-ap-model)# led
Type: Privileged

Enables the status of led.

ruckus(config-zone-ap-model)# led-mode
Type: Privileged

Sets the led mode description

ruckus(config-zone-ap-model)# lldp
Type: Privileged

Enables the LinkLayer Discovery
Protocol(LLDP).

ruckus(config-zone-ap-model)# lldp-adinterval
Type: Privileged



Sets the LLDP advertise interval.

ruckus(config-zone-ap-model)# lld p-holdtime
Type: Privileged



Sets the LLDP hold time.

ruckus(config-zone-ap-model)# ll dp-mgmt
Type: Privileged
ruckus(config-zone-ap-model)# no Type:
Privileged

Enables the LLDP management IP TL V .
Disables or deletes the settings that have
been configured.

ext-ant
internal-heater
lan1
lan2
lan3
lan4
lan5
led
lldp
lldp-mgmt
poe-out-port
radio-band
usb
usb-software

ruckus(config-zone-ap-model)# poeoperating-mode
Type: Privileged

${value}

Switch PoE mode.

ruckus(config-zone-ap-model)# poe-out-port
Type: Privileged

Enables the PoE out port

ruckus(config-zone-ap-model)# radio-b an d
Type: Privileged

${value}

Switches the radio band.

ruckus(config-zone-ap-model)# usb
Type: Privileged

 [ enable | disable]

Sets the USB port for a specific AP model.

ruckus(config-zone-ap-model)# usb-soft ware
Type: Privileged

 [ enable | disable]

Sets the AP USB software package.

The following table lists the related zone-ap-model-lan1 configuration commands.

252

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 68 Commands related to ruckus(config-zone-ap-model-lan1)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-model-lan1)# 8021x
Type: Privileged

<8021x-type >

Sets the 802.1x.

ruckus(config-zone-ap-model-lan1)# acctservice
Type: Privileged



Sets the accounting service configurations.

ruckus(config-zone-ap-model-lan1)# authservice
Type: Privileged



Sets the authentication service configurations.

ruckus(config-zone-ap-model-lan1)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-ap-model-lan1)# end
Type: Privileged

Ends the current configuration session and
returns to privilegedEXECmode.

ruckus(config-zone-ap-model-lan1) # exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-ap-model-lan1)# help
Type: Privileged

Displays the help.

ruckus(config-zone-ap-model-lan1)# macbypass
Type: Privileged

Sets the MAC authentication bypass.

ruckus(config-zone-ap-model-lan1)#
members
Type: Privileged



Sets the members.

ruckus(config-zone-ap-model-lan1)# no
Type: Privileged

acct-service mac-bypass

Disables or deletes the settings that have
been configured.

ruckus(config-zone-ap-model-lan1)# profile
Type: Privileged

: Ethernet port profile.

Sets the Ethernet port profile.

ruckus(config-zone-ap-model-lan1) #
supplicant
Type: Privileged

mac custom  

Sets the supplicant.

ruckus(config-zone-ap-model-lan1)# type
Type: Privileged

[ trunk-port | access-port | general-port ]

Sets the port type.

ruckus(config-zone-ap-model-lan1)# vlanuntag-id
Type: Privileged



Sets the VLAN untag ID.

The following table lists the related zone-ap-registration-rule configuration commands.
TABLE 69 Commands related to ruckus(config-zone-ap-registration-rule)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-registrationrule)#description
Type: Privileged



Sets the description.

ruckus(config-zone-ap-registration-rule)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-ap-registration-rule)# end
Type: Privileged

Ends the current configuration session and
returns to privilegedEXEC mode.

ruckus(config-zone-ap-registration-rule)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-ap-registration-rule)# gps
Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

  

Sets the GPS coordinates.

253

Configuration Commands S - W
zone

TABLE 69 Commands related to ruckus(config-zone-ap-registration-rule) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ap-registration-rule)# help
Type: Privileged

Displays the help.

ruckus(config-zone-ap-registration-rule)#iprange
Type: Privileged

 

Sets the IP address range from and to IP
address.

ruckus(config-zone-ap-registrationrule)#provision-tag
Type: Privileged



Sets the provision tags.

ruckus(config-zone-ap-registrationrule)#subnet
Type: Privileged

 

Sets the subnet IP address and subnet mask.

ruckus(config-zone-ap-registration-rule)# type
Type: Privileged

[ gps | provision-tag | ip-range | subnet ]

Sets the rule type.

The following table lists the related zone-ap-snmp-options configuration commands.
TABLE 70 Commands related to ruckus(config-zone-ap-snmp-options configuration)
Syntax and Type

Parameters (if any)

Description

ruckus( config-zone-ap-snmp-options )# apsnmp
Type: Privileged
ruckus( config-zone-ap-snmp-options )# no
Type: Privileged

Enables AP SNMP.

ap-snmp
snmp-v2-community 

Disables the settings that have been
configured with these commands.

snmp-v3-user 
ruckus( config-zone-ap-snmp-options )#
snmp-v2-community
Type: Privileged



Adds or updates the AP SNMPv2 community.

ruckus( config-zone-ap-snmp-options) #
snmp-v3-user
Type: Privileged



Adds or updates the AP SNMPv3 user.

The following table lists the related zone-ap-snmp-options-snmp-v2-community configuration commands.
TABLE 71 Commands related to ruckus(config-zone-ap-snmp-options-snmp-v2-community configuration)

254

Syntax and Type

Parameters (if any)

Description

ruckus( config-zone-ap-snmp-options-snmpv2-community )# no
Type: Privileged

snmp-v2-community  snmp-v3-user


Disables the settings that have been
configured with these commands.

ruckus( config-zone-ap-snmp-options-snmpv2-community )# read
Type: Privileged

Enable the read privilege.

ruckus( config-zone-ap-snmp-options-snmpv2-community)# write
Type: Privileged

Enable the write privilege.

ruckus( config-zone-ap-snmp-options-snmpv2-community)# notification
Type: Privileged

Enable notification privilege.

ruckus( config-zone-ap-snmp-options-snmpv2-community)# notification-target

Enables notification target configuration
commands.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 71 Commands related to ruckus(config-zone-ap-snmp-options-snmp-v2-community configuration) (continued)
Syntax and Type

Parameters (if any)

Description

Type: Privileged
ruckus( config-zone-ap-snmp-options-snmpv2-community)# notification-type
Type: Privileged

Sets the notification type.

The following table lists the related config-zone-ap-snmp-options-snmp-v3-user configu-ration commands.
TABLE 72 Commands related to ruckus(config-zone-ap-snmp-options-snmp-v3-user configuration)
Syntax and Type

Parameters (if any)

ruckus( config-zone-ap-snmp-options-snmpv3-user )# auth
Type: Privileged
ruckus( config-zone-ap-snmp-options-snmpv3-user )# no
Type: Privileged

Description
Sets SNMPv3 user authentication.

snmp-v3-user 

Disables the settings that have been
configured with these commands.

ruckus( config-zone-ap-snmp-options-snmpv3-user )# read
Type: Privileged

Enable the readprivilege.

ruckus( config-zone-ap-snmp-options-snmpv3-user )# write
Type: Privileged

Enable the writeprivilege.

ruckus( config-zone-ap-snmp-op ti onssnmp-v3-user)# notification
Type: Privileged

Enable notification privilege.

The following table lists the related zone-block-client configuration commands.
TABLE 73 Commands related to ruckus(config-zone-block-client)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-block-client)# description
Type: Privileged



Sets the description.

The following table lists the related zone-bonjour-fencing-policy configuration commands.
TABLE 74 Commands related to ruckus(config-zone-bonjour-fencing-policy)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-bonjour-fencing-policy)#
description
Type: Privileged



Sets the description.

ruckus(config-zone-bonjour-fencing-policy)#
no
Type: Privileged

description
rule 

Sets to delete sub commands.

ruckus(config-zone-bonjour-fencing-policy)#
rule
Type: Privileged

-rule index

Sets the bonjour fencing rule.

The following table lists the related zone-bonjour-policy configuration commands.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

255

Configuration Commands S - W
zone

TABLE 75 Commands related to ruckus(config-zone-bonjour-policy)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-bonjour-policy)#
description
Type: Privileged



Sets the description.

ruckus(config-zone-bonjour-policy)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-bonjour-policy)# end
Type: Privileged

Ends the current configuration session and
returns to privilegedEXECmode.

ruckus(config-zone-bonjour-policy)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-bonjour-policy)# help
Type: Privileged

Displays the help.

ruckus(config-zone-bonjour-policy)# name
Type: Privileged



Sets the bonjour policy name.

ruckus(config-zone-bonjour-policy)# no rule
Type: Privileged



Deletes the rules based on the rule priority.

ruckus(config-zone-bonjour-policy)# rule
Type: Privileged



Sets the bonjour policy set of rules based on
the rule priority.

The following table lists the related zone-bonjour-policy-rule configuration commands.
TABLE 76 Commands related to ruckus(config-zone-bonjour-policy-rule)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-bonjour-policy-rule)#
bridge-service
Type: Privileged

airdisk

Sets the bridge service.

airplay
airport-management
airprint
airtunes
apple-file-sharing
apple-mobile-devices
(Allows sync with iTunesover Wi-Fi)
appletv
icloud-sync
itunes-remote
itunes-sharing
open-directory-master
optical-disk-sharing
other
screen-sharing
secure-file-sharing
secure-shell
workgroup-manager
www-http

256

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 76 Commands related to ruckus(config-zone-bonjour-policy-rule) (continued)
Syntax and Type

Parameters (if any)

Description

www-https
xgrid
ruckus(config-zone-bonjour-policy-rule)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-bonjour-policy-rule) # end
Type: Privileged

Ends the current configuration session and
returns to privilegedEXECmode.

ruckus(config-zone-bonjour-policy-rule) # exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-bonjour-policy-rule)# fromvlan
Type: Privileged

< int>

ruckus(config-zone-bonjour-policy-rule) # help
Type: Privileged
ruckus(config-zone-bonjour-policy-rule)#
notes
Type: Privileged

Exits from the EXEC.


ruckus(config-zone-bonjour-policy-rule)#
protocol
Type: Privileged
ruckus(config-zone-bonjour-policy-rule)# tovlan
Type: Privileged

Sets the from VLAN.

Sets the notes.

Sets the bridge service when it is 'other'.

< int>

Sets the VLAN.

GUID-4E95B98D-6847-493D-A307-3DBE78DE4D65#GUID-4E95B98D-6847-493D-A307-3DBE78DE4D65/ID-7405-00005EE4
lists the related zone-bonjour-fencing-policy-rule configuration commands.
TABLE 77 Commands related to ruckus(config-zone-bonjour-fencing-policy-rule)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-bonjour-fencing-policy-rule)#
closest-ap



Sets the configuration to the closest AP.



Sets the description.

${value}

Lists the devices, which use MAC address.

Type: Privileged
ruckus(config-zone-bonjour-fencing-policy-rule)#
description
Type: Privileged
ruckus(config-zone-bonjour-fencing-policy-rule)#
device-mac-list
Type: Privileged
ruckus(config-zone-bonjour-fencing-policy-rule)#
device-type

Sets the device type.

Type: Privileged
ruckus(config-zone-bonjour-fencing-policy-rule)#
fence-range

Sets the fence range.

Type: Privileged
ruckus(config-zone-bonjour-fencing-policy-rule)#
no

device-mac-list

Disables the configuration.

Type: Privileged

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

257

Configuration Commands S - W
zone

TABLE 77 Commands related to ruckus(config-zone-bonjour-fencing-policy-rule) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-bonjour-fencing-policy-rule)#
service-type

Sets the service type.

Type: Privileged

The following table lists the related zone-client-isolation-whitelist configuration commands.
TABLE 78 Commands related to ruckus(config-zone-client-isolation-whitelist)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-client-isolation-whitelist)#
auto
Type: Privileged

Enables the auto whitelist. Each entry must
have an IP address in order to enable auto
whitelist.

ruckus(config-zone-client-isolation-whitelist)#
description
Type: Privileged



Sets the description.

ruckus(config-zone-client-isolation-whitelist)#
entry
Type: Privileged

-entry index

Sets the client isolation entry.

ruckus(config-zone-bonjour-policy-rule)# no
Type: Privileged

auto
description

Sets to delete sub command

entry

The following table lists the related zone-device-policy configuration commands.
TABLE 79 Commands related to ruckus(config-zone-device-policy)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-device-policy)# defaultaction
Type: Privileged

[ allow | block ]

Sets the default action to either allow or block.

ruckus(config-zone-device-policy)#
description
Type: Privileged



Sets the description.

ruckus(config-zone-device-policy)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-device-policy)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-device-policy)# end
Type: Privileged

Ends the current configuration session and
returns to privileged EXEC mode.

ruckus(config-zone-device-policy)# help
Type: Privileged

Displays the help.

ruckus(config-zone-device-policy# no policyrule
Type: Privileged
ruckus(config-zone-device-policy)# policy-rule
Type: Privileged

[  ]

Deletes the device policy rules.

Sets the device policy.

The following table lists the related zone-device-policy-policy-rule configuration commands.

258

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 80 . Commands related to ruckus (config-zone-device-policy-policy rule)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-device-policy-policy-rule)
# action
Type: Privileged

[ allow | block ]

Sets the default action to either allow or block.

ruckus(config-zone-device-policy-policy-rule)
# description
Type: Privileged



Sets the description.

ruckus(config-zone-device-policy-policy-rule)#
downlink
Type: Privileged

[  ] Rate limiting (mbps)

Sets the downlink rate limiting.

ruckus(config-zone-device-policy-policy-rule)#
no vlan
Type: Privileged

Resets the VLAN number.

ruckus(config-zone-device-policy-policy-rule)
# type
Type: Privileged

[  ]

Sets the device type.

ruckus(config-zone-device-policy-policy-rule)#
uplink
Type: Privileged

[  ] Rate limiting (mbps)

Sets the uplink rate limiting.

ruckus(config-zone-device-policy-policy-rule)
# vlan
Type: Privileged

[  ]]

Sets the VLAN number.

The following table lists the related zone-diffserv configuration commands.
TABLE 81 Commands related to ruckus(config-zone-diffserv)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-dif fserv)# description
Type: Privileged



Sets the description.

ruckus(config-zone-dif fserv)# do
Type: Privileged
ruckus(config-zone-dif fserv)# downlink-dif
fserv
Type: Privileged

Executes the do command.


Enables the tunnel diffserv downlink and sets
the diffserv number.

ruckus(config-zone-dif fserv)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-dif fserv)# end
Type: Privileged

Ends the current configuration session and
returns to the privileged EXEC mode.

ruckus(config-zone-dif fserv)# help
Type: Privileged

Displays the help.

ruckus(config-zone-dif fserv)# no
Type: Privileged

description

Disables various options.

downlink-diffserv
preserved-diffserv
uplink-diffserv

ruckus(config-zone-dif fserv)# preserveddiffserv
Type: Privileged



Adds the preserved diffserv number .

ruckus(config-zone-diffserv)# uplink-diffserv
Type: Privileged



Enables the tunnel diffserv uplink and sets the
diffserv number.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

259

Configuration Commands S - W
zone

The following table lists the related zone-ethernet-port-profile configuration commands.
TABLE 82 Commands related to ruckus(config-zone-ethernet-port-profile)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ethernet-port-profile)#
8021x
Type: Privileged

Sets 802.1x.

ruckus(config-zone-ethernet-port-profile)#
8021x-enable

Enable 802.1x

Type: Privileged
ruckus(config-zone-ethernet-port-profile) #
acct-service
Type: Privileged



Accounting service.

ruckus(config-zone-ethernet-port-profile) #
auth-service
Type: Privileged



Authentication service.

ruckus(config-zone-ethernet-port-profile)#
client-visibility

Enables client visibility regardless of 802.1X
authentication

Type: Privileged
ruckus(config-zone-ethernet-port-profile) #
dvlan Type:
Type: Privileged
ruckus(config-zone-ethernet-port-profile )#
guest-vlan
Type: Privileged

Enable dynamic VLAN



Guest VLAN

ruckus(config-zone-ethernet-port-profile) #
mac-bypass
Type: Privileged
ruckus(config-zone-ethernet-port-profile) # no
Type: Privileged

Enable MAC authentication bypass

8021x-enable

Disables the various options.

acct-service
client-visibility
dvla
n
mac-bypass
proxy-acct
proxy-auth
tunnel

ruckus(config-zone-ethernet-port-profile) #
proxy-acct
Type: Privileged

Enables Proxy Accounting service.

ruckus(config-zone-ethernet-port-profile)#
proxy-auth
Type: Privileged

Enables Proxy Authentication service.

ruckus(config-zone-ethernet-port-profile) #
supplicant
Type: Privileged
ruckus(config-zone-ethernet-port-profile)#
tunnel
Type: Privileged

260

Set the supplicant.

•

mac

•

custom 
Enable tunnel

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 82 Commands related to ruckus(config-zone-ethernet-port-profile) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-ethernet-port-profile) #
type
Type: Privileged

Set port type

ruckus(config-zone-ethernet-port-profile) #
vlan-members
Type: Privileged

Describe VLAN members.

ruckus(config-zone-ethernet-port-profile) #
vlan-untag-id
Type: Privileged



Set the VLAN untag ID.

The following table lists the related guest-access configuration commands.
TABLE 83 Commands related to ruckus (config-guest-access)
Syntax and Type

Parameters (if any)

Description

ruckus(config-domain-guest-access)#
description
Type: Privileged



Sets the description.

ruckus(config-domain-guest-access)# do
Type: Privileged

Executes the do command.

ruckus(config-domain-guest-access)# enableterms-and-conditions
Type: Privileged

Enables the web portal terms and conditions.

ruckus(config-domain-guest-access)# end
Type: Privileged

Ends the current configuration session and
returns to privileged EXEC mode.

ruckus(config-domain-guest-access)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-domain-guest-access)# graceperiod
Type: Privileged



Sets the grace period.

ruckus(config-domain-guest-access)# help
Type: Privileged

Displays the help.

ruckus(config-domain-guest-access)#
language
Type: Privileged

Sets the language.

ruckus(config-domain-guest-access)# logo
Type: Privileged

 format: ftp://
:@/

Sets the logo by setting the FTP URL.

ruckus(config-domain-guest-access)# name
Type: Privileged



Sets the guess access service name.

ruckus(config-domain-guest-access)# no
Type: Privileged

enable-terms-andconditions

Disables the web portal terms and conditions.

ruckus(config-domain-guest-access)#
session-timeout
Type: Privileged



Sets the session timeout as per the specified
minutes.

ruckus(config-domain-guest-access)# smsgateway
Type: Privileged



Sets the guest pass for the SMS gateway.

ruckus(config-domain-guest-access)# startpage Type: Privileged

original redirect

Sets the start page.

sms-gateway
terms-and-condition

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

261

Configuration Commands S - W
zone

TABLE 83 Commands related to ruckus (config-guest-access) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-domain-guest-access)# termsand-conditions
Type: Privileged

Sets the web portal terms and conditions.

ruckus(config-domain-guest-access)# title
Type: Privileged

Sets the title for the web portal.

The following table lists the related zone-hotspot configuration commands.
TABLE 84 Commands related to ruckus(config-zone-hotspot)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-hotspot)# description
Type: Privileged



Sets the description.

ruckus(config-zone-hotspot)# do
Type: Privileged

Executes the do command.

ruckus(config-zone-hotspot)# end
Type: Privileged

Ends the current configuration session and
returns to privileged EXEC mode.

ruckus(config-zone-hotspot)# exit
Type: Privileged

Exits from the EXEC.

ruckus(config-zone-hotspot)# grace-period
Type: Privileged



Sets the EAP-SIMMAP version.

ruckus(config-zone-hotspot)# help
Type: Privileged
ruckus(config-zone-hotspot)# https-redirect
Type: Privileged

Displays the help.


If enabled, the AP tries to redirect the HTTPS
requests to the hotspot portal.

ruckus(config-zone-hotspot)# language
Type: Privileged

Sets the portal language.

ruckus(config-zone-hotspot)# location-id
Type: Privileged



Sets the location ID.

ruckus(config-zone-hotspot)# location-name
Type: Privileged



Sets the location name.

ruckus(config-zone-hotspot)# logo
Type: Privileged



Sets the logo.

ruckus(config-zone-hotspot)# logon-url
Type: Privileged

internal
external  <

Sets the logon model.

logon-url>: Redirects unauthenticated user to
the URL for authentication
ruckus(config-zone-hotspot)# mac-addressformat
Type: Privileged

Sets the MAC address format.

ruckus(config-zone-hotspot)# name
Type: Privileged

Renames the hotspot profile.

ruckus(config-zone-hotspot)# no
Type: Privileged

https-redirect show-terms-conditions walledgarden 

Disables the commands.

ruckus(config-zone-hotspot)# session-timeout
Type: Privileged



Sets the session timeout. Defined in minutes.

ruckus(config-zone-hotspot)# show-termsconditions
Type: Privileged

262

Shows the terms and conditions.

Ruckus Smart Zone 100 and Virtual Smart Zone Essentials Command Reference
Part Number: 800-71567-001 Rev A

Configuration Commands S - W
zone

TABLE 84 Commands related to ruckus(config-zone-hotspot) (continued)
Syntax and Type

Parameters (if any)

Description

ruckus(config-zone-hotspot)# smart-clientsupport
Type: Privileged

enable
none

Sets the smart client support.

ruckus(config-zone-hotspot)# start-page
Type: Privileged

original
redirect

only  Only smart client allowed
with instructions for enabling users to log on
using the smart client application
Sets the start page.

: Redirects to the defined URL
ruckus(config-zone-hotspot)# termsconditions
Type: Privileged



Sets the terms and conditions.

ruckus(config-zone-hotspot)# title
Type: Privileged