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 [warning: Documents this large are best viewed by clicking the View PDF Link!]

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
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 2
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 CONSEQUEN-
TIAL 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 3
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
Contents
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 4
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
Contents
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 5
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
Contents
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 6
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
Contents
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 7
screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
sslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
6Setup Commands
rbddump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
7Show 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
Contents
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 8
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 <new-password> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Contents
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 9
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 10
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.
About This Guide
Document Conventions
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 11
Document Conventions
Table 1 and Table 2 list the text and notice conventions that are used throughout
this guide.
Related Documentation
For a complete list of documents that accompany this release, refer to the Release
Notes.
Table 1. Text conventions
Convention Description Example
monospace Represents information as it
appears on screen
[Device name]>
monospace bold Represents information that
you enter
[Device name]> set
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. 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
About This Guide
Documentation Feedback
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 12
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 13
1
Introduction to the SmartZone
Command Line Interface
In this chapter:
•Overview of the SmartZone Command Line Interface
•Accessing the Command Line Interface
Introduction to the SmartZone Command Line Interface
Overview of the SmartZone Command Line Interface
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 14
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:
1A computer that you want to designate as administrative computer
2A 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)
3An 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.
1If 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.
2If 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.
Introduction to 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 15
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
Introduction to 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 16
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.
1Start PuTTY. The PuTTY configuration dialog box appears, showing the Session
screen as seen in Figure 2.
2In Connection type, select SSH.
Figure 2. Selecting SSH as a connection type
3Enter the IP address of the Management (Web) interface of the SmartZone in
the Host Name (or IP address) field as seen in Figure 2.
4Click Open. The PuTTY console appears and displays the login prompt. See
Figure 6.
Introduction to 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 17
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.
1Start PuTTY. The PuTTY Configuration dialog box appears, showing the Session
screen as seen in Figure 3.
2In Connection type, select Serial if you are connecting via serial cable.
Figure 3. Selecting serial as a connection type
3Under 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.
Introduction to 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 18
Figure 4. PuTTy’s default serial connection setting
4Configure 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
Introduction to 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 19
Figure 5. PuTTY’s serial connection settings for connecting to SmartZone
5Click Open. The PuTTY console appears and displays the login prompt as seen
in Figure 6.
Introduction to 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 20
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.
Introduction to 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 21
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.
Introduction to 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 22
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
Introduction to 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 23
• 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 24
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.
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)#
Table 3. Configuration commands
config admin config-admin-
radius
ap ap-auto-approve
ap-auto-tagging ap-cert-check ap-control-
mgmt-tos
ap-group ap-heartbeat
ap-portal-cert ap-root-ca ap-sci bonjour-
gateway
bonjour-policy
changepasswor
d
clock cluster-ip-list common-
settings
data-plane
device-policy do dp-group
Configuration Commands
admin
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 25
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)#
Configuration Commands
admin
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 26
Related Commands
Table 4 lists the related admin configuration commands.
Table 4. Commands related to ruckus(config-admin)
Syntax and Type Parameters (if any) Description
ruckus(config-admin)# do
Type: Privileged
Executes the do command.
ruckus(config-admin)# email
Type: Privileged
<email> Sets the user’s email details.
ruckus(config-admin)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-admin)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-admin)# help
Type: Privileged
Displays the help.
ruckus(config-admin)# name
Type: Privileged
<name> Sets the account name.
ruckus(config-admin)# password
Type: Privileged
<password> Sets the password for user.
ruckus(config-admin)# phone
Type: Privileged
<phone> Sets the phone number of the user.
ruckus(config-admin)# real-name
Type: Privileged
<name> Sets the real name.
ruckus(config-admin)# role
Type: Privileged
<name> Sets the user role.
ruckus(config-admin)# title
Type: Privileged
<text> Sets the user’s job title.
Configuration Commands
config-admin-radius
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 27
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 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
Configuration Commands
config-admin-radius
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 28
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
Type: Privileged
ip <ip>: Sets the IP
address of secondary
RADIUS server
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
Enables backup of RADIUS server.
ruckus(config-admin-radius)# do
Type: Privileged
Executes the do command.
ruckus(config-admin-radius)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-admin-radius)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-admin-radius)# help
Type: Privileged
Displays the help.
Configuration Commands
config-admin-radius
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 29
ruckus(config-admin-radius)# ip
Type: Privileged
<ip> Sets the IP addresses of the
primary RADIUS server.
ruckus(config-admin-radius)#
name Type: Privileged
<name> Sets the RADIUS server name.
ruckus(config-admin-radius)# port
Type: Privileged
<port> Sets the port addresses of the
primary RADIUS server.
ruckus(config-admin-radius)#
shared-secret
Type: Privileged
<shared-secret> Shared
secret between 1 and
255.
Sets the shared secret of the
primary RADIUS server.
ruckus(config-admin-radius)# test
Type: Privileged
<username>
<password>
Tests the RADIUS server based on
the user credentials.
ruckus(config-admin-radius)# type
Type: Privileged
[ radius | tacacs ]] Sets the admin authentication
type,
Table 5. Commands related to ruckus(config-radius-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 30
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> ap pre-prov <import <ftp-url>> <export <ftp-url>>
<mac>: AP MAC address
pre-prov: Update Pre-provision configuration
<import>: Import the pre-provision APs from a CSV file using FTP
<ftp-url>: FTP URL, format: ftp://:@/
export: Exports the pre-provision APs to a CSV file using FTP
<mac> ap swap <import <ftp-url>> <export <ftp-url>>
<mac>: AP MAC address
swap: Update Swap configuration
<import>: Imports the pre-provision APs from a CSV file using FTP
<ftp-url>: FTP URL, format: ftp://:@/
export: Exports the pre-provision APs to a CSV file using FTP
Default
This command has no default settings.
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 31
Command Mode
Config
Example
ruckus(config)# ap mac
SZ100-Node1(config)# ap A1:87:45:34:56:FE
ruckus(config)# ap pre-prov <export <ftp-url>>
SZ100-Node1(config)# ap pre-prov import ftp://
ruckus:ruckus1!@172.19.7.100/backup/AP_ad8745345
ruckus(config)# ap swap <import <ftp-url>>
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
Type: Privileged
<logon> <password> Sets the administrative logon
credentials.
ruckus(config-ap)# admin-mode
Type: Privileged
<locked> <unlocked> Sets the administrative mode to
either locked or unlocked.
ruckus(config-ap)# ap-logon
Type: Privileged
<logon-id> Sets the access point
administration login credentials.
ruckus(config-ap)# ap-model
Type: Privileged
<ap-model> Sets the model specification
(overrides the zone configuration).
ruckus(config-ap)# ap-password
Type: Privileged
<password> Sets the access point
administrative password.
ruckus(config-ap)# bonjour-
gateway
Type: Privileged
Enables the bonjour gateway.
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 32
ruckus(config-ap)# bonjour-policy
Type: Privileged
Enables the bonjour policy.
ruckus(config-ap)# client-
admission-control
Type: Privileged
2.4g
5g
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)
Enables the client admission
control.
ruckus(config-ap)# do
Type: Privileged
Executes the do command.
ruckus(config-ap)# description
Type: Privileged
<description> Sets the model specification
(overrides the zone configuration).
Table 6. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 33
ruckus(config-ap)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ap)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap)# gps
Type: Privileged
<latitude> <longitude> Sets the GPS coordinates to
latitude and longitude values.
ruckus(config-ap)# gps-latitude
Type: Privileged
<gps-latitude> Sets the GPS coordination
latitude.
ruckus(config-ap)# gps-longitude
Type: Privileged
<gps-longitude> Sets the GPS coordination
longitude.
ruckus(config-ap)# help
Type: Privileged
Displays the help.
ruckus(config-ap)# hotspot20
Type: Privileged
<name> [ swe | cze | spa
| eng | chi | ger | fre | jpn |
dan | tur | dut ]
<name>: Name
swe: Swedish
cze: Czech
spa: Spanish
eng: English
chi: Chinese
ger: German
fre: French
jpn: Japanese
dan: Danish
tur: Turkish
dut: Dutch
Sets the hotspot 2.0 settings.
Table 6. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 34
ruckus(config-ap)# ip
Type: Privileged
address <ip> <network-
mask> <gateway>
name-server <dns-
server> secondary
Sets the IP address and primary
and secondary DNS servers.
ruckus(config-ap)# location
Type: Privileged
<location> Sets the location.
ruckus(config-ap)# mesh
Type: Privileged
[ root | disable | auto |
mesh ]
Sets the mesh mode to either:
• root: Root AP
• disable: Disable
• auto: Auto
• mesh: Mesh AP
ruckus(config-ap)# model
Type: Privileged
Sets the model specifications. It
overrides the zone configuration.
ruckus(config-ap)# name
Type: Privileged
<name> Sets the AP name.
ruckus(config-ap)# no
Type: Privileged
admin
bonjour-gateway
client-admission-control
description
hotspot20
ip <address> <name-
server secondary>
location
Disables the configuration.
...................................continued
Table 6. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 35
ruckus(config-ap)# no
Type: Privileged
model
override-client-
admission-control
override-smart-mon
radio
smart-mon
swap-in-ap
syslog
uplink-ap
Disables the configuration.
ruckus(config-ap)# override-client-
admission-control
Type: Privileged
<2.4g> <5g> Overrides the client admission
control.
ruckus(config-ap)# override-smart-
mon
Type: Privileged
Overrides the smart monitor.
ruckus(config-ap)# radio
Type: Privileged
2.4g channel <channel>
5g channel <channel>
2.4g channelization
<channelization>
5g channelization
<channelization>
2.4g tx-power <tx-
power>
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 ]
Sets the radio channels.
Table 6. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 36
ruckus(config-ap)# smart-mon
Type: Privileged
interval <between 5-60>
threshold <between 1-
10>
Enables the smart monitor.
ruckus(config-ap)# swap-in-ap
Type: Privileged
<mac> Sets the AP Mac IP address for
swap-in.
ruckus(config-ap)# syslog
Type: Privileged
enable <ip> <port> -
Enable the syslog server
enable <ip> <port> [
Local2 | Keep Original |
Local1 | Local5 | Local6 |
Local0 | Local7 | Local3 |
Local4 ] [ Error |
Critical | Warning | All |
Alert | Notice | Info |
Emergency ]
disable - Disables the
syslog server
Sets the syslog server.
ruckus(config-ap)# uplink
Type: Privileged
[ smart | manual ] Sets the uplink selection to either
smart or manual.
ruckus(config-ap)# uplink-ap
Type: Privileged
Sets the uplink to manual access
point.
ruckus(config-ap)# zone
Type: Privileged
<name> Moves the access point to another
zone.
Table 6. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 37
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
Type: Privileged
2.4g <number> - 2.4 with
DBI number
2.4gg <number> [ 3 | 2 ] -
3/2 antennas
5g <number> - 5g with
DBI number
5gg <number> [ 2 | 3 ] -
5gg with 2/3 antennas
Enables the external antenna.
ruckus(config-ap-model)# internal-
heater
Type: Privileged
Enables the internal heater.
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
Sets the LAN configurations from 1
to 5.
ruckus(config-ap-model)# led
Type: Privileged
Enables the status of LEDs.
ruckus(config-ap-model)# led-
mode
Type: Privileged
Sets the LED mode.
ruckus(config-ap-model)# lldp
Type: Privileged
Enables link layer discovery
protocol.
ruckus(config-ap-model)# lldp-ad-
interval
Type: Privileged
<seconds> Sets the LLDP advertise interval.
ruckus(config-ap-model)# lldp-
hold-time
Type: Privileged
<seconds> Sets the LLDP hold time.
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 38
ruckus(config-ap-model)# lldp-
mgmt
Type: Privileged
Enables LLDP management IP
TLV.
ruckus(config-ap-model)# no
Type: Privileged
ext-ant
internal-heater
lan1
lan2
lan3
lan4
lan5
led
lldp
lldp-mgmt
poe-out-port
radio-band
Disables or deletes the settings
that have been configured.
ruckus(config-ap-model)# poe-
out-port
Type: Privileged
Enables the PoE out port.
ruckus(config-ap-model)# radio-
band
Type: Privileged
${value} Switches the radio band.
ruckus(config-ap-model)# do
Type: Privileged
Executes the do command.
ruckus(config-ap-model)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ap-model)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-model)# help
Type: Privileged
Displays the help.
Table 7. Commands related to ruckus(config-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 39
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
Type: Privileged
<802.1x-type> Sets 802.1x.
ruckus(config-ap-model-lan1)#
acct-service
Type: Privileged
<acct-service> Sets the authentication service
configurations.
ruckus(config-ap-model-lan1)#
auth-service
Type: Privileged
<auth-service> Sets the authentication service
configurations.
ruckus(config-ap-model-lan1)#
mac-bypass
Type: Privileged
Sets the MAC bypass.
ruckus(config-ap-model-lan1)#
members
Type: Privileged
<members> Sets the AP model configurations.
ruckus(config-ap-model-lan1)# no
Type: User
acct-service
mac-bypass
Disables or deletes the settings
that have been configured.
ruckus(config-ap-model-lan1)#
supplicant
Type: Privileged
mac
custom <username>
<password>
Sets the supplicant.
ruckus(config-ap-model-lan1)#
type
Type: Privileged
[trunk-port | access-port |
general-port]
Sets the port type.
ruckus(config-ap-model-lan1)#
vlan-untag-id
Type: Privileged
<vlan-untag-id> Sets the VLAN untag IID.
ruckus(config-ap-model-lan1)# do
Type: Privileged
Executes the do command.
Configuration Commands
ap-auto-approve
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 40
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(config-ap-model-lan1)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ap-model-lan1)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-model-lan1)#
help
Type: Privileged
Displays the help.
Table 8. Commands related to ruckus(config-ap-model-lan1)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-auto-tagging
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 41
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 Parameters (if any) Description
ruckus(config-ap-auto-tagging)#
do
Type: Privileged
Executes the do command.
ruckus(config-ap-auto-tagging)#
enable
Type: Privileged
Enables the auto tagging for critical
APs.
ruckus(config-ap-auto-tagging)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ap-auto-tagging)#
exit
Type: Privileged
Exits from the EXEC.
Configuration Commands
ap-cert-check
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 42
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
ruckus(config-ap-auto-tagging)#
help
Type: Privileged
Displays the help.
ruckus(config-ap-auto-tagging)#
no
Type: Privileged
<enable> Disables the auto tagging for
critical APs.
ruckus(config-ap-auto-tagging)#
rule
Type: Privileged
<daily-threshold> - Traffic
bytes exceeds threshold
rule
Selects the auto tagging rule. To
view this command the ap-auto-
tagging should be enabled.
ruckus(config-ap-auto-tagging)#
threshold
Type: Privileged
<daily-> Disables the auto tagging for
critical APs. To view this command
the ap-auto-tagging should be
enabled.
ruckus(config-ap-auto-tagging)#
unit
Type: Privileged
[ m | g ] Sets the unit to either mega bytes
or giga bytes.
Table 9. Commands related to ruckus(config-ap-auto-tagging)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-control-mgmt-tos
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 43
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
ap-group
To create or update the AP group configuration, use the following command:
ruckus(config)# ap-group <name>
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.
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 44
•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) Description
ruckus(config-ap-group)# channel
Type: Privileged
2.4g ${value}
5g indoor ${value}
5g outdoor ${value}
Sets the channel.
ruckus(config-ap-group)#
channelization
Type: Privileged
2.4g [ 20 | 40 ]
5g [ 40 | 20 ]
Sets the channelization.
ruckus(config-ap-group)# client-
admission-control
Type: Privileged
2.4g
5g
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)
Enables the client admission
control.
...................................continued
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 45
ruckus(config-ap-group)# client-
admission-control
Type: Privileged
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)
Enables the client admission
control.
ruckus(config-ap-group)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-ap-group)# do
Type: Privileged
Sets the do command
ruckus(config-ap-group)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-ap-group)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-group)#
external-antenna
Type: Privileged
<ap-model> 5g [ disable |
enable ]
<ap-model> 5g gain
<gain>
<ap-model> 2.4g gain
<gain>
<ap-model> 2.4g [ enable
| disable ]
<ap-model> 2.4g [ 3-
antennas | 2-antennas ]
<ap-model> 5g [ 3-
antennas | 2-antennas ]
Sets the external antenna for
specific AP model.
Table 10. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 46
ruckus(config-ap-group)# help
Type: Privileged
Displays the help message.
ruckus(config-ap-group)# internal-
heater
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the internal heater for specific
AP model.
ruckus(config-ap-group)# lbs
Type: Privileged
Enables the location based
service.
ruckus(config-ap-group)# lbs-
service
Type: Privileged
Sets the location based service.
ruckus(config-ap-group)# led-
mode
Type: Privileged
<ap-model> Sets the LED mode for specific AP
model.
ruckus(config-ap-group)# lldp
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the LLDP for a specific AP
model.
ruckus(config-ap-group)# member
Type: Privileged
add <ap-mac>
move-to <apgroup-
name> <ap-mac>
remove <mac>
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.
ruckus(config-ap-group)# no
Type: Privileged
channel 2.4g
channel 5g indoor
channel 5g outdoor
channelization 2.4g
channelization 5g
client-admission-control
Disables / deletes the
configuration settings.
..................continued
Table 10. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 47
ruckus(config-ap-group)# no
Type: Privileged
description
external-antenna <ap-
model> 5g
external-antenna <ap-
model> 2.4g
external-antenna
${model}
internal-heater
lbs
led-mode
lldp
override-client-admission-
control
override-lbs
poe-out
port-setting
radio-band
status-leds
tx-power 2.4g
tx-power 5g
wlan-group 2.4g
wlan-group 5g
Disables / deletes the
configuration settings.
ruckus(config-ap-group)#
override-client-admission-control
Type: Privileged
2.4g
5g
Overrides the client admission
control settings.
ruckus(config-ap-group)#
override-lbs
Type: Privileged
Overrides the location based
service to zone settings.
ruckus(config-ap-group)# poe-out
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the PoE out port for a specific
AP model.
Table 10. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 48
Table 11 lists the related ap-group-lldp configuration commands.
ruckus(config-ap-group)# port-
setting
Type: Privileged
<ap-model> Sets the port settings for specific
AP model.
ruckus(config-ap-group)# radio-
band
Type: Privileged
<ap-model> [ 2.4g | 5g ] Switches the radio band for a
specific AP model.
ruckus(config-ap-group)# status-
leds
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the status LED for specific AP
model.
ruckus(config-ap-group)# tx-
power
Type: Privileged
2.4g ${value}
5g ${value}
Sets the TX power adjustment.
ruckus(config-ap-group)# wlan-
group
Type: Privileged
2.4g
5g
Sets the WLAN group
configurations.
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
Type: Privileged
<seconds> Sets the LLDP advertise interval in
seconds from the range 1 to 300.
ruckus(config-ap-group-lldp)#
lldp-hold-time
Type: Privileged
<seconds> Sets the LLDP hold time in
seconds from the range 60 to
1200.
ruckus(config-ap-group-lldp)#
lldp-mgmt
Type: Privileged
Enables the LLDP management IP
TLV.
Table 10. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 49
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) Description
ruckus(config-ap-group-port-
setting)# do
Type: Privileged
Executes the do command.
ruckus(config-ap-group-port-
setting)# dot1x
Type: Privileged
authsvr [ <authenticator
server name> ]
accsvr <name>
mac-auth-bypass [ true |
false ]
supplicant user-name [
<user name> password
<password>
supplicant mac
Sets the 802.1x role.
ruckus(config-zone-ap-group-
port-setting)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC 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.
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 50
Table 13 lists the commands related ap-model configuration commands.
ruckus(config-zone-ap-group-
port-setting)# lan
Type: Privileged
<port>
<port> uplink [ general |
access | trunk ]
<port> untag <vlan>
<port> member <vlan-
members>
<port> dot1x [ auth-mac-
based | disabled | auth-
port-based | supplicant ]
Enables or disable specific port.
ruckus(config-zone-ap-group-
port-setting)# no
Type: Privileged
dot1x accsvr
lan <port>
Disables or deletes the
configuration settings.
Table 13. Commands related to (config-ap-model)
Syntax and Type Parameters (if any) Description
ruckus(config-ap-model)# do
Type: Privileged
Executes the do command.
ruckus(config-zone-ap-model)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-zone-ap-model)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-model)# ext-ant
Type: Privileged
2.4g <number>
2.4gg <number> [ 3 | 2 ]
5g <number>
5gg <number> [ 2 | 3 ]
Sets the external antenna.
Table 12. Commands related to ruckus(config-ap-group-port)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 51
ruckus(config-zone-ap-model)#
help
Type: Privileged
Displays the help.
ruckus(config-ap-model)# internal-
heater
Type: Privileged
Enables international heater.
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
Sets the LAN configurations from
1 to 5.
ruckus(config-ap-model)# led
Type: Privileged
Enables the status of led.
ruckus(config-ap-model)# led-
mode
Type: Privileged
Sets the led mode description.
ruckus(config-ap-model)# lldp
Type: Privileged
Enables the Link Layer Discovery
Protocol (LLDP).
ruckus(config-ap-model)# lldp-ad-
interval
Type: Privileged
<seconds> Sets the LLDP advertise interval.
ruckus(config-ap-model)# lldp-
hold-time
Type: Privileged
<seconds> Sets the LLDP hold time.
ruckus(config-ap-model)# lldp-
mgmt
Type: Privileged
Enables the LLDP management IP
TLV.
Table 13. Commands related to (config-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 52
Table 14 lists the related ap-model-lan1 configuration commands.
ruckus(config-ap-model)# no
Type: Privileged
ext-ant
internal-heater
lan1
lan2
lan3
lan4
lan5
led
lldp
lldp-mgmt
poe-out-port
radio-band
Disables or deletes the settings
that have been configured.
ruckus(config-ap-model)# poe-
out-port
Type: Privileged
Enables the PoE out port.
ruckus(config-ap-model)# radio-
band
Type: Privileged
${value} Switches the radio band.
Table 14. Commands related to ruckus(config-ap-model-lan1)
Syntax and Type Parameters (if any) Description
ruckus(config-ap-model-lan1)#
8021x
Type: Privileged
<8021x-type> Sets the 802.1x.
ruckus(config-ap-model-lan1)#
acct-service
Type: Privileged
<acct-service> Sets the accounting service
configurations.
ruckus(config-ap-model-lan1)#
auth-service
Type: Privileged
<auth-service> Sets the authentication service
configurations.
Table 13. Commands related to (config-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 53
ruckus(config-ap-model-lan1)# do
Type: Privileged
Executes the do command.
ruckus(config-ap-model-lan1)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ap-model-lan1)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-model-lan1)#
help
Type: Privileged
Displays the help.
ruckus(config-ap-model-lan1)#
mac-bypass
Type: Privileged
Sets the MAC authentication
bypass.
ruckus(config-ap-model-lan1)#
members
Type: Privileged
<members> Sets the members.
ruckus(config-ap-model-lan1)# no
Type: Privileged
acct-service
mac-bypass
Disables or deletes the settings
that have been configured.
ruckus(config-ap-model-lan1)#
supplicant
Type: Privileged
mac
custom <username>
<password>
Sets the supplicant.
ruckus(config-ap-model-lan1)#
type
Type: Privileged
[ trunk-port | access-port |
general-port ]
Sets the port type.
ruckus(config-ap-model-lan1)#
vlan-untag-id
Type: Privileged
<vlan-untag-id> Sets the VLAN untag ID.
Table 14. Commands related to ruckus(config-ap-model-lan1)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-heartbeat
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 54
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 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)#
Configuration Commands
ap-portal-cert
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 55
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) Description
ruckus(config-ap-portal-cert)# do
Type: Privileged
Executes the do command.
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
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-portal-cert)#
generate-csr
Type: Privileged
<ftp-url>
FTP URL, format: ftp:/
<username>:<password
>@<ftp-host>[/<dir-
path>]
Generates the certificate signing
request.
ruckus(config-ap-portal-cert)#
help
Type: Privileged
Displays the help.
ruckus(config-ap-portal-cert)#
upload-cert
Type: Privileged
<ftp-url>
FTP URL, format: ftp:/
<username>:<password
>@<ftp-host>[/<dir-
path>]
Uploads the certificate.
Configuration Commands
ap-portal-cert
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 56
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-cert-
generate-csr)# city
Type: Privileged
<city> Sets the city name.
ruckus(config-ap-portal-cert-
generate-csr)# common-name
Type: Privileged
<name> Sets the domain name.
ruckus(config-ap-portal-cert-
generate-csr)# country
Type: Privileged
<country> Sets the county.
ruckus(config-ap-portal-cert-
generate-csr)# email
Type: Privileged
<email> Sets the email address.
ruckus(config-ap-portal-cert-
generate-csr)# organization
Type: Privileged
<organization> Sets the organization name.
ruckus(config-ap-portal-cert-
generate-csr)# state
Type: Privileged
<state> Sets the state name.
ruckus(config-ap-portal-cert-
generate-csr)# unit
Type: Privileged
<unit> Sets the unit name.
Configuration Commands
ap-root-ca
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 57
ap-root-ca
To update the AP root CA, use the following command:
ruckus(config)# ap-root-ca <ftp-url>
Syntax Description
This command uses the following syntax:
ftp-url: AP Root CA file, FTP URL Format: ftp://<username>:<password>@<ip>/
<file-path>)
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
Configuration Commands
bonjour-gateway
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 58
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
Configuration Commands
bonjour-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 59
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
Type: Privileged
<text> Sets the description.
ruckus(config-bonjour-policy)# do
Type: Privileged
Executes the do command.
ruckus(config-bonjour-policy)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-bonjour-policy)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-bonjour-policy)#
help
Type: Privileged
Displays the help.
ruckus(config-bonjour-policy)#
name
Type: Privileged
<name> Sets the bonjour policy name.
ruckus(config-bonjour-policy)# no
rule
Type: Privileged
<priority> Deletes the rules based on the rule
priority.
ruckus(config-bonjour-policy)# rule
Type: Privileged
<priority> Sets the bonjour policy set of rules
based on the rule priority.
Configuration Commands
bonjour-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 60
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-policy-
rule)# bridge-service
Type: Privileged
airdisk
airplay
airport-management
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
Sets the bridge service.
ruckus(config-bonjour-policy-
rule)# do
Type: Privileged
Executes the do command.
ruckus(config-bonjour-policy-
rule)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Configuration Commands
bonjour-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 61
ruckus(config-bonjour-policy-
rule)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-bonjour-policy-
rule)# from-vlan
Type: Privileged
<int> Sets the from VLAN.
ruckus(config-bonjour-policy-
rule)# help
Type: Privileged
Exits from the EXEC.
ruckus(config-bonjour-policy-
rule)# notes
Type: Privileged
<text> Sets the notes.
ruckus(config-bonjour-policy-
rule)# protocol
Type: Privileged
Sets the bridge service when it is
'other'.
ruckus(config-bonjour-policy-
rule)# to-vlan
Type: Privileged
<int> Sets the VLAN.
Table 18. Commands related to ruckus(config-bonjour-policy-rule)
Syntax and Type Parameters (if any) Description
Configuration Commands
changepassword
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 62
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: ruckus1!
New Password:ruckus2!
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
Configuration Commands
cluster-ip-list
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 63
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 <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 <old-ip>:<new-ip> <old-
ip2>:<new-ip2>
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
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 64
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 config-
uration commands.
•Table 25 lists the related common-settings-ap-model-lan1 configuration
commands.
•Table 26 lists the commands related config-common-settings-ap-tunnel-
settings 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.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 65
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)#
adj-threshold
Type: Privileged
2.4g ${value}
5g ${value}
Value is minimum = 1 and
maximum = 100
Sets the adjacent radio threshold
of the client load balancing.
ruckus(config-common-settings)#
ap-firmware
Type: Privileged
<ap-firmware> Sets the AP firmware version.
ruckus(config-common-settings)#
ap-logon
Type: Privileged
<logon-id> Sets the access point
administration login credentials.
ruckus(config-common-settings)#
ap-model
Type: Privileged
<ap-model> Sets the model specification.
ruckus(config-common-settings)#
ap-password
Type: Privileged
<password> Sets the access point
administrative password.
ruckus(config-common-settings)#
ap-reboot-timeout
Type: Privileged
default-gateway <hours>:
Sets the default gateway
timeout in hours.
control-gateway [ <hours
and minutes> ] Sets the
control gateway timeout in
hours and minutes.
Sets the AP reboot timeout.
ruckus(config-common-settings)#
ap-tunnel-settings
Type: Privileged
Sets the access point tunnel
settings.
ruckus(config-common-settings)#
background-scan
Type: Privileged
2.4g <seconds>
5g <seconds>
Sets the background scanning.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 66
ruckus(config-common-settings)#
band-balancing
Type: Privileged
2.4g <int>
2.4G band
<int>: Percentage of
clients on 2.4G band
Sets the band balance.
ruckus(config-common-settings)#
channel
Type: Privileged
2.4g ${value}
5g indoor ${value}
5g outdoor ${value}
Sets the channel.
ruckus(config-common-settings)#
channelization
Type: Privileged
2.4g [ 20 | 40 ]
5g [ 40 | 20 ]
Sets the channelization.
ruckus(config-common-settings)#
client-admission-control
Type: Privileged
2.4g
5g
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)
Enables the client admission
control.
..................continued
Table 19. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 67
ruckus(config-common-settings)#
client-admission-control
Type: Privileged
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)
Enables the client admission
control.
ruckus(config-common-settings)#
country-code
Type: Privileged
<country-code> Sets the country code.
ruckus(config-common-settings)#
do
Type: Privileged
Executes the do command.
ruckus(config-common-settings)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-common-settings)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-settings)#
headroom
Type: Privileged
2.4g <client>
5g: 5 GHz radio
Sets the headroom (number of
client) of the client load balancing.
ruckus(config-common-settings)#
help
Type: Privileged
Displays the help.
ruckus(config-common-settings)#
indoor-channel
Type: Privileged
Enables the indoor channels.
Table 19. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 68
ruckus(config-common-settings)#
lbs
Type: Privileged
Enables the location based
service.
ruckus(config-common-settings)#
lbs-service
Type: Privileged
Sets the location based service.
ruckus(config-common-settings)#
load-balancing
Type: Privileged
2.4g
5g
Sets the client load balancing.
ruckus(config-common-settings)#
mesh
Type: Privileged
Enables mesh networking.
ruckus(config-common-settings)#
mesh-name
Type: Privileged
<name> Sets the mesh name (ESSID).
ruckus(config-common-settings)#
mesh-passphrase
Type: Privileged
<passphrase> Sets the mesh passphrase.
ruckus(config-common-settings)#
mesh-uplink-selection
Type: Privileged
[ dynamic | static ]
dynamic: Use dynamic
link metrics for automatic
mesh uplink selection.
static: Use static link
metrics for automatic
mesh uplink selection.
Sets the mesh uplink auto
selection.
Table 19. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 69
ruckus(config-common-settings)#
no
Type: Privileged
background-scan
band-balancing
client-admission-control
indoor-channel
lbs
load-balancing
mesh
roam
smart-mon
smart-roam-disconnect-
event
syslog-enabled
timezone-dst
Disables or deletes various sub
command.
ruckus(config-common-settings)#
roam
Type: Privileged
2.4g
5g
Sets the smart roam.
ruckus(config-common-settings)#
rouge-ap-detection
Type: Privileged
[ disable | enable ] -
Disables or enables rogue
access points
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
Sets the report rouge access
point.
...........................continued
Table 19. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 70
ruckus(config-common-settings)#
rouge-ap-detection
Type: Privileged
report-same-network [
enable | disable ] - Enables
or disables malicious
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
Sets the report rouge access
point.
ruckus(config-common-settings)#
smart-mon
Type: Privileged
interval <value>
threshold <value>
Sets the smart monitor interval.
ruckus(config-common-settings)#
smart-roam-disconnect-event
Type: Privileged
Enables smart roam disconnect
event.
ruckus(config-common-settings)#
syslog-enabled
Type: Privileged
Enables the external syslog server
for APs for the specified zone.
ruckus(config-common-settings)#
syslog-facility
Type: Privileged
[Local6 | Keep Original |
Local0 | Local5 | Local7 |
Local1 | Local4 | Local3 |
Local2]
Sets the syslog server facility,
ruckus(config-common-settings)#
syslog-ip
Type: Privileged
<ip> Sets the IP address for the syslog
server.
ruckus(config-common-settings)#
syslog-port
Type: Privileged
<port> Sets the port number for the
syslog server.
Table 19. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 71
ruckus(config-common-settings)#
syslog-priority
Type: Privileged
[ Alert | Info | Critical |
Warning | Notice |
Emergency | All | Error ]
Sets the syslog server priority.
ruckus(config-common-settings))#
timezone
Type: Privileged
System - Follows the SZ
time zone setting
System [ <time zone> ]
Select the time zone from
system database
User-defined [ <time zone
abbr.> ]
User defined time zone
Time zone abbreviation
(example: GMT, CST, EST)
Sets the timezone for zone.
ruckus(config-common-settings))#
timezone-dst
Type: Privileged
[ <Start | End> ] <order>
<weekday> <month>
<hour>
Sets the user defined timezone for
daylight savings.
ruckus(config-common-settings)#
timezone-gmt-offset
Type: Privileged
[ <hour | hour: minute>]
For example, 8, -7:45
Sets the user defined timezone for
GMT offset.
ruckus(config-common-settings)#
tx-power
Type: Privileged
2.4g ${value}
5g ${value}
Value is minimum = 1 and
maximum = 100
Sets the TX power adjustment.
ruckus(config-common-settings)#
weak-bypass
Type: Privileged
2.4g ${value}
5g ${value}
Value is minimum = 1 and
maximum = 100
Sets the weak bypass threshold of
the client load balancing.
Table 19. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 72
Table 20 lists the related common-settings-aaa configuration commands.
Table 20. Commands related ruckus(config-common-settings-aaa)
Syntax and Type Parameters (if any) Description
ruckus(config-settings-aaa)#
admin-domain
Type: Privileged
Enables the admin domain name.
ruckus(config-settings-aaa)#
admin-domain-name
Type: Privileged
<admin-domain> Creates or updates the admin
domain name.
ruckus(config-settings-aaa)#
admin-password
Type: Privileged
<admin-password> Creates or updates the admin
password.
ruckus(config-settings-aaa)#
backup
Type: Privileged
ip <ip>: Sets the IP
address of secondary
RADIUS server.
port <port>: Sets the port
of secondary RADIUS
server.
shared-secret: Sets the
shared secret of
secondary RADIUS
server.
Enables backup of RADIUS
support and set related settings.
ruckus(config-settings-aaa)#
base-domain
Type: Privileged
<base-domain> Set the base domain.
ruckus(config-settings-aaa)#
description
Type: Privileged
<description> Sets the description.
ruckus(config-settings-aaa)# do
Type: Privileged
Executes the do command.
ruckus(config-settings-aaa)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 73
ruckus(config-settings-aaa)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-settings-aaa)# help
Type: Privileged
Displays the help.
ruckus(config-settings-aaa)#
global-catalog
Type: Privileged
Enables the global catalog
support.
ruckus(config-settings-aaa)# ip
Type: Privileged
<ip> Sets the IP addresses of the
primary RADIUS server.
ruckus(config-settings-aaa)# key-
attribute
Type: Privileged
<key-attribute> Sets the key attributes for the
primary RADIUS server.
ruckus(config-settings-aaa)# no
Type: Privileged
backup
global-catalog
no-response-fail
Disables or deletes configuration
settings.
ruckus(config-settings-aaa)# no-
response-fail
Type: Privileged
Enables no response fail.
ruckus(config-settings-aaa)#
password
Type: Privileged
<password> Sets the password for the primary
RADIUS server.
ruckus(config-settings-aaa)# port
Type: Privileged
<port> Sets the port number of the
primary RADIUS server.
ruckus(config-settings-aaa)#
response-window
Type: Privileged
<seconds> Sets the response window.
ruckus(config-settings-aaa)#
revive-interval
Type: Privileged
<seconds> Sets the revive interval.
Table 20. Commands related ruckus(config-common-settings-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 74
ruckus(config-settings-aaa)#
search-filter
Type: Privileged
<search-filter> Sets the search filter.
ruckus (config-settings-aaa)#
shared-secret
Type: Privileged
<shared-secret> Sets the shared secret of the
primary RADIUS server.
ruckus(config-settings-aaa)# test
Type: Privileged
<username> <password> Tests the connectivity of the AAA
server.
ruckus(config-settings-aaa)# type
Type: Privileged
[ radius | radius-acct |
LDAP | AD ]
radius: RADIUS type
radius-acct: RADIUS
accounting type
LDAP: LDAP
AD: Active Directory
Sets the RADIUS type.
ruckus(config-settings-aaa)#
windows-domain
Type: Privileged
<windows-domain> Sets the windows domain name.
ruckus(config-settings-aaa)#
zombie-period
Type: Privileged
<seconds> Sets the zombie period.
Table 20. Commands related ruckus(config-common-settings-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 75
Table 21 lists the related common-settings-ap-group configuration commands.
Table 21. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-group)# channel
Type: Privileged
2.4g ${value}
5g indoor ${value}
5g outdoor ${value}
Sets the channel.
ruckus(config-common-settings-
ap-group)# channelization
Type: Privileged
2.4g [ 20 | 40 ]
5g [ 40 | 20 ]
Sets the channelization.
ruckus(config-common-settings-
ap-group)# client-admission-
control
Type: Privileged
2.4g
5g
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)
Enables the client admission
control.
.................continued
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 76
ruckus(config-common-settings-
ap-group)# client-admission-
control
Type: Privileged
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)
Enables the client admission
control.
ruckus(config-common-settings-
ap-group)# description
Type: Privileged
<text> 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)#
help
Type: Privileged
Displays the help.
Table 21. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 77
ruckus(config-common-settings-
ap-group)# external-antenna
Type: Privileged
<ap-model> 5g [ disable |
enable ]
<ap-model> 5g gain
<gain>
<ap-model> 5g [ 3-
antennas | 2-antennas ]
<ap-model> 2.4g gain
<gain>
<ap-model> 2.4g [ enable
| disable ]
<ap-model> 2.4g [ 2-
antennas | 3-antennas ]
Sets the external antenna for
specific AP model.
ruckus(config-common-settings-
ap-group)# internal-heater
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the internal heater for specific
AP model.
ruckus(config-common-settings-
ap-group)# lbs
Type: Privileged
Enables the location based
service.
ruckus(config-common-settings-
ap-group)# lbs-service
Type: Privileged
Sets the location based service.
ruckus(config-common-settings-
ap-group)# led-mode
Type: Privileged
<ap-model> Sets the LED mode for specific AP
model.
ruckus(config-common-settings-
ap-group)# lldp
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the LLDP for a specific AP
model.
Table 21. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 78
ruckus(config-common-settings-
ap-group)# member
Type: Privileged
add <ap-mac>
move-to <name> <mac>
remove <mac>
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.
ruckus(config-common-settings-
ap-group)# no
Type: Privileged
channel 2.4g
channel 5g indoor
channel 5g outdoor
channelization 2.4g
channelization 5g
client-admission-control
description
external-antenna <ap-
model> 5g
external-antenna <ap-
model> 2.4g
internal heater
Disables / deletes the
configuration settings.
..................continued
Table 21. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 79
ruckus(config-common-settings-
ap-group)# no
Type: Privileged
lbs
led-mode
lldp
override-client-
admission-control
override-lbs
poe-out
poe-port
port-setting
radio-band
status-led
tx-power 2.4g
tx-power 5g
wlan-group 2.4g
wlan-group 5g
Disables / deletes the
configuration settings.
ruckus(config-common-settings-
ap-group)# override-client-
admission-control
Type: Privileged
2.4g
5g
Overrides the client admission
control settings.
ruckus(config-common-settings-
ap-group)# override-lbs
Type: Privileged
Overrides the location based
service to zone settings.
ruckus(config-common-settings-
ap-group)# poe-out
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the PoE out port for a specific
AP model.
ruckus(config-common-settings-
ap-group)# port-setting
Type: Privileged
<ap-model> Sets the port settings for specific
AP model.
ruckus(config-common-settings-
ap-group)# radio-band
Type: Privileged
${value} Switches the radio band for a
specific AP model.
Table 21. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 80
Table 22 lists the related ap-group-lldp configuration commands.
ruckus(config-common-settings-
ap-group)# status-leds
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the status LED for specific AP
model.
ruckus(config-common-settings-
ap-group)# tx-power
Type: Privileged
2.4g ${value}
5g ${value}
Sets the TX power adjustment.
ruckus(config-common-settings-
ap-group)# wlan-group
Type: Privileged
2.4g
5g
Sets the WLAN group
configurations.
Table 22. Commands related to ruckus(config-ap-group-lldp)
Syntax and Type Parameters (if any) Description
ruckus(config-ap-group-lldp)#
lldp-ad-interval
Type: Privileged
<seconds> Sets the LLDP advertise interval in
seconds from the range 1 to 300.
ruckus(config-ap-group-lldp)#
lldp-hold-time
Type: Privileged
<seconds> Sets the LLDP hold time in
seconds from the range 60 to
1200.
ruckus(config-ap-group-lldp)#
lldp-mgmt
Type: Privileged
[ enable | disable ] Enables or disables the LLDP
management IP TLV.
Table 21. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 81
Table 23 lists the related ap-group-port-setting configuration commands.
Table 23. Commands related to ruckus(config-ap-group-port-setting)
Syntax and Type Parameters (if any) Description
ruckus(config-ap-group-port-
setting)# do
Type: Privileged
Executes the do command.
ruckus(config-ap-group-port-
setting)# dot1x
Type: Privileged
authsvr [ <authenticator
server name> ]
accsvr <name>
mac-auth-bypass [ true |
false ]
supplicant user-name [
<user name> password
<password>
supplicant mac
Sets the 802.1x role.
ruckus(config-ap-group-port-
setting)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ap-group-port-
setting)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ap-group-port-
setting)# help
Type: Privileged
Displays the help.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 82
Table 24 lists the commands related config-common-settings-ap-model configura-
tion commands.
ruckus(config-ap-group-port-
setting)# lan
Type: Privileged
<port>
<port> uplink [ general |
access | trunk ]
<port> untag <vlan>
<port> member <vlan-
members>
<port> dot1x [ auth-mac-
based | disabled | auth-
port-based | supplicant ]
Enables or disable specific port.
ruckus(config-ap-group-port-
setting)# no
Type: Privileged
dot1x accsvr
lan <port>
Disables or deletes the
configuration settings.
Table 24. Commands related to (config-config-common-settings-ap-model)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-model)# do
Type: Privileged
Executes the do command.
ruckus(config-common-settings-
ap-model)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-common-settings-
ap-model)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-settings-
ap-model)# help
Type: Privileged
Displays the help.
Table 23. Commands related to ruckus(config-ap-group-port-setting)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 83
ruckus(config-common-settings-
ap-model)# ext-ant
Type: Privileged
2.4g <number>
2.4gg <number> [ 3 | 2 ]
3 antennas
2 antennas
5g <number>
5gg <number> [ 2 | 3 ]
2 antennas
3 antennas
Sets the external antenna.
ruckus(config-common-settings-
ap-model)# internal-heater
Type: Privileged
Enables international heater.
ruckus(config-common-settings-
ap-model)# lan1
ruckus(config-common-settings-
ap-model)# lan2
ruckus(config-common-settings-
ap-model)# lan3
ruckus(config-common-settings-
ap-model)# lan4
ruckus(config-common-settings-
ap-model)# lan5
Type: Privileged
Sets the LAN configurations from
1 to 5.
ruckus(config-common-settings-
ap-model)# led
Type: Privileged
Enables the status of led.
ruckus(config-common-settings-
ap-model)# led-mode
Type: Privileged
Sets the led mode description.
ruckus(config-common-settings-
ap-model)# lldp
Type: Privileged
Enables the Link Layer Discovery
Protocol (LLDP).
Table 24. Commands related to (config-config-common-settings-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 84
ruckus(config-common-settings-
ap-model)# lldp-ad-interval
Type: Privileged
<seconds> Sets the LLDP advertise interval.
ruckus(config-common-settings-
ap-model)# lldp-hold-time
Type: Privileged
<seconds> Sets the LLDP hold time.
ruckus(config-common-settings-
ap-model)# lldp-mgmt
Type: Privileged
Enables the LLDP management IP
TLV.
ruckus(config-common-settings-
ap-model)# no
Type: Privileged
ext-ant
internal-heater
lan1
lan2
lan3
lan4
lan5
led
lldp
lldp-mgmt
poe-out-port
radio-band
Disables or deletes the settings
that have been configured.
ruckus(config-common-settings-
ap-model)# poe-out-port
Type: Privileged
Enables the PoE out port.
ruckus(config-common-settings-
ap-model)# radio-band
Type: Privileged
${value} Switches the radio band.
Table 24. Commands related to (config-config-common-settings-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 85
Tabl e 25 lists the related common-settings-ap-model-lan1 configuration commands.
Table 25. Commands related to ruckus(config-common-settings-ap-model-lan1)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-model-lan1)# 8021x
Type: Privileged
<8021x-type> Sets the 802.1x.
ruckus(config-common-settings-
ap-model-lan1)# acct-service
Type: Privileged
<acct-service> Sets the accounting service
configurations.
ruckus(config-common-settings-
ap-model-lan1)# auth-service
Type: Privileged
<auth-service> Sets the authentication service
configurations.
ruckus(config-common-settings-
ap-model-lan1)# do
Type: Privileged
Executes the do command.
ruckus(config-common-settings-
ap-model-lan1)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-common-settings-
ap-model-lan1)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-settings-
ap-model-lan1)# help
Type: Privileged
Displays the help.
ruckus(config-common-settings-
ap-model-lan1)# mac-bypass
Type: Privileged
Sets the MAC authentication
bypass.
ruckus(config-common-settings-
ap-model-lan1)# members
Type: Privileged
<members> Sets the members.
ruckus(config-common-settings-
ap-model-lan1)# no
Type: Privileged
acct-service
mac-bypass
Disables or deletes the settings
that have been configured.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 86
Table 26 lists the commands related config-common-settings-ap-tunnel-settings
configuration commands.
ruckus(config-common-settings-
ap-model-lan1)# supplicant
Type: Privileged
mac
custom <username>
<password>
Sets the supplicant.
ruckus(config-common-settings-
ap-model-lan1)# type
Type: Privileged
[ trunk-port | access-port |
general-port ]
Sets the port type.
ruckus(config-common-settings-
ap-model-lan1)# vlan-untag-id
Type: Privileged
<vlan-untag-id> Sets the VLAN untag ID.
Table 26. Commands related to (config-config-common-settings-ap-tunnel-settings)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-tunnel-settings)# gateway
<ip> [ primary | secondary
]
<ip>: Gateway address
primary: Primary gateway
address
secondary: Secondary
gateway address
Sets the gateway address.
ruckus(config-common-settings-
ap-tunnel-settings)# icmp-retry
Type: Privileged
<retryTimes> Sets the ICMP keep alive retry.
ruckus(config-common-settings-
ap-tunnel-settings)# do
Type: Privileged
Executes the do command.
ruckus(config-common-settings-
ap-tunnel-settings# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Table 25. Commands related to ruckus(config-common-settings-ap-model-lan1)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 87
ruckus(config-common-settings-
ap-tunnel-settings)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-settings-
ap-tunnel-settings)# help
Type: Privileged
Displays the help.
ruckus(config-common-settings-
ap-tunnel-settings)# no
Type: Privileged
gateway <seconds>
tunnel-encryption
tunnel-mtu
Disables various configuration
settings.
ruckus(config-common-settings-
ap-tunnel-settings)# tunnel-
encryption
Type: Privileged
Enables the tunnel encryption.
ruckus(config-common-settings-
ap-tunnel-settings)# tunnel-mode
Type: Privileged
[ gre | gre-udp ]
gre: GRE
gre-udp: GRE+UDP
(Support for APs behind
NAT.)
Sets the Ruckus tunnel mode.
ruckus(config-common-settings-
ap-tunnel-settings)# tunnel-mtu
Type: Privileged
auto: Enables auto
discovery
<manually-size>: Manual
size is between 850 and
1500
Sets the tunnel MTU.
ruckus(config-common-settings-
ap-tunnel-settings)# tunnel-type
Type: Privileged
[ ruckus-gre | soft-gre ]
ruckus-gre: Ruckus GRE
soft-gre: Soft GRE
Sets the tunnel type.
ruckus(config-common-settings-
ap-tunnel-settings)# udp-port
Type: Privileged
Sets the data plane UDP port.
Table 26. Commands related to (config-config-common-settings-ap-tunnel-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 88
Table 27 lists the related common-settings-guest-access configuration commands.
Table 27. Commands related to ruckus (config-common-settings-guest-access)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
guest-access)# description
Type: Privileged
<text> Sets the description.
ruckus(config-common-settings-
guest-access)# enable-terms-and-
conditions
Type: Privileged
Enables the web portal terms and
conditions.
ruckus(config-common-settings-
guest-access)# grace-period
Type: Privileged
<minutes> Sets the grace period.
ruckus(config-common-settings-
guest-access)# language
Type: Privileged
Sets the language.
ruckus(config-common-settings-
guest-access)# no
Type: Privileged
enable-terms-and-
conditions
sms-gateway
terms-and-conditions
Disables the various options.
ruckus(config-common-settings-
guest-access)# session-timeout
Type: Privileged
<minutes> Sets the session timeout as per
the specified minutes.
ruckus(config-common-settings-
guest-access)# sms-gateway
Type: Privileged
Sets the guest pass for the SMS
gateway.
ruckus(config-common-settings-
guest-access)# start-page
Type: Privileged
original
redirect <start-url>:
Redirects to the specified
URL
Sets the start page.
ruckus(config-common-settings-
guest-access)# terms-and-
conditions
Type: Privileged
Sets the terms and conditions for
the web portal.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 89
Table 28 lists the related common-settings-hotspot configuration commands.
ruckus(config-common-settings-
guest-access)# title
Type: Privileged
Sets the title for the web portal.
Table 28. Commands related to ruckus(config-common-settings-hotspot)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
hotspot)# description
Type: Privileged
<text> Sets the description.
ruckus(config-common-settings-
hotspot)# do
Type: Privileged
Executes the do command.
ruckus(config-common-settings-
hotspot)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-common-settings-
hotspot)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-settings-
hotspot)# help
Type: Privileged
Displays the help.
ruckus(config-common-settings-
hotspot)# grace-period
Type: Privileged
<minutes> Sets the grace period.
ruckus(config-common-settings-
hotspot)# location-id
Type: Privileged
<location-id> Sets the location ID.
ruckus(config-common-settings-
hotspot)# location-name
Type: Privileged
<name> Sets the location name.
Table 27. Commands related to ruckus (config-common-settings-guest-access)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 90
ruckus(config-common-settings-
hotspot)# logon-url
Type: Privileged
internal
external <logon-url> -
Redirects
unauthenticated user to
the URL for authentication
Sets the logon URL.
ruckus(config-common-settings-
hotspot)# no
Type: Privileged
walled-garden <walled-
garden-list>
Disables the accounting server /
walled-garden list options.
ruckus(config-common-settings-
hotspot)# session-timeout
Type: Privileged
<minutes> Sets the sessions timeout.
ruckus(config-common-settings-
hotspot)# smart-client-support
Type: Privileged
none
enable
only <instructions>
Sets the smart client support.
ruckus(config-common-settings-
hotspot)# start-page
Type: Privileged
original
redirect <start-url>
Sets the start page.
ruckus(config-common-settings-
hotspot)# walled-garden
Type: Privileged
<walled-garden-list> Enables Walled Garden. Allows
unauthorized destinations.
Comma-separated IP, IP range,
CIDR and regular expression
domain name list
Table 28. Commands related to ruckus(config-common-settings-hotspot)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 91
Table 29 lists the related common-settings-web-authentication configuration
commands.
Table 30 lists the related common-settings-wlan configuration commands.
Table 29. Commands related to ruckus (config-common-settings-web-authentication)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
web-authentication)# description
Type: Privileged
<text> Sets the description.
ruckus(config-common-settings-
web-authentication)# grace-period
Type: Privileged
<minutes> Sets the grace period.
ruckus(config-common-settings-
web-authentication)# language
Type: Privileged
Sets the language.
ruckus(config-common-settings-
web-authentication)# session-
timeout
Type: Privileged
<minutes> Sets the session timeout as per
the specified minutes.
ruckus(config-common-settings-
web-authentication)# start-page
Type: Privileged
original
redirect <start-url>
Sets the start page.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
wlan)# access-network
Type: Privileged
Enables tunnel WLAN traffic to the
SZ.
ruckus(config-common-settings-
wlan)# acct-delay-time
Type: Privileged
Enables the acct-delay time.
ruckus(config-common-settings-
wlan)# acct-interval
Type: Privileged
<minutes> Set the authentication service.
Enables accounting interval to
send interim updates.
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 92
ruckus(config-common-settings-
wlan)# acct-service
Type: Privileged
<name> Sets the accounting service.
ruckus(config-common-settings-
wlan)# acct-service-use-proxy
Type: Privileged
Set the accounting service: Uses
the SZ as proxy.
ruckus(config-common-settings-
wlan)# acct-ttg-session
Type: Privileged
Sets the accounting service.
Enables accounting for TTG
sessions.
ruckus(config-common-settings-
wlan)# auth-method
Type: Privileged
<name> Sets the authentication method.
ruckus(config-common-settings-
wlan)# auth-service
Type: Privileged
<name> Sets the authentication service.
ruckus(config-common-settings-
wlan)# auth-service-use-proxy
Type: Privileged
Sets the authentication service.
Enables accounting for TTG
sessions.
ruckus(config-common-settings-
wlan)# auth-type
Type: Privileged
Sets the authentication type.
ruckus(config-common-settings-
wlan)# bss-minrate
Type: Privileged
[ 5.5mbps | 24mbps |
12mbps | 1mbps | 2mbps
]
Sets the BSS minimum rate.
ruckus(config-common-settings-
wlan)# called-sta
Type: Privileged
Sets the called STA ID.
ruckus(config-common-settings-
wlan)# client-fingerprinting
Type: Privileged
Sets the client fingerprinting.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 93
ruckus(config-common-settings-
wlan)# client-tx-rx-statistics
Type: Privileged
Enables ignore statistics from
unauthorized clients.
ruckus(config-common-settings-
wlan)# description
Type: Privileged
<text> Sets the description.
ruckus(config-common-settings-
wlan)# device-policy
Type: Privileged
[ <policy name> ] Sets the device policy.
ruckus(config-common-settings-
wlan)# dgaf
Type: Privileged
Disables downstream group-
address frame forwarding.
ruckus(config-common-settings-
wlan)# dhcp-option-82
Type: Privileged
Enables DHCP option 82.
ruckus(config-common-settings-
wlan)# dhcp-option-82-format
Type: Privileged
[ ruckus-gre | soft-gre ] Enables DHCP option 82 format
options.
ruckus(config-common-settings-
wlan)# disable-band-balancing
Type: Privileged
Disables radio band balancing on
WLAN.
ruckus(config-common-settings-
wlan)# disable-load-balancing
Type: Privileged
Disables client load balancing on
WLAN.
ruckus(config-common-settings-
wlan)# disable-wlan
Type: Privileged
Disables this WLAN service.
ruckus(config-common-settings-
wlan)# dnlink-limit
Type: Privileged
Sets the downlink rate limiting.
ruckus(config-zone-wlan)# do
Type: Privileged
Executes the do command.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 94
ruckus(config-zone-wlan)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-zone-wlan)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-zone-wlan)# help
Type: Privileged
Displays the help.
ruckus(config-common-settings-
wlan)# enable-type
Type: Privileged
Enables the WLAN service type.
ruckus(config-common-settings-
wlan)# enc-algorithm
Type: Privileged
Sets the encryption algorithm.
ruckus(config-common-settings-
wlan)# enc-method
Type: Privileged
Sets the encryption method.
ruckus(config-common-settings-
wlan)# enc-passphrase
Type: Privileged
<password> Sets the encryption passphrase.
ruckus(config-common-settings-
wlan)# enc-wep-key
Type: Privileged
<wep-key-index> <wep-
key>
WEP key (HEX), length
should be 10 (WEP-64) or
26 (WEP-128)
Sets WEP key (HEX).
ruckus(config-common-settings-
wlan)# force-dhcp
Type: Privileged
timeout <seconds>
timeout: Sets the
disconnect client timeout
interval
<seconds>: Sets the
disconnect client timeout
in intervals of 5 - 15
seconds
Sets the timeout for DHCP in
seconds.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 95
ruckus(config-common-settings-
wlan)# guest-access
Type: Privileged
<name> Sets the guest access service.
ruckus(config-common-settings-
wlan)# guest-access-auth-service
Type: Privileged
Sets the authentication server.
ruckus(config-common-settings-
wlan)# hide-ssid
Type: Privileged
Hides SSID in beacon broadcast.
ruckus(config-common-settings-
wlan)# hotspot
Type: Privileged
<name> Sets the hotspot service.
ruckus(config-common-settings-
wlan)# hotspot2
Type: Privileged
<name> Sets the hotspot 2.0 configuration.
ruckus(config-common-settings-
wlan)# inactivity-timeout
Type: Privileged
<number> Sets the inactivity timeout.
Terminates idle user sessions after
the specified seconds of inactivity.
ruckus(config-common-settings-
wlan)# l2-acl
Type: Privileged
[ <ACL name> ] Sets the layer 2 access control list.
ruckus(config-common-settings-
wlan)# mac-802-11x-format
Type: Privileged
Sets the MAC authentication. Sets
the MAC address in 802.1X
format.
ruckus(config-common-settings-
wlan)# mac-auth
Type: Privileged
<password> Sets the MAC authentication.
ruckus(config-common-settings-
wlan)# max-clients
Type: Privileged
<number> Sets the maximum clients. Allows
clients per AP radio to associate
with this WLAN. Range is between
1 and 512.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 96
ruckus(config-common-settings-
wlan)# mgmt-tx-rate
Type: Privileged
[ 5.5mbps | 48mbps |
6mbps | 2mbps | 36mbps
| 1mbps | 18mbps |
12mbps | 54mbps |
9mbps | 11mbps |
24mbps ]
Sets the management Tx rates.
ruckus(config-common-settings-
wlan)# no
Type: Privileged
access-network
acct-delay-time
acct-service
acct-service-use-proxy
acct-ttg-session
auth-service-use-proxy
bss-minrate
client-fingerprinting
client-tx-rx-statistics
device-policy
dgaf
dhcp-option-82
disable-band-balancing
disable-load-balancing
disable-wlan
dnlink-limit
force-dhcp
hide-ssid
l2-acl
mac-802-11x-format
mac-auth
ofdm-only
onboarding-auth-service-
use-proxy
Disables or deletes the
configurations that have been set.
....................................continued
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 97
ruckus(config-common-settings-
wlan)# no
Type: Privileged
uplink-limit
user-traffic-profile
vlan-enabled
wireless-client-isolation
zero-it-activation
zero-it-onboarding
Disables or deletes the
configurations that have been set.
ruckus(config-common-settings-
wlan)# ofdm-only
Type: Privileged
Enables OFDM only.
ruckus(config-common-settings-
wlan)# onboarding-auth-service
Type: Privileged
<name> Sets the onboarding
authentication service.
ruckus(config-common-settings-
wlan)# onboarding-auth-service-
use-proxy
Type: Privileged
Sets the onboarding
authentication service using the
SZ proxy server.
ruckus(config-common-settings-
wlan)# priority
Type: Privileged
Sets the priority as either low or
high.
ruckus(config-common-settings-
wlan)# proxy-arp
Type: Privileged
Enables proxy ARP.
ruckus(config-common-settings-
wlan)# radius-nas-id
Type: Privileged
<number> Sets the RADIUS NAS ID.
ruckus(config-common-settings-
wlan)# radius-nas-max-retries
Type: Privileged
<times> Sets the maximum number of
retries for RADIUS NAS.
ruckus(config-common-settings-
wlan)# radius-nas-reconnect-
primary
Type: Privileged
<minutes> Sets the reconnection to the
primary RADIUS NAS.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 98
ruckus(config-common-settings-
wlan)# radius-nas-request-timeout
Type: Privileged
<seconds> Sets the RADIUS NAS request
timeout.
ruckus(config-common-settings-
wlan)# radius-nas-type
Type: Privileged
Sets the RADIUS NAS type.
ruckus(config-common-settings-
wlan)# roam
Type: Privileged
Enables roaming.
ruckus(config-common-settings-
wlan)# roam-factor
Type: Privileged
2.4g <value>
5g <value>
Sets the roam factor.
ruckus(config-common-settings-
wlan)# scheduler
Type: Privileged
[ <Profile name> ] Sets the WLAN scheduler profile.
ruckus(config-common-settings-
wlan)# ssid
Type: Privileged
<ssid> Sets the WLAN SSID
configuration.
ruckus(config-common-settings-
wlan)# support-802-11d
Type: Privileged
Enables support for 802.11d.
ruckus(config-common-settings-
wlan)# uplink-limit
Type: Privileged
Sets the uplink rate limiting.
ruckus(config-common-settings-
wlan)# user-traffic-profile
Type: Privileged
Sets the user traffic profile.
ruckus(config-common-settings-
wlan)# vlan-enabled
Type: Privileged
Enables dynamic VLAN.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 99
Table 31 lists the related common-settings-wlan-group configuration commands.
.
ruckus(config-common-settings-
wlan)# vlan-id
Type: Privileged
<vlan-id> Sets the VLAN ID.
ruckus(config-config-common-
settings-wlan)# web-
authentication
Type: Privileged
<name> Sets the web authentication
service.
ruckus(config-common-settings-
wlan)# wireless-client-isolation
Type: Privileged
Sets the wireless client isolation.
ruckus(config-common-settings-
wlan)# zero-it-activation
Type: Privileged
Enables zero-it activation (WLAN
users are provided with wireless
configuration installer after they log
in).
ruckus(config-common-settings-
wlan)# zero-it-onboarding
Type: Privileged
Enables zero-it device registration
from the guest portal.
Table 31. Commands related to ruckus(config-common-settings-wlan-group)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
wlan-group)# description
Type: Privileged
<text> Sets the description,
ruckus(config-common-settings-
wlan-group)# do
Type: Privileged
Executes the do command.
ruckus(config-common-settings-
wlan-group)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Table 30. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 100
Table 32 lists the related common-settings-wlan-scheduler configuration
commands.
.
ruckus(config-common-settings-
wlan-group)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-settings-
wlan-group)# help
Type: Privileged
Displays the help.
ruckus(config-common-settings-
wlan-group)# no
Type: Privileged
wlan <name> Disables or deletes the
configuration settings.
ruckus(config-common-settings-
wlan-group)# wlan
Type: Privileged
<name> vlan <vlanTag>
nasid <nasid>
<name> nasid <nasid>
vlan <vlanTag>
<name> vlan <vlanTag>
<name> nasid <nasid>
<name>
Sets a WLAN in this group, or
overrides the VLAN setting.
Table 32. Commands related to ruckus (config-common-settings-wlan-scheduler)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
wlan-scheduler)# description
Type: Privileged
<text> Sets the description,
ruckus(config-common-settings-
wlan-scheduler)# schedule-data
Type: Privileged
${state} ${weekday}
${from} ${to}
Sets the schedule table.
Table 31. Commands related to ruckus(config-common-settings-wlan-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
data-plane
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 101
data-plane
To update the dataplane configuration, use the following command:
ruckus(config)# data-plane <name> <<name> forward-stp>
Syntax Description
This command uses the following syntax:
<name>: Name of the dataplane
forward-stp: Disables the STP package bridge
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# data-plane indus4d1
Related Commands
Table 33 lists the related data plane configuration commands
Table 33. Commands related to ruckus(config-data-plane)
Syntax and Type Parameters (if any) Description
ruckus(config-data-plane)# ip
Type: Privileged
route <dest-network>
<network-mask> <next-
hop-ip>
address dhcp
address <ip> <mask>
<gateway>
secondary <ip> <mask>
name-server <ip>
secondary
route <ip> <mask> <ip>
Sets the IP configuration
commands.
Configuration Commands
data-plane
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 102
ruckus(config-data-plane)# no
Type: Privileged
ip secondary
ip name-server secondary
ip route <dest-network>
<network-mask> <nexth-
op-ip>
ip route <ip> <mask>
<ip>
vlan
Disables / deletes options.
ruckus(config-data-plane)# do
Type: Privileged
Executes the do command.
ruckus(config-data-plane)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-data-plane)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-data-plane)# help
Type: Privileged
Displays the help.
ruckus(config-data-plane)# vlan
Type: Privileged
<vlan-id> secondary Updates the VLAN configuration.
Table 33. Commands related to ruckus(config-data-plane)
Syntax and Type Parameters (if any) Description
Configuration Commands
device-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 103
device-policy
To create or update 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)# device-policy dp1
SZ100-Node1(config-device-policy)#
Related Commands
•Table 34 lists the related device policy configuration commands.
•Table 35 lists the related device policy policy rule configuration commands
Table 34 lists the related device policy configuration commands
Table 34. Commands related to ruckus(config-device-policy)
Syntax and Type Parameters (if any) Description
ruckus(config-device-policy)#
default-action
Type: Privileged
[ allow | block ] Sets the default action to either
allow or block.
ruckus(config-device-policy)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-device-policy)# do
Type: Privileged
Executes the do command.
ruckus(config-device-policy)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Configuration Commands
device-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 104
ruckus(config-device-policy)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-device-policy)# help
Type: Privileged
Displays the help.
ruckus(config-device-policy#
name
Type: Privileged
<name> Sets the device policy name.
ruckus(config-device-policy# no
policy-rule
Type: Privileged
<device type>
android
blackberry
gaming
iOS
linux
macOS
printers
voip
windows
Removes the device type with its
policy rules.
ruckus(config-device-policy)#
policy-rule
Type: Privileged
Sets the device policy rule.
Table 34. Commands related to ruckus(config-device-policy)
Syntax and Type Parameters (if any) Description
Configuration Commands
device-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 105
Table 35 lists the related device-policy-policy-rule configuration commands.
Table 35. Commands related to ruckus(config-device-policy-policy rule)
Syntax and Type Parameters (if any) Description
ruckus(config-device-policy-
policy-rule)# action
Type: Privileged
[ allow | block ] Sets the default action to either
allow or block.
ruckus(config-device-policy-
policy-rule)# description
Type: Privileged
<text> Sets the description.
ruckus(config-device-policy-
policy-rule)# do
Type: Privileged
Executes the do command.
ruckus(config-device-policy-
policy-rule)# downlink
Type: Privileged
[ <rate limiting> ]
Rate limiting (mbps)
Sets the downlink rate limiting.
ruckus(config-device-policy-
policy-rule)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-device-policy-
policy-rule)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-device-policy-
policy-rule)# help
Type: Privileged
Displays the help.
ruckus(config-device-policy-
policy-rule)# no vlan
Type: Privileged
Resets the VLAN number.
Configuration Commands
do
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 106
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
ruckus(config-device-policy-
policy-rule)# type
Type: Privileged
<device type>
android
blackberry
gaming
iOS
linux
macOS
printers
voip
windows
Sets the device type.
ruckus(config-device-policy-
policy-rule)# uplink
Type: Privileged
[ <rate limiting>]
Rate limiting (mbps)
Sets the uplink rate limiting.
ruckus(config-device-policy-
policy-rule)# vlan
Type: Privileged
[ <VLAN number>] Sets the VLAN number.
Table 35. Commands related to ruckus(config-device-policy-policy rule)
Syntax and Type Parameters (if any) Description
Configuration Commands
dp-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 107
dp-group
To enable and set 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
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 108
3
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
3 chapters based on the alphabetical order of commands.
Table 36. Configuration commands
encrypt-mac-ip end event event db-
persistence
event email
event snmp-trap event-email exit ftp-server ftp-test
guest-access help hostname hotspot import-zdbackup
interface ip ip name-server ip route l2-acl
lbs-service license license cloud license export license import
license local license sync-
now
lineman logging
console
lwapp2scg
no admin no admin-
radius
no ap no ap auto-
tagging
no ap-cert-check
no ap-control-
mgmt-tos
no ap-group no ap-root-ca no ap-sci no bonjour-
gateway
no bonjour-
policy
no cls-sess no control-
plane
no data-plane no device-policy
no dp-group no encrypt-
mac-ip
no event no ftp-server no guest-access
no ftp-server no interface no ip no lineman no logging
no non-proxy-
aaa
no proxy-aaa no report no role no snmp-trap
no snmp-v2-
community
no snmp-v3-
user
no user-agent-
blacklist
no user-role no user-traffic-
profile
Configuration Commands
encrypt-mac-ip
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 109
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
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.
no web-
authentication
no wlan no wlan-group no wlan-
scheduler
non-proxy-aaa
northbound-
authtype
northbound-
portal
ntp-server proxy-aaa report
role
Table 36. Configuration commands
Configuration Commands
event
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 110
Command Mode
Config
Example
SZ100-Node1(config)# end
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
Table 37 lists the related event configuration commands.
Table 37. Commands related to ruckus(config-event)
Syntax and Type Parameters (if any) Description
ruckus(config-event)# db-
persistence
Type: Privileged
Enables the data blade
persistence for the event.
ruckus(config-event)# do
Type: Privileged
Executes the do command.
ruckus(config-event)# email
Type: Privileged
Enables the email notification.
Configuration Commands
event db-persistence
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 111
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 approby the SmartZone. Informational
Disabled Disabled Enabled
v e d
ruckus(config-event)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-event)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-event)# help
Type: Privileged
Displays the help.
ruckus(config-event)# no
Type: Privileged
db-persistence
email
snmp-trap
Enables the SNMP trap.
ruckus(config-event)# snmp-trap
Type: Privileged
Enables the SNMP trap.
Table 37. Commands related to ruckus(config-event)
Syntax and Type Parameters (if any) Description
Configuration Commands
event email
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 112
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
4 107 AP Communication AP firmware update
failed This event occurs when the AP fails to update its firmware.
Major Enabled Disabled Enabled
s
5 108 AP Communication Updating AP firmware...
This event occurs when AP is updating its firmware. Informational
Disabled Disabled Enabled
6 109 AP Communication Updating AP
configuration... This event occurs when the AP is updating its
configuration. Informational Disabled Disabled Enabled
7 110 AP Communication AP configuration
updated This event occurs when the AP has successfully updated
its configuration Informational Disabled Disabled Enabled
Please choose Event Codes (separated by ',') to enable DB persistence
events:
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
----- ----------- ------------------------ ----------------------
Configuration Commands
event snmp-trap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 113
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:
event snmp-trap
To enable the events to trigger the SNMP trap, use the following command.
ruckus(config)# event snmp-trap <eventCode>
Syntax Description
This command has no arguments or keywords.
Command Mode
Config
Example
SZ100-Node1(config)# event snmp-trap
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
Configuration Commands
event-email
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 114
Please choose Event Codes (separated by ',') to enable Event to
trigger SNMP Trap:
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
Table 38 lists the related event-email configuration commands.
Table 38. Commands related to ruckus(config-event-email)
Syntax and Type Parameters (if any) Description
ruckus(config-event-email)# do
Type: Privileged
Enables the do command.
ruckus(config-event-email)#
enable
Type: Privileged
Enables the email notifications for
events.
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.
Configuration Commands
exit
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 115
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
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
ruckus(config-event)# mail-to
Type: Privileged
<email> Sets the email address
configuration.
ruckus(config-event)# no
Type: Privileged
enable
mail-to
Disables various options.
Table 38. Commands related to ruckus(config-event-email)
Syntax and Type Parameters (if any) Description
Configuration Commands
ftp-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 116
Example
SZ100-Node1(config)# ftp-server f1
SZ100-Node1(config-ftp-server)#
SZ100-Node1(config-ftp-server)# host 1.1.1.1
SZ100-Node1(config-ftp-server)# port 21
SZ100-Node1(config-ftp-server)# username test
SZ100-Node1(config-ftp-server)# password test
Retype: ****
SZ100-Node1(config-ftp-server)# exit
SZ100-Node1(config)#
Related Commands
Table 39 lists the related ftp-server commands.
Table 39. Commands related to ruckus(config-ftp-server)
Syntax and Type Parameters (if any) Description
ruckus(config-ftp-server)# do
Type: Privileged
Executes the do command.
ruckus(config-ftp-server)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ftp-server)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ftp-server)# help
Type: Privileged
Displays the help.
ruckus(config-ftp-server)# host
Type: Privileged
<ip> Sets the FTP server IP address.
ruckus(config-ftp-server)#
password
Type: Privileged
<password> Sets the FTP password.
ruckus(config-ftp-server)# port
Type: Privileged
<port> Sets the FTP server port.
ruckus(config-ftp-server)# remote-
directory
Type: Privileged
<directory> Sets the FTP remote directory.
Configuration Commands
ftp-test
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 117
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
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.
ruckus(config-ftp-server)# test
Type: Privileged
Test the FTP settings.
ruckus(config-ftp-server)#
username
Type: Privileged
<username> Sets the user name.
Table 39. Commands related to ruckus(config-ftp-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
guest-access
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 118
Command Mode
config
Example
SZ100-Node1(config)# guest-access dominic
SZ100-Node1(config-guest-access)#
Related Commands
Table 40 lists the related guest access configuration commands.
Table 40. Commands related to ruckus (config-guest-access)
Syntax and Type Parameters (if any) Description
ruckus(config-guest-access)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-guest-access)# do
Type: Privileged
Executes the do command.
ruckus(config-guest-access)#
enable-terms-and-conditions
Type: Privileged
Enables the web portal terms and
conditions.
ruckus(config-guest-access)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-guest-access)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-guest-access)#
grace-period
Type: Privileged
<minutes> Sets the grace period.
ruckus(config-guest-access)# help
Type: Privileged
Displays the help.
ruckus(config-guest-access)#
language
Type: Privileged
Sets the language.
ruckus(config-guest-access)#
name
Type: Privileged
<name> Sets the guess access service
name.
Configuration Commands
help
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 119
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
ruckus(config-guest-access)# no
Type: Privileged
enable-terms-and-
conditions
sms-gateway
terms-and-conditions
Disables the web portal terms and
conditions.
ruckus(config-guest-access)#
session-timeout
Type: Privileged
<minutes> Sets the session timeout as per the
specified minutes.
ruckus(config-guest-access)#
sms-gateway
Type: Privileged
<disabled> Sets the guest pass for the SMS
gateway.
ruckus(config-guest-access)#
start-page
Type: Privileged
original
redirect <start-url>
Sets the start page.
ruckus(config-guest-access)#
terms-and-conditions
Type: Privileged
Sets the web portal terms and
conditions.
ruckus(config-guest-access)# title
Type: Privileged
Sets the title for the web portal.
Table 40. Commands related to ruckus (config-guest-access)
Syntax and Type Parameters (if any) Description
Configuration Commands
hostname
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 120
admin Create/Update Administrator account configuration
admin-radius Create/Update RADIUS server for Administrators
ap-auto-approve Enable AP auto approve
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
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)#
Configuration Commands
hotspot
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 121
Related Commands
Table 41 lists the related hotspot configuration commands.
Table 41. Commands related to ruckus(config-hotspot)
Syntax and Type Parameters (if any) Description
ruckus(config-hotspot)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-hotspot)# do
Type: Privileged
Executes the do command.
ruckus(config-hotspot)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-hotspot)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-hotspot)# grace-
period
Type: Privileged
<minutes> Sets the EAP-SIM MAP version.
ruckus(config-hotspot)# help
Type: Privileged
Displays the help.
ruckus(config-hotspot)# location-
id
Type: Privileged
<location-id> Sets the location ID.
ruckus(config-hotspot)# location-
name
Type: Privileged
<location-name> Sets the location name.
ruckus(config-hotspot)# logon-url
Type: Privileged
internal
external <logon-url>
<logon-url>: Redirects
unauthenticated user to
the URL for
authentication
Sets the logon model.
ruckus(config-hotspot)# name
Type: Privileged
Renames the hotspot profile.
Configuration Commands
hotspot
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 122
ruckus(config-hotspot)# no walled-
garden
Type: Privileged
<walled-garden-list> Disables the walled garden
configurations.
ruckus(config-hotspot)# session-
timeout
Type: Privileged
<minutes> Sets the session timeout. Defined
in minutes.
ruckus(config-hotspot)# smart-
client-support
Type: Privileged
enable
none
only <instructions> Only
smart client allowed with
instructions for enabling
users to log on using the
smart client application
Sets the smart client support.
ruckus(config-hotspot)# start-
page
Type: Privileged
original
redirect <start-url>
<start-url>: Redirects to
the defined URL
Sets the start page.
ruckus(config-hotspot)# walled-
garden
Type: Privileged
<walled-garden-list> Enables walled garden. Allows
unauthorized destinations.
Comma-separated IP, IP range,
CIDR and regular expression
domain name list.
Table 41. Commands related to ruckus(config-hotspot)
Syntax and Type Parameters (if any) Description
Configuration Commands
import-zdbackup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 123
import-zdbackup
To import the ZD backup, use the following command.
ruckus(config)# import-zdbackup import <ftp-url>
Syntax Description
This command uses the following syntax:
import: Import ZD backup from FTP server
<ftp-url>: FTP URL, format: ftp://<username>:<password>@<ftp-host>/<file-
path>
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# import-zdbackup import ftp://
dm:ruckus1!@172.19.7.100/backup/AP_ad87453456fe.csv
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
Configuration Commands
interface
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 124
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
end End the current configuration session and return to privileged
EXEC mode
e x i t E x i t f r o m t h e E X E C
help Display this help message
ip Update IP configuration
no Disable and delete commands ned UD1
Configuration Commands
interface
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 125
Related Commands
•Table 42 lists the related interface-ap-tunnel-data and mgmt-and-ap-control
configuration commands.
•Table 43 lists the related interface-user-defined configuration commands.
Table 42 lists the related interface-ap-tunnel-data and mgmt-and-ap-control config-
uration commands.
Table 42. Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-ap-
control)
Syntax and Type Parameters (if any) Description
ruckus(config-if)# data-plane
Type: Privileged
Updates the data plane
configuration
ruckus(config-if)# do
Type: Privileged
Executes the do command.
ruckus(config-if)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-if)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-if)# help
Type: Privileged
Displays the help.
ruckus(config-if)# ip
Type: Privileged
<address> Sets the IP address.
ruckus(config-if)# no data-plane
Type: Privileged
<name> Disables the data-plane
Configuration Commands
interface
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 126
Table 43 lists the related interface-user-defined configuration commands.
Table 43. Commands related to ruckus(config-interface-user-defined)
Syntax and Type Parameters (if any) Description
ruckus(config-if)# do
Type: Privileged
Executes the do command.
ruckus(config-if)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-if)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-if)# help
Type: Privileged
Displays the help.
ruckus(config-if)# interface
Type: Privileged
[ control | management ] Sets the physical interface such as
control and management
interface. Executed in conjunction
with user defined sub command.
ruckus(config-if)# name
Type: Privileged
Renames the user-define
interface.
ruckus(config-if)# ip
Type: Privileged
<address> Sets the IP address for the user
defined interface.
ruckus(config-if)# service
Type: Privileged
<any>
<hotspot>
Sets the service.
ruckus(config-if)# vlan
Type: Privileged
<vlan-id> Sets the VLAN ID for the interface.
Configuration Commands
ip
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 127
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
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
Configuration Commands
ip route
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 128
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> <mask> <ip> <interface> <metric>
<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
l2-acl
To create or update the L2ACL configuration, use the following command.
ruckus(config)# l2-acl <name>
Syntax Description
This command uses the following syntax:
<name> : L2ACL name
Default
This command has no default settings.
Command Mode
Config
Configuration Commands
l2-acl
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 129
Example
SZ100-Node1(config)# l2-acl l2
SZ100-Node1(config-l2-acl)#
Related Commands
Table 44 lists the related to l2-acl configuration commands.
Table 44. Commands related to ruckus(config-l2-acl)
Syntax and Type Parameters (if any) Description
ruckus(config-l2-acl)# action
Type: Privileged
[ allow | block ] Sets the handling action to allow or
block.
ruckus(config-l2-acl)# description
Type: Privileged
<text> Sets the description.
ruckus(config-l2-acl)# do
Type: Privileged
Executes the do command.
ruckus(config-l2-acl)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-l2-acl)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-l2-acl)# help
Type: Privileged
Displays the help.
ruckus(config-l2-acl)# mac
Type: Privileged
${value} Sets the MAC value.
ruckus(config-l2-acl)# name
Type: Privileged
<name> Sets the name of the L2ALC.
ruckus(config-l2-acl)# no mac
Type: Privileged
${value} Disables the MAC value.
Configuration Commands
lbs-service
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 130
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
<name> LBS venue name
SZ100-Node1(config)# lbs-service n3
Related Commands
Table 45 lists the related lbs-service configuration command
.
Table 45. Commands related to ruckus(config-lbs-service)
Syntax and Type Parameters (if any) Description
ruckus(config-lbs-service)# do
Type: Privileged
Sets the do command.
ruckus(config-lbs-service)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-lbs-service)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-lbs-service)# help
Type: Privileged
Displays the help message.
ruckus(config-lbs-service)# host
Type: Privileged
<IP address> <domain
name>
Sets the server address.
Configuration Commands
license
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 131
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: <local-server> <port>
sync-now Sync License with Server
ruckus(config-lbs-service)#
password
Type: Privileged
<password> Sets the password.
ruckus(config-lbs-service)# port
Type: Privileged
<port> Sets the port number.
ruckus(config-lbs-service)# venue
Type: Privileged
<venue> Sets the LBS venue.
Table 45. Commands related to ruckus(config-lbs-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
license cloud
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 132
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]
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>@<ip>/
<file-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
Configuration Commands
license import
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 133
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>@<ip>/
<file-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
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
Configuration Commands
license sync-now
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 134
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
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
Configuration Commands
logging console
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 135
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: 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.Help-
Command; options: [logging, console]
2014-11-14 11:17:24,687 wsg.cli[main] INFO c.r.w.c.c.CommandOp-
tionsMixin[-1] - Starting to cache validation status
2014-11-14 11:17:24,689 wsg.cli[main] INFO c.r.w.c.c.CommandOp-
tionsMixin[-1] - Finished to cache validation status
Configuration Commands
lwapp2scg
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 136
2014-11-14 11:17:24,690 wsg.cli[main] INFO c.r.w.c.c.CommandOp-
tionsMixin[-1] - Starting to cache validation status
2014-11-14 11:17:24,700 wsg.cli[main] INFO c.r.w.c.c.CommandOp-
tionsMixin[-1] - Finished to cache validation status
lwapp2scg
To update the LWAPP to SZ 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
2014-11-14 11:19:35,252 wsg.cli[main] INFO c.r.w.c.g.ShellRunner[-
1] - Read line: lwapp2scg
2014-11-14 11:19:35,254 wsg.cli[CliSessionTimeout] INFO
c.r.w.c.Context[-1] - sleep interrupted
2014-11-14 11:19:35,254 wsg.cli[main] INFO c.r.w.c.g.Shell[-1] -
Input command: lwapp2scg
2014-11-14 11:19:35,254 wsg.cli[main] INFO c.r.w.c.g.Shell[-1] -
Executing command (noCommandName-Ymfv4Ftq3X): com.ruckuswire-
less.wsg.cli.command.configure.ConfigureComplexCommand; options:
[lwapp2scg]
2014-11-14 11:19:35,255 wsg.cli[main] INFO c.r.w.c.c.c.Configure-
ComplexCommand[-1] - Complex command and the invoked function is
'lwapp2scg'; options: []
2014-11-14 11:19:35,259 wsg.cli[main] INFO c.r.w.c.c.Configure-
ComplexCommandOptionsSupport[-1] - Use RESTFul resource to query
the config model object
2014-11-14 11:19:35,261 wsg.cli[main] INFO c.r.w.c.r.RESTUtils[-
1] - 1th do HTTP action (Path: api/sz/globalSettings/system/
lwapp2scg)
Configuration Commands
lwapp2scg
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 137
2014-11-14 11:19:35,263 wsg.cli[main] INFO c.r.w.c.r.RESTUtils[-
1] - HTTP Action: GET https://100.31.1.41:8443/wsg/api/sz/global-
Settings/system/lwapp2scg
2014-11-14 11:19:35,329 wsg.cli[main] INFO c.r.w.c.r.RESTUtils[-
1] - HTTP Response Status: 200
2014-11-14 11:19:35,337 wsg.cli[main] INFO c.r.w.c.c.Configure-
ComplexCommandOptionsSupport[-1] - Prepare to update a model
object, so get it first
2014-11-14 11:19:35,340 wsg.cli[main] INFO c.r.w.c.c.c.s.Lwapp2Sc-
gConfigCommand[-1] - setDefaultValue...
2014-11-14 11:19:35,348 wsg.cli[main] INFO c.r.w.c.c.c.s.Lwapp2Sc-
gConfigCommand[-1] - No key defined in com.ruckuswire-
less.wsg.cli.command.configure.system.Lwapp2ScgConfigCommand.
2014-11-14 11:19:35,349 wsg.cli[main] INFO c.r.w.c.Context[-1] -
Current command is noCommandName-R1ykVtG30W (com.ruckuswire-
less.wsg.cli.command.configure.system.Lwapp2ScgConfigCommand)
Related Commands
Table 46 lists the related lwapp2scg configuration command
.
Table 46. Commands related to ruckus(config-lwapp2scg).
Syntax and Type Parameters (if any) Description
ruckus(config-lwapp2scg)# acl-ap
Type: Privileged
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
serial <SerialNumber>:
Sets the serial number.
Use commas to separate
the serial numbers. For
example:
123456789012,9876543
21021
Sets the ACL AP.
ruckus(config-lwapp2scg)# do
Type: Privileged
Sets the do command
ruckus(config-lwapp2scg)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
Configuration Commands
no admin
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 138
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(config-lwapp2scg)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-lwapp2scg)# help
Type: Privileged
Displays the help message.
ruckus(config-lwapp2scg)# no
Type: Privileged
Deletes the AP ACL.
ruckus(config-lwapp2scg)# pasv-
port
Type: Privileged
<port> <port> - Sets it to
minimum and maximum
port.
Set the dynamic data transmission
port range to minimum and
maximum.
ruckus(config-lwapp2scg)# policy
Type: Privileged
<accept> Accept by ACL
AP list
<accept-all> Accept all
<deny> Deny by ACL AP
list
<deny-all> Deny all
Sets the ACL policy.
Table 46. Commands related to ruckus(config-lwapp2scg).
Syntax and Type Parameters (if any) Description
Configuration Commands
no admin-radius
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 139
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
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
Configuration Commands
no ap auto-approve
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 140
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
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
Configuration Commands
no ap-cert-check
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 141
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
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
Configuration Commands
no ap-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 142
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]
no ap-root-ca
To disable or delete the access point root ca, use the following command.
ruckus(config)# no ap-root-ca
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-root-ca
Configuration Commands
no ap-sci
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 143
no ap-sci
To disable the access point SCI configurations, use the following command.
ruckus(config)# no ap-sci <enable>
Syntax Description
This command uses the following syntax:
enable: Disables the AP SCI.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ap-sci enable
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
Configuration Commands
no bonjour-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 144
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]
no cls-sess
To delete Q-in-Q layer 3 profile configurations, use the following command.
ruckus(config)# no cls-sess msisdn <msisdn>
Syntax Description
This command uses the following syntax:
msisdn: msisdn
<msisdn>: The length of MSISDN should be between 10 to15 digits.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no cls-sess msisdn 1234567
Configuration Commands
no control-plane
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 145
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
no data-plane
To disable the STP package bridge of the local dataplane 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
Configuration Commands
no device-policy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 146
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
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
Configuration Commands
no encrypt-mac-ip
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 147
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]
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 even
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no event email 305, 214, 113
Configuration Commands
no ftp-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 148
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
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
Configuration Commands
no hotspot
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 149
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
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
Configuration Commands
no ip
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 150
no ip
To remove all IP address static routes, use the following command.
ruckus(config)# no ip <route> <route <dest-network> <network-mask>
<nexth-op-ip> [ cluster | management | control ]> <name-server secondary>
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
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
enable: Disables the access and core gateway
control-nat: Deletes the NAT IP address
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ip route ip 193.12.30.10
Configuration Commands
no l2-acl
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 151
no l2-acl
To disables the layer 2 Access Control List (ACL) configuration, use the following
command.
ruckus(config)# no l2-acl <name>
Syntax Description
This command uses the following syntax:
<name>: Layer 2 Access Control List name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no l2-acl n3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
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>: Set the 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
Configuration Commands
no logging
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 152
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
no non-proxy-aaa
To disable the non proxy AAA server settings, use the following command.
ruckus(config)# no non-proxy-aaa non-proxy-aaa ${aaaName}?| <name>
Syntax Description
This command uses the following syntax:
non-proxy-aaa ${aaaName}?
<name>: Proxy AAA server name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no non-proxy-aaa nam3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
Configuration Commands
no proxy-aaa
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 153
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]
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
Configuration Commands
no role
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 154
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]
no snmp-trap
To disable SNMP trap configuration, use the following command.
ruckus(config)# no snmp-trap
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no snmp-trap 113
Do you want to continue to disable (or input 'no' to cancel)? [yes/
no]
Configuration Commands
no snmp-v2-community
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 155
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]
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]
Configuration Commands
no user-agent-blacklist
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 156
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]
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]
Configuration Commands
no user-traffic-profile
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 157
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]
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:
name: Name of the user traffic profile
web-authentication ${webAuthenticationName}?
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]
Configuration Commands
no wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 158
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]
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]
Configuration Commands
no wlan-scheduler
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 159
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]
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)#
Configuration Commands
non-proxy-aaa
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 160
Related Commands
Table 47 lists the related config-non-proxy-aaa configuration commands.
Table 47. Commands related ruckus(config-non-proxy-aaa)
Syntax and Type Parameters (if any) Description
ruckus(config-non-proxy-aaa)#
admin-domain
Type: Privileged
Sets the admin domain.
ruckus(config-non-proxy-aaa)#
admin-domain-name
Type: Privileged
<admin-domain> Creates or updates the admin
domain name.
ruckus(config-non-proxy-aaa)#
admin-password
Type: Privileged
<admin-password> Creates or updates the admin
password.
ruckus(config-non-proxy-aaa)#
base-domain
Type: Privileged
<base-domain> Set the base domain.
ruckus(config-non-proxy-aaa)#
backup
Type: Privileged
ip <ip>: Sets the IP
address of secondary
RADIUS server
port <port>: Sets the port
of secondary RADIUS
server
shared-secret: Sets the
shared secret of
secondary RADIUS server
Enables backup of the RADIUS
support.
ruckus(config-non-proxy-aaa)#
base-domain
Type: Privileged
<base-domain> Sets the base domain.
ruckus(config-non-proxy-aaa)#
description
Type: Privileged
<description> Sets the description.
ruckus(config-non-proxy-aaa)# do
Type: Privileged
Executes the do command.
Configuration Commands
non-proxy-aaa
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 161
ruckus(config-non-proxy-aaa)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-non-proxy-aaa)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-non-proxy-aaa)#
help
Type: Privileged
Displays the help.
ruckus(config-non-proxy-aaa)#
global-catalog
Type: Privileged
Enables the global catalog
support.
ruckus(config-non-proxy-aaa)# ip
Type: Privileged
<ip> Sets the IP addresses of the
primary RADIUS server.
ruckus(config-non-proxy-aaa)#
key-attribute
Type: Privileged
<key-attribute> Sets the key attributes for the
primary RADIUS server.
ruckus(config-non-proxy-aaa)# no
Type: Privileged
backup
global-catalog
no-response-fail
Sets the RADIUS server name.
ruckus(config-non-proxy-aaa)#
name
Type: Privileged
Sets the RADIUS server name.
ruckus(config-non-proxy-aaa)#
no-response-fail
Type: Privileged
Enables the no response fail
setting.
ruckus(config-non-proxy-aaa)#
password
Type: Privileged
<password> Sets the password.
ruckus(config-non-proxy-aaa)#
port
Type: Privileged
<port> Sets the port number of the
primary RADIUS server.
Table 47. Commands related ruckus(config-non-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
northbound-authtype
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 162
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
ruckus(config-non-proxy-aaa)#
response-window
Type: Privileged
<seconds> Sets the response window.
ruckus(config-non-proxy-aaa)#
revive-interval
Type: Privileged
<seconds> Sets the revive interval.
ruckus(config-non-proxy-aaa)#
search-filter
Type: Privileged
<search-filter> Sets the search filter.
ruckus(config-non-proxy-aaa)#
shared-secret
Type: Privileged
Sets the shared secret of the
primary RADIUS server.
ruckus(config-non-proxy-aaa)#
test
Type: Privileged
<username> <password> Sets the test AAA server.
ruckus(config-non-proxy-aaa)#
windows-domain
Type: Privileged
<windows-domain> Sets the windows domain.
ruckus(config-non-proxy-aaa)#
zombie-period
Type: Privileged
<seconds> Sets the zombie period.
Table 47. Commands related ruckus(config-non-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
northbound-portal
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 163
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# northbound-authtype PAP
SZ100-Node1(config)# northbound-authtype CHAP
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!
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.
Configuration Commands
proxy-aaa
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 164
Command Mode
Config
Example
SZ100-Node1(config)# ntp-server host 172.19.13.53
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)#
Configuration Commands
proxy-aaa
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 165
Related Commands
Table 48 lists the related config-proxy-aaa configuration commands.
Table 48. Commands related ruckus(config-proxy-aaa)
Syntax and Type Parameters (if any) Description
ruckus(config-proxy-aaa)# backup
Type: Privileged
ip <ip>: Sets the IP
address of secondary
RADIUS server
port <port>: Sets the port
of secondary RADIUS
server
shared-secret: Sets the
shared secret of
secondary RADIUS server
Enables backup of the RADIUS
support.
ruckus(config-proxy-aaa)#
description
Type: Privileged
<description> Sets the description.
ruckus(config-proxy-aaa)# do
Type: Privileged
Executes the do command.
ruckus(config-proxy-aaa)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-proxy-aaa)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-proxy-aaa)# help
Type: Privileged
Displays the help.
ruckus(config-proxy-aaa)# ip
Type: Privileged
<ip> Sets the IP addresses of the
primary RADIUS server.
ruckus(config-proxy-aaa)# mor
Type: Privileged
[ <0 or 10-4096>]
Maximum outstanding
requests per server
Sets the maximum outstanding
requests per server.
ruckus(config-proxy-aaa)# no
Type: Privileged
backup
no-response-fail
Disables various options
Configuration Commands
proxy-aaa
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 166
ruckus(config-proxy-aaa)# no-
response-fail
Type: Privileged
Enables no response fail settings.
ruckus(config-proxy-aaa)# name
Type: Privileged
Sets the RADIUS server name.
ruckus(config-aaa)# port
Type: Privileged
<port> Sets the port number of the
primary RADIUS server.
ruckus(config-proxy-aaa)#
response-window
Type: Privileged
<seconds> Sets the response window.
ruckus(config-proxy-aaa)# revive-
interval
Type: Privileged
<seconds> Sets the revive interval.
ruckus(config-proxy-aaa)# sanity-
timer
Type: Privileged
<seconds> Sets the sanity timer.
ruckus(config-proxy-aaa)# shared-
secret
Type: Privileged
Sets the shared secret of the
primary RADIUS server.
ruckus(config-proxy-aaa)# test
Type: Privileged
<username>
<password>
Sets the RADIUS server using
login credentials.
ruckus(config-proxy-aaa)#
threshold
Type: Privileged
[ <10-90 %> ] Percentage
of maximum number of
outstanding requests.
Sets the percentage of maximum
number of outstanding requests.
ruckus(config-proxy-aaa# type
Type: Privileged
[ radius | radius-acct |
LDAP | AD ]
radius: RADIUS type
radius-acct: RADIUS
accounting type
LDAP: LDAP
AD: Active Directory
Sets the RADIUS type.
Table 48. Commands related ruckus(config-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
report
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 167
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
Table 49 lists the related report configuration command.
ruckus(config-proxy-aaa)#
zombie-period
Type: Privileged
<seconds> Sets the zombie period.
Table 49. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
ruckus(config-report)# csv-format
Type: Privileged
Sets the output of the report in
CSV format.
ruckus(config-report)# description
Type: Privileged
<text> Sets the description.
ruckus(config-report)# do
Type: Privileged
Executes the do command.
ruckus(config-report)# email
Type: Privileged
<email> Sets the email notification.
Table 48. Commands related ruckus(config-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
report
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 168
ruckus(config-report)# enable-
export
Type: Privileged
Enables the export report results
to the FTP server.
ruckus(config-report)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-report)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-report)# export
Type: Privileged
<ftp-url> - FTP URL format
is: ftp://
<username>:<password>
@<ftp-host>[/<dir-path>]
Sets the export report results to
FTP server.
ruckus(config-report)# export-test
Type: Privileged
Tests the FTP server.
ruckus(config-report)# help
Type: Privileged
Displays the help.
ruckus(config-report)# no
Type: Privileged
csv-format
email
enable export
export
pdf-format
resource-filter
schedule
Disables and deletes commands.
ruckus(config-report)# pdf-format
Type: Privileged
Sets the outputs of the report in a
PDF format.
ruckus(config-report)# resource-
filter
Type: Privileged
ggsn <ggsn-ip>
ssid <ssid>
radio ${value}
device plane <name>
device domain <name>
device zone <name>
device ap <name>
Sets the resource filter criteria.
Table 49. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
Configuration Commands
report
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 169
ruckus(config-report)# schedule
Type: Privileged
monthly <date-of-month>
hour <hour> minute
<minute>
weekly <date-of-week>
hour <hour> minute
<minute>
daily <hour> minute
<minute>
hourly <minute>
Sets the schedule.
ruckus(config-report)# time-filter
Type: Privileged
monthly months
<months>
daily days <days>
hourly days <days>
hourly hours <hours>
15min hours <hours>
5min hours <hours>
time-period hours
<hours>
Sets the time filter.
ruckus(config-report)# tittle
Type: Privileged
<title> Sets the report title.
Table 49. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
Configuration Commands
role
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 170
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
ruckus(config-report)# type
Type: Privileged
<client-number>
< client-number-vs-air-
time>
<continuously-
disconnected-aps>
<failed-client-
associations>
<new-client-
associations>
<system-resource-
utilization>
<tx-rx-bytes>
Sets the report type.
Table 49. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
Configuration Commands
role
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 171
Related Commands
Table 50 lists the related role configuration commands.
Table 50. Commands related to ruckus(config-role).
Syntax and Type Parameters (if any) Description
ruckus(config-role)# capabilities
Type: Privileged
administration
configuration
device
monitor
reports
<capabilities-depth-1>
Sets the capabilities details.
ruckus(config-role)# description
Type: Privileged
<text> Sets the description for the
assigned role.
ruckus(config-role)# do
Type: Privileged
Executes the do command.
ruckus(config-role)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-role)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-role)# help
Type: Privileged
Displays the help.
ruckus(config-role)# no
Type: Privileged
administration
configuration
device
monitor
reports
<capabilities-depth-1>
Disables the capabilities assigned.
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 172
4
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
3 chapters based on the alphabetical order of commands.
Table 51. Configuration commands
sms-server smtp-server snmp-trap snmp-v2-
community
snmp-v3-user
syslog-server user-agent-
blacklist
user-role user-traffic-
profile
web-cert
wlan wlan-group wlan-scheduler
Configuration Commands
sms-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 173
sms-server
To enable SMS server configurations, use the following command.
ruckus(config)# sms-server
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# sms-server
Related Commands
Table 52 lists the related sms-server configuration commands.
Table 52. Commands related to ruckus(config-sms-server)
Syntax and Type Parameters (if any) Description
ruckus(config-sms-server)#
account-side
Type: Privileged
<sid> Sets the account SID, which is a 34
character string that uniquely
identifies this account. The enable
commands set this command.
ruckus(config-sms-server)# auth-
token
Type: Privileged
<token> Sets the authorization token
identifier. The enable commands
set this command.
ruckus(config-sms-server)# do
Type: Privileged
Executes the do command.
ruckus(config-sms-server)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-sms-server)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-sms-server)# enable
Type: Privileged
Enables the SMS server.
Configuration Commands
smtp-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 174
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
SZ30(config)# smtp-server
Related Commands
Table 53 lists the related smtp-server configuration commands.
ruckus(config-sms-server)# from
Type: Privileged
<from> Sets the sender’s mail address.
ruckus(config-sms-server)# help
Type: Privileged
Displays the help.
ruckus(config-sms-server)# no
enable
Type: Privileged
Disables the SMS server.
ruckus(config-sms-server)# server-
name
Type: Privileged
<server-name> Sets the server name.
Table 53. Commands related to ruckus(config-smtp-server)
Syntax and Type Parameters (if any) Description
ruckus(config-smtp-server)# do
Type: Privileged
Executes the do command.
Table 52. Commands related to ruckus(config-sms-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
smtp-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 175
ruckus(config-smtp-server)#
enable
Type: Privileged
Enables the SMTP server.
ruckus(config-smtp-server)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(diagnostic)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-smtp-server)# from
Type: Privileged
<mail> Sets the sender’s mail address.
ruckus(config-smtp-server)# help
Type: Privileged
Displays the help.
ruckus(config-smtp-server)# host
Type: Privileged
<host> Sets the SMTP server IP address
or domain name.
ruckus(config-smtp-server)# no
Type: Privileged
enable: Disables SMTP
Server
password: Removes
password
start-tls: Disables
STARTTLS encryption
tls: Disables TLS
encryption
username: Removes the
username
Disables TLS or STARTTLS
encryption commands.
ruckus(config-smtp-server)#
password
Type: Privileged
<password> Sets the password.
ruckus(config-smtp-server)# port
Type: Privileged
<port> Sets the port number.
ruckus(config-smtp-server)# start-
tls
Type: Privileged
Enables STARTTLS encryption.
The TLS commands set this
command.
Table 53. Commands related to ruckus(config-smtp-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
snmp-trap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 176
snmp-trap
To enable SNMP traps, use the following command.
ruckus(config)# snmp-trap
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# snmp-trap
ruckus(config-smtp-server)# test
Type: Privileged
Tests the SMTP settings. The TLS
commands set this command.
ruckus(config-smtp-server)# tls
Type: Privileged
Enables TLS encryption.
ruckus(config-smtp-server)# to
Type: Privileged
<mail> Sets the receiver’s email address.
ruckus(config-smtp-server)#
username
Type: Privileged
<username> Sets the logon name.
Table 53. Commands related to ruckus(config-smtp-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
snmp-v2-community
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 177
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
Table 54 lists the related snmp-v2-community configuration commands.
.
Table 54. Commands related to ruckus(config-snmp-v2-community)
Syntax and Type Parameters (if any) Description
ruckus(config-snmp-v2-
community)# do
Type: Privileged
Executes the do command.
ruckus(config-snmp-v2-
community)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-snmp-v2-
community)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-snmp-v2-
community)# help
Type: Privileged
Displays the help.
Configuration Commands
snmp-v2-community
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 178
ruckus(config-snmp-v2-
community)# no
Type: Privileged
read: Disables read
privilege
trap: Disables trap
privilege
trap-target <ip> <port>:
Deletes trap target IP
address and port
write: Disables write
privilege
Disables various options.
ruckus(config-snmp-v2-
community)# read
Type: Privileged
Enables the read privileges.
ruckus(config-snmp-v2-
community)# trap
Type: Privileged
Enables trap privileges.
ruckus(config-snmp-v2-
community)# trap-target
Type: Privileged
<ip> <port> Enables trap target by setting the
IP address and port. The trap
command sets this command.
ruckus(config-snmp-v2-
community)# write
Type: Privileged
Enables the write privileges.
Table 54. Commands related to ruckus(config-snmp-v2-community)
Syntax and Type Parameters (if any) Description
Configuration Commands
snmp-v3-user
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 179
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
Table 55 lists the related config-snmp-v3-user configuration commands.
.
Table 55. Commands related to ruckus(config-snmp-v3-user)
Syntax and Type Parameters (if any) Description
ruckus(config-snmp-v3-user)#
auth
Type: Privileged
md5 <auth-password>
none
sha <auth-password>
Sets SNMPv3 user authentication.
ruckus(config-snmp-v3-user)# do
Type: Privileged
Executes the do command.
ruckus(config-snmp-v3-user)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-snmp-v3-user)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-snmp-v3-user)#
help
Type: Privileged
Displays the help.
Configuration Commands
snmp-v3-user
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 180
ruckus(config-snmp-v3-user)# no
Type: Privileged
read: Disables read
privilege
trap: Disables trap
privilege
trap-target <ip> <port>:
Deletes trap target IP
address and port
write: Disables write
privilege
Disables various options.
ruckus(config-snmp-v3-user)#
privacy
Type: Privileged
none: Set to none
des <privacy-phrase>:
DES privacy phrase
aes <privacy-phrase>:
AES privacy phrase
Sets the user privacy. The auth-
md5 command sets this
command.
ruckus(config-snmp-v3-user)#
read
Type: Privileged
Enables read privileges.
ruckus(config-snmp-v3-user)#
trap
Type: Privileged
Enables trap privileges.
ruckus(config-snmp-v3-user)#
trap-target
Type: Privileged
<ip> <port> Enables trap target by setting the
IP address and port. The trap
command sets this command.
ruckus(config-snmp-v3-user)#
write
Type: Privileged
Enables write privileges.
Table 55. Commands related to ruckus(config-snmp-v3-user)
Syntax and Type Parameters (if any) Description
Configuration Commands
syslog-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 181
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
Table 56 lists the relate syslog-server configuration commands.
.
Table 56. Commands related to ruckus(config-syslog-server)
Syntax and Type Parameters (if any) Description
ruckus(config-syslog-server)# do
Type: Privileged
Executes the do command.
ruckus(config-syslog-server)#
enable
Type: Privileged
Enables sending events to the
remote syslog server.
ruckus(config-syslog-server)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-syslog-server)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-syslog-server)#
facility
Type: Privileged
[ Local1 | Local2 | Local4 |
Local3 | Local7 | Local0 |
Local5 | Local6]
Sets the facility to send events
from the remote syslog server to
the local systems.
Configuration Commands
syslog-server
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 182
ruckus(config-syslog-server)# filter
Type: Privileged
[ all | severity | exclude-
client] <filter>
Sets the settings for filtering events
to either all or events above a
certain severity level or events
except client associate/
disassociate.
ruckus(config-syslog-server)#
filter-severity
Type: Privileged
[Critical | Debug | Info |
Major | Minor | Warning
<filter-severity>
Sets the event severity filter
settings. Command filter
<severity> sets this command.
The filter severity is based on
severity.
ruckus(config-syslog-server)# help
Type: Privileged
Displays the help.
ruckus(config-syslog-server)# host
Type: Privileged
<ip> Sets the syslog server IP address.
ruckus(config-syslog-server)# no
Type: Privileged
<enable> Disables the syslog server.
ruckus(config-syslog-server)# ping
Type: Privileged
Pings the syslog server.
ruckus(config-syslog-server)# port
Type: Privileged
<port> Sets the syslog server port.
ruckus(config-syslog-server)#
priority
Type: Privileged
[Critical | Debug | Info |
Major | Minor | Warning
<event severity> <syslog-
priority>
Sets the priority for events. The
event severity and syslog-severity
is based on priority.
Table 56. Commands related to ruckus(config-syslog-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-agent-blacklist
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 183
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
SZ30(config)# user-agent-blacklist user-agent-blacklist
SZ30(config-user-agent-blacklist)#
Related Commands
Table 57 lists the related user-agent-blacklist configuration commands.
Table 57. Commands related to ruckus(config-user-agent-blacklist)
Syntax and Type Parameters (if any) Description
ruckus(config-user-agent-
blacklist)# do
Type: Privileged
Sets the do command.
ruckus(config-user-agent-
blacklist)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-user-agent-
blacklist)# error
Type: Privileged
<error> Sets the error code between 400
and 599.
ruckus(config-user-agent-
blacklist)# error-message
Type: Privileged
<error message> Sets the error message.
Configuration Commands
user-role
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 184
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)#
ruckus(config-user-agent-
blacklist)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-user-agent-
blacklist)# help
Type: Privileged
Displays the help.
ruckus(config-user-agent-
blacklist)# name
Type: Privileged
<name> Sets the user agent name who is
blacklisted.
ruckus(config-user-agent-
blacklist)# pattern
Type: Privileged
<pattern> Sets the user agent pattern
Table 57. Commands related to ruckus(config-user-agent-blacklist)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-role
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 185
Related Commands
Table 58 lists the related user-role configuration commands.
Table 58. Commands related to ruckus(config-user-role)
Syntax and Type Parameters (if any) Description
ruckus(config-user-role)# allow-
wlan-type
Type: Privileged
<all>: Allows zero IT
access to all WLANs
<wlans>: Allows zero IT
access to selected
WLANs
Sets the allowed resources.
ruckus(config-user-role)#
customize-group-attr
Type: Privileged
non-proxy <name> aaa
<name> <text>
radius-nonproxy
proxy-aaa <name> <text>
accounting-proxy
radius-proxy
Adds the customized group
attribute value for various AAA
servers.
ruckus(config-user-role)#
description
Type: Privileged
<description> Sets the description.
ruckus(config-user-role)# do
Type: Privileged
Sets the do command.
ruckus(config-user-role)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-user-role)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-user-role)# group-
attr
Type: Privileged
<text> Sets the default group attribute
value.
ruckus(config-user-role)# help
Type: Privileged
Displays the help.
ruckus(config-user-role)# max-
devices
Type: Privileged
<max-devices> Sets the number for maximum
devices allowed (1-10).
Configuration Commands
user-traffic-profile
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 186
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 59 lists the related user-traffic-profile configuration commands.
•Table 60 lists the related user-traffic-profile-acl configuration commands.
Table 59 lists the related user-traffic-profile configuration commands.
ruckus(config-user-role)# no
Type: Privileged
customize-group-attr
description
Disables the override on the
specified settings.
Table 59. Commands related to (config-user-traffic-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-user-traffic-profile)#
acl
Type: Privileged
Sets the network access control
list.
Table 58. Commands related to ruckus(config-user-role)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-traffic-profile
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 187
ruckus(config-user-traffic-profile)#
default-action
Type: Privileged
<default-action> Sets the default action.
ruckus(config-user-traffic-profile)#
description
Type: Privileged
<description> Sets the description.
ruckus(config-user-traffic-profile)#
do
Type: Privileged
Sets the do command.
ruckus(config-user-traffic-profile)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-user-traffic-profile)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-user-traffic-profile)#
help
Type: Privileged
Displays the help.
ruckus(config-user-traffic-profile)#
name
Type: Privileged
<name> Sets the number for maximum
devices allowed.
ruckus(config-user-traffic-profile)#
no
Type: Privileged
<acl> Disables the override on the
specified settings.
Table 59. Commands related to (config-user-traffic-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-traffic-profile
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 188
Table 60 lists the related user-traffic-profile-acl configuration commands.
Table 60. Commands related to ruckus(config-user-traffic-profile-acl)
Syntax and Type Parameters (if any) Description
ruckus(config-user-traffic-profile-
acl)# action
Type: Privileged
<action> Sets the handling action.
ruckus(config-user-traffic-profile-
acl)# description
Type: Privileged
<description> Sets the description.
ruckus(config-user-traffic-profile-
acl)# destination-ip
Type: Privileged
network [ <Network
Address> ] subnet-mask
<subnet-mask> - Sets the
destination subnet
host [ <Host IP Address> ]
- Sets the destination host
Sets the destination IP address.
ruckus(config-user-traffic-profile-
acl)# destination-port
Type: Privileged
[ <Port Number> ] - Sets
the destination port
number
range [ <Port Number> ] [
<Port Number> ] - Sets the
destination port range
Sets the destination port number.
ruckus(config-user-traffic-profile-
acl)# direction
Type: Privileged
${value} Sets the traffic direction.
ruckus(config-user-traffic-profile-
acl)# do
Type: Privileged
Sets the do command.
ruckus(config-user-traffic-profile-
acl)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-user-traffic-profile-
acl)# exit
Type: Privileged
Exits from the EXEC.
Configuration Commands
user-traffic-profile
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 189
ruckus(config-user-traffic-profile-
acl)# help
Type: Privileged
Displays the help.
ruckus(config-user-traffic-profile-
acl)# protocol
Type: Privileged
<protocol> Value should
be in the range of 1 to 255
Sets the protocol.
ruckus(config-user-traffic-profile-
acl)# source-ip
Type: Privileged
network [ <Network
Address> ] subnet-mask
<subnet-mask> - Sets the
source subnet
host [ <Host IP Address> ]
- Sets the source host
Sets the matching source IP
address.
ruckus(config-user-traffic-profile-
acl)# source-port
Type: Privileged
[ <Port Number> ] - Sets
the destination port
number
range [ <Port Number> ] [
<Port Number> ] - Sets the
destination port range
Sets the source port number.
Table 60. Commands related to ruckus(config-user-traffic-profile-acl)
Syntax and Type Parameters (if any) Description
Configuration Commands
web-authentication
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 190
web-authentication
To create or update the web authentication configurations, use the following
command.
ruckus(config)# web-authentication <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)# web-authentication webab1
Related Commands
Table 61 lists the related web-authentication configuration commands.
Table 61. Commands related to ruckus (config-web-authentication)
Syntax and Type Parameters (if any) Description
ruckus(config-web-
authentication)# description
Type: Privileged
<text> Sets the description.
ruckus(config-web-
authentication)# grace-period
Type: Privileged
<minutes> Sets the grace period.
ruckus(config-web-
authentication)# language
Type: Privileged
Sets the language.
ruckus(config-web-
authentication)# session-timeout
Type: Privileged
<minutes> Sets the session timeout as per the
specified minutes.
Configuration Commands
web-cert
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 191
web-cert
Sets the web certification configurations, use the following command.
ruckus(config)# web-cert
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# web-cert
SZ100-Node1(config-web-cert)#
Related Commands
•Table 62 lists the related web-cert configuration commands.
•Table 63 lists the related web-cert-generate-csr configuration commands.
ruckus(config-web-
authentication)# start-page
Type: Privileged
original
redirect <start-url>
Sets the start page.
Table 61. Commands related to ruckus (config-web-authentication)
Syntax and Type Parameters (if any) Description
Configuration Commands
web-cert
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 192
Table 62 lists the related web-cert configuration commands.
.
Table 62. Commands related to ruckus(config-web-cert)
Syntax and Type Parameters (if any) Description
ruckus(config-web-cert)# do
Type: Privileged
Executes the do command.
ruckus(config-web-cert)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-web-cert)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-web-cert)#
generate-csr
Type: Privileged
<ftp-url>: FTP URL format
is: ftp://
<username>:<password
>@ <ftp-host>[/<dir-
path>]
Generates the certificate signing
request.
ruckus(diagnostic)# help
Type: Privileged
Displays the help.
ruckus(config-web-cert)# upload-
cert
Type: Privileged
<ftp-url>: FTP URL format
is: ftp://
<username>:<password
>@ <ftp-host>[/<dir-
path>]
Uploads the certificate.
Configuration Commands
web-cert
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 193
Table 63 lists the related web-cert-generate-csr configuration commands.
.
Table 63. Commands related to ruckus(config-web-cert-generate-csr)
Syntax and Type Parameters (if any) Description
ruckus(config-web-cert-generate-
csr)# citged
<city> Sets the city.
ruckus(config-web-cert-generate-
csr)# common-name
Type: Privileged
<name> Sets the domain name.
ruckus(config-web-cert-generate-
csr)# country
Type: Privileged
<country> Sets the country.
ruckus(config-web-cert-generate-
csr)# do
Type: Privileged
Executes the do command.
ruckus(config-web-cert-generate-
csr)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-web-cert-generate-
csr)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-web-cert-generate-
csr)# email
Type: Privileged
<email> Sets the email address.
ruckus(config-web-cert-generate-
csr)# help
Type: Privileged
Displays the help.
ruckus(config-web-cert-generate-
csr)# organization
Type: Privileged
<organization> Sets the organization.
ruckus(config-web-cert-generate-
csr)# state
Type: Privileged
<state> Sets the state.
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 194
wlan
To create or update the WLAN configurations, use the following command.
ruckus(config)# wlan <name>
Syntax Description
This command uses the following syntax:
<name>: WLAN name / ESSID
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# wlan wan1
Related Commands
Table 64 lists the related wlan configuration commands.
ruckus(config-web-cert-generate-
csr)# unit
Type: Privileged
<organization-unit> Sets the organization unit.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
ruckus(config-wlan)# access-
network
Type: Privileged
Enables tunnel WLAN traffic to the
SZ.
ruckus(config-wlan)# acct-delay-
time
Type: Privileged
Enables the acct-delay time.
ruckus(config-wlan)# acct-interval
Type: Privileged
<minutes> Set the authentication service.
Enables accounting interval to
send interim updates.
Table 63. Commands related to ruckus(config-web-cert-generate-csr)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 195
ruckus(config-wlan)# acct-service
Type: Privileged
<name> Sets the accounting service.
ruckus(config-wlan)# acct-service-
use-proxy
Type: Privileged
Set the accounting service: Uses
the SZ as proxy.
ruckus(config-wlan)# acct-ttg-
session
Type: Privileged
Sets the accounting service.
Enables accounting for TTG
sessions.
ruckus(config-wlan)# auth-method
Type: Privileged
<name> Sets the authentication method.
ruckus(config-wlan)# auth-service
Type: Privileged
<name> Sets the authentication service.
ruckus(config-wlan)# auth-service-
use-proxy
Type: Privileged
Sets the authentication service.
Enables accounting for TTG
sessions.
ruckus(config-wlan)# auth-type
Type: Privileged
Sets the authentication type.
ruckus(config-wlan)# bss-minrate
Type: Privileged
[ 5.5mbps | 24mbps |
12mbps | 1mbps | 2mbps
]
Sets the BSS minimum rate.
ruckus(config-wlan)# called-sta
Type: Privileged
Sets the called STA ID.
ruckus(config-wlan)# client-
fingerprinting
Type: Privileged
Sets the client fingerprinting.
ruckus(config-wlan)# client-tx-rx-
statistics
Type: Privileged
Enables ignore statistics from
unauthorized clients.
ruckus(config-wlan)# description
Type: Privileged
<text> Sets the description.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 196
ruckus(config-wlan)# device-policy
Type: Privileged
[ <Policy Name> ] Sets the device policy.
ruckus(config-wlan)# dgaf
Type: Privileged
Disables downstream group-
address frame forwarding.
ruckus(config-wlan)# dhcp-option-
82
Type: Privileged
Enables DHCP option 82.
ruckus(config-wlan)# dhcp-option-
82-format
Type: Privileged
[ ruckus-gre | soft-gre ] Enables DHCP option 82 format
options.
ruckus(config-wlan)# disable-
band-balancing
Type: Privileged
Disables radio band balancing on
WLAN.
ruckus(config-wlan)# disable-load-
balancing
Type: Privileged
Disables client load balancing on
WLAN.
ruckus(config-wlan)# disable-wlan
Type: Privileged
Disables this WLAN service.
ruckus(config-wlan)# dnlink-limit
Type: Privileged
Sets the downlink rate limiting.
ruckus(config-wlan)# do
Type: Privileged
Executes the do command.
ruckus(config-wlan)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-wlan)# enable-type
Type: Privileged
Enables the WLAN service type.
ruckus(config-wlan)# enc-
algorithm
Type: Privileged
Sets the encryption algorithm.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 197
ruckus(config-wlan)# enc-method
Type: Privileged
Sets the encryption method.
ruckus(config-wlan)# enc-
passphrase
Type: Privileged
<password> Sets the encryption passphrase.
ruckus(config-wlan)# enc-wep-key
Type: Privileged
<wep-key-index> <wep-
key>
WEP key (HEX), length
should be 10 (WEP-64) or
26 (WEP-128)
Sets WEP key (HEX).
ruckus(config-wlan)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-wlan)# force-dhcp
Type: Privileged
timeout <seconds>
timeout: Sets the
disconnect client timeout
interval
<seconds>: Sets the
disconnect client timeout
in intervals of 5 - 15
seconds
Sets the timeout for DHCP in
seconds.
ruckus(config-wlan)# guest-
access
Type: Privileged
<name> Sets the guest access service.
ruckus(config-wlan)# guest-
access-auth-service
Type: Privileged
Sets the authentication server.
ruckus(config-wlan)# help
Type: Privileged
Displays the help.
ruckus(config-wlan)# hide-ssid
Type: Privileged
Hides SSID in beacon broadcast.
ruckus(config-wlan)# hotspot
Type: Privileged
<name> Sets the hotspot service.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 198
ruckus(config-wlan)# hotspot2
Type: Privileged
<name> Sets the hotspot 2.0 configuration.
ruckus(config-wlan)# inactivity-
timeout
Type: Privileged
<number> Sets the inactivity timeout.
Terminates idle user sessions after
the specified seconds of inactivity.
ruckus(config-wlan)# l2-acl
Type: Privileged
[ <ACL Name> ] Sets the layer 2 access control list.
ruckus(config-wlan)# mac-802-
11x-format
Type: Privileged
Sets the MAC authentication. Sets
the MAC address in 802.1X
format.
ruckus(config-wlan)# mac-auth
Type: Privileged
<password> Sets the MAC authentication.
ruckus(config-wlan)# max-clients
Type: Privileged
<number> Sets the maximum clients. Allows
clients per AP radio to associate
with this WLAN. Range is between
1 and 512.
ruckus(config-wlan)# mgmt-tx-rate
Type: Privileged
[ 5.5mbps | 48mbps |
6mbps | 2mbps | 36mbps
| 1mbps | 18mbps |
12mbps | 54mbps |
9mbps | 11mbps |
24mbps ]
Sets the management Tx rates.
ruckus(config-wlan)# no
Type: Privileged
access-network
acct-delay-time
acct-service
acct-service-use-proxy
acct-ttg-session
auth-service-use-proxy
bss-minrate
client-fingerprinting
client-tx-rx-statistics
Disables or deletes the
configurations that have been set.
........................continued
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 199
ruckus(config-wlan)# no
Type: Privileged
device-policy
dgaf
dhcp-option-82
disable-band-balancing
disable-load-balancing
disable-wlan
dnlink-limit
force-dhcp
hide-ssid
l2-acl
mac-802-11x-format
mac-auth
ofdm-only
onboarding-auth-service-
use-proxy
proxy-arp
roam
support-802-11d
uplink-limit
user-traffic-profile
vlan-enabled
wireless-client-isolation
zero-it-activation
zero-it-onboarding
Disables or deletes the
configurations that have been set.
ruckus(config-wlan)# ofdm-only
Type: Privileged
Enables OFDM only.
ruckus(config-wlan)# onboarding-
auth-service
Type: Privileged
<name> Sets the onboarding
authentication service.
ruckus(config-wlan)# onboarding-
auth-service-use-proxy
Type: Privileged
Sets the onboarding
authentication service using the
SZ proxy server.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 200
ruckus(config-wlan)# priority
Type: Privileged
Sets the priority as either low or
high.
ruckus(config-wlan)# proxy-arp
Type: Privileged
Enables proxy ARP.
ruckus(config-wlan)# radius-nas-id
Type: Privileged
<number> Sets the RADIUS NAS ID.
ruckus(config-wlan)# radius-nas-
max-retries
Type: Privileged
<times> Sets the maximum number of
retries for RADIUS NAS.
ruckus(config-wlan)# radius-nas-
reconnect-primary
Type: Privileged
<minutes> Sets the reconnection to the
primary RADIUS NAS.
ruckus(config-wlan)# radius-nas-
request-timeout
Type: Privileged
<seconds> Sets the RADIUS NAS request
timeout.
ruckus(config-wlan)# radius-nas-
type
Type: Privileged
Sets the RADIUS NAS type.
ruckus(config-wlan)# roam
Type: Privileged
Enables roaming.
ruckus(config-wlan)# roam-factor
Type: Privileged
2.4g <value>
5g <value>
Sets the roam factor.
ruckus(config-wlan)# scheduler
Type: Privileged
[ <profile name> ] Sets the WLAN scheduler profile.
ruckus(config-wlan)# ssid
Type: Privileged
<ssid> Sets the WLAN SSID
configuration.
ruckus(config-wlan)# support-802-
11d
Type: Privileged
Enables support for 802.11d.
ruckus(config-wlan)# uplink-limit
Type: Privileged
Sets the uplink rate limiting.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 201
ruckus(config-wlan)# user-traffic-
profile
Type: Privileged
Sets the user traffic profile.
ruckus(config-wlan)# vlan-enabled
Type: Privileged
Enables dynamic VLAN.
ruckus(config-wlan)# vlan-id
Type: Privileged
<vlan-id> Sets the VLAN ID.
ruckus(config-wlan)# web-
authentication
Type: Privileged
<name> Sets the web authentication
service.
ruckus(config-wlan)# wireless-
client-isolation
Type: Privileged
Sets the wireless client isolation.
ruckus(config-wlan)# zero-it-
activation
Type: Privileged
Enables zero-it activation (WLAN
users are provided with wireless
configuration installer after they log
in).
ruckus(config-wlan)# zero-it-
onboarding
Type: Privileged
Enables zero-it device registration
from the guest portal.
Table 64. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan-group
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 202
wlan-group
To create or update the WLAN group configurations, use the following command.
ruckus(config)# wlan-group <name>
Syntax Description
This command uses the following syntax:
<name>: WLAN group name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# wlan-group wan1
Related Commands
Table 65 lists the related wlan-group configuration commands.
.
Table 65. Commands related to ruckus(config-wlan-group)
Syntax and Type Parameters (if any) Description
ruckus(config-wlan-group)#
description
Type: Privileged
<text> Sets the description,
ruckus(config-wlan-group)# do
Type: Privileged
Executes the do command.
ruckus(config-wlan-group)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-wlan-group)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-wlan-group)# help
Type: Privileged
Displays the help.
ruckus(config-wlan-group)# no
Type: Privileged
wlan <name> Disables or deletes the
configuration settings.
Configuration Commands
wlan-scheduler
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 203
wlan-scheduler
To create or update the WLAN scheduler configurations, use the following
command.
ruckus(config)# wlan-scheduler <name>
Syntax Description
This command uses the following syntax:
<name>: WLAN scheduler name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# wlan-scheduler wan1
ruckus(config-wlan-group)# wlan
Type: Privileged
<name> vlan <vlanTag>
nasid <nasid>
<name> nasid <nasid>
vlan <vlanTag>
<name> vlan <vlanTag>
<name> nasid <nasid>
<name>
Sets a WLAN in this group, or
overrides the VLAN setting.
Table 65. Commands related to ruckus(config-wlan-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan-scheduler
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 204
Related Commands
Table 66 lists the related wlan-scheduler configuration commands.
.
Table 66. Commands related to ruckus (config-wlan-scheduler)
Syntax and Type Parameters (if any) Description
ruckus(config-wlan-scheduler)#
description
Type: Privileged
<text> Sets the description,
ruckus(config-wlan-scheduler)#
schedule-data
Type: Privileged
${state} ${weekday}
${from} ${to}
Sets the schedule table.
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 205
5
Debug Commands
This chapter describes the commands that you can use to debug the SZ-100. The
following table lists the commands.
debug
To execute commands in debug mode, you need to change the mode to:
ruckus(debug)#
Example
SZ100-Node1# debug
SZ100-Node1(debug)#
Table 67. Debug commands
debug ap-subnet-
discovery
apcli delete diagnostic
do end exit export log help
no ap-subnet-
discovery
no screen-
pagination
no ssslv3 screen-
pagination
show
sslv3
Debug Commands
ap-subnet-discovery
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 206
ap-subnet-discovery
To enable AP subnet discover service, use the following command:
ruckus(debug)# ap-subnet-discovery
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# ap-subnet-discovery
Shutting down Avahi daemon: [ OK ]
Starting Avahi daemon... [ OK ]
Successful operation
apcli
To run AP CLI debug script management, use the following command:
ruckus(debug)# apcli
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# apcli
SZ100-Node1(debug-apcli)#
Debug Commands
apcli
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 207
Related Commands
Table 68 lists the related debug apcli configuration commands.
Table 68. Commands related to ruckus(debug-apcli)
Syntax and Type Parameters (if any) Description
ruckus(debug-apcli)# do
Type: Privileged
Executes the do command.
ruckus(debug-apcli)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(debug-apcli)# execute
Type: Privileged
Executes the API CLI script.
ruckus(debug-apcli)# exit
Type: Privileged
Exits from the EXEC.
ruckus(debug-apcli)# help
Type: Privileged
Displays the help.
ruckus(debug-apcli)# show
Type: Privileged
diagnostic-script
schedule
Shows the diagnostic script or the
schedule script.
ruckus(debug-apcli)# show-
execution-status
Type: Privileged
Shows the script execution
summary.
ruckus(debug-apcli)# upload
Type: Privileged
<ftp-url> Uploads the API CLI script from a
remote FTP server.
Debug Commands
delete
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 208
delete
To delete a debug script that has been uploaded to the SZ, use the following
command:
ruckus(debug)# delete <script-name>
Syntax Description
This command uses the following syntax:
script-name: Name of the debug script that you want to delete
Default
This command has no default settings.
Command Mode
privileged
Example
SZ100-Node1(debug)# delete spn-1test
diagnostic
To run debug diagnostic script management, use the following command:
ruckus(debug)# diagnostic
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# diagnostic
SZ100-Node1(debug-diagnostic)#
Debug Commands
diagnostic
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 209
Related Commands
Table 69 lists the related debug diagnostic commands.
Table 69. Commands related to ruckus(debug-diagnostic)
Syntax and Type Parameters (If Any) Description
ruckus(debug-diagnostic)# delete
Type: Privileged
<name> Deletes a diagnostic script.
Specify the script name.
ruckus(debug-diagnostic)# do
Type: Privileged
Executes the do command.
ruckus(debug-diagnostic)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(debug-diagnostic)#
execute
Type: Privileged
<name> <params> Executes a diagnostic script.
Specify the script name.
ruckus(debug-diagnostic)# exit
Type: Privileged
Exits from the EXEC.
ruckus(debug-diagnostic)# help
Type: Privileged
Displays the help.
ruckus(debug-diagnostic)# no
Type: Privileged
<schedule> Disables the scheduled script.
ruckus(debug-diagnostic)#
schedule
Type: Privileged
<name> Schedules a script to run with
arguments.
ruckus(debug-diagnostic)# show
Type: Privileged
diagnostic-script
schedule
Shows the diagnostic or the
schedule script. Specify the script
name and its parameters.
ruckus(debug-diagnostic)# upload
Type: Privileged
<ftp-url>: FTP URL format
is: ftp://
<username>:<password
>@<ftp-host>/<file-path>
Uploads a diagnostic script from a
remote FTP server.
Debug Commands
do
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 210
do
To run the debug do command:
ruckus(debug)# do
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# do
end
To end the current configuration session and returns to privileged exec mode, use
the following command:
ruckus(debug)# end
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# end
Debug Commands
exit
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 211
exit
To exit from the exec mode, use the following command:
ruckus(debug)# exit
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# exit
export log
To export the local system logs to external FTP server, use the following command:
ruckus(debug)# export log <ftp-url> <ftp-url> app <name>
Syntax Description
This command uses the following syntax:
<ftp-url> - FTP URL, Format: ftp://<username>:<password>@<ftp-host>[/<dir-
path>]]
app: Application
<name>: Application name
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# export log ftp://mahan:ruckus1!@172.19.7.100
Debug Commands
help
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 212
help
To display the command line interface help, use the following command:
ruckus(debug)# help
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# help
no ap-subnet-discovery
To disable the AP subnet discovery service, use the following command:
ruckus(debug)# no ap-subnet-discovery
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no ap-subnet-discovery
Debug Commands
no screen-pagination
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 213
no screen-pagination
To disable the screen pagination, use the following command:
ruckus(debug)# no screen-pagination
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no screen-pagination
no ssslv3
To disable the SSLv3 support, use the following command:
ruckus(debug)# no sslv3
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no sslv3
Debug Commands
screen-pagination
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 214
screen-pagination
To enable the screen pagination, use the following command:
ruckus(debug)# screen-pagination
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# screen-pagination
show
To enable the screen pagination, use the following command:
ruckus(debug)# screen-pagination <ap-subnet-discovery-status > |
<sslv3-state>
Syntax Description
This command uses the following syntax:
ap-subnet-discovery-status: Shows the AP subnet discovery service status
sslv3-state: Shows the SSLv3 support state
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# show ap-subnet-discovery-status
enabled 1
SZ100-Node1(debug)# show sslv3-state
SLv3 support: disabled
Debug Commands
sslv3
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 215
sslv3
To enable the SSLV3 support, use the following command:
ruckus(debug)# sslv3
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# sslv3
Successful operation
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 216
6
Setup Commands
This chapter describes the commands that you can use Sets up the SZ-100
commands covered include:
•rbddump
•setup
rbddump
To display the board data of the SZ, use the following command:
ruckus# rbddump
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# rbddump
name: Gallus
magic: 35333131
cksum: b19
rev: 5.4
Serial#: 531336000194
Customer ID: ruckus
Model: sz124
V54 Board Type: Undef
V54 Board Class: AP71
Random#: 0000 0000 0000 0000 0000 0000 0000 0000
symimgs: no
ethport: 0
V54 MAC Address Pool: yes, size 32, base 24:C9:A1:3F:06:10
Setup Commands
setup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 217
major: 0
minor: 0
pciId: 0000
dblade0: yes 24:C9:A1:3F:06:20
dblade1: yes 24:C9:A1:3F:06:28
eth0: yes 24:C9:A1:3F:06:10
eth1: yes 24:C9:A1:3F:06:11
eth2: - 24:C9:A1:3F:06:12
eth3: - 24:C9:A1:3F:06:13
eth4: - 24:C9:A1:3F:06:14
eth5: - 24:C9:A1:3F:06:15
uart0: no
sysled: no, gpio 0
sysled2: no, gpio 0
sysled3: no, gpio 0
sysled4: no, gpio 0
Fixed Ctry Code: no
Antenna Info: no, value 0x00000000
Local Bus: disabled
factory: yes, gpio 8
serclk: internal
cpufreq: calculated 0 Hz
sysfreq: calculated 0 Hz
memcap: disabled
watchdg: enabled
setup
Sets up the SZ network interface settings, use the following command:
ruckus# setup
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Setup Commands
setup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 218
Example
SZ# setup
Stopping crond: [ OK ]
################################################
Start SZ104 setup process:
################################################
************************************
Port Grouping Configuration
************************************
1. One Port Group
[ETH 1-4] Management/AP Tunnel Traffic
2. Two Port Group
[ETH 1-2] Port Group 1: Management & AP Control
[ETH 3-4] Port Group 2: AP Tunnel Data
************************************
Select Port Grouping Configuration (1/2) [1]2
Current network settings:
************************************
Port Group 1: Management & AP Control:
************************************
IP TYPE :
IP Address :
Netmask :
Gateway :
Default Gateway :
************************************
************************************
IP address setup for Port Group 1: Management & AP Control
************************************
1. MANUAL
2. DHCP
************************************
Select IP configuration: (1/2) 2
Setup Commands
setup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 219
************************************
Port Group 1: Management & AP Control:
************************************
IP Address : 182.21.160.67
Netmask : 255.255.255.240
Gateway : 182.21.160.65
************************************
Are these correct? (y/n): y
Execute networking configuration of Port Group 1: Management & AP
Control!
Save networking configuration of Port Group 1: Management & AP
Control!
Primary DNS: 4.2.2.2
Secondary DNS: 172.19.0.5
************************************
IP address setup for Port Group 2: AP Tunnel Data
************************************
1. MANUAL
2. DHCP
************************************
Select IP configuration: (1/2) 2
************************************
Interface : DataPlane0
Type : dhcp
************************************
Are these correct? (y/n): y
Execute dataplane networking configuration of Port Group 2: AP
Tunnel Data!
Save dataplane networking configuration of Port Group 2: AP Tunnel
Data!
(C)reate a new cluster or (J)oin an exist cluster: (c/j) c
Cluster Name ([a-zA-Z0-9_-]): ruckController Description: SZ104 for
FT
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 220
7
Show Commands
This chapter describes the commands that you can use to view information about
the various components of SZ-100. The following table lists the various show
commands.
NOTE: Use the “do show” command to use show commands in either user or
privileged mode.
Table 70. Show commands
show admin-
activity
show alarm show ap show ap-stats show backup
show backup-
config
show backup-
config-state
show backup-
network
show backup-
state
show backup-
upgrade-state
show client show clock show cluster show cluster-
node
show cluster-
state
show control-
plane-stats
show cpuinfo show dhcp-
relay-stats
show diskinfo show event
show history show interface show internal-
subnet
show ip show license
show meminfo show ntp show radius-
proxy-stats
show report-
result
show rogue-aps
show running-
config
show service show upgrade-
history
show upgrade-
state
show version
Show Commands
show admin-activity
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 221
show admin-activity
To view the activities of an administrator account, use the following command:
ruckus# show admin-activity
Syntax Description
This command uses the following syntax:
admin <username>
admin: Filtered by user
<username>: User name
ip <ip>
ip: Filtered by browser IP
<ip>: Browser IP
resource <resource> <action>
resource: Filtered by resource
<resource>: Resource
<action>: Resource action
datetime <from-time> <to-time>
datetime: Filtered by datetime
<from-time>: From time
<to-time>: To time
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show admin-activity SZ_admin
No. Datetime Administrator Browser IP
Action Resource Description
----- ------------------------ -------------- -------------------
1 2014-09-11 17:27:33 GMT admin 172.19.10.9
Log on Administrator Administrator [admin] logged on
from CLI
Show Commands
show alarm
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 222
2 2014-09-11 16:53:26 GMT admin 172.19.10.9
Log on Administrator Administrator [admin] logged on
from CLI
3 2014-09-11 16:52:41 GMT admin 172.19.10.9
Create System System configuration backup created.
4 2014-09-11 16:51:27 GMT admin 172.19.10.9
Log on Administrator Administrator [admin] logged on
from CLI
show alarm
To see the outstanding access point alarms, use the following command:
ruckus# show alarm
Syntax Description
This command uses the following syntax:
category <alarm-category>
category: Filtered by alarm category
<alarm-category>: Alarm category
control-plane <name>
control-plane: Control Plane
<name>: Plane name
data-plane <name>
data-plane: Data Plane
<name>: Plane name
ap-mac <value>
ap-mac: AP MAC address
<value>: Filter Value
status [ outstanding | cleared ]
status: Filtered by Status
outstanding: Outstanding
cleared: Cleared
ack-time <ack-from-time> <ack-to-time>
ack-time: Filtered by Acknowledge Time
Show Commands
show ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 223
<ack-from-time>: From time
<ack-to-time>: To time
datetime <from-time> <to-time>
datetime: Filtered by Datetime
<from-time>: From time
<to-time>: To time
severity [ minor | info | major | critical | warn ]
severity: Filtered by Severity
minor: Minor
info: Informational
major: Major
critical: Critical
warn: Warning
type <alarm-type>
type: Filtered by Type
<alarm-type>: Alarm type
Default
This command has no default settings.
Command Mode
privileged
Example
SZ30# show alarm category session control-plane indus7-c
show ap
To display details about a particular access point, use the following command:
ruckus# show ap <mac> <mac> mesh [ downlinks | neighbors | topology ]
Syntax Description
This command uses the following syntax:
show ap: Displays a list of MAC addresses of managed access points
show ap <mac>: Displays information about the access point with the MAC
address you specified
Show Commands
show ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 224
show <mac> mesh [ downlinks | neighbors | topology ]: Displays the following
information:
<mac>: AP MAC address
mesh: AP Mesh stats
downlinks: Show AP Mesh downlinks
neighbors: Show AP Mesh neighbors
topology: Show AP Mesh topology
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show ap
1: 00:0C:29:02:7C:E1
2: 00:0C:29:01:B7:E1
SZ30# show ap 00:0C:29:02:7C:E1
General Information
-----------------------------------
AP MAC Address : 00:0C:29:02:7C:E1
AP Name : Sim-10191
Description :
Serial Number : 870731467648
Location :
GPS Coordinates : 40.831,-76.457
Firmware Version : 9.4.0.2.81
IP Address : 4.112.40.32
External IP Address : 10.2.4.112:54188
Model : ZF7343
Mesh Role (Hops) : Disabled
Status Summary
-----------------------------------
Connection Status : Connect
Uptime : 21d 5h 6m
Configuration Status: Up-to-date
AP Zone : sim-zone-10
Show Commands
show ap-stats
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 225
Control Plane : SZ186
Data Plane :
Associated Clients : 4
Sensor Information
-----------------------------------
Sensor Available : Disabled
Mounting Direction :
Current Temperature :
Highest Temp Since Bootup :
Lowest Temp Since Bootup :
show ap-stats
To display the AP statistics, use the following command:
ruckus# show ap-stats
Syntax Description
This command uses the following syntax:
<mac> type [ ap-traffic | client-count | client-association ] ap period [ 30-d | 8-h
| 24-h | 7-d ]
<mac>: AP MAC address
type: Statistics data type
ap-traffic: AP Traffic
client-count: Client count
client-association: Client associations
ap: Per AP
period: Statistics period
30-d: 30 days
8-h: 8 hours
24-h: 24 hours
7-d: 7 days
<mac> type [ ap-traffic | client-association | client-count ] radio [ 2.4g | 5g ] period
[ 8-h | 30-d | 7-d | 24-h ]
<mac>: AP MAC address
type: Statistics data type
Show Commands
show ap-stats
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 226
ap-traffic: AP Traffic
client-association: Client associations
client-count: Client count
radio: Per Radio
2.4g: 2.4 GHz radio
5g: 5 GHz radio
period: Statistics period
8-h: 8 hours
30-d: 30 days
7-d: 7 days
24-h: 24 hours
<mac> type [ client-association | client-count | ap-traffic ] wlan <ssid> period [
30-d | 24-h | 8-h | 7-d ]
<mac>: AP MAC address
type: Statistics data type
client-association: Client associations
client-count: Client count
ap-traffic: AP Traffic
wlan: WLAN
<ssid>: WLAN SSID
period: Statistics period
30-d: 30 days
24-h: 24 hours
8-h: 8 hours
7-d: 7 days
<mac> type [ client-association | client-count | ap-traffic ] wlan <ssid> radio [
2.4g | 5g ] period [ 7-d | 24-h | 8-h | 30-d ]
<mac>: AP MAC address
type: Statistics data type
client-association: Client associations
client-count: Client count
ap-traffic: AP Traffic
Show Commands
show ap-stats
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 227
wlan: WLAN
<ssid>: WLAN SSID
radio: Per Radio
2.4g: 2.4 GHz radio
5g: 5 GHz radio
period: Statistics period
7-d: 7 days
24-h: 24 hours
8-h: 8 hours
30-d: 30 days
<mac> type client-os
<mac>: AP MAC address
type: Statistics data type
client-os: Client OS types
<mac> type client-os wlan <ssid>
<mac>: AP MAC address
type: Statistics data type
client-os: Client OS types
wlan: WLAN
<ssid>: WLAN SSID
<mac> type rks-gre period [ 7-d | 30-d | 8-h | 24-h ]
<mac>: AP MAC address
type: Statistics data type
rks-gre: Ruckus GRE tunnel usage
period: Statistics period
7-d: 7 days
30-d: 30 days
8-h: 8 hours
24-h: 24 hours
<mac> type air-time radio [ 2.4g | 5g ] period [ 8-h | 30-d | 7-d | 24-h ]
<mac>: AP MAC address
type: Statistics data type
Show Commands
show backup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 228
air-time: Air Time
radio: Per Radio
2.4g: 2.4 GHz radio
5g: 5 GHz radio
period: Statistics period
8-h: 8 hours
30-d: 30 days
7-d: 7 days
24-h: 24 hours
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show ap-stats A1:87:45:34:56:FE
show backup
To display a list of available system backup versions, use the following command:
ruckus# show backup
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show backup
No. Created on Patch Version File Size
----- ----------------------------- --------------------------
1 2014-07-16 22:47:04 GMT 3.0.0.0.277
837.9MB
2 2014-07-26 16:23:00 GMT 3.0.0.0.308 895.2MB
Show Commands
show backup-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 229
3 2014-07-26 19:45:17 GMT 3.0.0.0.308 892.9MB
4 2014-08-01 18:00:38 GMT 3.0.0.0.327 938.9MB
5 2014-08-02 17:02:09 GMT 3.0.0.0.327 920.4MB
6 2014-08-12 14:25:52 GMT
3.0.0.0.338 998.2MB
7 2014-08-27 15:05:05 GMT 3.0.0.0.351 1GB
8 2014-09-04 12:19:54 GMT 3.0.0.0.371 1.1GB
9 2014-09-10 18:37:55 GMT 3.0.0.0.394 1.1GB
idx version date
------------------------------------------
1 1.1.0.0.207 2012-10-16 06:46:07 GMT
2 1.1.0.0.209 2012-10-17 05:20:51 GMT
show backup-config
To display a list of available configuration backup versions, use the following
command:
ruckus# show backup-config
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show backup-config
No. Created on Version CP Version
DP Version Created By Backup Elapsed File Size
----- --------------------------- -------------- -------------
1 2014-09-11 16:52:41 GMT 3.0.0.0.401 3.0.0.0.1164
3.0.0.0.130 admin 1 249.8KB
2 2014-07-22 15:30:43 GMT 3.0.0.0.308 3.0.0.0.863
3.0.0.0.94 admin 1 156.5KB
3 2014-07-17 21:28:50 GMT 3.0.0.0.308 3.0.0.0.863
3.0.0.0.94 admin 1 153.9KB
Show Commands
show backup-config-state
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 230
4 2014-07-15 13:02:58 GMT 3.0.0.0.277 3.0.0.0.769
3.0.0.0.82 admin 1 110KB
5 2014-07-11 16:00:27 GMT 3.0.0.0.277 3.0.0.0.769
3.0.0.0.82 admin 1 107.8KB
show backup-config-state
To display the status of the available configuration backup, use the following
command:
ruckus# show backup-config-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show backup-config-state
Operation : Successful
Progress Status : Completed
show backup-network
To display backup network configuration versions, use the following command:
ruckus# show backup-network
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Show Commands
show backup-state
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 231
Example
SZ30# show backup-network
No. Created on Patch Version File Size
----- ----------------------------- --------------------------
1 2014-09-11 16:53:26 GMT 3.0.0.0.401 1.2KB
show backup-state
To display the system backup state, use the following command:
ruckus# show backup-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show backup-state
No running configuration
Show Commands
show backup-upgrade-state
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 232
show backup-upgrade-state
To display the system backup system backup and upgrade state, use the following
command:
ruckus# show backup-upgrade-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show backup-upgrade-state
No running configuration
show client
To display current AP associated client sessions, use the following command:
ruckus# show client <client-mac>
Syntax Description
This command uses the following syntax:
<client-mac>: Client MAC IP address
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show client 00:03:00:15:40:08
General Information
-----------------------------------
STA MAC Address : 00:03:00:15:40:08
IP Address : 1.21.64.8
User Name :
Show Commands
show clock
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 233
Auth Method : NONE
Encryption Method :
Connected Since :
OS Type :
Host Name :
Status : Unauthorized
AP Zone : Antonio-Sim
Access Point : Sim-21
-----------------------------------
Channel : 0
VLAN : 1
SNR (dB) : 32
Packets from Client : 0
Bytes from Client : 67.3K
Packets to Client : 0
Bytes to Client : 134.6K
Dropped Packets to Client : 427.9K
# of Events
Critical : 0
Major : 0
Minor : 0
Warning : 0
Informational : 0
show clock
To display the current GMT date and time, use the following command:
ruckus# show clock
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show clock
2014-09-11 17:47:34 GMT
Show Commands
show cluster
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 234
show cluster
To display the system cluster settings, use the following command:
ruckus# show cluster
Syntax Description
This command uses the following syntax:
<name>: Name of the cluster
<ip-list>: Cluster node IP list
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show cluster 172.17.22.11
show cluster-node
To display the cluster node status, use the following command:
ruckus# show cluster-node <name>
Syntax Description
This command uses the following syntax:
<name>: Name of the node
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show cluster-node ez1
Show Commands
show cluster-state
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 235
show cluster-state
To display the system cluster state, use the following command:
ruckus# show cluster-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show cluster-state
Current Node Status : In service
Cluster Status : In service
Cluster Operation : None
System Mode : None
Cluster Node Information
--------------------------------------------------------------
No. Name Role
----- ------------------------ -----------
1 NTeja1-C LEADER
show control-plane-stats
To display control plane status, use the following command:
ruckus# show control-plane-stats <name>
Syntax Description
This command uses the following syntax:
<name> type [ memory | disk | cpu ] period [ 7-d | 30-d | 24-h | 8-h ]
<name>: Controlplane name
type: Statistics data type
memory: Memory usage
disk: Disk usage
cpu: CPU usage
Show Commands
show control-plane-stats
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 236
period: Statistics period
7-d: 7 days
30-d: 8 hours
24-h: 24 hours
8-h: 8 hours
<name> type port <name> period [ 8-h | 30-d | 24-h | 7-d ]
<name>: Controlplane name
type: Statistics data type
port: Port usage
<name>: Port name
period: Statistics period
8-h: 8 hours
30-d: 30 days
24-h: 24 hours
7-d: 7 days
<name> type interface <type> period [ 24-h | 7-d | 8-h | 30-d ]
<name>: Control Plane name
type: Statistics data type
interface: Interface usage
<type>: Interface type
period: Statistics period
24-h: 24 hours
7-d: 7 days
8-h: 8 hours
30-d: 30 days
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show control-plane-stats indus7-c
Show Commands
show cpuinfo
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 237
show cpuinfo
To display the current CPU usage status, use the following command:
ruckus> show cpuinfo
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show cpuinfo
processor : 0
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 1
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 2
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 3
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 4
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 5
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 6
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
processor : 7
model name : Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz
Cpu(s): 51.0%us, 0.2%sy, 0.0%ni, 48.1%id, 0.8%wa, 0.0%hi,
0.0%si, 0.0%st
Show Commands
show dhcp-relay-stats
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 238
show dhcp-relay-stats
To display a list of DHCP relay statistics, use the following command:
ruckus# show dhcp-relay-stats
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show dhcp-relay-stats
show diskinfo
To display the current disk usage on the SmartZone, use the following command:
ruckus> show diskinfo
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show diskinfo
Filesystem Size Used Avail Use% Mounted on
/dev/sda3 20G 2.1G 17G 12% /
/dev/mapper/vg00-lv00 242G 22G 208G 10% /data
tmpfs 1.0G 812K 1.0G 1% /tmp
/dev/sda1 9.9G 151M 9.2G 2% /boot_mbr
Show Commands
show event
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 239
show event
To see events based on staging zones, use the following command:
ruckus# show event
Syntax Description
This command uses the following syntax:
category <event-category>
category: Filtered by event category
<event-category>: Event category
control-plane <name>
control-plane: Control Plane
<name>: Plane name
data-plane <name>
data-plane: Data Plane
<name>: Plane name
ap-mac <value>
ap-mac: AP MAC address
<value>: Filter Value
<client-mac>
<client-mac>: Client MAC address
datetime <from-time> <to-time>
datetime: Filtered by Datetime
<from-time>: From time
<to-time>: To time
severity [ minor | warn | debug | major | critical | info ]
severity: Filtered by Severity
minor: Minor
warn: Warning
debug: Debug
major: Major
critical: Critical
info: Informational
type <event-type>
Show Commands
show history
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 240
type: Filtered by Type
<event-type>: Event type
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show event A1:87:45:34:56:FE
show history
To display a list of CLI commands that have recently been executed, use the
following command:
ruckus# show history
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show history
0. en
1. config
2. helop
3. help
4. exit
5. help
6. ping host
7. ping 172.19.10.9
8. setup
9. show clock
10. show cpuinfo
11. show diskinfo
Show Commands
show interface
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 241
12. show meminfo
13. show version
show interface
To display the interface runtime status, use the following command:
ruckus# show interface
Syntax Description
This command uses the following syntax:
cluster
cluster: Cluster interface
control
control: Control interface
management
management: Management interface
mgmt-or-ap-tunnel
mgmt-or-ap-tunnel: Management/AP Tunnel Traffic
mgmt-and-ap-control
mgmt-and-ap-control: Management & AP Control
ap-tunnel-data
ap-tunnel-data: AP Tunnel Data
user-defined
user-defined: User defined interface
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show interfaces
===================================================
Interfaces
--------------------------------------------------------------
Interface : Management & AP Control
IP Mode : Static
Show Commands
show internal-subnet
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 242
IP Address : 172.19.10.9
Subnet Mask : 255.255.0.0
Gateway : 172.19.10.254
Interface : AP Tunnel Data
IP Mode : Static
IP Address : 121.0.0.5
Subnet Mask : 255.255.255.0
Gateway : 121.0.0.1
Primary DNS Server : 172.19.0.5
Secondary DNS Server : 4.2.2.2
User Defined Interfaces
------------------------------------------------------------
IP Address : 172.19.10.91
Subnet Mask : 255.255.0.0
Gateway :
VLAN : 1
Physical Interface : Control
show internal-subnet
To display the runtime internal subnet prefix, use the following command:
ruckus# show internal-subnet
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show internal-subnet
Internal Subnet Prefix: 10.254.1
Show Commands
show ip
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 243
show ip
To display information about SmartZone static route, use the following command:
ruckus# show ip <route static>
Syntax Description
This command uses the following syntax:
route: IP routing table
static: Static routes
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show ip route static
Static Routes
--------------------------------------------------------------
No. Network Address Subnet Mask Gateway
Interface Metric
----- ------------------- ------------------- ----------------
1 10.1.31.0 255.255.255.0 172.19.9.1
Control 0
show license
To display information about the current SmartZone license, use the following
command:
ruckus# show license
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Show Commands
show license
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 244
Example
SZ30# show license
License Summary
--------------------------------------------------------------
No. License Type #of Units Total #of
Units Consumed #of Units Available
- ------------------------- ------------------------ ---------
1 WiFi Controller License 50 1
(2%) 49 (98%)
2 AP Direct Tunnel License 10 0
(0%) 10 (100%)
--------------------------------------------------------------
License Information
--------------------------------------------------------------
Copy/paste this URL to activate your product today.
https://support.ruckuswireless.com/activate
Installed Licenses
-------------------------------------------------------------------------------------------
No. SZ Node Feature Capacity Description
Start Date Status Expiration Date
----- -------------- ----------------- --------- --------------
1 NTeja1 CAPACITY-RXGW-DE 10 Default AP
Direct Tunnel Lic 2014-08-12 GMT valid Permanent
FAULT ense for SZ100
Show Commands
show meminfo
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 245
show meminfo
To view the current memory usage status, use the following command:
ruckus> show meminfo
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Enable
Example
SZ30# show meminfo
MemTotal: 32775708 kB
MemFree: 13928668 kB
Buffers: 181264 kB
Cached: 785124 kB
SwapCached: 0 kB
total used free shared buffers cached
Mem: 32775708 18847040 13928668 0 181264 785124
-/+ buffers/cache: 17880652 14895056
Swap: 4194296 0 4194296
show ntp
To view the NTP status, use the following command:
ruckus# show ntp <associations>
Syntax Description
This command uses the following syntax:
associations: NTP peer status.
Default
This command has no default settings.
Command Mode
Privileged
Show Commands
show radius-proxy-stats
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 246
Example
SZ30# show ntp associations
remote refid st t when poll reach delay offset jitter
==============================================================
123.108.200.163 .INIT. 16 u - 1024 0 0.000
0.000 0.000
*LOCAL(0) .LOCL. 12 l 18 64 377 0.000
0.000 0.000
show radius-proxy-stats
To view statistics of RADIUS proxy on SmartZone, use the following command:
ruckus# show radius-proxy-stats
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show radius-proxy-stats
No. MVNO Account Control Plane AAA IP Created
On Last Modified On NAS Type Auth
Accounting ACCESS Request ACCESS Challenge ACCESS Accept
ACCESS Reject Account Request Accounting Response CoA (AAA)
DM (AAA) DM (NAS) Dropped requests due to rate Limiting
(Auth/Acc) AP Accounting AP Accounting Request/Response CoA
(NAS) CoA Autz Only
------------ ----------- --------------
1 Super INDUS7-C 104.0.0.10 2014-04-18 11:22:18 GMT 2014-
04-24 13:33:17 GMT Ruckus AP 76/0/0 59/11 112/112 0/0 76/76
0/0 178/178 118/118 0/0/0 0/0/0 0/0/0 12/65 59/12 178/118 0/0/
0 0/0/0
Show Commands
show report-result
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 247
show report-result
To view report results or to view a specific report, use the following command:
ruckus# show report-result <report-title>
Syntax Description
This command uses the following syntax:
report-title: Report title
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show report-result report1
No.Date and Time Title Report Template Result Links Status Time
Taken
---------- ------------- ------------------------------------
1 2014-04-25 09:02:26 GMT Report1Client Number CSV Success 43ms
2 2014-04-25 00:00:02 GMT Report1 Client Number CSV Success 19ms
3 2014-04-24 00:00:02 GMT Report1 Client Number CSV Success 23ms
4 2014-04-23 00:00:02 GMT Report1 Client Number CSV Success 20ms
show rogue-aps
To view the rouge access points, use the following command:
ruckus# show rouge-aps rogueMac ${rogueMac}
ruckus# show rouge-aps type [ MaliciousAP(SSID-spoof) | Ad-hoc | Rogue
| MaliciousAP(Same-Network) | MaliciousAP(MAC-spoof) |
RogueAPtimeout ]
Syntax Description
This command uses the following syntax:
rogueMac ${rogueMac}
rogueMac: Rogue Mac
${rogueMac}:
type [ MaliciousAP(SSID-spoof) | Ad-hoc | Rogue | MaliciousAP(Same-Network)
| MaliciousAP(MAC-spoof) ]
Show Commands
show running-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 248
type: Rogue Type
MaliciousAP(SSID-spoof): Malicious AP (SSID-spoof)
Ad-hoc: Ad-hoc
Rogue: Rogue
MaliciousAP(Same-Network): Malicious AP (Same-Network)
MaliciousAP(MAC-spoof): Malicious AP (MAC-spoof)
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show rogue-aps type type
No data found
show running-config
To view the current system configuration, use the following commands:
ruckus# show running-config
Syntax Description
This command uses the following syntax:
ap <mac>
ap: Show AP configurations
<mac>: AP MAC IP address
ap-heartbeat
ap-heartbeat:
ap-auto-tagging
ap-auto-tagging: Show critical AP auto tagging rules configurations
ap-cert-check
ap-cert-check:
ap-root-ca
ap-root-ca:
dhcp-service <name>
Show Commands
show running-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 249
dhcp-service:
<name>: DHCP service name
lbs-service <name>
lbs-service:
<name>: LBS service name
sms-server
sms-server: Enable SMS server configurations
admin <username>
admin:
<username>: User name
admin-radius <name>
admin-radius:
<name>: RADIUS server name
role <name>
role:
<name>: Role name
user-role <name>
user-role:
<name>: User role name
cluster-node <name>
cluster-node: Show cluster node configurations
<name>: Cluster node name
cluster-node <name> ip route static
cluster-node: Show cluster node configurations
<name>: Cluster node name
ip: Show cluster node IP configurations
route: Show cluster node routing configurations
static: Show static routes
cluster-node <name> interface user-defined <name>
cluster-node: Show cluster node configurations
<name>: Cluster node name
interface: Show interface configurations
user-defined: Show user defined interface configurations
Show Commands
show running-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 250
<name>: User defined interface name
cluster-node <name> interface ${ifName}
cluster-node: Show cluster node configurations
<name>: Control plane name
interface: Show interface configurations
${ifName}:
snmp-trap
snmp-trap:
snmp-v2-community <snmp-community>
snmp-v2-community: Show SNMPv2 community configurations
<snmp-community>: SNMPv2 community
event
event: Show Events configurations
event ${eventCode}
event:
${eventCode}:
event email
event:
email:
snmp-v3-user <snmp-user>
snmp-v3-user: Show SNMPv3 user configurations
<snmp-user>: SNMPv3 User
interface ${ifName}?
interface:
${ifName}?:
interface user-defined <name>
interface:
user-defined: Show user defined interface configurations
<name>: User defined interface name
ip route static
ip: Show control plane IP configurations
route: Show control plane routing configurations
static: Show static routes
Show Commands
show running-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 251
internal-subnet
internal-subnet: Show internal subnet prefix
proxy-aaa <name>
proxy-aaa: Show proxy AAA server configurations
<name>: Proxy AAA server name
user-traffic-profile <name>
user-traffic-profile:
<name>: User traffic profile name
ntp-server
ntp-server:
lineman
lineman:
smtp-server
smtp-server
ftp-server <name>
ftp-server:
<name>: FTP name
syslog-server
syslog-server:
northbound-portal
northbound-portal: Show northbound portal interface configurations
web-cert
web-cert:
ap-portal-cert
ap-portal-cert:
user-agent-blacklist <name>
user-agent-blacklist: Show user agent black list configurations
<name>: User agent black name
lwapp2scg
lwapp2scg: Show LWAPP2SCG configuration
encrypt-mac-ip
encrypt-mac-ip:
ap-control-mgmt-tos
Show Commands
show running-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 252
ap-control-mgmt-tos:
license
license:
report <report-title>
report:
<report-title>: Report title
non-proxy-aaa <name>
non-proxy-aaa: Show non proxy AAA server configurations
<name>: Non proxy AAA server name
hotspot <name>
hotspot: Show WISPr (hotspot) configurations
<name>: WISPr (hotspot) name
guest-access <name>
guest-access: Show guest access configurations
<name>: Guest access name
web-authentication <name>
web-authentication: Show web authentication configurations
<name>: Web authentication name
wlan-scheduler <name>
wlan-scheduler: Show WLAN scheduler profile configurations
<name>: WLAN scheduler name
wlan <name>
wlan: Show WLAN configurations
<name>: WLAN name
ap-group <name>
ap-group: Show AP group configurations
<name>: AP group name
wlan-group <name>
wlan-group: Show WLAN group configurations
<name>: WLAN group name
common-settings
common-settings: Show wireless network common configurations
common-settings [ ap-model | ap-tunnel-settings | ap-sci ]
Show Commands
show running-config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 253
common-settings: Show wireless network common configurations
ap-model: Show AP model setting
ap-tunnel-settings: Show AP tunnel settings
ap-sci: Show AP SCI
common-settings [ ap-model | ap-tunnel-settings | ap-sci ] ${apModel}?
common-settings: Show wireless network common configurations
ap-model: Show AP model setting
ap-tunnel-settings: Show AP tunnel settings
ap-sci: Show AP SCI
${apModel}?:
bonjour-gateway
bonjour-gateway: Show bonjour gateway
bonjour-policy <name>
bonjour-policy: Show bonjour policy
<name>: Policy name
ap-list
ap-list: Show AP configurations list
hotspot-v2-sp <name>
hotspot-v2-sp: Show hotspot 2.0 service provider profile configurations
<name>: Service provider profile name
hotspot-v2-op <name>
hotspot-v2-op: Show hotspot 2.0 operator profile configurations
<name>: Operator profile name
device-policy <name>
device-policy: Show device policy
<name>: Policy name
l2-acl <name>
l2-acl: Show Layer 2 Access Control list
<name>: ACL name
Default
This command has no default settings.
Show Commands
show service
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 254
Command Mode
Privileged
Example
SZ30# show running-config license
License Server Configuration
------------------------------------------------------------
Cloud License Server : Enabled
SZ30# show running-config user-role
No. User Role Name Description
----- ------------------------------- ----------------------
1 Default Allow Access to All WLANs
SZ30# show running-config user-traffic-profile
No. Name
Default Action Description
----- ----------------------------- ------------------------
1 Factory Default Allow The default UTP package
show service
To view the system service state, use the following command:
ruckus# show service
Syntax Description
This command uses the following syntax:
name: System service name
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show service
No. Application Name Health Status Log Level # of Logs
----- ------------------------ ---------------- ------------ ---
1 API Online WARN 2
2 AUT Online WARN 1
3 CNR Online DEBUG 10
Show Commands
show upgrade-history
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 255
4 CaptivePortal Online WARN 2
5 Cassandra Online 3
6 Communicator Online DEBUG 11
7 Configurer Online DEBUG 22
8 Diagnostics 1
9 ElasticSearch Online 15
10 EventReader Online WARN 2
11 Greyhound Online WARN 2
12 MemProxy Online WARN 1
13 Memcached Online 1
14 Monitor Online DEBUG 6
15 Mosquitto Online 0
16 Mqttclient Online WARN 12
17 NC Online WARN 5
18 Northbound Online DEBUG 4
19 RadiusProxy Online WARN 4
show upgrade-history
To display system upgrade history, use the following command:
ruckus# show upgrade-history
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show upgrade-history
No. Start time SmartZone System Version Control Plane version
Data Plane version AP Firmware version File name Elapsed
----- ------------------------ ------------------------- -----
1 2014-09-10 18:43:01 GMT 3.0.0.0.394->3.0.0.0.401
3.0.0.0.1156->3.0.0.0.1 3.0.0.0.128->3.0.0 3.0.0.0.260->3.0.0.
SZ-installer_3.0 17m 47s 164 .0.130 0.266
.0.0.401.ximg
Show Commands
show upgrade-state
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 256
2 2014-09-04 12:24:13 GMT 3.0.0.0.371->3.0.0.0.394
3.0.0.0.1072->3.0.0.0.1 3.0.0.0.122->3.0.0 3.0.0.0.244->3.0.0.
SZ-installer_3.0 19m 10s 156 .0.128
0.260 .0.0.394.ximg
3 2014-08-27 15:09:09 GMT 3.0.0.0.351->3.0.0.0.371
3.0.0.0.996->3.0.0.0.10 3.0.0.0.114->3.0.0 3.0.0.0.232->3.0.0.
SZ-installer_3.0 18m 32s 72 .0.122 0.244
.0.0.371.ximg
4 2014-08-12 14:30:24 GMT 3.0.0.0.338->3.0.0.0.351
3.0.0.0.952->3.0.0.0.99 3.0.0.0.106->3.0.0 3.0.0.0.216->3.0.0.
SZ-installer_3.0 38m 15s
show upgrade-state
To display the system upgrade state, use the following command:
ruckus# show upgrade-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ30# show upgrade-state
Show Commands
show version
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 257
show version
To view the SmartZone version, use the following command:
ruckus# show version
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Enable
Example
SZ30# ruckus> show version
Model : SZ124
Serial # : 531336000194
SZ Version : 3.0.0.0.530
Control Plane Software Version : 3.0.0.0.1496
Data Plane Software Version : 3.0.0.0.157
AP Firmware Version : 3.0.0.0.360
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 258
8
System Commands
This chapter describes the commands that you can use to configure administrative
and system settings on the SmartZone. The following table list the system
commands.
?
To display commands that are available on the command line, use the following
command:
ruckus# ?
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Table 71. System commands
? backup backup config backup network backup-
upgrade
cluster in-
service
config copy copy backup copy backup-
config
copy backup-
network
copy client copy report-
result
delete backup delete backup-
config
delete backup-
network
delete client diagnostic enable enable <new-
password>
exit help logout no service ping
reload reload ap reload now remote ap-cli restore config
restore local restore
network
service restart service start set-factory
shutdown shutdown
now
upgrade
System Commands
?
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 259
Command Mode
Privileged
Example
SZ100-Node1#
backup Backup system or configuration
backup-upgrade Backup and upgrade system
cluster Cluster commands
config Enter configuration mode
copy Copy commands
debug Debug commands
delete Delete commands
diagnostic Diagnostic commands
enable Modify enable password
exit Exit from the EXEC
help Display this help message
logout Exit from the EXEC
no No commands
ping Send ICMP echo request to network host
rbddump Dump Rbd board data
reload Reload system
remote Remote commands
restore Restore system
service Service commands
set-factory Set Factory
show Show system information
shutdown Shutdown system
traceroute Print the route packets take to network host
upgrade Upgrade system
System Commands
backup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 260
backup
To backup the SmartZone whole cluster system, use the following command:
ruckus# backup
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1#
Please note that event, alarm and statistic data will be deleted
from the backup file after 7 days. Do you want to backup whole
system (or input 'no' to cancel)? [yes/no]
backup config
To backup SmartZone configuration, use the following command:
ruckus# backup config
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# backup config
Do you want to backup configurations (or input 'no' to cancel)?
[yes/no] yes
Starting to backup configurations...
Successful operation
System Commands
backup network
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 261
backup network
To backup SmartZone network configuration, use the following command:
ruckus# backup network
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# backup network
Do you want to backup network configurations (or input 'no' to
cancel)? [yes/no] yes
Starting to backup network configurations...
Successful operation
backup-upgrade
To backup and upgrade the SmartZone whole cluster system, use the following
command:
ruckus# backup-upgrade <ftp-url>
Syntax Description
This command uses the following syntax:.
<ftp-url> : Upgrade file. The FTP URL format: ftp://<username>:<pass-
word>@<ftp-host>[/<dir-path>]
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# backup-upgrade ftp://mahan:ruckus1!@172.19.7.100/
backup/AP_ad87453456fe.csv
System Commands
cluster in-service
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 262
cluster in-service
To restore the cluster to a normal state, use the following command:
ruckus# cluster in-service
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# cluster in-service
% Unable to change the cluster state back to service. Reason:
Only Network Partition State can change to In Service State!.
config
To change to configuration mode, use the following command:
ruckus# config
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# config
SZ30(config)#
NOTE: To view configuration commands, see Configuration Commands chapters.
System Commands
copy
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 263
copy
To copy backup, backup-config, or backup-network file from external FTP server,
use the following command:
ruckus# copy backup
ruckus# copy backup-config
ruckus# copy backup-network
ruckus# copy client
ruckus# copy report-result
ruckus# copy <ftp-url>
Syntax Description
This command uses the following syntax:
backup: Backup file. FTP URL format: ftp://<username>:<password>@<ftp-
host>[/<dir-path>]
backup-config: Backup of the configuration file. The FTP URL format: ftp://
<username>:<password>@<ftp-host>[/<dir-path>]
backup-network: Backup of the network configuration file. The FTP URL
format: ftp://<username>:<password>@<ftp-host>[/<dir-path>]
client: Copy AP Clients Statistics to external FTP server
rep ort- res u lt: C opy Repo rt R e sult to ex ter na l FTP serv e r
<ftp-url>: Copy file from external FTP server, Format: ftp://<user-
name>:<password>@<ftp-host>[/<dir-path>]
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# copy ftp://test:testpwd@172.17.22.11 backup
SZ100-Node1# copy ftp://test:testpwd@172.17.22.11/SmartZone-
config backup-config
SZ100-Node1# copy ftp://test:testpwd@172.17.22.11/SmartZone-
network backup-network
System Commands
copy backup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 264
copy backup
To copy backup file to external FTP server, use the following command:
ruckus# copy backup <ftp-url>
Syntax Description
This command uses the following syntax:
<ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftp-
host>[/<dir-path>]
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# copy backup ftp://test:testpwd@172.17.22.11
copy backup-config
To copy backup configuration file to external FTP server, use the following command:
ruckus# copy backup-config <ftp-url>
Syntax Description
This command uses the following syntax:
<ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftp-
host>[/<dir-path>]
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# copy backup-config ftp://
test:testpwd@172.17.22.11/SmartZone-config
System Commands
copy backup-network
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 265
copy backup-network
To copy backup network configuration file to external FTP server, use the following
command:
ruckus# copy backup-network <ftp-url>
Syntax Description
This command uses the following syntax:
<ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftp-
host>[/<dir-path>]
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# copy backup-network ftp://
test:testpwd@172.17.22.11/SmartZone-network
copy client
To copy AP client statistics to external FTP server, use the following command:
ruckus# copy client <name> <ftp-url>
Syntax Description
The command uses the following syntax:
<name> <ftp-url>
<name>: AP Zone name
<ftp-url>: FTP directory, FTP URL Format: ftp://<username>:<pass-
word>@<ftp-host>[/<dir-path>]
Default
This command has no default settings.
Command Mode
Privileged
System Commands
copy report-result
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 266
Example
SZ100-Node1# copy client test Zone ftp://
test:testpwd@172.17.22.11
copy report-result
To copy report result to external FTP server, use the following command:
ruckus# copy report-result <name> <ftp-url>
Syntax Description
The command uses the following syntax:
<name> <ftp-url>
<name>: Report name
<ftp-url>: FTP directory, FTP URL format: ftp://<username>:<pass-
word>@<ftp-host>[/<dir-path>]]
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# copy report-result SmartZone report ftp://
test:testpwd@172.17.22.11
copy ftp-url
To copy files from external FTP server, use the following command:
ruckus# copy ftp-url <name> <ftp-url>
Syntax Description
The command uses the following syntax:
<ftp-url>: FTP directory, FTP URL format: ftp://<username>:<password>@<ftp-
host>[/<dir-path>]]
Default
This command has no default settings.
System Commands
delete backup
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 267
Command Mode
Privileged
Example
SZ100-Node1# copy ftp://test:testpwd@172.17.22.11
delete backup
To delete certain or all backup files, use the following command:
ruckus# delete backup <version>
Syntax Description
This command uses the following syntax:
<version>: Backup version
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# delete backup
SZ100-Node1# delete backup 1
delete backup-config
To delete certain or all backup configuration files, use the following command:
ruckus# delete backup-config <version>
Syntax Description
This command uses the following syntax:
<version>: Backup configuration version
Default
This command has no default settings.
Command Mode
Privileged
System Commands
delete backup-network
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 268
Example
SZ100-Node1# delete backup-config
SZ100-Node1# delete backup-config 1
delete backup-network
To delete certain or all backup network configuration files, use the following
command:
ruckus# delete backup-network <version>
Syntax Description
This command uses the following syntax:
<version>: Backup network configuration version
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# delete backup-network
SZ100-Node1# delete backup-network 1
delete client
To delete AP client, use the following command:
ruckus# delete client <client-mac>
Syntax Description
This command uses the following syntax:
<client-mac>: Client Mac address
Default
This command has no default settings.
Command Mode
Privileged
System Commands
diagnostic
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 269
Example
SZ100-Node1# delete client A1:87:45:34:56:FE
diagnostic
To run diagnostic commands, use the following command:
ruckus# diagnostic
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# diagnostic
SZ100-Node1(diagnostic)#
Related Commands
Table 72 lists the related diagnostic commands.
Table 72. Commands related to ruckus(diagnostic)
Syntax and Type Parameters (If Any) Description
ruckus(diagnostic)# copy snapshot
Type: Privileged
<ftp-url>:
FTP directory URL,
Format: ftp://
<username>:<password
>@<ftp-host>[/<dir-
path>]
Copy snapshot to external FTP
server.
ruckus(diagnostic)# delete
snapshot
Type: Privileged
${snapshotName} Deletes all snapshot.
ruckus(diagnostic)# do
Type: Privileged
Executes the do command.
System Commands
diagnostic
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 270
ruckus(diagnostic)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(diagnostic)# execute all
Type: Privileged
Executes all cases.
ruckus(diagnostic)# execute case
Type: Privileged
<name>: Case name Executes the specified case.
ruckus(diagnostic)# exit
Type: Privileged
Exits from the EXEC.
ruckus(diagnostic)# help
Type: Privileged
Displays the help.
ruckus(diagnostic)# remote-
packet-capture-disable
Type: Privileged
Disables the remote packet
capture.
ruckus(diagnostic)# remote-
packet-capture-enable
Type: Privileged
Enables the remote packet
capture.
ruckus(diagnostic)# show case
Type: Privileged
Shows the case.
ruckus(diagnostic)# show ipmi
Type: Privileged
[ health | sensors | sel ]
health: Shows the BMC
basic health
sensors: Shows the
hardware sensors, fru,
LEDs information
sel: Shows the system
event log records
Shows IPMI information.
ruckus(diagnostic)# show
snapshot
Type: Privileged
Show snapshot files.
ruckus(diagnostic)# show version
Type: Privileged
Shows the version.
Table 72. Commands related to ruckus(diagnostic)
Syntax and Type Parameters (If Any) Description
System Commands
enable
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 271
enable
To enable privileged commands on the command line interface, use the following
command:
ruckus# enable
Syntax Description
This command uses the following syntax:
password: Password to change the mode.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# enable
Old Password:
New Password:
SZ30> enable
SZ100-Node1# config
SZ100-Node1(config)#
enable <new-password>
To setup or update the SmartZone administrator password, use the following
command:
ruckus# enable <new-password>
Syntax Description
This command uses the following syntax:
new-password: The new SmartZone administrator password that you want to
set.
Default
This command has no default settings.
Command Mode
Privileged
System Commands
exit
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 272
Example
SZ100-Node1# enable password!356
Retype: ************
Enable password updated
exit
To exit from EXEC, use the following command:
ruckus# exit
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
User
Example
SZ100-Node1# exit
help
To display the command line interface help, use the following command:
ruckus# help
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
User
Example
SZ100-Node1# help
backup-upgrade Backup and upgrade system
config Enter configuration mode
debug Debug commands
System Commands
logout
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 273
logout
To exit from EXEC, use the following command:
ruckus# logout
Syntax Description
This command has no arguments or keywords
Default
This command has no default settings.
Command Mode
User
Example
SZ100-Node1# logout
no service
To stop all SmartZone services, use the following command:
ruckus# no service
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# no service
Please note that this command will cause current SSH connection
closed for SSH restart. Do you want to stop all services (yes/
no)? yes
Stopping all services...
Connection to 10.2.6.230 closed by remote host.
System Commands
ping
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 274
ping
To send an ICMP echo request to the network host, use the following command:
ruckus# ping <host>
Syntax Description
This command uses the following syntax:
<ip>: IP address
Default
This command has no default settings.
Command Mode
User
Example
SZ100-Node1# ping 172.19.10.9
Start ping server (172.19.10.9) for 3 times...
PING 172.19.10.9 (172.19.10.9) 56(84) bytes of data.
64 bytes from 172.19.10.9: icmp_seq=1 ttl=64 time=0.016 ms
64 bytes from 172.19.10.9: icmp_seq=2 ttl=64 time=0.014 ms
64 bytes from 172.19.10.9: icmp_seq=3 ttl=64 time=0.017 ms
--- 172.19.10.9 ping statistics ---
3 packets transmitted, 3 received, 0% packet loss, time 2001ms
rtt min/avg/max/mdev = 0.014/0.015/0.017/0.004 ms
reload
To reload the SmartZone after 30 seconds, use the following command:
ruckus# reload <seconds>
Syntax Description
This command uses the following syntax:
seconds: Indicate the number of seconds before SmartZone reboots itself.
Default
This command has no default settings.
Command Mode
Privileged
System Commands
reload ap
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 275
Example
SZ100-Node1# reload <60>
Do you want to reboot system (yes/no)? yes
Server would be rebooted in 60 seconds.
Broadcast message from admin (Tue June 18 15:11:24 2013):
The system is going down for reboot NOW!
reload ap
To reboot an access point, use the following command:
ruckus# reload <mac>
Syntax Description
This command uses the following syntax:
mac: AP Mac address
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# reload ap 00:1c:2d:ee:ff:cc
Success to trigger AP (00:1c:2d:ee:ff:cc) reboot.
reload now
To reload the system immediately, use the following command:
ruckus# reload now
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
System Commands
remote ap-cli
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 276
Example
SZ100-Node1# reload now
remote ap-cli
To display the name and firmware version of a remote access point, use the following
command:
ruckus# remote ap-cli <mac> <command>
Syntax Description
This command uses the following syntax:
mac: MAC address of the access point
command: Command that retrieves the access point name and firmware
version, double-quoted
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# remote ap-cli 74:91:1A:2A:DB:80 "get version"
Ruckus 7962 Multimedia Hotzone Wireless AP
Version: 1.1.0.0.151
OK
restore
To restore the entire cluster configuration, use the following command:
ruckus# restore
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
System Commands
restore config
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 277
Example
SZ100-Node1# restore config
No. Created on Patch Version File Size
----- ----------------------------- --------------------------
1 2014-11-14 06:38:41 GMT 3.0.0.0.530 1.1GB
2 2014-11-17 12:33:50 GMT 3.0.0.0.534 1.2GB
Please choose a backup to restore or 'No' to cancel:
restore config
To restore a configuration backup file that you uploaded to the FTP server, use the
following command:
ruckus# restore config
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# restore config
No. Created on Patch Version File Size
----- ----------------------------- --------------------------
1 2014-10-17 12:32:14 GMT 3.0.0.0.479
160.3KB
Please choose a backup to restore or 'No' to cancel:
restore local
To restore the current system without a system integrity test, use the following
command:
ruckus# restore local
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
System Commands
restore network
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 278
Command Mode
Privileged
Example
SZ100-Node1# restore local
No. Created on Patch Version File Size
---- ----------------------------- ---------------------------
1 2014-11-14 06:38:41 GMT 3.0.0.0.530
1.1GB
2 2014-11-17 12:33:50 GMT 3.0.0.0.534 1.2GB
Please choose a backup to restore or 'No' to cancel:
restore network
To restore the network configuration, use the following command:
ruckus# restore network
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# restore network
service restart
To restart all the SmartZone services, use the following command:
ruckus# service restart
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
System Commands
service start
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 279
Example
SZ100-Node1# service restart
Please note that this command will cause current SSH connection
closed for SSH restart. Do you want to restart all services (yes/
no)? yes
Restarting all services...
service start
To start all the SmartZone services, use the following command:
ruckus# service start
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# service start
Please note that this command will cause current SSH connection
closed for SSH restart. Do you want to start all services (yes/
no)? yes
Starting all services...
wait for (cassandra,communicator,eventreader,freera-
dius,memcached,monitor,northbound,repcached,scheduler,tomcat)
Up!
wait for (cassandra,communicator,eventreader,freera-
dius,memcached,monitor,northbound,repcached,scheduler,tomcat)
Up!
wait for (communicator,eventreader,freera-
dius,memcached,monitor,northbound,repcached,scheduler,tomcat)
Up!
wait for (communicator,eventreader,monitor,north-
bound,repcached,scheduler,tomcat) Up!
wait for (communicator,eventreader,monitor,north-
bound,repcached,scheduler,tomcat) Up!
wait for (communicator,eventreader,monitor,north-
bound,repcached,scheduler,tomcat) Up!
System Commands
set-factory
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 280
wait for (communicator,eventreader,monitor,north-
bound,repcached,scheduler,tomcat) Up!
wait for (communicator,eventreader,northbound,tomcat) Up!
All services are up!
ruckus# Connection to 10.2.6.230 closed by remote host.
set-factory
To reset to factory settings of the SmartZone system, use the following command:
ruckus# set-factory
CAUTION! Resetting a node to factory settings will erase all of its system
configuration settings, backup files, and cluster settings. Before resetting a node to
factory settings, Ruckus Wireless strongly recommends that you export all of the
backup files on the SmartZone to an FTP server using either the web interface or CLI.
NOTE: For information on how to use the SmartZone web interface to reset a node
to factory settings, see the SmartCell Gateway 200 Administrator Guide.
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# set-factory
NOTE: For Show commands refer to the chapter Show Commands
System Commands
shutdown
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 281
shutdown
To shutdown the SmartZone gracefully after 30 seconds, use the following
command:
ruckus# shutdown <seconds>
Syntax Description
This command uses the following syntax:
seconds: Indicates the number of seconds before SmartZone shutdowns.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# shutdown 10
Do you want to shutdown system
Server would be shutdown in 10 seconds
shutdown now
To shutdown the SmartZone immediately, use the following command:
ruckus# shutdown now
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# shutdown now
Do you want to shutdown system?
Server would be shutdown in 30 seconds
System Commands
traceroute
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 282
traceroute
To print the route packets that are taken to the network host, use the following
command:
ruckus# traceroute <options>
Syntax Description
This command uses the following syntax:
-4 Use IPv4
-6 Use IPv6
-d --debug Enable socket level debugging
-F --dont-fragment Do not fragment packets
-f first_ttl --first=first_ttl Start from the first_ttl hop (instead from 1)
-g gate,. --gateway=gate,...
Route packets through the specified gateway
(maximum 8 for IPv4 and 127 for IPv6)
-I --icmp Use ICMP ECHO for tracerouting
-T --tcp Use TCP SYN for tracerouting
-i device --interface=device
Specify a network interface to operate with
-m max_ttl --max-hops=max_ttl
Set the max number of hops (max TTL to be reached). Default is 30
-N squeries --sim-queries=squeries
Set the number of probes to be tried simultaneously (default is 16)
-n Do not resolve IP addresses to their domain names
-p port --port=port Set the destination port to use. It is either initial udp port value
for "default" method (incremented by each probe, default is 33434), or initial seq for
"icmp" (incremented as well, default from 1), or some constant destination port for
other methods (with default of 80 for "tcp", 53 for "udp", etc.)
-t tos --tos=tos Set the TOS (IPv4 type of service) or TC (IPv6 traffic class)
value for outgoing packets -l flow_label --flowlabel=flow_label Use specified
flow_label for IPv6 packets -w waittime --wait=waittime
Set the number of seconds to wait for response to a probe (default is 5.0). Non-
integer (float point) values allowed too
-q nqueries --queries=nqueries Set the number of probes per each hop. Default is
3
System Commands
traceroute
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 283
-r Bypass the normal routing and send directly to a host on an attached network
-s src_addr --source=src_addr Use source src_addr for outgoing packets
-z sendwait --sendwait=sendwait Minimal time interval between probes (default 0).
If the value is more than 10, then it specifies a number in milliseconds, else it is a
number of seconds (float point values allowed too)
-e --extensions Show ICMP extensions (if present), including MPLS
-A --as-path-lookups Perform AS path lookups in routing registries and print results
directly after the corresponding addresses
-M name --module=name Use specified module (either builtin or external) for
traceroute operations. Most methods have their shortcuts (`-I' means `-M icmp' etc.)
-O OPTS,... --options=OPTS,.. Use module-specific option OPTS for the traceroute
module. Several OPTS allowed, separated by comma. If OPTS is "help", print info
about available options
--sport=num Use source port num for outgoing packets. Implies `-N 1'
-U --udp Use UDP to particular port for tracerouting (instead of increasing the port
per each probe), default port is 53
-UL Use UDPLITE for tracerouting (default dest port is 53)
-P prot --protocol=prot Use raw packet of protocol prot for tracerouting
--mtu Discover MTU along the path being traced. Implies `-F -N 1'
--back Guess the number of hops in the backward path and print if it differs
-V --version Print version info and exit
--help Read this help and exit
Arguments:
+ host The host to traceroute to
packetlen The full packet length (default is the length of an IP header plus 40).
Can be ignored or increased to a minimal allowed value
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# traceroute
System Commands
upgrade
SmartZone100 Command Line Interface Reference Guide for RuckOS 3.0, 800-70741-001 Rev A 284
upgrade
To upgrade the SmartZone system, use the following command:
ruckus# upgrade <ftp-url>
Syntax Description
This command uses the following syntax:
<ftp-url>: Upgrade file. FTP URL format is: ftp://<username>:<password>@<ip>[/
<file-path>].
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# upgrade ftp://mahan:ruckus1!@172.19.7.100
SmartZone100 Command Line Interface Reference Guide for Release 3.0, 800-70741-001 Rev A 285
Index
Symbols
? 258
A
access the SmartZone CLI 14
admin 25
ap 30
ap-auto-tagging 40, 41
ap-cli 206
ap-heartbeat 54
ap-root-ca 57
ap-sci |enable 42, 57
B
backup 260
backup config 260
backup network 261
backup-upgrade 261
C
clock 62
cluster in-service 262
cluster-ip-list 63
config 262
config-admin 26
config-ap 31
config-ap-auto-tagging 41
config-ap-group 44
config-ap-group-lldp 48, 80
config-ap-group-port 49
config-ap-group-port-setting 81
config-ap-model 37, 50
config-ap-model-lan1 39, 52
config-ap-portal-cert 55
config-ap-portal-cert-generate-csr 56
config-bonjour-policy 59
config-common-settings 65
config-common-settings-aaa 72
config-common-settings-ap-group 75
config-common-settings-ap-model-lan1
85
config-common-settings-guest-access
88
config-common-settings-web-authentica-
tion 91
config-common-settings-wlan 91
config-common-settings-wlan-group 99
config-common-settings-wlan-scheduler
100
config-config-common-settings-ap-mod-
el 82
config-config-common-settings-ap-tun-
nel-settings 86
config-data-plane commands 101
config-device-policy 103
config-device-policy-policy rule 105
config-eap-sim commands 110, 114
config-ftp-server commands 116
config-guest-access 118
config-hotspot 121
config-interface-ap-tunnel-data 125
config-interface-user-defined 126
config-l2-acl 129
config-lbs-service 130
config-lwapp2scg 137
config-mgmt-and-ap-control 125
config-non-proxy-aaa 160
config-proxy-aaa 165
config-radius-service 28
config-report commands 167
config-role commands 171
config-sms-server 173
config-smtp-server commands 174
config-snmp-v2-community commands
177
config-snmp-v3-user 179
config-syslog-server 181
config-user-agent-blacklist 183
config-user-role 185
config-user-traffic-profile 186
config-user-traffic-profile-acl 188
config-web-authentication 190
config-web-cert commands 192
config-wlan 194
config-wlan-group 202
config-wlan-scheduler 204
config-zone-bonjour-policy-rule 60
Index
SmartZone100 Command Line Interface Reference Guide for Release 3.0, 800-70741-001 Rev A 286
config-zone-hotspot 89
copy 263
copy backup 264
copy backup-config 264
copy client 265
copy report-result 266
D
data-plane 101
debug 205
debug diagnostic 209
debug-ap-cli 207
delete 208
delete backup 267
delete backup-config 267
delete backup-network 268
delete client 268
dhcp-service 210
diagnostic 208, 269
E
enable 271, 271
end 109, 210
event 110
event email 112, 114
exit 115, 272
export log 211
F
ftp-server 115
H
help 212, 272
hotspot 120
I
interface management 123
ip internal-subnet 127
ip name-server 127
ip route 128
L
license import 131, 132, 133, 134
limited privileges 21
lineman 134
log on to CLI 20
logging console 135
logout 273
M
management (Web) interface 14
N
no admin 138
no admin-radius 139
no ap 139
no ap auto-tagging 140
no ap-cert-check 141
no ap-root-ca 142
no ap-sci 143
no cls-sess 144
no control-plane 145
no data-plane 145
no event 147
no ftp-server 148
no interface 149
no ip 150
no logging 152, 153
no report 153
no role 154
no screen-pagination 212, 213
no service 273
no snmp-trap 154
no snmp-v2-community 155
no snmp-v3-user 155
northbound-authtype 162
northbound-portal 163
ntp-server 163
O
overview 14
P
ping 274
R
rbddump 216
reload 274
reload ap 275
reload now 275
remote ap-cli 276
Index
SmartZone100 Command Line Interface Reference Guide for Release 3.0, 800-70741-001 Rev A 287
report 167
restore config 276, 277
restore local 277
restore network 278
rJ45 cable 14
role 170
rS-232 serial 14
S
screen-pagination 214, 215
serial connection 14, 17
service restart 278
service start 279
set-factory 280
setup 217
show admin 221
show admin-activity 221
show alarm 222
show ap 223
show ap-heartbeat 225
show backup 228
show backup-config 229
show backup-network 230
show backup-state 231
show backup-upgrade-state 232
show client 232
show clock 233
show cluster 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 running-config 248
show service 254
show upgrade-history 255
show upgrade-state 256
show version 257
shutdown 281
shutdown force 284
shutdown now 281
smtp-server 173, 174
snmp-trap 176
snmp-v2-community 177
snmp-v3-user 179
sSH client 15
SSH connection 16
sSH connection 14
syslog server 181
U
upgrade 284
W
web-cert 190, 191
Copyright © 2006-2014. Ruckus Wireless, Inc.
350 West Java Dr. Sunnyvale, CA 94089. USA
www.ruckuswireless.com

Navigation menu