Ruckus SmartZone™ 100 Command Line Interface Reference Guide For RuckOS 3.0 SZ Ruck OS V3 0 Cli Rg Rev A 20141203

2015-03-03

User Manual: Ruckus SZ-100 Command Line Interface Reference Guide for RuckOS 3.0

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

DownloadRuckus SmartZone™ 100 Command Line Interface Reference Guide For RuckOS 3.0 SZ-100 Ruck OS Sz-100-v3-0-cli-rg-rev A-20141203
Open PDF In BrowserView PDF
Ruckus Wireless
SmartZone 100

™

™

Command Line Interface Reference Guide for
RuckOS 3.0

Part Number 800-70741-001 Rev A
Published December 2014
www.ruckuswireless.com

Copyright Notice and Proprietary Information
Copyright 2014. Ruckus Wireless, 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 Ruckus Wireless, Inc.
(“Ruckus”), or as expressly provided by under license from Ruckus.

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. RUCKUS AND ITS 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. RUCKUS RESERVES THE RIGHT TO MAKE CHANGES OR
UPDATES TO THE MATERIAL AT ANY TIME.

Limitation of Liability
IN NO EVENT SHALL 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, ZoneFlex, FlexMaster, ZoneDirector, SmartMesh, Channelfly, Smartcell,
Dynamic PSK, and Simply Better Wireless are trademarks of Ruckus Wireless, Inc. in the United States and other
countries. All other product or company names may be trademarks of their respective owners.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

2

Contents

About This Guide
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1

Introduction to the SmartZone Command Line Interface
Overview of the SmartZone Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Accessing the Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
What You Will Need . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Connect the Administrative Computer to SmartZone. . . . . . . . . . . . . . . . . . . . . . . . . 14
Start and Configure the SSH Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Using SSH Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Using Serial Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Log On to CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

2

Configuration Commands
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
config-admin-radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ap-auto-approve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
ap-auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
ap-cert-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
ap-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
ap-heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
ap-portal-cert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
ap-root-ca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
ap-sci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
bonjour-gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
bonjour-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
changepassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
clock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

3

Contents

cluster-ip-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
common-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
device-policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

3

Configuration Commands
encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
event db-persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
event email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
event snmp-trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
event-email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
ftp-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
guest-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
import-zdbackup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ip name-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ip route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
l2-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
license cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
license export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
license import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
license local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
license sync-now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
logging console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
lwapp2scg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
no admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

4

Contents

no admin-radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
no ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
no ap auto-approve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
no ap auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
no ap-cert-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
no ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
no ap-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
no ap-root-ca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
no ap-sci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
no bonjour-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
no bonjour-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
no cls-sess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
no control-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
no data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
no device-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
no dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
no encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
no event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
no ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
no guest-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
no hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
no interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
no ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
no l2-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
no lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
no logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
no non-proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
no proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
no report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
no role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
no snmp-trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
no snmp-v2-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
no snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
no user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
no user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
no user-traffic-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
no web-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
no wlan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
no wlan-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

5

Contents

no wlan-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
non-proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
northbound-authtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
northbound-portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ntp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

4

Configuration Commands
sms-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
smtp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
snmp-trap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
snmp-v2-community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
syslog-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
user-traffic-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
web-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
web-cert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
wlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
wlan-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
wlan-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

5

Debug Commands
debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
ap-subnet-discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
apcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
export log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
no ap-subnet-discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
no screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
no ssslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

6

Contents

screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
sslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

6

Setup Commands
rbddump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

7

Show Commands
show admin-activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
show alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
show ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
show ap-stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
show backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
show backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
show backup-config-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
show backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
show backup-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
show backup-upgrade-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
show client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
show clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
show cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
show cluster-node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
show cluster-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
show control-plane-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
show cpuinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
show dhcp-relay-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
show diskinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
show event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
show internal-subnet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
show ip. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
show license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
show meminfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
show radius-proxy-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
show report-result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
show rogue-aps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

7

Contents

show running-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
show service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
show upgrade-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
show upgrade-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
show version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

8

System Commands
? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
backup config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
backup network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
backup-upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
cluster in-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
copy backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
copy backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
copy backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
copy client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
copy report-result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
copy ftp-url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
delete backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
delete backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
delete backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
delete client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
enable  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
no service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
reload ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
reload now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
remote ap-cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
restore config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

8

Contents

restore local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
restore network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
service restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
service start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
set-factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
shutdown now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Index

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

9

About This Guide
This SmartZone™ (SZ) 100 Command Line Interface Reference Guide contains the
syntaxes and commands for configuring and managing the SmartZone 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: This guide assumes that the SmartZone has already been installed as
described in Getting Started Guide.
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/documents.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

10

About This Guide
Document Conventions

Document Conventions
Table 1 and Table 2 list the text and notice conventions that are used throughout
this guide.
Table 1.

Text conventions

Convention

Description

monospace

Represents information as it [Device name]>
appears on screen

monospace bold

Represents information that [Device name]> set
you enter
ipaddr 10.0.0.12

default font bold

Keyboard keys, software
buttons, and field names

On the Start menu, click All
Programs.

italics

Screen or page names

Click Advanced Settings.
The Advanced Settings page
appears.

Table 2.

Example

Notice conventions

Notice Type

Description

NOTE

Information that describes important features or instructions

CAUTION!

Information that alerts you to potential loss of data or potential
damage to an application, system, or device

WARNING!

Information that alerts you to potential personal injury

Related Documentation
For a complete list of documents that accompany this release, refer to the Release
Notes.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

11

About This Guide
Documentation Feedback

Documentation Feedback
Ruckus Wireless is interested in improving its documentation and welcomes your
comments and suggestions. You can email your comments to Ruckus Wireless at:
docs@ruckuswireless.com
When contacting us, please include the following information:
• Document title
• Document part number (on the cover page)
• Page number (if appropriate)
For example:
• Ruckus Wireless SmartZone 100 Administrator Guide (Release 3.0)
• Part number: 800-70747-001
• Page 88

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

12

Introduction to the SmartZone
Command Line Interface

1

In this chapter:
• Overview of the SmartZone Command Line Interface
• Accessing the Command Line Interface

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

13

Introduction to the SmartZone Command Line Interface
Overview of the SmartZone Command Line Interface

Overview of the SmartZone Command Line
Interface
The SmartZone (SZ-100) command line interface (CLI) is a software tool that enables
you to configure and manage SZ-100. 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 SmartZone has a built-in command line interface (CLI) that you can use to
configure SmartZone settings and manage access points. This section describes
the requirements and the procedure for accessing the SmartZone CLI.

What You Will Need
To access the SmartZone CLI, you will need the following:
1 A computer that you want to designate as administrative computer
2 A network connection to SmartZone (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 SmartZone
Connect the administrative computer to SmartZone 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 SmartZone.
2 If you want to use a serial connection, make sure that both the administrative
computer and the SmartZone 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 SmartZone. See Figure 1 for the location of the console port.
• Connect the RS-232 end of the cable to a COM port on the administrative
computer.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

14

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

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 SmartZone 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
• Using Serial Connection

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

15

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

Using SSH Connection
If you have connected the administrative computer to the same subnet or broadcast
domain as the Management (Web) interface of the SmartZone, 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 2.
2 In Connection type, select SSH.
Figure 2. Selecting SSH as a connection type

3 Enter the IP address of the Management (Web) interface of the SmartZone 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.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

16

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

Using Serial Connection
If you have connected the administrative computer to the console port on the
SmartZone 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.
2 In Connection type, select Serial if you are connecting via serial cable.
Figure 3. Selecting serial as a connection type

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.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

17

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

Figure 4. PuTTy’s default serial connection setting

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

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

18

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

Figure 5. PuTTY’s serial connection settings for connecting to SmartZone

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

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

19

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

Figure 6. PuTTY console displaying the login prompt

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

Log On to CLI
The following describes the process for log on to the CLI.
• Log on to the SmartZone 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 SmartZone
installation procedure.
• The Ruckus Wireless SmartZone CLI welcome message appears with the CLI
prompt as seen in Figure 7.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

20

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

Figure 7. Welcome to SmartZone

• You are now logged into the SmartZone 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.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

21

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

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

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

22

Introduction to the SmartZone Command Line Interface
Accessing the Command Line Interface

• 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 command for details.
Figure 10. Changing to privileged mode

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

23

2

Configuration Commands

This chapter describes the commands that you can use to configure, enable, and
disable various SZ-100 components. The following table lists the commands.
NOTE: For easy access and reading, the configuration chapter has been split into
three chapters based on the alphabetical order of commands.
Table 3.

Configuration commands

config

admin

ap

ap-auto-approve

ap-auto-tagging ap-cert-check ap-controlmgmt-tos

ap-group

ap-heartbeat

ap-portal-cert

ap-sci

bonjourgateway

bonjour-policy

changepasswor clock
d

cluster-ip-list

commonsettings

data-plane

device-policy

dp-group

ap-root-ca

do

config-adminradius

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)#

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

24

Configuration Commands
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 
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)#

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

25

Configuration Commands
admin

Related Commands
Table 4 lists the related admin configuration commands.
Table 4.

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



Sets the user’s email details.

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

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

ruckus(config-admin)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-admin)# help

Displays the help.

Type: Privileged
ruckus(config-admin)# name



Sets the account name.



Sets the password for user.



Sets the phone number of the user.

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

Sets the real name.

Type: Privileged
ruckus(config-admin)# role



Sets the user role.



Sets the user’s job title.

Type: Privileged
ruckus(config-admin)# title
Type: Privileged

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

26

Configuration Commands
config-admin-radius

config-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

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

27

Configuration Commands
config-admin-radius

Related Commands
Table 5 lists the related admin-radius-service configuration commands.
Table 5.

Commands related to ruckus(config-radius-service)

Syntax and Type

Parameters (if any)

Description

ruckus(config-admin-radius)#
backup

ip : Sets the IP
address of secondary
RADIUS server

Enables backup of RADIUS server.

Type: Privileged

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

Executes the do command.

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

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

ruckus(config-admin-radius)# exit

Exits from the EXEC.

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

Displays the help.

Type: Privileged

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

28

Configuration Commands
config-admin-radius

Table 5.

Commands related to ruckus(config-radius-service)

Syntax and Type

Parameters (if any)

Description

ruckus(config-admin-radius)# ip



Sets the IP addresses of the
primary RADIUS server.



Sets the RADIUS server name.

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

ruckus(config-admin-radius)# port 
Type: Privileged
ruckus(config-admin-radius)#
shared-secret
Type: Privileged

Sets the port addresses of the
primary RADIUS server.

 Shared Sets the shared secret of the
primary RADIUS server.
secret between 1 and
255.

ruckus(config-admin-radius)# test 

Type: Privileged

Tests the RADIUS server based on
the user credentials.

ruckus(config-admin-radius)# type [ radius | tacacs ]]

Sets the admin authentication
type,

Type: Privileged

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

29

Configuration Commands
ap

ap
To update the AP configuration, use the following commands:
ruckus(config)# ap 
ruckus(config)# ap pre-prov > >
ruckus(config)# ap swap > >
Syntax Description
This command uses the following syntax:
 lock
: AP MAC address
lock: Lock AP
 pre-prov
: AP MAC address
pre-prov: Update Pre-provision configuration
 swap
: AP MAC address
swap: Update Swap configuration
 ap pre-prov > >
: AP MAC address
pre-prov: Update Pre-provision configuration
: Import the pre-provision APs from a CSV file using FTP
: FTP URL, format: ftp://:@/
export: Exports the pre-provision APs to a CSV file using FTP
 ap swap > >
: AP MAC address
swap: Update Swap configuration
: Imports the pre-provision APs from a CSV file using FTP
: FTP URL, format: ftp://:@/
export: Exports the pre-provision APs to a CSV file using FTP
Default
This command has no default settings.

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

30

Configuration Commands
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 6 lists the related ap profile configuration commands.
• Table 7 lists the related ap model configuration commands.
• Table 8 lists the related ap model lan1 configuration commands.
Table 6 lists the related ap profile configuration commands.
Table 6.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# admin

 

Sets the administrative logon
credentials.

 

Sets the administrative mode to
either locked or unlocked.



Sets the access point
administration login credentials.



Sets the model specification
(overrides the zone configuration).



Sets the access point
administrative password.

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)# bonjourgateway

Enables the bonjour gateway.

Type: Privileged

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

31

Configuration Commands
ap

Table 6.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

ruckus(config-ap)# bonjour-policy

Description
Enables the bonjour policy.

Type: Privileged
ruckus(config-ap)# clientadmission-control

2.4g

Type: Privileged

2.4g minClientCount


5g

Enables the client admission
control.

Min Client Count (Default:
10)
2.4g maxRadioLoad

Max Radio Load (Default:
75%)
2.4g
minClientThroughput
:
Min Client Throughput
(Default: 0.0Mbps)
5g minClientCount

Min Client Count (Default:
20)
5g maxRadioLoad

Max Radio Load (Default:
75%)
5g minClientThroughput

Min Client Throughput
(Default: 0.0Mbps)
ruckus(config-ap)# do

Executes the do command.

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



Sets the model specification
(overrides the zone configuration).

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

32

Configuration Commands
ap

Table 6.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

ruckus(config-ap)# end

Description

Type: Privileged

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

ruckus(config-ap)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ap)# gps

 

Sets the GPS coordinates to
latitude and longitude values.



Sets the GPS coordination
latitude.



Type: Privileged

Sets the GPS coordination
longitude.

ruckus(config-ap)# help

Displays the help.

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

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

 [ swe | cze | spa Sets the hotspot 2.0 settings.
| eng | chi | ger | fre | jpn |
dan | tur | dut ]
: Name
swe: Swedish
cze: Czech
spa: Spanish
eng: English
chi: Chinese
ger: German
fre: French
jpn: Japanese
dan: Danish
tur: Turkish
dut: Dutch

SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A

33

Configuration Commands
ap

Table 6.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

ruckus(config-ap)# ip

address   
and secondary DNS servers.

Type: Privileged

Description

name-server  secondary
ruckus(config-ap)# location



Sets the location.

[ root | disable | auto |
mesh ]

Sets the mesh mode to either:

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

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

ruckus(config-ap)# model

Sets the model specifications. It
overrides the zone configuration.

Type: Privileged
ruckus(config-ap)# name



Sets the AP name.

ruckus(config-ap)# no

admin

Disables the configuration.

Type: Privileged

bonjour-gateway

Type: Privileged

client-admission-control
description
hotspot20
ip 
location ...................................continued SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 34 Configuration Commands ap Table 6. Commands related to ruckus(config-ap). Syntax and Type Parameters (if any) Description ruckus(config-ap)# no model Disables the configuration. Type: Privileged override-clientadmission-control override-smart-mon radio smart-mon swap-in-ap syslog uplink-ap ruckus(config-ap)# override-client- <2.4g> <5g> admission-control Overrides the client admission control. Type: Privileged ruckus(config-ap)# override-smartmon Overrides the smart monitor. Type: Privileged ruckus(config-ap)# radio 2.4g channel Sets the radio channels. Type: Privileged 5g channel 2.4g channelization 5g channelization 2.4g tx-power 5g tx-power 2.4g wlan-service 5g wlan-service 2.4g wlan-group 5g wlan-group 2.4g roam [ enable | disable ] 5g roam [ enable | disable ] SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 35 Configuration Commands ap Table 6. Commands related to ruckus(config-ap). Syntax and Type Parameters (if any) ruckus(config-ap)# smart-mon interval Enables the smart monitor. Type: Privileged threshold ruckus(config-ap)# swap-in-ap Type: Privileged ruckus(config-ap)# syslog Type: Privileged Description Sets the AP Mac IP address for swap-in. enable Sets the syslog server. Enable the syslog server enable [ Local2 | Keep Original | Local1 | Local5 | Local6 | Local0 | Local7 | Local3 | Local4 ] [ Error | Critical | Warning | All | Alert | Notice | Info | Emergency ] disable - Disables the syslog server ruckus(config-ap)# uplink [ smart | manual ] Type: Privileged ruckus(config-ap)# uplink-ap Sets the uplink to manual access point. Type: Privileged ruckus(config-ap)# zone Type: Privileged Sets the uplink selection to either smart or manual. Moves the access point to another zone. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 36 Configuration Commands ap Table 7 lists the related to ap-model configuration commands. Table 7. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-ap-model)# ext-ant 2.4g - 2.4 with Enables the external antenna. DBI number Type: Privileged 2.4gg [ 3 | 2 ] 3/2 antennas 5g - 5g with DBI number 5gg [ 2 | 3 ] 5gg with 2/3 antennas ruckus(config-ap-model)# internalheater Enables the internal heater. Type: Privileged Sets the LAN configurations from 1 to 5. ruckus(config-ap-model)# lan1 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)# ledmode 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 Sets the LLDP advertise interval. Type: Privileged ruckus(config-ap-model)# lldphold-time Sets the LLDP hold time. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 37 Configuration Commands ap Table 7. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) ruckus(config-ap-model)# lldpmgmt Description 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-out-port radio-band ruckus(config-ap-model)# poeout-port Enables the PoE out port. Type: Privileged ruckus(config-ap-model)# radioband ${value} Switches the radio band. Type: Privileged ruckus(config-ap-model)# do Executes the do command. Type: Privileged ruckus(config-ap-model)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ap-model)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-model)# help Displays the help. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 38 Configuration Commands ap Table 8 lists the related to ap-model-lan1 configuration commands. Table 8. 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. Sets the authentication service configurations. 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)# mac-bypass Sets the MAC bypass. Type: Privileged ruckus(config-ap-model-lan1)# members Sets the AP model configurations. Type: Privileged 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)# supplicant mac Sets the supplicant. Type: Privileged custom ruckus(config-ap-model-lan1)# type [trunk-port | access-port | Sets the port type. general-port] Type: Privileged ruckus(config-ap-model-lan1)# vlan-untag-id Sets the VLAN untag IID. Type: Privileged ruckus(config-ap-model-lan1)# do Executes the do command. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 39 Configuration Commands ap-auto-approve Table 8. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) ruckus(config-ap-model-lan1)# end Type: Privileged ruckus(config-ap-model-lan1)# exit Description Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-ap-model-lan1)# help Displays the help. Type: Privileged 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 SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 40 Configuration Commands 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 Table 9 lists the related to ap-auto-tagging configuration commands. exi Table 9. Commands related to ruckus(config-ap-auto-tagging) Syntax and Type ruckus(config-ap-auto-tagging)# do Parameters (if any) Description 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 Type: Privileged ruckus(config-ap-auto-tagging)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 41 Configuration Commands ap-cert-check Table 9. Commands related to ruckus(config-ap-auto-tagging) Syntax and Type Parameters (if any) ruckus(config-ap-auto-tagging)# help Description Displays the help. Type: Privileged ruckus(config-ap-auto-tagging)# no Disables the auto tagging for critical APs. Type: Privileged ruckus(config-ap-auto-tagging)# rule Type: Privileged ruckus(config-ap-auto-tagging)# threshold - Traffic Selects the auto tagging rule. To bytes exceeds threshold view this command the ap-autorule tagging should be enabled. 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 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 SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 42 Configuration Commands 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 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 ap-group To create or update the AP group configuration, use the following command: ruckus(config)# ap-group Syntax Description This command has no arguments or keywords. Default This command uses the following syntax: name: Name of the AP group Command Mode Config Example SZ100-Node1(config)# ap-control-mgmt-tos 10 Related Commands • Table 10 lists the related to ap-group configuration commands. • Table 11 lists the related ap-group-lldp configuration commands. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 43 Configuration Commands ap-group • Table 12 lists the related ap-group-port-setting configuration commands. • Table 13 lists the commands related ap-model configuration commands. • Table 14 lists the related ap-model-lan1 configuration commands. Table 10 lists the related to ap-group configuration commands. Table 10. Commands related to ruckus(config-ap-group) Syntax and Type Parameters (if any) ruckus(config-ap-group)# channel 2.4g ${value} Type: Privileged Description Sets the channel. 5g indoor ${value} 5g outdoor ${value} ruckus(config-ap-group)# channelization 2.4g [ 20 | 40 ] Sets the channelization. 5g [ 40 | 20 ] Type: Privileged ruckus(config-ap-group)# clientadmission-control 2.4g Type: Privileged 2.4g minClientCount 5g Enables the client admission control. Min Client Count (Default: 10) 2.4g maxRadioLoad Max Radio Load (Default: 75%) 2.4g minClientThroughput : Min Client Throughput (Default: 0.0Mbps) ...................................continued SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 44 Configuration Commands ap-group Table 10. Commands related to ruckus(config-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-ap-group)# clientadmission-control 5g minClientCount Enables the client admission control. Type: Privileged Min Client Count (Default: 20) 5g maxRadioLoad Max Radio Load (Default: 75%) 5g minClientThroughput Min Client Throughput (Default: 0.0Mbps) ruckus(config-ap-group)# description Sets the description. Type: Privileged ruckus(config-ap-group)# do Sets the do command Type: Privileged ruckus(config-ap-group)# end Type: Privileged Ends the current configuration session and returns to the privileged EXEC mode. ruckus(config-ap-group)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-group)# external-antenna 5g [ disable | Sets the external antenna for enable ] specific AP model. Type: Privileged 5g gain 2.4g gain 2.4g [ enable | disable ] 2.4g [ 3antennas | 2-antennas ] 5g [ 3antennas | 2-antennas ] SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 45 Configuration Commands ap-group Table 10. Commands related to ruckus(config-ap-group) Syntax and Type Parameters (if any) ruckus(config-ap-group)# help Description Displays the help message. Type: Privileged ruckus(config-ap-group)# internal- [ enable | heater disable ] Sets the internal heater for specific AP model. Type: Privileged ruckus(config-ap-group)# lbs Enables the location based service. Type: Privileged ruckus(config-ap-group)# lbsservice Sets the location based service. Type: Privileged ruckus(config-ap-group)# ledmode Sets the LED mode for specific AP model. [ enable | disable ] Sets the LLDP for a specific AP model. Type: Privileged ruckus(config-ap-group)# lldp Type: Privileged ruckus(config-ap-group)# member add Type: Privileged move-to Sets the AP group member. It adds a new access point to current AP group. remove The AP Mac address removes the access point from the current AP group and moves it to other AP group. ruckus(config-ap-group)# no channel 2.4g Type: Privileged channel 5g indoor Disables / deletes the configuration settings. channel 5g outdoor channelization 2.4g channelization 5g client-admission-control ..................continued SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 46 Configuration Commands ap-group Table 10. Commands related to ruckus(config-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-ap-group)# no description Type: Privileged external-antenna 5g Disables / deletes the configuration settings. external-antenna 2.4g external-antenna ${model} internal-heater lbs led-mode lldp override-client-admissioncontrol override-lbs poe-out port-setting radio-band status-leds tx-power 2.4g tx-power 5g wlan-group 2.4g wlan-group 5g ruckus(config-ap-group)# override-client-admission-control 2.4g 5g Overrides the client admission control settings. Type: Privileged ruckus(config-ap-group)# override-lbs Overrides the location based service to zone settings. Type: Privileged ruckus(config-ap-group)# poe-out [ enable | disable ] Type: Privileged Sets the PoE out port for a specific AP model. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 47 Configuration Commands ap-group Table 10. Commands related to ruckus(config-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-ap-group)# portsetting Sets the port settings for specific AP model. [ 2.4g | 5g ] Switches the radio band for a specific AP model. [ enable | disable ] Sets the status LED for specific AP model. ruckus(config-ap-group)# txpower 2.4g ${value} Sets the TX power adjustment. Type: Privileged 5g ${value} ruckus(config-ap-group)# wlangroup 2.4g Type: Privileged ruckus(config-ap-group)# radioband Type: Privileged ruckus(config-ap-group)# statusleds Type: Privileged 5g Sets the WLAN group configurations. Type: Privileged Table 11 lists the related ap-group-lldp configuration commands. Table 11. Commands related to ruckus(config-ap-group-lldp) Syntax and Type Parameters (if any) Description ruckus(config-ap-group-lldp)# lldp-ad-interval Sets the LLDP advertise interval in seconds from the range 1 to 300. Type: Privileged Sets the LLDP hold time in seconds from the range 60 to 1200. ruckus(config-ap-group-lldp)# lldp-mgmt Enables the LLDP management IP TLV. Type: Privileged ruckus(config-ap-group-lldp)# lldp-hold-time Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 48 Configuration Commands ap-group Table 12 lists the related ap-group-port-setting configuration commands. Table 12. Commands related to ruckus(config-ap-group-port) Syntax and Type Parameters (if any) ruckus(config-ap-group-portsetting)# do Description Executes the do command. Type: Privileged ruckus(config-ap-group-portsetting)# dot1x authsvr [ ] Sets the 802.1x role. Type: Privileged accsvr mac-auth-bypass [ true | false ] supplicant user-name [ password supplicant mac ruckus(config-zone-ap-groupport-setting)# end Type: Privileged ruckus(config-zone-ap-groupport-setting)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-zone-ap-groupport-setting)# help Displays the help. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 49 Configuration Commands ap-group Table 12. Commands related to ruckus(config-ap-group-port) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-groupport-setting)# lan Enables or disable specific port. Type: Privileged uplink [ general | access | trunk ] untag member dot1x [ auth-macbased | disabled | authport-based | supplicant ] ruckus(config-zone-ap-groupport-setting)# no dot1x accsvr lan Disables or deletes the configuration settings. Type: Privileged Table 13 lists the commands related ap-model configuration commands. Table 13. Commands related to (config-ap-model) Syntax and Type Parameters (if any) ruckus(config-ap-model)# do Description Executes the do command. Type: Privileged ruckus(config-zone-ap-model)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-ap-model)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-model)# ext-ant 2.4g Type: Privileged Sets the external antenna. 2.4gg [ 3 | 2 ] 5g 5gg [ 2 | 3 ] SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 50 Configuration Commands ap-group Table 13. Commands related to (config-ap-model) Syntax and Type Parameters (if any) ruckus(config-zone-ap-model)# help Description Displays the help. Type: Privileged ruckus(config-ap-model)# internalheater Enables international heater. Type: Privileged Sets the LAN configurations from 1 to 5. ruckus(config-ap-model)# lan1 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 led. Type: Privileged ruckus(config-ap-model)# ledmode Sets the led mode description. Type: Privileged ruckus(config-ap-model)# lldp Enables the Link Layer Discovery Protocol (LLDP). Type: Privileged ruckus(config-ap-model)# lldp-ad- interval Sets the LLDP advertise interval. Type: Privileged ruckus(config-ap-model)# lldphold-time Sets the LLDP hold time. Type: Privileged ruckus(config-ap-model)# lldpmgmt Enables the LLDP management IP TLV. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 51 Configuration Commands ap-group Table 13. Commands related to (config-ap-model) Syntax and Type Parameters (if any) Description 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-out-port radio-band ruckus(config-ap-model)# poeout-port Enables the PoE out port. Type: Privileged ruckus(config-ap-model)# radioband ${value} Switches the radio band. Type: Privileged Table 14 lists the related ap-model-lan1 configuration commands. Table 14. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-ap-model-lan1)# 8021x <8021x-type> Sets the 802.1x. Sets the accounting service configurations. 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 SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 52 Configuration Commands ap-group Table 14. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) ruckus(config-ap-model-lan1)# do Description Executes the do command. Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ap-model-lan1)# end Type: Privileged Exits from the EXEC. ruckus(config-ap-model-lan1)# exit Type: Privileged ruckus(config-ap-model-lan1)# help Displays the help. Type: Privileged ruckus(config-ap-model-lan1)# mac-bypass Sets the MAC authentication bypass. Type: Privileged ruckus(config-ap-model-lan1)# members Sets the members. Type: Privileged ruckus(config-ap-model-lan1)# no acct-service Type: Privileged mac-bypass Disables or deletes the settings that have been configured. ruckus(config-ap-model-lan1)# supplicant mac Sets the supplicant. Type: Privileged custom ruckus(config-ap-model-lan1)# type [ trunk-port | access-port | Sets the port type. general-port ] Type: Privileged ruckus(config-ap-model-lan1)# vlan-untag-id Sets the VLAN untag ID. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 53 Configuration Commands ap-heartbeat ap-heartbeat To setup the access point heartbeat, use the following command: ruckus(config)# ap-heartbeat Syntax Description This command uses the following syntax: seconds: Interval in seconds, which the AP sends the heartbeat to the SZ such as: 30, 60, 150 and 300 Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-heartbeat 30 ap-portal-cert To update the AP portal certificate configuration, use the following command: ruckus(config)# ap-portal-cert Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-portal-cert SZ100-Node1(config-ap-portal-cert)# SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 54 Configuration Commands ap-portal-cert Related Commands • Table 15 lists the related to ap-portal-cert configuration commands. • Table 16 lists the related to ap-portal-cert-generate-csr configuration commands. Table 15 lists the related to ap-portal-cert configuration commands. Table 15. Commands related to ruckus(config-ap-portal-cert) Syntax and Type Parameters (if any) ruckus(config-ap-portal-cert)# do Description Executes the do command. Type: Privileged ruckus(config-ap-portal-cert)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ap-portal-cert)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-portal-cert)# generate-csr Type: Privileged FTP URL, format: ftp:/ :@[/] ruckus(config-ap-portal-cert)# help Generates the certificate signing request. Displays the help. Type: Privileged ruckus(config-ap-portal-cert)# upload-cert Type: Privileged Uploads the certificate. FTP URL, format: ftp:/ :@[/] SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 55 Configuration Commands ap-portal-cert Table 16 lists the related to ap-portal-cert-generate-csr configuration commands. Table 16. Commands related to ruckus(config-ap-portal-cert-generate-csr) Syntax and Type Parameters (if any) Description ruckus(config-ap-portal-certgenerate-csr)# city Sets the city name. Sets the domain name. Sets the county. Sets the email address. Sets the organization name. Sets the state name. Sets the unit name. Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# common-name Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# country Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# email Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# organization Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# state Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# unit Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 56 Configuration Commands ap-root-ca ap-root-ca To update the AP root CA, use the following command: ruckus(config)# ap-root-ca Syntax Description This command uses the following syntax: ftp-url: AP Root CA file, FTP URL Format: ftp://:@/ ) Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-root-ca ftp:// mahan:ruckus1!@172.19.7.100/backup/AP_ad87453456fe.csv ap-sci To enable the access point SCI, use the following command: ruckus(config)# ap-sci enable Syntax Description This command uses the following syntax: enable: Enables the AP SCI. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-sci enable SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 57 Configuration Commands bonjour-gateway bonjour-gateway To enable the bonjour-gateway, use the following command: ruckus(config)# 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)# bonjour-gateway Bonjour service is enabled bonjour-policy To create or update the bonjour policy, use the following command: ruckus(config)# bonjour-policy Syntax Description This command uses the following syntax: name: Name of the bonjour-policy Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# bonjour-policy SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 58 Configuration Commands bonjour-policy Related Commands Table 17 lists the related bonjour-policy configuration commands. Table 17. Commands related to ruckus(config-bonjour-policy) Syntax and Type Parameters (if any) Description ruckus(config-bonjour-policy)# description Sets the description. Type: Privileged ruckus(config-bonjour-policy)# do Executes the do command. Type: Privileged ruckus(config-bonjour-policy)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-bonjour-policy)# exit Exits from the EXEC. Type: Privileged ruckus(config-bonjour-policy)# help Displays the help. Type: Privileged ruckus(config-bonjour-policy)# name Sets the bonjour policy name. Type: Privileged ruckus(config-bonjour-policy)# no rule Deletes the rules based on the rule priority. Type: Privileged ruckus(config-bonjour-policy)# rule Type: Privileged Sets the bonjour policy set of rules based on the rule priority. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 59 Configuration Commands bonjour-policy Table 18 lists the related bonjour-policy-rule configuration commands. Table 18. Commands related to ruckus(config-bonjour-policy-rule) Syntax and Type Parameters (if any) Description ruckus(config-bonjour-policyrule)# bridge-service airdisk Sets the bridge service. Type: Privileged airport-management airplay airprint airtunes apple-file-sharing apple-mobile-devices (Allows sync with iTunes over 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 www-https xgrid ruckus(config-bonjour-policyrule)# do Executes the do command. Type: Privileged ruckus(config-bonjour-policyrule)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 60 Configuration Commands bonjour-policy Table 18. Commands related to ruckus(config-bonjour-policy-rule) Syntax and Type Parameters (if any) ruckus(config-bonjour-policyrule)# exit Description Exits from the EXEC. Type: Privileged ruckus(config-bonjour-policyrule)# from-vlan Sets the from VLAN. Type: Privileged Exits from the EXEC. ruckus(config-bonjour-policyrule)# help Type: Privileged ruckus(config-bonjour-policyrule)# notes Sets the notes. Type: Privileged ruckus(config-bonjour-policyrule)# protocol Sets the bridge service when it is 'other'. Type: Privileged ruckus(config-bonjour-policyrule)# to-vlan Sets the VLAN. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 61 Configuration Commands changepassword changepassword To change the administrative password, use the following command: ruckus(config)# changepassword 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: ruckus1! New Password:ruckus2! clock To update the system clock or the timezone configuration, use the following command: ruckus(config)# clock timezone Syntax Description This command uses the following syntax: timezone: Sets the system clock timezone : Timezone name of the domain Default This command has no default settings. Command Mode Config SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 62 Configuration Commands cluster-ip-list Example SZ100-Node1(config)# clock timezone Africa/Nairobi cluster-ip-list To update the node IP address mapping list of the cluster configuration, use the following command: ruckus(config)# cluster-ip-list 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 common-settings To update the common settings, use the following command: ruckus(config)# common-settings 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 SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 63 Configuration Commands common-settings Example SZ100-Node1(config)# common-settings SZ100-Node1(config-common-settings)# Related Commands • Table 19 lists the related common-settings configuration commands. • Table 20 lists the related common-settings-aaa configuration commands. • Table 21 lists the related common-settings-ap-group configuration commands. • Table 22 lists the related ap-group-lldp configuration commands. • Table 23 lists the related ap-group-port-setting configuration commands. • Table 24 lists the commands related config-common-settings-ap-model configuration commands. • Table 25 lists the related common-settings-ap-model-lan1 configuration commands. • Table 26 lists the commands related config-common-settings-ap-tunnelsettings configuration commands. • Table 27 lists the related common-settings-guest-access configuration commands. • Table 28 lists the related common-settings-hotspot configuration commands. • Table 29 lists the related common-settings-web-authentication configuration commands. • Table 30 lists the related common-settings-wlan configuration commands. • Table 31 lists the related common-settings-wlan-group configuration commands. • Table 32 lists the related common-settings-wlan-scheduler configuration commands. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 64 Configuration Commands common-settings Table 19 lists the related common-settings configuration commands. Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) Description ruckus(config-common-settings)# 2.4g ${value} Sets the adjacent radio threshold of the client load balancing. adj-threshold 5g ${value} Type: Privileged Value is minimum = 1 and maximum = 100 ruckus(config-common-settings)# ap-firmware Sets the AP firmware version. Type: Privileged ruckus(config-common-settings)# ap-logon Sets the access point administration login credentials. Type: Privileged ruckus(config-common-settings)# ap-model Sets the model specification. Type: Privileged ruckus(config-common-settings)# ap-password Sets the access point administrative password. Type: Privileged ruckus(config-common-settings)# default-gateway : Sets the AP reboot timeout. ap-reboot-timeout Sets the default gateway timeout in hours. Type: Privileged control-gateway [ ] Sets the control gateway timeout in hours and minutes. ruckus(config-common-settings)# ap-tunnel-settings Sets the access point tunnel settings. Type: Privileged ruckus(config-common-settings)# 2.4g background-scan 5g Type: Privileged Sets the background scanning. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 65 Configuration Commands common-settings Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) ruckus(config-common-settings)# 2.4g band-balancing 2.4G band Type: Privileged : Percentage of Description Sets the band balance. clients on 2.4G band ruckus(config-common-settings)# 2.4g ${value} channel 5g indoor ${value} Type: Privileged 5g outdoor ${value} Sets the channel. ruckus(config-common-settings)# 2.4g [ 20 | 40 ] channelization 5g [ 40 | 20 ] Type: Privileged Sets the channelization. ruckus(config-common-settings)# 2.4g client-admission-control 5g Type: Privileged 2.4g minClientCount Enables the client admission control. Min Client Count (Default: 10) 2.4g maxRadioLoad Max Radio Load (Default: 75%) 2.4g minClientThroughput : Min Client Throughput (Default: 0.0Mbps) ..................continued SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 66 Configuration Commands common-settings Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) ruckus(config-common-settings)# 5g minClientCount client-admission-control Type: Privileged Description Enables the client admission control. Min Client Count (Default: 20) 5g maxRadioLoad Max Radio Load (Default: 75%) 5g minClientThroughput Min Client Throughput (Default: 0.0Mbps) ruckus(config-common-settings)# country-code Sets the country code. Type: Privileged ruckus(config-common-settings)# do Executes the do command. Type: Privileged ruckus(config-common-settings)# end Type: Privileged ruckus(config-common-settings)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-common-settings)# 2.4g headroom 5g: 5 GHz radio Type: Privileged Sets the headroom (number of client) of the client load balancing. ruckus(config-common-settings)# help Displays the help. Type: Privileged ruckus(config-common-settings)# indoor-channel Enables the indoor channels. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 67 Configuration Commands common-settings Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) ruckus(config-common-settings)# lbs Description Enables the location based service. Type: Privileged ruckus(config-common-settings)# lbs-service Sets the location based service. Type: Privileged ruckus(config-common-settings)# 2.4g load-balancing 5g Type: Privileged Sets the client load balancing. ruckus(config-common-settings)# mesh Enables mesh networking. Type: Privileged ruckus(config-common-settings)# mesh-name Sets the mesh name (ESSID). Type: Privileged ruckus(config-common-settings)# mesh-passphrase Sets the mesh passphrase. Type: Privileged ruckus(config-common-settings)# [ dynamic | static ] Sets the mesh uplink auto selection. mesh-uplink-selection dynamic: Use dynamic Type: Privileged link metrics for automatic mesh uplink selection. static: Use static link metrics for automatic mesh uplink selection. SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 68 Configuration Commands common-settings Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) ruckus(config-common-settings)# background-scan no band-balancing Type: Privileged client-admission-control Description Disables or deletes various sub command. indoor-channel lbs load-balancing mesh roam smart-mon smart-roam-disconnectevent syslog-enabled timezone-dst ruckus(config-common-settings)# 2.4g roam 5g Type: Privileged Sets the smart roam. ruckus(config-common-settings)# [ disable | enable ] Sets the report rouge access rouge-ap-detection Disables or enables rogue point. access points Type: Privileged report-all [ disable | enable ] - Enables or disables all rogue devices report-only-malicious [ enable | disable ] - Enables or disables only malicious rogue device types report-ssid-spoofing [ disable | enable ] - Enables or disables malicious rogue devices which have SSID spoofing ...........................continued SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 69 Configuration Commands common-settings Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) Description ruckus(config-common-settings)# report-same-network [ Sets the report rouge access rouge-ap-detection enable | disable ] - Enables point. or disables malicious Type: Privileged rogue devices which have 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-common-settings)# interval smart-mon threshold Type: Privileged Sets the smart monitor interval. ruckus(config-common-settings)# smart-roam-disconnect-event Enables smart roam disconnect event. Type: Privileged ruckus(config-common-settings)# syslog-enabled Enables the external syslog server for APs for the specified zone. Type: Privileged ruckus(config-common-settings)# [Local6 | Keep Original | Sets the syslog server facility, Local0 | Local5 | Local7 | syslog-facility Local1 | Local4 | Local3 | Type: Privileged Local2] ruckus(config-common-settings)# syslog-ip Sets the IP address for the syslog server. Type: Privileged ruckus(config-common-settings)# syslog-port Sets the port number for the syslog server. Type: Privileged SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 70 Configuration Commands common-settings Table 19. Commands related to ruckus(config-common-settings) Syntax and Type Parameters (if any) ruckus(config-common-settings)# [ Alert | Info | Critical | syslog-priority Warning | Notice | Emergency | All | Error ] Type: Privileged Description Sets the syslog server priority. ruckus(config-common-settings))# System - Follows the SZ Sets the timezone for zone. timezone time zone setting Type: Privileged System [