Ruckus Wireless™ SmartZone™ 100 And Virtual SmartZone Essentials Command Line Interface Reference Guide For 3.1.2 Smart Zone (SZ 100/v SZ E) Vsz E 3 1 2 Cli Rg 20151211

2016-01-19

User Manual: Ruckus SmartZone 3.1.2 Command Line Interface Reference Guide (SZ-100/vSZ-E)

Open the PDF directly: View PDF PDF.
Page Count: 404 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Ruckus Wireless™
SmartZone™ 100 and Virtual SmartZone
Essentials
Command Line Interface Reference Guide for
SmartZone 3.1.2
Part Number 800-71121-001 Rev A
Published December 2015
www.ruckuswireless.com
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 2
Copyright Notice and Proprietary Information
Copyright 2015. 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.
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 3
Contents
About This Guide
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Documentation Feedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1 Introduction to the Controller Command Line Interface
Overview of the Controller Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Accessing the Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
What You Will Need . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Connect the Administrative Computer to the Controller. . . . . . . . . . . . . . . . . . . . . . . 16
Start and Configure the SSH Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Using SSH Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Using Serial Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Log On to CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2 Configuration Commands
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
ad-service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
admin-radius. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
ap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ap-auto-approve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
ap-auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
ap-cert-check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
ap-certificate-reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ap-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ap-heartbeat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
ap-portal-cert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
ap-root-ca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
ap-sci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
ap-snmp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
app-denial-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 4
app-port-mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
bonjour-gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
bonjour-policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
bridge-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
cert-store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
changepassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
clock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
cluster-ip-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
common-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
device-policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
diffserv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
diameter-remote-service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
SZ100-Node1(config)# diameter-remote-service name . . . . . . 135
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3 Configuration Commands
encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
ethernet-port-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
event db-persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
event email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
event snmp-trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
event-email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
event-threshold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
ftp-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
guest-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
hotspot20-venue-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
hotspot20-wlan-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
hs20-sslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
identity-provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
import-zdbackup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 5
ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
ip control-nat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
ip name-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
ip name-server-ipv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
ip route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
ip route-ipv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
ipsec-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
l2-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
ldap-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
license cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
license export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
license import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
license local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
license sync-now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
lineman. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
localdb-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
logging console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
lwapp2scg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
mgmt-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
no ad-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
no admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
no admin-radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
no ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
no ap auto-approve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
no ap auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
no ap-cert-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
no ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
no ap-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
no ap-root-ca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
no ap-sci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
no ap-snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
no app-denial-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
no app-port-mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
no bonjour-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
no bonjour-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
no bridge-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
no cert-store. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 6
no control-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
no data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
no device-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
no diffserv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
no dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
no encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
no event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
no ethernet-port-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
no ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
no guest-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
no hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
no hotspot20-venue-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
no hotspot20-wlan-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
no hs20-sslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
no identity-provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
no interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
no ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
no ipsec-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
no l2-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
no lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
no ldap-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
no lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
no logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
no non-proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
no oauth-service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
no operator-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
no osu-portal-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
no outbound firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
no proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
no report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
no role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
no snmp-trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
no snmp-v2-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
no snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
no subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
no usb-software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
no user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
no user-defined-app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
no user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 7
no user-traffic-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
no vlan-pooling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
no web-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
no wlan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
no wlan-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
no wlan-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
non-proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
northbound-authtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
northbound-portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
ntp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
oauth-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
operator-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
osu-portal-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
outbound-firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
rebalance-aps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
4 Configuration Commands
sms-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
smtp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
snmp-trap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
snmp-v2-community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
support-admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
syslog-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
usb-software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
user-defined-app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
user-traffic-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
vlan-pooling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
web-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
wechat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
wlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
wlan-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
wlan-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 8
5 Debug Commands
debug. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
all-log-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
ap-subnet-discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
apcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
dataplane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
diagnostic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
display-format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
dpcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
export log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
no all-log-level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
no ap-subnet-discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
no output-format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
no save. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
no schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
no screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
no sslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
no strict-wfa-compliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
no web-backdoor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
no web-debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
output-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
show ap-subnet-discovery-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
show diagnostic-script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
show schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
show sslv3-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
show strict-wfa-compliance-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
sslv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
strict-wfa-compliance-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
6Setup Commands
rbd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
rbddump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 9
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
7Show Commands
show admin-activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
show alarm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
show ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
show ap-certificate-status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
show ap-stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
show backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
show backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
show backup-config-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
show backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
show backup-schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
show backup-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
show backup-upgrade-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
show client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
show clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
show cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
show cluster-node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
show cluster-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
show control-plane-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
show counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
show cpuinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
show dhcp-relay-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
show diskinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
show event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
show ip. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
show license. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
show meminfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
show radius-proxy-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
show report-result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
show rogue-aps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
show running-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
show service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
show snapshot-disk-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
show upgrade-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 10
show upgrade-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
show version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
8 System Commands
?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
backup config. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
backup network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
backup schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
backup-upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
cluster in-service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
copy ap-certificate-request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
copy backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
copy backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
copy backup-network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
copy client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
copy report-result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
copy ftp-url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
delete backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
delete backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
delete backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
delete client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
diagnostic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
enable <new password>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
no service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
ping6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
reload ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
reload now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
remote ap-cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Contents
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 11
restore config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
restore local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
restore network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
service restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
service start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
set-factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
shutdown now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
snapshot disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
upload ap-certificate-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Index
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 12
About This Guide
This SmartZone™ (SZ) 100 and Virtual SmartZone Essentials (vSZ-E) Command
Line Interface Reference Guide contains the syntaxes and commands for config-
uring and managing the SZ-100/vSZ-E (collectively referred to as “the controller”
throughout this guide) from the command line interface.
This guide is written for service operators and system administrators who are
responsible for managing, configuring, and troubleshooting Ruckus Wireless
devices. Consequently, it assumes a basic working knowledge of local area
networks, wireless networking, and wireless devices.
NOTE If release notes are shipped with your product and the information there
differs from the information in this guide, follow the instructions in the release notes.
Most user guides and release notes are available in Adobe Acrobat Reader Portable
Document Format (PDF) or HTML on the Ruckus Wireless Support Web site at
https://support.ruckuswireless.com/contact-us.
About This Guide
Document Conventions
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 13
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 14
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.1.1)
• Part number: 800-70944-001
• Page 88
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 15
1
Introduction to the Controller
Command Line Interface
In this chapter:
•Overview of the Controller Command Line Interface
•Accessing the Command Line Interface
Introduction to the Controller Command Line Interface
Overview of the Controller Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 16
Overview of the Controller Command Line
Interface
The Controller command line interface (CLI) is a software tool that enables you to
configure and manage the controller. Using the command line interface, you can
issue commands from an operating system prompt, such as the Microsoft Windows
command prompt or a Linux operating system terminal. Each command performs
a specific action for configuring device settings or returning information about the
status of a specific device feature.
Accessing the Command Line Interface
The controller has a built-in command line interface (CLI) that you can use to
configure controller settings and manage access points. This section describes the
requirements and the procedure for accessing the controller’s CLI.
What You Will Need
To access the controller CLI, you will need the following:
1A computer that you want to designate as administrative computer
2A network connection to the controller (if you want to use an SSH connection)
or an RS-232 serial to RJ45 cable (if you want to use a serial connection)
3An SSH (secure shell) client
Connect the Administrative Computer to the Controller
Connect the administrative computer to the controller either through the network
or directly using an RS-232 serial to RJ45 cable.
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 controller.
2If you want to use a serial connection, make sure that both the administrative
computer and the controller are both powered on. And then, do the following:
• Connect the RJ45 end of the cable to the port labeled |O|O| (console port)
on the controller. See 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 Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 17
Figure 1. Location of console port
Start and Configure the SSH Client
Before starting this procedure, make sure that the SSH client is already installed on
the administrative computer.
NOTE: The following procedure describes how to use PuTTY, a free and open
source telnet/SSH client, to access the controller CLI. If you are using a different
SSH client, the procedure may be slightly different (although the connection settings
should be the same). For more information on PuTTY, visit www.putty.org.
See the following sections depending on your connection method:
•Using SSH Connection
•Using Serial Connection
Introduction to the Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 18
Using SSH Connection
If you have connected the administrative computer to the same subnet or broadcast
domain as the Management (Web) interface of the controller, follow these steps to
start and configure the SSH client.
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 controller 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 Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 19
Using Serial Connection
If you have connected the administrative computer to the console port on the
controller using an RS-232 serial to RJ45 cable, follow these steps to start and
configure the SSH client.
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 Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 20
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 Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 21
Figure 5. PuTTY’s serial connection settings for connecting to the controller
5Click Open. The PuTTY console appears and displays the login prompt as seen
in Figure 6.
Introduction to the Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 22
Figure 6. PuTTY console displaying the login prompt
You have completed configuring the SSH client to connect to the controller CLI.
Log On to CLI
The following describes the process for log on to the CLI.
• Log on to the controller using putty/Xssh (any other application) using the user
credentials of login name and password as given.
NOTE: You cannot use 'admin' as a password, which is used during the controller
installation procedure.
• The Ruckus Wireless controller CLI welcome message appears with the CLI
prompt as seen in Figure 7.
Introduction to the Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 23
Figure 7. Welcome to SmartZone
• You are now logged into the controller CLI as a user with limited privileges by
looking at the CLI prompt. If you are in limited mode, the prompt appears as
ruckus> (with a greater than sign). To view a list of commands that are available
at the root level or user mode, enter help or? as seen in Figure 7 and Figure 8.
NOTE: To change the CLI prompt to a privileged mode, see step 5.
Introduction to the Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 24
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.
Introduction to the Controller Command Line Interface
Accessing the Command Line Interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 25
Figure 9. Using the Ping command
• 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 26
2
Configuration Commands
This chapter describes the commands that you can use to configure, enable, and
disable various controller 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 ad-service admin admin-radius ap
ap-auto-
approve
ap-auto-
tagging
ap-cert-check ap-certificate-
reset
ap-control-mgmt-
tos
ap-group ap-heartbeat ap-portal-cert ap-root-ca ap-sci
bonjour-
gateway
bonjour-policy bridge-profile cert-store changepassword
clock cluster-ip-list common-
settings
device-policy diameter-remote-
service
diffserv do dp-group
Configuration Commands
ad-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 27
ad-service
To create or update the active directory service configuration, use the following
command:
ruckus(config)# ad-service <name>
Once you enter the config-admin context, you can configure the rest of the
administrator’s profile (see example below).
Syntax Description
This command uses the following syntax:
name: Active service directory name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ad-service ads
SZ100-Node1(config-ad-service)#
Related Commands
Table 5 lists the related ad-service configuration commands.
Table 4. Commands related to ruckus(config-ad-service)
Syntax and Type Parameters (if any) Description
ruckus(config-ad-service)# admin-
domain-name
Type: Privileged
<domain-name> Sets the administrator domain
name. This field is applicable on
executing the group attribute
command.
ruckus(config-ad-service)# admin-
password
Type: Privileged
<password> Sets the administrator domain
password. This field is applicable
on executing the group attribute
command.
ruckus(config-ad-service)#
description
Type: Privileged
<text> Sets the description
Configuration Commands
ad-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 28
ruckus(config-ad-service)# do
Type: Privileged
Executes the do command.
ruckus(config-ad-service)# email
Type: Privileged
<email> Sets the user’s email details.
ruckus(config-ad-service)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-ad-service)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ad-service)#
friendly-name
Type: Privileged
<friendly-name> Sets friendly name for the active
service directory.
ruckus(config-ad-service)# global-
catalog
Type: Privileged
<friendly-name> Enables the global catalog
support
ruckus(config-ad-service)# group-
attrs
Type: Privileged
<attr-value>: Group
attribute value
<user-role>: User Role
Sets the user traffic profile
mapping.
ruckus(config-ad-service)# help
Type: Privileged
Displays the help.
ruckus(config-ad-service)# ip-
address
Type: Privileged
<ip> - Sets the primary
server IP address
Sets the primary service IP
address.
ruckus(config-ad-service)# name
Type: Privileged
<name> Sets the active directory service
name.
ruckus(config-ad-service)# no
Type: Privileged
<global-catalog>
<group-attrs> <attr-
value>
Disables the commands.
ruckus(config-ad-service)# port
Type: Privileged
<port> Sets the primary server port.
Table 4. Commands related to ruckus(config-ad-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
admin
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 29
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
ruckus(config-ad-service)#
windows-domain-name
Type: Privileged
<domain-name>
Example: dc=domain,
dc=ruckuswireless,
dc=com
Sets the windows domain name
ruckus(config-ad-service)# title
Type: Privileged
<text> Sets the user’s job title.
Table 4. Commands related to ruckus(config-ad-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
admin
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 30
Retype: **
SZ100-Node1(config-admin-radius)# exit
SZ100-Node1(config-admin)# exit
SZ100-Node1(config)#
Related Commands
Table 5 lists the related admin configuration commands.
Table 5. 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
admin-radius
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 31
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
admin-radius
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 32
Related Commands
Table 6 lists the related admin-radius-service configuration commands.
Table 6. 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
admin-radius
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 33
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)# no
Type: Privileged
backup Disables the backup RADIUS
support.
ruckus(config-admin-radius)# port
Type: Privileged
<port> Sets the port addresses of the
primary RADIUS server.
ruckus(config-admin-radius)#
realm
Type: Privileged
<realms> Multiple realms
supported. Use a comma
(,) to separate realms
(example:home1,home2)
Sets the realms.
ruckus(config-admin-radius)#
service
Type: Privileged
<services>: Multiple
services supported. Use a
comma (,) to separate
services
(example:home1,home2)
Sets the services.
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 6. Commands related to ruckus(config-radius-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 34
ap
To update the AP configuration, use the following commands:
ruckus(config)# ap <mac>
ruckus(config)# ap pre-prov <import <ftp-url>> <export <ftp-url>>
ruckus(config)# ap swap <import <ftp-url>> <export <ftp-url>>
Syntax Description
This command uses the following syntax:
<mac> lock
<mac>: AP MAC address
lock: Lock AP
<mac> pre-prov
<mac>: AP MAC address
pre-prov: Update Pre-provision configuration
<mac> swap
<mac>: AP MAC address
swap: Update Swap configuration
<mac> trigger-swap
<mac>: AP MAC address
trigger-swap: Trigger swap action
<mac> approve
<mac>: AP MAC address
approve: Approve AP to go ahead registration process
Default
This command has no default settings.
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>>
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 35
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 7 lists the related ap profile configuration commands.
•Table 8 lists the related ap model configuration commands.
•Table 10 lists the related ap model lan1 configuration commands.
Table 7 lists the related ap profile configuration commands.
Table 7. 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)# area-code
Type: Privileged
<areacode> Sets the user location information
of LAC or TAC.
ruckus(config-ap)# bonjour-
gateway
Type: Privileged
Enables the bonjour gateway.
ruckus(config-ap)# bonjour-policy
Type: Privileged
Enables the bonjour policy.
ruckus(config-ap)# channel-
evaluation-interval
Type: Privileged
<seconds>:The interval
value (Range: 60-3600
sec)
Sets the channel evaluation
interval.
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 36
ruckus(config-ap)# channel-select-
mode
Type: Privileged
2.4g ${value}: 2.4GHz
radio
5g ${value}: 5GHz radio
Sets a mode to automatically
adjust AP channels.
ruckus(config-ap)# channelfly-
mtbc
Type: Privileged
2.4g <number>: 2.4GHz
radio
<number>: MTBC value
(Range:100~1440)
5g <number>: 5GHz
radio
Set MTBC value of ChannelFly
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 37
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)# description
Type: Privileged
<description> Sets the model specification
(overrides the zone configuration).
ruckus(config-ap)# device-ip-
mode
Type: Privileged
[ ipv6 | ipv4 ] Sets the device IP mode.
ruckus(config-ap)# do
Type: Privileged
Executes the do command.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 38
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 ]
<name>: Name
swe: Swedish
cze: Czech
spa: Spanish
eng: English
chi: Chinese
ger: German
fre: French
jpn: Japanese
dan: Danish
tur: Turkish
Sets the hotspot 2.0 settings.
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.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 39
ruckus(config-ap)# ip6
Type: Privileged
[ keep | auto ]: Retains the
AP settings
static <ipv6> <gateway>
<primaryDNS>
<secondaryDNS : Static
IPv6 address with the
primary and secondary
server details.
Sets the AP IPv6 address.
ruckus(config-ap)# location
Type: Privileged
<location> Sets the location.
ruckus(config-ap)# location-
additional-info
Type: Privileged
<text> Sets the additional information for
location.
ruckus(config-ap)# mesh
Type: Privileged
[ disable | mesh | root |
auto ]
Sets the mesh mode to either:
• disable: Disable
• mesh: Mesh AP
• root: Root AP
• auto: Auto
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.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 40
ruckus(config-ap)# no
Type: Privileged
admin
bonjour-gateway
channel-evaluation-
interval
channel-select-mode
client-admission-control
description
gps
hotspot20
ip <address> <name-
server secondary>
ip6 <address> <name-
server secondary>
location
location-additional-info
Disables the configuration.
...................................continued
ruckus(config-ap)# no
Type: Privileged
model
override-ap-mgmt-vlan
channel-select-mode
override-client-
admission-control
override-smart-mon
override-syslog-opt
override-zone-location
override-zone-location-
additional-info
radio
smart-mon
swap-in-ap
syslog
uplink-ap
venue-profile
Disables the configuration.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 41
ruckus(config-ap)# override-ap-
mgmt-vlan
Type: Privileged
<vlanTag> Override AP Management VLAN.
ruckus(config-ap)# override-
channel-select-mode
Type: Privileged
<2.4g> : 2.4 GHz radio
<5g> : 5 GHz radio
Overrides the auto channel
selection mode and channelFly
MTBC.
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)# override-
syslog-opt
Type: Privileged
Override Syslog options
ruckus(config-ap)# override-zone-
location
Type: Privileged
Overrides the zone location
settings.
ruckus(config-ap)# override-zone-
location-additional-info
Type: Privileged
Overrides the zone’s additional
information setting on location.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 42
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.
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.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 43
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)# venue-profile
Type: Privileged
<name> Sets the venue profile
ruckus(config-ap)# zone
Type: Privileged
<name> Moves the access point to another
zone.
Table 7. Commands related to ruckus(config-ap).
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 44
Table 8 lists the related to ap-model configuration commands.
Table 8. Commands related to ruckus(config-ap-model)
Syntax and Type Parameters (if any) Description
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)# 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)# help
Type: Privileged
Displays the help.
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.
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 45
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.
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-operating-mode
poe-out-port
radio-band
usb
usb-software
Disables or deletes the settings
that have been configured.
ruckus(config-ap-model)# poe-
operating-mode
Type: Privileged
Switches the PoE mode.
ruckus(config-ap-model)# poe-
out-port
Type: Privileged
Enables the PoE out port.
Table 8. Commands related to ruckus(config-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 46
Table 9 lists the related to ap-model-lan1 configuration commands.
ruckus(config-ap-model)# radio-
band
Type: Privileged
${value} Switches the radio band.
ruckus(config-ap-model)# usb
Type: Privileged
<ap-model> [ enable |
disable]
Sets the USB port for a specific AP
model.
ruckus(config-ap-model)# usb-
software
Type: Privileged
<value> Sets the AP USB software
package.
Table 9. 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)# 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.
Table 8. Commands related to ruckus(config-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-auto-approve
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 47
ap-auto-approve
To enable auto approve, use the following command:
ruckus(config)# ap-auto-approve
ruckus(config-ap-model-lan1)# no
Type: Privileged
overwrite Does not permit overwriting.
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)#
profile
Type: Privileged
<profile> : Ethernet port
profile.
Sets the Ethernet port profile.
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.
ruckus(config-ap-model-lan1)#
vlan-members
Type: Privileged
<members>: VLAN
members
Sets the VLAN members.
Table 9. Commands related to ruckus(config-ap-model-lan1)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-auto-approve
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 48
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
Configuration Commands
ap-auto-tagging
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 49
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 10 lists the related to ap-auto-tagging configuration commands.
exi
Table 10. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 50
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 10. Commands related to ruckus(config-ap-auto-tagging)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-certificate-reset
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 51
ap-certificate-reset
To the AP certificate request which failed to update the certificate, use the following
command:
ruckus(config)# ap-certificate-reset
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ap-certificate-reset
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>
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 52
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-group name1
Related Commands
•Table 11 lists the related to ap-group configuration commands.
•Table 12 lists the related ap-group-lldp configuration commands.
•Table 13 lists the related ap-group-port-setting configuration commands.
Table 11 lists the related to ap-group configuration commands.
Table 11. 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)#
channel-evaluation-interval
Type: Privileged
<seconds>: The interval
value (Range: 60~3600
sec)
Sets the channel evaluation
interval.
ruckus(config-ap-group)#
channel-range
Type: Privileged
• 2.4g [ <channels | all>]
• 5g indoor [ <channels |
all> ]
• 5g outdoor [ <channels
| all> ]
Sets the channel range
ruckus(config-ap-group)#
channel-select-mode
Type: Privileged
2.4g ${value}
5g ${value}
Sets a mode to automatically
adjust AP channels
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 53
ruckus(config-ap-group)#
channelfly-mtbc
Type: Privileged
2.4g <number>
5g <number>
<number> is the MTBC
value (Range: 100~1440)
Set the MTBC value of ChannelFlu
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
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.
Table 11. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 54
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.
ruckus(config-ap-group)# help
Type: Privileged
Displays the help message.
ruckus(config-ap-group)# gps
Type: Privileged
<latitude> <longitude> Sets the GPS coordinates.
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.
Table 11. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 55
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)# location
Type: Privileged
<location> Sets the location.
ruckus(config-ap-group)#
location-additional-info
Type: Privileged
<text> Sets the additional information for
location.
ruckus(config-ap-group)# member
Type: Privileged
add <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.
Table 11. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 56
ruckus(config-ap-group)# no
Type: Privileged
channel 2.4g
channel 5g indoor
channel 5g outdoor
channel-evaluation-
interval
channel-range
channel-select-mode
channelization 2.4g
channelization 5g
client-admission-control
description
external-antenna <ap-
model> 5g
external-antenna <ap-
model> 2.4g
external-antenna
${model}
gps
internal-heater
lbs
led-mode
lldp
location
location-additional-info
override-ap-mgmt-vlan
override-channel-select-
mode
override-client-admission-
control
Disables / deletes the
configuration settings.
..................continued
Table 11. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 57
ruckus(config-ap-group)# no
Type: Privileged
override-lbs
override-zone-location
override-zone-location-
additional-info
poe-operating-mode
poe-out
port-setting
radio-band
status-leds
tx-power 2.4g
tx-power 5g
usb-port
usb-software
venue-profile
wlan-group 2.4g
wlan-group 5g
Disables / deletes the
configuration settings.
ruckus(config-ap-group)#
override-ap-mgmt-vlan
Type: Privileged
<vlanTag> Overrides AP Management VLAN
ruckus(config-ap-group)#
override-channel-select-mode
Type: Privileged
2.4g
5g
Overrides Auto Channel Selection
Mode and ChannelFlyMTBC
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)#
override-zone-location
Type: Privileged
Overrides the zone location
settings.
Table 11. Commands related to ruckus(config-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 58
ruckus(config-ap-group)#
override-zone-location-additional-
info
Type: Privileged
Overrides the zone’s additional
information setting on location.
ruckus(config-ap-group)# poe-
operating-mode
Type: Privileged
Switch the PoE Operating Mode
for specific AP model
ruckus(config-ap-group)# poe-out
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the PoE out port for a specific
AP model.
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)# usb-port
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the USB port for a specific AP
model.
ruckus(config-ap)# usb-software
Type: Privileged
<ap-model> AP model
name
<name> AP USB software
name
Sets the USB port for a specific AP
model.
ruckus(config-ap)# venue-profile
Type: Privileged
<name> Sets the venue profile
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)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 59
Table 12 lists the related ap-group-lldp configuration commands.
Table 12. 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.
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 60
Table 13 lists the related ap-group-port-setting configuration commands.
Table 13. 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)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-zone-ap-group-
port-setting)# help
Type: Privileged
Displays the help.
Configuration Commands
ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 61
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 ruckus(config-ap-group-port)
Syntax and Type Parameters (if any) Description
Configuration Commands
ap-heartbeat
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 62
ap-heartbeat
To setup the access point heartbeat, use the following command:
ruckus(config)# ap-heartbeat <seconds>
Syntax Description
This command uses the following syntax:
seconds: Interval in seconds, which the AP sends the heartbeat to the controller
such as: 30, 60, 150 and 300
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ap-heartbeat 30
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 63
Related Commands
•Table 14 lists the related to ap-portal-cert configuration commands.
•Table 15 lists the related to ap-portal-cert-generate-csr configuration
commands.
Table 14 lists the related to ap-portal-cert configuration commands.
Table 14. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 64
Table 15 lists the related to ap-portal-cert-generate-csr configuration commands.
Table 15. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 65
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
ap-snmp
To enable SNMP on AP, use the following command:
Configuration Commands
app-denial-policy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 66
ruckus(config)# ap-snmp
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1(config)# ap-snmp
app-denial-policy
To create or update an Application Denial Policy, use the following command:
ruckus(config)# app-denial-policy <name>
Syntax Description
This command has the following parameter:
<name>: application name
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1(config)# app-denial-policy xyz
Related Commands
Table 16 lists the related app-denial-policy configuration commands.
Table 16. Commands related to ruckus(config-app-denial-policy)
Syntax and Type Parameters (if any) Description
ruckus(config-app-denial-policy)#
description
Type: Privileged
<text> Sets the description.
Configuration Commands
app-port-mapping
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 67
app-port-mapping
To create or update application port mapping, use the following command:
ruckus(config)# app-port-mapping <name>
Syntax Description
This command has the following parameter:
<name>: application name
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1(config)# app-port-mapping abc
Related Commands
Table 17 lists the related app-port-mapping configuration commands.
ruckus(config-app-denial-policy)#
rule
Type: Privileged
Creates/Updates Application
Denial Policy rule
ruckus(config-app-denial-policy)#
no
Type: Privileged
rule Removes Application Denial Policy
rule.
Table 17. Commands related to ruckus(config-app-port-mapping)
Syntax and Type Parameters (if any) Description
ruckus(config-app-port-
mapping)# port
Type: Privileged
<port>: Port Sets the port.
ruckus(config-app-port-
mapping)# protocol
Type: Privileged
[tcp | udp] Sets the protocol
Table 16. Commands related to ruckus(config-app-denial-policy)
Syntax and Type Parameters (if any) Description
Configuration Commands
bonjour-gateway
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 68
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 69
Related Commands
Table 18 lists the related bonjour-policy configuration commands.
Table 18. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 70
Table 19 lists the related bonjour-policy-rule configuration commands.
Table 19. 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
bridge-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 71
bridge-profile
To create or update the bridge configuration, use the following command:
ruckus(config)# bridge-profile <name>
Syntax Description
This command uses the following syntax:
name: Authorization service profile name
Default
This command has no default settings.
Command Mode
Config
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 19. Commands related to ruckus(config-bonjour-policy-rule)
Syntax and Type Parameters (if any) Description
Configuration Commands
bridge-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 72
Example
SZ100#(config)# bridge-profile auth-prof
Related Commands
•Table 20 lists the related bridge-profile configuration commands.
•Table 20 lists the related bridge-profile-dhcp-option82 configuration commands.
Table 20 lists the related bridge-profile configuration commands.
Table 20. Commands related to ruckus(config-bridge-profile) configuration
Syntax and Type Parameters (if any) Description
ruckus(config-bridge-profile)#
description
Type: Privileged
<text> Sets the description
ruckus(config-bridge-profile)#
dhcp-option82
Type: Privileged
Enables the DHCP Option 82.
ruckus(config-bridge-profile)#
dhcp-relay
Type: Privileged
Enables the DHCP relay.
ruckus(config-bridge-profile)#
dhcp-server1
Type: Privileged
<ip> Sets the DHCP Server 1
ruckus(config-bridge-profile)#
dhcp-server2
Type: Privileged
<ip> Sets the DHCP Server 1
ruckus(config-bridge-profile)# do
Type: Privileged
Executes the do command. .
ruckus(config-bridge-profile)#
end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-bridge-profile)#
exit
Type: Privileged
Exits from the EXEC.
Configuration Commands
bridge-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 73
Table 21 lists the related bridge-profile-dhcp-option82 configuration commands.
ruckus(config-bridge-profile)#
help
Type: Privileged
Displays the help.
ruckus(config-bridge-profile)#
name
Type: Privileged
<name> Set the authentication service
profile name
ruckus(config-bridge-profile)# no
Type: Privileged
dhcp-option82
dhcp-relay
dhcp-server2
relay-both
Disables DHCP Option 82, DHCP
Relay or deletes DHCP Server 2
ruckus(config-bridge-profile)#
relay-both
Type: Privileged
Enables sending DHCP requests
to both the servers
simultaneously.
Table 21. Commands related to ruckus(config-bridge-profile-dhcp-option82)
Syntax and Type Parameters (if any) Description
ruckus(config-bridge-profile-
dhcp-option82)# do
Type: Privileged
Executes the do command.
ruckus(config-bridge-profile-
dhcp-option82)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-bridge-profile-
dhcp-option82)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-bridge-profile-
dhcp-option82)# help
Type: Privileged
Displays the help.
Table 20. Commands related to ruckus(config-bridge-profile) configuration
Syntax and Type Parameters (if any) Description
Configuration Commands
bridge-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 74
ruckus(config-bridge-profile-
dhcp-option82)# no
Type: Privileged
subopt1
subopt150
subopt151
subopt2
Disables various options
ruckus(config-bridge-profile-
dhcp-option82)# subtopt1
Type: Privileged
[ ap-info | ap-essid | ap-mac ] Enables subopt-1
ruckus(config-bridge-profile-
dhcp-option82)# subtopt150
Type: Privileged
Enables subopt-150
ruckus(config-bridge-profile-
dhcp-option82)# subtopt151
Type: Privileged
essid
area-name <name>
Enables subopt-151
ruckus(config-bridge-profile-
dhcp-option82)# subtopt2
Type: Privileged
[ ap-essid | ue-essid | ue-mac
| ap-mac ]
Enables subopt-2
Table 21. Commands related to ruckus(config-bridge-profile-dhcp-option82)
Syntax and Type Parameters (if any) Description
Configuration Commands
cert-store
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 75
cert-store
To create or update certificate configurations, use the following command:
ruckus(config)# cert-store ap-cert <name>
ruckus(config)# cert-store cert <name>
ruckus(config)# cert-store csr <name>
ruckus(config)# cert-store hotspot-cert <name>
ruckus(config)# cert-store web-cert <name>
Syntax Description
This command uses the following syntax:
ap-cert <name>: Create / updates the AP port certificate
cert <name>: Create / updates the certificate configuration
csr <name>: Create / updates CSR (Certificate Signing Request) configuration
hotspot-cert <name>: Sets the hotspot certificate
web-cert <name>: Sets the management web certificate
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# cert-store cert apcert
SZ100-Node1(config-cert)#
Related Commands
Table 22 lists the related cert-store configuration commands.
Table 22. Commands related to ruckus(config-cert-store) configuration
Syntax and Type Parameters (if any) Description
ruckus(config-cert-store)# cert
Type: Privileged
<ftp-url>
<ftp-url> append
Uploads the certificate file.
ruckus(config-cert-store)# city
Type: Privileged
<city> Sets the city
Configuration Commands
cert-store
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 76
ruckus(config-cert-store)#
common-name
Type: Privileged
<domain-name> Sets the domain name
ruckus(config-cert-store)# country
Type: Privileged
<country> Sets the country.
ruckus(config-cert-store)#
description
Type: Privileged
<text> Sets the description
ruckus(config-cert-store# do
Type: Privileged
Executes the do command.
ruckus(config-cert-store)# email
Type: Privileged
<email> Sets the email address.
ruckus(config-cert-store)# end
Type: Privileged
Ends the current configuration
session and return to privileged
EXEC mode.
ruckus(config-cert-store)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-cert-store)# help
Type: Privileged
Displays the help.
ruckus(config-cert-store)#inter-
cert
Type: Privileged
<ftp-url>:FTP URL
format: ftp://
<username>:<password>
@<ftp-host>/<file-path>
Upload intermediate CA
certificate.
ruckus(config-cert-store)# no
Type: Privileged
inter-cert
root-cert
Disables all commands.
ruckus(config-cert-store)#
organization
Type: Privileged
<org> Sets the organization.
ruckus(config-cert-store)#
passphrase
Type: Privileged
<passphrase> Sets the key passphrase.
Table 22. Commands related to ruckus(config-cert-store) configuration
Syntax and Type Parameters (if any) Description
Configuration Commands
changepassword
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 77
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 $(.
ruckus(config-cert-store)# private-
key
Type: Privileged
upload <ftp-url>
csr <csr-name>
Sets the private key.
ruckus(config-cert-store)# root-
cert
Type: Privileged
<ftp-url>:FTP URL
format: ftp://
<username>:<password>
@<ftp-host>/<file-path>
Select the root certificate.
ruckus(config-cert-store)# root-
cert-type
Type: Privileged
Sets the certificate type to trusted
root certificate.
ruckus(config-cert-store)# server-
cert
Type: Privileged
<ftp-url>:FTP URL
format: ftp://
<username>:<password>
@<ftp-host>/<file-path>
Upload server certificates.
ruckus(config-cert-store)# state
Type: Privileged
<state> Sets the state
ruckus(config-cert-store)# unit
Type: Privileged
<org-unit> Sets the organization unit.
Table 22. Commands related to ruckus(config-cert-store) configuration
Syntax and Type Parameters (if any) Description
Configuration Commands
clock
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 78
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# changepassword
Old Password: *******
New Password: *******
clock
To update the system clock or the timezone configuration, use the following
command:
ruckus(config)# clock timezone <timezone>
Syntax Description
This command uses the following syntax:
timezone: Sets the system clock timezone
<timezone>: Timezone name of the domain
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# clock timezone Africa/Nairobi
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.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 79
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
Example
SZ100-Node1(config)# common-settings
SZ100-Node1(config-common-settings)#
Related Commands
•Table 23 lists the related common-settings configuration commands.
•Table 24 lists the related common-settings-aaa configuration commands.
•Table 25 lists the related common-settings-ap-group configuration commands.
•Table 28 lists the related common-settings-ap-model configuration commands
•Table 29 lists the related common-settings-ap-model-lan1 configuration
commands.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 80
•Table 30 lists the related common-settings-ap-tunnel-settings configuration
commands.
•Table 31 lists the commands related common-settings-diffserv configuration
commands.
•Table 32 lists the related common-settings-guest-access configuration
commands.
•Table 33 lists the related common-settings-hotspot configuration commands.
•Table 34 lists the related common-settings-vlan-pooling configuration
commands.
•Table 36 lists the related common-settings-web-authentication configuration
commands.
•Table 37 lists the related common-settings-wlan configuration commands.
•Table 38 lists the related common-settings-wlan-group configuration
commands.
•Table 39 lists the related common-settings-wlan-scheduler configuration
commands.
Table 23 lists the related common-settings configuration commands.
Table 23. 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-ip-mode
Type: Privileged
[ ipv4 | ipv6 ] Sets the AP IP mode.
ruckus(config-common-settings)#
ap-logon
Type: Privileged
<logon-id> Sets the access point
administration login credentials.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 81
ruckus(config-common-settings)#
ap-mgmt-vlan
Type: Privileged
<vlanTag> Set AP management VLAN
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
and minutes> ] : Sets the
default gateway timeout in
hours and minutes.
control-interface <hours>
Sets the control gateway
timeout in hours.
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.
ruckus(config-common-settings)#
band-balancing
Type: Privileged
2.4g <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)#
channel-select-mode
Type: Privileged
Selects the channel mode.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 82
ruckus(config-common-settings)#
channel-evaluation-interval
Type: Privileged
<seconds> The interval
value (Range:60~3600
sec)
Sets the channel evaluation
interval.
ruckus(config-common-settings)#
channel-range
Type: Privileged
2.4g [ <channels | all> ]
5g indoor [ <channels |
all>]
5g outdoor [ <channels |
all>]
Set channel range.
ruckus(config-common-settings)#
channel-select-mode
Type: Privileged
2.4g ${value}
5g ${value}
Set a mode to automatically adjust
AP channels.
ruckus(config-common-settings)#
channelization
Type: Privileged
2.4g [ 20 | 40 ]
5g [ 40 | 20 ]
Sets the channelization.
ruckus(config-common-settings)#
channelfly-mtbc
Type: Privileged
2.4g <number>
5g <number>
Set MTBC value of channelFly
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 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 83
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)#
dfs-channel
Type: Privileged
Enable DFS channels for the US
country code.
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)#
gps
Type: Privileged
<latitude> <longitude> Sets the GPS coordinates.
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.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 84
ruckus(config-common-settings)#
help
Type: Privileged
Displays the help.
ruckus(config-common-settings)#
indoor-channel
Type: Privileged
Enables the indoor channels.
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)#
location
Type: Privileged
<location> Sets the location.
ruckus(config-common-settings)#
location-additional-info
Type: Privileged
<text> Sets the additional information for
location.
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
<mesh-passphrase> Sets the mesh passphrase.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 85
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.
ruckus(config-common-settings)#
no
Type: Privileged
background-scan
band-balancing
channel-select-mode
client-admission-control
dfs-channel
gps
indoor-channel
lbs
load-balancing
location
location-additional-info
mesh
roam
smart-mon
smart-roam-disconnect-
event
syslog-enabled
timezone-dst
venue-profile
vlan-overlapping
Disables or deletes various sub
command.
ruckus(config-common-settings)#
roam
Type: Privileged
2.4g
5g
Sets the smart roam.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 86
ruckus(config-common-settings)#
rogue-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 rogue access
point.
...........................continued
ruckus(config-common-settings)#
rogue-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 rogue access
point.
ruckus(config-common-settings)#
smart-mon
Type: Privileged
interval <value>
threshold <value>
Sets the smart monitor interval.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 87
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-ip6
Type: Privileged
<ipv6> Sets the syslog server IPv6
address.
ruckus(config-common-settings)#
syslog-port
Type: Privileged
<port> Sets the port number for the
syslog server.
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
controller 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.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 88
Table 24 lists the related common-settings-aaa configuration commands.
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)#
venue-profile
Type: Privileged
<name> Sets the venue profile.
ruckus(config-common-settings)#
vlan-overlapping
Type: Privileged
Enables overlapping of VLAN
pooling.
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 24. 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.
Table 23. Commands related to ruckus(config-common-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 89
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.
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.
Table 24. Commands related ruckus(config-common-settings-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 90
ruckus(config-common-settings-
aa)# ip6
Type: Privileged
<ipv6> Sets the IPv6 address 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
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.
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.
Table 24. Commands related ruckus(config-common-settings-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 91
Table 25 lists the related common-settings-ap-group configuration commands.
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 25. 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)# channel-evaluation-
interval
Type: Privileged
<seconds>: The interval
value
Sets the Channel Evaluation
interval.
ruckus(config-common-settings-
ap-group)# channel-range
Type: Privileged
2.4g [<channels | all>]
5g indoor [<channels |
all>]
5g outdoor [<channels |
all>]
Sets the channel range.
ruckus(config-common-settings-
ap-group)# channel-select-mode
Type: Privileged
2.4g ${value}
5g ${value}
Sets a mode to automatically
adjust AP channels
Table 24. Commands related ruckus(config-common-settings-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 92
ruckus(config-common-settings-
ap-group)# channelfly-mtbc
Type: Privileged
2.4g<number>
5g <number>
<number>:MTBC value
(Range: 100-1440)
Sets the MTBC value of
ChannelFly.
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
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 93
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 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 94
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> gain <gain>
<a<ap-model> [ disable |
enable ]
<ap-model> 2.4g [ 2-
antennas | 3-antennas ]
<ap-model> 5g [ 3-
antennas | 2-antennas ]
Sets the external antenna for
specific AP model.
ruckus(config-common-settings-
ap-group)# gps
Type: Privileged
<latitude> <longitude> Sets the GPS coordinates.
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.
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 95
ruckus(config-common-settings-
ap-group)# lldp
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the LLDP for a specific AP
model.
ruckus(config-common-settings-
ap-group)# location
Type: Privileged
<location> Sets the location.
ruckus(config-common-settings-
ap-group)# location-additional-info
Type: Privileged
<text> Sets the additional information for
location.
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.
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 96
ruckus(config-common-settings-
ap-group)# no
Type: Privileged
channel 2.4g
channel 5g indoor
channel 5g outdoor
channel-evaluation-
interval
channel-range
channel-select-mode
channelization 2.4g
channelization 5g
client-admission-control
description
external-antenna <ap-
model> 5g
external-antenna <ap-
model> 2.4g
gps
internal heater
lbs
led-mode
lldp
location
location-additional-info
override-ap-mgmt-vlan
override-channel-select-
mode
override-client-
admission-control
override-lbs
override-zone-location
override-zone-location-
additional-info
Disables / deletes the
configuration settings.
..................................continued
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 97
ruckus(config-common-settings-
ap-group)# no
Type: Privileged
poe-operating-mode
poe-out
poe-port
port-setting
radio-band
status-led
tx-power 2.4g
tx-power 5g
usb-port
usb-software
venue-profile
wlan-group 2.4g
wlan-group 5g
Disables / deletes the
configuration settings.
ruckus(config-common-settings-
ap-group)# override-ap-mgmt-
vlan
Type: Privileged
<vlanTag> Overrides the AP management
VLAN
ruckus(config-common-settings-
ap-group)# override-channel-
select-mode
Type: Privileged
2.4g
5g
Overrides auto channel selection
mode and ChannelFly MTBC.
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)# override-zone-location
Type: Privileged
Overrides the zone location
settings.
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 98
ruckus(config-common-settings-
ap-group)# override-zone-
location-additional-info
Type: Privileged
Overrides the zone’s additional
information setting on location.
ruckus(config-common-settings-
ap-group)# poe-operating-mode
Type: Privileged
Switch the PoE operating mode
for a specific AP model.
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.
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-ap)# usb-port
Type: Privileged
<ap-model> [ enable |
disable ]
Sets the USB port for the specific
AP.
ruckus(config-ap)# usb-software
Type: Privileged
<ap-model>: AP model
name
<name>: AP USB
software name. Format:
{VID}-{PID}-{Version
Set AP USB software package for
specific AP model.
ruckus(config-ap)# venue-profile
Type: Privileged
<name> Sets the venue profile
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 99
ruckus(config-common-settings-
ap-group)# wlan-group
Type: Privileged
2.4g
5g
Sets the WLAN group
configurations.
Table 25. Commands related to ruckus(config-common-settings-ap-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 100
Table 26 lists the commands related config-common-settings-ap-group-port-setting
configuration commands.
Table 26. Commands related to (config-common-settings-ap-group-port-setting)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-group-port-setting)# dot1x
Type: Privileged
• authsvr [
<Authenticator Server
Name> :
• authsvr: Set
authenticator server
• <Authenticator
Server Name>:
Authenticator server
• accsvr <name>:
accsvr <name>
• accsvr: Set
accounting server
•<name>:
Accounting server
name
• mac-auth-bypass [
true | false ]
• mac-auth-bypass:
Set MAC
authentication
bypass for
authenticator true:
Enable MAC
authentication
bypass
• false: Disable MAC
authentication
bypass
• supplicant user-name
<username>
password
<password> contd...
Sets the 802.1x role.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 101
• supplicant: Set
supplicant setting
• user-name: specify
user name
• <username>: User
name
• password: specify
password
• <password>:
Password
• supplicant mac
• supplicant: Set
supplicant setting
• mac: Use MAC
address as
username and
password
ruckus(config-common-settings-
ap-group-port-setting)# lan
Type: Privileged
• <port>:The AP port
• <port> uplink [ general
| access | trunk]:
• <port>: The AP port
• uplink: Sets the AP
port to use the
specified type
• general: Sets the AP
port type to general
• access: Sets the AP
port type to access
• trunk: Sets the AP
port type to trunk
• <port> untag <vlan>:
• <port>: The AP port
• continued....
Enables or disables a specific port.
Table 26. Commands related to (config-common-settings-ap-group-port-setting)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 102
• untag: Sets the AP
port to use the
specified VLAN
Untag ID
•<vlan>: VLAN Untag
ID
• <port> member <vlan-
members>:
• <port>: The AP port
• member: Sets the
AP port to use the
specified members
• <vlan-members>:
VLAN members(1-
4094)
• <port> dot1x [ auth-
mac-based | disabled |
auth-port-based |
supplicant] :
• <port>: The AP port
• dot1x: Sets the AP
port 802.1X
• auth-mac-based:
Sets 802.1x Role to
authenticator (mac-
based)
• disabled: Disables
802.1x
• auth-port-based:
Sets 802.1x Role to
authenticator (port-
based)
• supplicant: Sets
802.1x Role to
supplicant
Table 26. Commands related to (config-common-settings-ap-group-port-setting)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 103
Table 27 lists the commands related config-common-settings-ap-group-lldp config-
uration commands.
Table 28 lists the commands related config-common-settings-ap-model configura-
tion commands.
ruckus(config-common-settings-
ap-group-port-setting)# no
Type: Privileged
dot1x accsvr
lan <port>
Disables the settings.
Table 27. Commands related to (config-common-settings-ap-group-lldp)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-group-lldp)# lldp-ad-interval
Type: Privileged
<seconds>: LLDP
advertise interval (1- 300)
Sets the LLDP advertise interval.
ruckus(config-common-settings-
ap-group-lldp)# lldp-hold-time
Type: Privileged
<seconds>: LLDP hold
time (60 - 1200)
Sets the LLDP hold time.
ruckus(config-common-settings-
ap-group-lldp)# lldp-mgmt
Type: Privileged
[enable | disable]:
enable: Enable LLDP
management IP TLV
disable: Disable LLDP
management IP TLV
Enables LLDP management IP
TLV.
Table 28. Commands related to (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.
Table 26. Commands related to (config-common-settings-ap-group-port-setting)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 104
ruckus(config-common-settings-
ap-model)# exit
Type: Privileged
Exits from the EXEC.
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)# help
Type: Privileged
Displays the help.
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.
Table 28. Commands related to (config-common-settings-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 105
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).
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-operating-mode
poe-out-port
radio-band
usb
usb-software
Disables or deletes the settings
that have been configured.
Table 28. Commands related to (config-common-settings-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 106
Tabl e 29 lists the related common-settings-ap-model-lan1 configuration commands.
ruckus(config-common-settings-
ap-model)# poe-operating-mode
Type: Privileged
${value} Switch the PoE mode
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.
ruckus(config-common-settings-
ap-model)# usb
Type: Privileged
Enables the USB port.
ruckus(config-common-settings-
ap-model)# usb-software
Type: Privileged
${value} Enables the AP USB software
package.
Table 29. 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.
Table 28. Commands related to (config-common-settings-ap-model)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 107
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.
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 29. Commands related to ruckus(config-common-settings-ap-model-lan1)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 108
Table 30 lists the commands related config-common-settings-ap-tunnel-settings
configuration commands.
Table 30. Commands related to (config-config-common-settings-ap-tunnel-settings)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
ap-tunnel-settings)# force-
disassociate-client
Force disassociates the client
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)# gateway6
Type: Privileged
<ipv6> [ primary |
secondary ]
Sets the gateway IPv6 address.
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.
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)# icmp-period
Type: Privileged
<seconds> Sets the ICMP keep alive.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 109
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)# ipsec-tunnel-
profile
Type: Privileged
${value} Sets IPsec Tunnel profile.
ruckus(config-common-settings-
ap-tunnel-settings)# no
Type: Privileged
force-disassociate-client
gateway <seconds>
gateway6 <secondary>
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 30. Commands related to (config-config-common-settings-ap-tunnel-settings)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 110
Table 31 lists the related config-common-settings-diffserv configuration commands.
Table 31. Commands related to ruckus(config-common-settings-diffserv)
Syntax and Type Parameters (if any) Description
ruckus(config-config-common-
settings-diffserv)# description
Type: Privileged
<text> Sets the description.
ruckus(config-config-common-
settings-diffserv)# do
Type: Privileged
Executes the do command.
ruckus(config-config-common-
settings-diffserv)# downlink-
diffserv
Type: Privileged
<value> Enables the tunnel diffserv
downlink and sets the diffserv
number.
ruckus(config-config-common-
settings-diffserv)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-config-common-
settings-diffserv)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-config-common-
settings-diffserv)# help
Type: Privileged
Displays the help.
ruckus(config-config-common-
settings-diffserv)# no
Type: Privileged
description
downlink-diffserv
preserved-diffserv
uplink-diffserv
Disables various options.
ruckus(config-config-common-
settings-diffserv)# preserved-
diffserv
Type: Privileged
<value> Adds the preserved diffserv
number.
ruckus(config-config-common-
settings-diffserv)# uplink-diffserv
Type: Privileged
<value> Enables the tunnel diffserv uplink
and sets the diffserv number.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 111
Table 32 lists the related common-settings-guest-access configuration commands.
Table 32. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 112
Table 33 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 33. 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)# language
Type: Privileged
Sets the portal language.
ruckus(config-common-settings-
hotspot)# location-id
Type: Privileged
<location-id> Sets the location ID.
Table 32. Commands related to ruckus (config-common-settings-guest-access)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 113
ruckus(config-common-settings-
hotspot)# location-name
Type: Privileged
<name> Sets the location name.
ruckus(config-common-settings-
hotspot)# logo
Type: Privileged
<ftp-url> Sets the logo.
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
show-terms-conditions
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)# show-terms-conditions
Type: Privileged
Shows the terms and conditions.
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)# terms-conditions
Type: Privileged
<terms> Sets the terms and conditions.
ruckus(config-common-settings-
hotspot)# title
Type: Privileged
<title> Sets the title.
Table 33. Commands related to ruckus(config-common-settings-hotspot)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 114
Table 34 lists the related common-settings-vlan-pooling configuration commands.
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 34. Commands related to ruckus(config-common-settings-vlan-pooling)
Syntax and Type Parameters (if any) Description
ruckus(config-common-
settings-vlan-pooling)# algo
Type: Privileged
mac-hash Sets the algorithm.
ruckus(config-common-
settings-vlan-pooling)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-common-
settings-vlan-pooling)# do
Type: Privileged
Executes the do command.
ruckus(config-common-
settings-vlan-pooling)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-common-
settings-vlan-pooling)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-common-
settings-vlan-pooling)# help
Type: Privileged
Displays the help.
ruckus(config-common-
settings-vlan-pooling# no
Type: Privileged
description
pooling
Disables various option
Table 33. Commands related to ruckus(config-common-settings-hotspot)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 115
Table 35 lists the related common-settings-wechat configuration commands.
ruckus(config-common-
settings-vlan-pooling)# pooling
Type: Privileged
range <start-value> <end-
value>: VLAN range
single <value>: Single VLAN
ID
Adds the VLAN pooling.
Table 35. Commands related to ruckus (config-zone-wechat) and (config-domain-zone-
wechat)
Syntax and Type Parameters (if any) Description
ruckus(config-common-settings-
wechat)# authentication-url
Type: Privileged
<text>: Authentication
URL
Sets Authentication URL
ruckus(config-common-settings-
wechat)# black-list
Type: Privileged
<text>: Black list Sets black list.
rruckus(config-common-settings-
wechat)# description
Type: Privileged
<text>: Description Sets description.
ruckus(config-common-settings-
wechat)# dnat-destination
Type: Privileged
<text>: DNAT destination Sets DNAT destination.
ruckus(config-common-settings-
wechat)# dnat-port-mapping
Type: Privileged
<source><dest>: Source
and destination ports
Set DNAT port mappings
ruckus(config-common-settings-
wechat)# grace-period
Type: Privileged
<minutes>: Grace Period
minutes
Set grace period
ruckus(config-common-settings-
wechat)# no
Type: Privileged
dnat-port-mapping
white-list
Disable the options.
Table 34. Commands related to ruckus(config-common-settings-vlan-pooling)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 116
Table 36 lists the related common-settings-web-authentication configuration
commands.
ruckus(config-common-settings-
wechat)# whitelist
Type: Privileged
<white-list> Allowed
unauthorized
destinations, comma-
separated IP, IP range,
CIDR and regular
expression Domain name
list
Sets White list.
Table 36. 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 35. Commands related to ruckus (config-zone-wechat) and (config-domain-zone-
wechat)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 117
Table 37 lists the related common-settings-wlan configuration commands.
Table 37. 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
controller.
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.
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 controller 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)# app-denial-policy
Type: Privileged
<name>: Application
Denial Policy Name
Sets Application Denial Policy.
ruckus(config-common-settings-
wlan)# app-visibility
Type: Privileged
Sets Application visibility.
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.
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 118
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)# bypass-cna
Type: Privileged
Enables bypassing CNA.
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.
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
(DGAF).
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 119
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
[ subopt-1 | ruckus-gre |
soft-gre ]
Enables DHCP option 82 format
options.
ruckus(config-common-settings-
wlan)# diffserv-profile
Type: Privileged
<name> Sets the differential server profile
configuration.
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.
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.
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 120
ruckus(config-common-settings-
wlan)# enable-rfc5580-support
Type: Privileged
Enables this attribute to deliver
location information only for those
APs which have the location
attribute configured.
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-mfp
Type: Privileged
Sets the MFP configuration.
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 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 121
ruckus(config-common-settings-
wlan)# forwarding-policy
Type: Privileged
Sets the forwarding policy.
ruckus(config-common-settings-
wlan)# guest-access
Type: Privileged
<name> Sets the guest access service.
ruckus(config-common-settings-
wlan)# guest-access-acct-service
Type: Privileged
Sets the accounting server.
ruckus(config-common-settings-
wlan)# guest-access-auth-service
Type: Privileged
Sets the authentication server.
ruckus(config-common-settings-
wlan)# hessid
Type: Privileged
<hessid> Sets the WLAN HESSID.
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)# hotspot20-osu-support
Type: Privileged
Enables the Hotspot 2.0 enabled
device registration from this guest
portal.
ruckus(config-common-settings-
wlan)# inactivity-timeout
Type: Privileged
<number> Sets the inactivity timeout.
Terminates idle user sessions after
the specified seconds of inactivity.
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 122
ruckus(config-common-settings-
wlan)# l2-acl
Type: Privileged
[ <ACL name> ] Sets the layer 2 access control list.
ruckus(config-common-settings-
wlan)# mac-address-format
Type: Privileged
Sets the MAC address format.
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.
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.
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 123
ruckus(config-common-settings-
wlan)# no
Type: Privileged
access-network
acct-delay-time
acct-service
acct-service-use-proxy
acct-ttg-session
app-denial-policy
app-visibility
auth-service-use-proxy
bss-minrate
bypass-cna
client-fingerprinting
client-tx-rx-statistics
device-policy
dgaf
dhcp-option-82
diffserv-profile
disable-band-balancing
disable-load-balancing
disable-wlan
dnlink-limit
Disables or deletes the
configurations that have been set.
...................................continued
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 124
ruckus(config-common-settings-
wlan)# no
Type: Privileged
enable-rfc5580-support
force-dhcp
hessid
hide-ssid
hotspot20-osu-support
l2-acl
mac-802-11x-format
mac-auth
ofdm-only
okc-support
onboarding-auth-service-
use-proxy
pmk-caching-support
proxy-arp
qos-map-enable
roam
support-802-11d
uplink-limit
user-traffic-profile
vlan-enabled
vlan-pooling
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)# okc-support
Type: Privileged
Enables OKC support.
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 125
ruckus(config-common-settings-
wlan)# onboarding-auth-service
Type: Privileged
<service-name> local
<realm>
<service-name> remote
<realm>
<service-name> local
<realm> never
<service-name> local
<realm> hour <expiration-
value> - Expiration value
between 1 and 175200.
<service-name> local
<realm> day <expiration-
value> - Expiration value
between 1 and 7300.
<service-name> local
<realm> week
<expiration-value> -
Expiration value between
1 and 1040.
<service-name> local
<realm> month
<expiration-value> -
Expiration value between
1 and 240.
Sets the onboarding
authentication service.
ruckus(config-common-settings-
wlan)# onboarding-auth-service-
use-proxy
Type: Privileged
Sets the onboarding
authentication service using the
controller proxy server.
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 126
ruckus(config-common-settings-
wlan)# onboarding-portal
Type: Privileged
<name> Sets the onboarding portal.
ruckus(config-common-settings-
wlan)# operator-realm
Type: Privileged
Sets the operator realm.
ruckus(config-common-settings-
wlan)# pmk-caching-support
Type: Privileged
Enables the PMK caching
support.
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)# qos-map
Type: Privileged
<priority> Updates the QoS map.
ruckus(config-common-settings-
wlan)# qos-map-enable
Type: Privileged
Enables the QoS map.
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 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 127
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 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 128
Table 38 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-common-settings-
wlan)# vlan-pooling
Type: Privileged
<vlan-id> Enables and sets the VLAN
pooling profile.
ruckus(config-config-common-
settings-wlan)# web-
authentication
Type: Privileged
<name> Sets the web authentication
service.
ruckus(config-config-common-
settings-wlan)# wechat
Type: Privileged
Sets the WeChat 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 38. 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,
Table 37. Commands related to ruckus(config-common-settings-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
common-settings
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 129
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.
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> vlan-pooling
<vlanPooling>
<name> vlan-pooling
<vlanPooling> nasid
<nasid>
<name>
Sets a WLAN in this group, or
overrides the VLAN setting.
Table 38. Commands related to ruckus(config-common-settings-wlan-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
device-policy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 130
Table 39 lists the related common-settings-wlan-scheduler configuration
commands.
.
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 dp
SZ100-Node1(config-device-policy)#
Table 39. 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)# no
Type: Privileged
description
schedule-data [
<weekday | empty> ] [
<start time value | empty>
] [ <end time value> ] |
${weekday}
Disables the commands.
ruckus(config-common-settings-
wlan-scheduler)# schedule-data
Type: Privileged
<weekday | empty> ] [
<start time value | empty>
] [ <end time value> ]
${weekday}
Sets the schedule table.
Configuration Commands
device-policy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 131
Related Commands
Table 40 lists the related device-policy configuration commands
Table 40. 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)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-device-policy)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-device-policy)# help
Type: Privileged
Displays the help.
ruckus(config-device-policy# no
policy-rule
Type: Privileged
[ <Device Type> ] Deletes the device policy rules.
ruckus(config-device-policy)#
policy-rule
Type: Privileged
Sets the device policy.
Configuration Commands
device-policy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 132
Table 41 lists the related device-policy-policy-rule configuration commands.
Table 41. 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)# downlink
Type: Privileged
[ <Rate Limiting> ]
Rate limiting (mbps)
Sets the downlink rate limiting.
ruckus(config-device-policy-
policy-rule)# no vlan
Type: Privileged
Resets the VLAN number.
ruckus(config-device-policy-
policy-rule)# type
Type: Privileged
[ <Device Type> ] 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.
Configuration Commands
diffserv
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 133
diffserv
To create or update the differential server profile configuration, use the following
command:
ruckus(config)# diffserv <name>
Syntax Description
This command uses the following syntax:
<name>: Name of the differential server policy
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# diffserv dp
SZ100-Node1(config-diffserv)#
Related Commands
Table 42 lists the related config-diffserv configuration commands.
Table 42. Commands related to ruckus(config-diffserv)
Syntax and Type Parameters (if any) Description
ruckus(config-diffserv)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-diffserv)# do
Type: Privileged
Executes the do command.
ruckus(config-diffserv)# downlink-
diffserv
Type: Privileged
<value> Enables the tunnel diffserv
downlink and sets the diffserv
number.
ruckus(config-diffserv)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-diffserv)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
Configuration Commands
diameter-remote-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 134
diameter-remote-service
To configure the diameter remote peer service, use the following command.
ruckus(config)# diameter-remote-service <name>
Syntax Description
This command has the following syntax:
<name>: Diameter remote peer service name.
Default
This command has no default settings.
Command Mode
Config
ruckus(config-diffserv)# help
Type: Privileged
Displays the help.
ruckus(config-diffserv)# no
Type: Privileged
description
downlink-diffserv
preserved-diffserv
uplink-diffserv
Disables various options.
ruckus(config-diffserv)#
preserved-diffserv
Type: Privileged
<value> Adds the preserved diffserv
number.
ruckus(config-diffserv)# uplink-
diffserv
Type: Privileged
<value> Enables the tunnel diffserv uplink
and sets the diffserv number.
Table 42. Commands related to ruckus(config-diffserv)
Syntax and Type Parameters (if any) Description
Configuration Commands
SZ100-Node1(config)# diameter-remote-service name
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 135
Example
SZ100-Node1(config)# diameter-remote-service name
Related Commands
Table 43 lists the related diameter-remote-service configuration commands.
Table 43. Commands related to ruckus(config-diameter-remote-service)
Syntax and Type Parameters (if any) Description
ruckus(config-diameter-remote-
service)# alt-peer-name
Type: Privileged
<alter_peername>: Alter
peer name
Sets the alter peer name.
ruckus(config-diameter-remote-
service)# description
Type: Privileged
<text> Sets the description.
ruckus(config-diameter-remote-
service)# do
Type: Privileged
Executes the do command.
ruckus(config-diameter-remote-
service)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-diameter-remote-
service)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-diameter-remote-
service)# help
Type: Privileged
Displays the help.
ruckus(config-diameter-remote-
service)# ip
Type: Privileged
<ip> : IP address. Sets the IP address.
ruckus(config-diameter-remote-
service)# no
Type: Privileged
description
peer
Disables various options.
ruckus(config-diameter-remote-
service)# peer
Type: Privileged
<peer-name>: Peer name Associates the peer to the
diameter.
Configuration Commands
do
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 136
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
ruckus(config-diameter-remote-
service)# port
Type: Privileged
<port>: Port number Sets the port.
ruckus(config-diameter-remote-
service)# realm-name
Type: Privileged
<name>: Realm name Updates or adds the remote realm
name.
ruckus(config-diameter-remote-
service)# retransmit-count
Type: Privileged
<retransmit count>: STA
re-transmit count
Updates or adds the re-transmit
count.
ruckus(config-diameter-remote-
service)# service-type
Type: Privileged
[2 | 1 | 4 | 3]:
2: PCRF
1: OCS
4: STA
3: DRA
Updates or adds the service type.
ruckus(config-diameter-remote-
service)# transport-type
Type: Privileged
[1 | 0]
1: SCTP
0: TCP
Updates or adds the transport
type.
ruckus(config-diameter-remote-
service)# tx-timer
Type: Privileged
[<Tx Timer in seconds>]:
STA Tx timer
Updates or adds the Tx timer.
Table 43. Commands related to ruckus(config-diameter-remote-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
dp-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 137
Example
SZ100-Node1(config)# do
dp-group
To enable and sets the data plane grouping, use the following command.
ruckus(config)# dp-group <dp-mac-group>
Syntax Description
This command uses the following syntax:
<dp-mac-group>: Dataplane groups, which is comma separated DP MAC
addresses in a group. For example, 3 DP value is seen as “,”.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# dp-group dp1-172.19.7.100 dp2-172.19.8.120
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 138
3
Configuration Commands
This chapter describes the commands that you can use to configure, enable, and
disable various components of the controller. 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 44. Configuration commands
encrypt-mac-ip end ethernet-port-
profile
event event db-
persistence
event email event snmp-
trap
event-email event-
threshold
exit
ftp-server ftp-test guest-access help hostname
hotspot hotspot20-
venue-profile
hotspot20-
wlan-profile
hs20-sslv3 identity-provider
import-
zdbackup
interface ip ip control-nat ip name-server
ip name-server-
ipv6
ip route ip route-ipv6 ipsec-profile l2-acl
lbs-service ldap-service license license cloud license export
license import license local license sync-
now
lineman localdb-service
logging console lwapp2scg mgmt-acl no ad-service no admin
no admin-radius no ap no ap auto-
approve
no ap auto-
tagging
no ap-cert-check
no ap-control-
mgmt-tos
no ap-group no ap-root-ca no ap-sci no ap-snmp
no app-denial-
policy
no app-port-
mapping
no bonjour-
gateway
no bonjour-
policy
no bridge-profile
Configuration Commands
encrypt-mac-ip
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 139
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.
no cert-store no control-
plane
no data-plane no device-
policy
no diffserv
no dp-group no encrypt-
mac-ip
no event no ethernet-
port-profile
no ftp-server
no guest-
access
no hotspot no hotspot20-
venue-profile
no hotspot20-
wlan-profile
no hs20-sslv3
no identity-
provider
no interface no ip no ipsec-
profile
no l2-acl
no lbs-service no ldap-
service
no lineman no logging no non-proxy-aaa
no oauth-
service
no operator-
profile
no osu-portal-
profile
no outbound
firewall
no proxy-aaa
no report no role no snmp-trap no snmp-v2-
community
no snmp-v3-user
no
subpackages
no usb-
software
no user-agent-
blacklist
no user-
defined-app
no user-role no user-traffic-
profile
no vlan-pooling no web-
authentication
no wlan
no wlan-group no wlan-
scheduler
non-proxy-aaa northbound-
authtype
northbound-portal
ntp-server oauth-service operator-profile osu-portal-
profile
outbound-firewall
proxy-aaa rebalance-aps report role
Table 44. Configuration commands
Configuration Commands
end
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 140
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.
Command Mode
Config
Example
SZ100-Node1(config)# end
ethernet-port-profile
To define the Ethernet port profile, use the following command.
ruckus(config)# ethernet-port-profile
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Configuration Commands
ethernet-port-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 141
Example
SZ100-Node1(config)# ethernet-port-profile
Table 45 lists the related config-ethernet-port-profile configuration commands.
Table 45. Commands related to ruckus(config-ethernet-port-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-ethernet-port-
profile)# 8021x
Type: Privileged
Sets 802.1x.
ruckus(config-ethernet-port-
profile)# acct-service
Type: Privileged
<acct-service> Accounting service.
ruckus(config-ethernet-port-
profile)# auth-service
Type: Privileged
<auth-service> Authentication service.
ruckus(config-ethernet-port-
profile)# dvlan
Type: Privileged
Enable dynamic VLAN
ruckus(config-ethernet-port-
profile)# guest-vlan
Type: Privileged
<guest-vlan-id> Guest VLAN
ruckus(config-ethernet-port-
profile)# mac-bypass
Type: Privileged
Enable MAC authentication
bypass
ruckus(config-ethernet-port-
profile)# no
Type: Privileged
acct-service
dvlan
mac-bypass
proxy-acct
proxy-auth
tunnel
Disables the various options.
ruckus(config-ethernet-port-
profile)# proxy-acct
Type: Privileged
Enables Proxy Accounting
service.
Configuration Commands
event
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 142
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
ruckus(config-ethernet-port-
profile)# proxy-auth
Type: Privileged
Enables Proxy Authentication
service.
ruckus(config-ethernet-port-
profile)# supplicant
Type: Privileged
•mac
• custom <username>
<password>
Set the supplicant.
ruckus(config-ethernet-port-
profile)# tunnel
Type: Privileged
Enable tunnel
ruckus(config-ethernet-port-
profile)# type
Type: Privileged
Set port type
ruckus(config-ethernet-port-
profile)# vlan-members
Type: Privileged
Describe VLAN members.
ruckus(config-ethernet-port-
profile)# vlan-untag-id
Type: Privileged
<vlan-untag-id> Set the VLAN untag ID.
Table 45. Commands related to ruckus(config-ethernet-port-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
event db-persistence
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 143
Example
SZ100-Node1(config)# event 1002
Related Commands
Table 46 lists the related event configuration commands.
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.
Table 46. 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.
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.
Configuration Commands
event db-persistence
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 144
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# event db-persistence
No. Event Code Category Type Description Severity SNMP Email
DB Persistence
----- ----------- ------------------------ ----------------------
1 103 AP Communication AP managed
This event occurs when AP is approved by the SmartZone. Informational
Disabled Disabled Enabled
2 105 AP Communication AP rejected
This event occurs when AP is rejected by the SmartZone.Minor
Enabled Disabled Enabled
3 106 AP Communication AP firmware updated
This event occurs when AP successfully updates its firmware.
Informational Disabled Disabled Enabled
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:
Configuration Commands
event email
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 145
event email
To enable event triggers for selected email notification, use the following command.
ruckus(config)# event email <eventCode>
Syntax Description
This command has no arguments or keywords.
Command Mode
Config
Example
SZ100-Node1(config)# event email
No. Event Code Category Type Description Severity SNMP Email
DB Persistence
----- ----------- ------------------------ ----------------------
1 103 AP Communication AP managed This event
occurs when AP is approved by the SmartZone Informational Enabled
Enabled Enabled .
2 105 AP Communication AP rejected
This event occurs when AP is rejected by SmartZone Minor
Enabled Enabled Enabled
3 106 AP Communication AP firmware updated
This event occurs when AP successfully updates its firmware
Informational Enabled Enabled Enabled
Please choose Event Codes (separated by ',') to enable Event to
trigger Email:
Related Commands
Table 47 lists the related event-email configuration commands.
Table 47. Commands related to ruckus(config-event-email)
Syntax and Type Parameters (if any) Description
ruckus(config-event-email)#
enable
Type: Privileged
Enables notification email for
events.
Configuration Commands
event snmp-trap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 146
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
ruckus(config-event-email)# mail-
to
Type: Privileged
<email> email address Email address configuration.
ruckus(config-event-email)# no
enable
Type: Privileged
Disables the email notification for
events.
ruckus(config-event-email)# no
mail-to
Type: Privileged
Disables email address
configuration.
Table 47. Commands related to ruckus(config-event-email)
Syntax and Type Parameters (if any) Description
Configuration Commands
event-email
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 147
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 48 lists the related event-email configuration commands.
Table 48. 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.
ruckus(config-event)# mail-to
Type: Privileged
<email> Sets the email address
configuration.
Configuration Commands
event-threshold
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 148
event-threshold
To update the event threshold configuration, use the following command.
ruckus(config)# event-threshold <threshold>
Syntax Description
This command has no arguments or keywords.
Command Mode
Config
Example
SZ100-Node1(config)# event-threshold thres
SZ100-Node1(config-event-threshold)#
Related Commands
Table 49 lists the related event-threshold configuration commands.
ruckus(config-event)# no
Type: Privileged
enable
mail-to
Disables various options.
Table 49. Commands related to ruckus(config-event-threshold)
Syntax and Type Parameters (if any) Description
ruckus(config-event-threshold)#
do
Type: Privileged
Enables the do command.
ruckus(config-event-threshold)#
end: Privileged
End the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-event-threshold)#
exit
Type: Privileged
Exit from the EXEC.
ruckus(config-event-threshold)#
help
Type: Privileged
Display the help message.
Table 48. Commands related to ruckus(config-event-email)
Syntax and Type Parameters (if any) Description
Configuration Commands
exit
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 149
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-threshold)# unit
Type: Privileged
Sets the threshold unit.
ruckus(config-threshold)# value
Type: Privileged
Sets the threshold value.
Table 49. Commands related to ruckus(config-event-threshold)
Syntax and Type Parameters (if any) Description
Configuration Commands
ftp-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 150
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
Password: ****
Retype: ****
SZ100-Node1(config-ftp-server)# exit
SZ100-Node1(config)#
Related Commands
Table 50 lists the related ftp-server commands.
Table 50. 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)# protocol
Type: Privileged
Sets the protocol.
Configuration Commands
ftp-test
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 151
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
ruckus(config-ftp-server)# remote-
directory
Type: Privileged
<directory> Sets the FTP remote directory.
ruckus(config-ftp-server)# test
Type: Privileged
Test the FTP settings.
ruckus(config-ftp-server)#
username
Type: Privileged
<username> Sets the user name.
Table 50. Commands related to ruckus(config-ftp-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
guest-access
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 152
Default
This command has no default settings.
Command Mode
config
Example
SZ100-Node1(config)# guest-access dominic
SZ100-Node1(config-guest-access)#
Related Commands
Table 51 lists the related guest access configuration commands.
Table 51. 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.
Configuration Commands
help
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 153
help
To display the help message, use the following command.
ruckus(config)# help
Syntax Description
This command has no arguments or keywords.
ruckus(config-guest-access)# logo
Type: Privileged
<ftp-url>: FTP URL,
format: ftp://
<username>:<password
>@<ip>/<file-path>
Sets the logo.
ruckus(config-guest-access)#
name
Type: Privileged
<name> Sets the guess access service
name.
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 51. Commands related to ruckus (config-guest-access)
Syntax and Type Parameters (if any) Description
Configuration Commands
hostname
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 154
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# help
admin Create/Update Administrator account configuration
admin-radius Create/Update RADIUS server for Administrators
ap-auto-approve Enable AP auto approve
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
Configuration Commands
hotspot
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 155
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# hotspot hsp1
SZ100-Node1(config-hotspot)#
Related Commands
Table 52 lists the related hotspot configuration commands.
Table 52. 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)# language
Type: Privileged
Sets the portal language.
ruckus(config-hotspot)# location-
id
Type: Privileged
<location-id> Sets the location ID.
Configuration Commands
hotspot
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 156
ruckus(config-hotspot)# location-
name
Type: Privileged
<location-name> Sets the location name.
ruckus(config-hotspot)# logo
Type: Privileged
<ftp-url> Sets the logo.
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)# mac-
address-format
Type: Privileged
Set MAC address format.
ruckus(config-hotspot)# name
Type: Privileged
Renames the hotspot profile.
ruckus(config-hotspot)# no
Type: Privileged
show-terms-conditions
<walled-garden-list>
Disables the commands.
ruckus(config-hotspot)# session-
timeout
Type: Privileged
<minutes> Sets the session timeout. Defined
in minutes.
ruckus(config-hotspot)# show-
terms-conditions
Type: Privileged
Shows the terms and conditions.
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.
Table 52. Commands related to ruckus(config-hotspot)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-venue-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 157
hotspot20-venue-profile
To create or update the hotspot 2.0 venue profile configuration, use the following
command.
ruckus(config)# hotspot20-venue-profile <name>
Syntax Description
This command uses the following syntax:
name: Name of the hotspot2.0 venue profile
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# hotspot20-venue-profile hsp1
SZ100-Node1(config-hotspot20-venue-profile)#
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)# terms-
conditions
Type: Privileged
<terms> Sets the terms and conditions.
ruckus(config-hotspot)# title
Type: Privileged
<title> Sets the title.
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 52. Commands related to ruckus(config-hotspot)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-venue-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 158
Related Commands
Table 53 lists the related hotspot20-venue-profile configuration commands.
Table 53. Commands related to ruckus(config-hotspot20-venue-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-hotspot20-venue-
profile)# description
Type: Privileged
<text> Sets the description.
ruckus(hotspot20-venue-profile)#
do
Type: Privileged
Executes the do command.
ruckus(hotspot20-venue-profile#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(hotspot20-venue-profile)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(hotspot20-venue-profile)#
help
Type: Privileged
Displays the help.
ruckus(hotspot20-venue-profile)#
name
Type: Privileged
<name> Sets the hotspot 2.0 venue profile
name.
ruckus(hotspot20-venue-profile)#
no
Type: Privileged
venue-names
<language>
wan-at-capacity
wan-sym-link
Disables the commands.
Configuration Commands
hotspot20-venue-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 159
ruckus(hotspot20-venue-profile)#
venue-category
Type: Privileged
unspecified assembly [
coffee-shop | passenger-
terminal | restaurant | bar
| arena | library | place-of-
worship |
emergencycoordination-
center | museum |
stadium | convention-
center | unspecified |
amphitheater |
amusement-park |
theater | zoo-or-aquarium
]
Sets the venue category
...................................continued
business [ unspecified |
police-station | attorney-
office | professional-office
| research-and-
development-facility
|doctor-or-dentist-office |
fire-station | post-office |
bank ]
educational [ unspecified |
school-primary |
university-or-college |
school-secondary ]
Table 53. Commands related to ruckus(config-hotspot20-venue-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-venue-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 160
ruckus(hotspot20-venue-profile)#
venue-category
Type: Privileged
factory-and-industrial [
unspecified | factory ]
institutional [ hospital |
group-home | unspecified
| prison-or-jail | long-term-
care-facility | alcohol-and-
drugrehabilitation-
center ]
mercantile [ grocery-
market | automotive-
service-station |
unspecified | retail-store |
gas-station | shopping-
mall ]
residential [ unspecified |
private-residence | hotel-
or-motel | dormitory |
boarding-house ]
storage unspecified
utility-and-miscellaneous
unspecified
vehicular [ train | airplane |
ferry | automobile-or-
truck | bus | motor-bike |
unspecified | ship-or-boat
outdoor [ unspecified |
city-park | bus-stop |
traffic-control | rest-area |
muni-mesh-network |
kiosk ]
Sets the venue category
...................................continued
Table 53. Commands related to ruckus(config-hotspot20-venue-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-wlan-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 161
hotspot20-wlan-profile
To create or update the hotspot 2.0 WLAN profile configuration, use the following
command.
ruckus(config)# hotspot20-wlan-profile <name>
ruckus(hotspot20-venue-profile)#
venue-names
Type: Privileged
<language> <names> Sets the venue-names.
ruckus(hotspot20-venue-profile)#
wan-at-capacity
Type: Privileged
Sets the WAN capacity.
ruckus(hotspot20-venue-profile)#
wan-downlink-load
Type: Privileged
<downlink-load> - Load
between 1 and 255
Sets the WAN downlink load.
ruckus(hotspot20-venue-profile)#
wan-downlink-speed
Type: Privileged
<speed> Sets the WAN downlink speed in
(kbps).
ruckus(hotspot20-venue-profile)#
wan-link-status
Type: Privileged
[ link-up | link-test | link-
down ]
Sets the link status.
ruckus(hotspot20-venue-profile)#
wan-load-duration
Type: Privileged
<duration> Sets the load measurement
duration.
ruckus(hotspot20-venue-profile)#
wan-sym-link
Type: Privileged
Enable symmetric link.
ruckus(hotspot20-venue-profile)#
wan-uplink-load
Type: Privileged
<uplink-load> Sets the WAN uplink load.
ruckus(hotspot20-venue-profile)#
wan-uplink-speed
Type: Privileged
<speed> - Uplink speed
in kbps
Sets the WAN uplink speed.
Table 53. Commands related to ruckus(config-hotspot20-venue-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-wlan-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 162
Syntax Description
This command uses the following syntax:
name: Name of the hotspot2.0 WLAN profile
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# hotspot20-wlan-profile wlan1
SZ100-Node1(config-hotspot20-wlan-profile)#
Related Commands
•Table 54 lists the related hotspot20-wlan-profile configuration commands.
•Table 55 lists the related hotspot20-wlan-profile cust-connect-capabilities
configuration commands.
Table 54 lists the related hotspot20-wlan-profile configuration commands.
Table 54. Commands related to ruckus(config-hotspot20-wlan-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-hotspot20-wlan-
profile)# access-network-type
Type: Privileged
Sets the access network type.
ruckus(config-hotspot20-wlan-
profile)# asra
Type: Privileged
Sets the ASRA profile.
ruckus(config-hotspot20-wlan-
profile)# asra-dns-redirect
Type: Privileged
<url> Sets the ASRA DNS redirection.
ruckus(config-hotspot20-wlan-
profile)# asra-http-redirect
Type: Privileged
Sets the ASRA HTTP redirection.
Configuration Commands
hotspot20-wlan-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 163
ruckus(config-hotspot20-wlan-
profile)# asra-online-signup
Type: Privileged
<ssid> Sets the ASRA online signup.
ruckus(config-hotspot20-wlan-
profile)# asra-terms-conditions
Type: Privileged
<url> Sets the ASRA terms and
conditions.
ruckus(config-hotspot20-wlan-
profile)# connect-capabilities
Type: Privileged
[ pptp | http | voip-6 |
ipsec-vpn | ikev2 | ftp | tls
| voip-17 | icmp | ssh | esp
] [ open | unknown |
closed ]
Sets the connection capabilities.
pptp: Protocol Number:6
Port:1723
Protocol Name: Used by PPTP
VPNs
http: Protocol Number:6 Port:80
Protocol Name: HTTP
voip-6: Protocol Number:6
Port:5060 Protocol Name: VoIP
ipsec-vpn: Protocol Number:17
Port:4500 Protocol Name: IPSec
VPN
ikev2: Protocol Number:17
Port:500
Protocol Name: Used by
IKEv2(IPSec VPN)
tls: Protocol Number:6 Port:443
Protocol Name:Used by TLS VPN
voip-17: Protocol Number:17
Port:5060 Protocol Name: Voip
icmp: Protocol Number:1 Port:0
Protocol Name: ICMP
..................................continued
Table 54. Commands related to ruckus(config-hotspot20-wlan-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-wlan-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 164
ruckus(config-hotspot20-wlan-
profile)# connect-capabilities
Type: Privileged
[ pptp | http | voip-6 |
ipsec-vpn | ikev2 | ftp | tls
| voip-17 | icmp | ssh | esp
] [ open | unknown |
closed ]
ssh: Protocol Number:6 Port:22
Protocol Name: SSH
esp: Protocol Number:50 Port:0
Protocol Name: ESP
open: Open
unknown: Unknown
closed: Closed
ruckus(config-hotspot20-wlan-
profile)# cust-connect-capabilities
Type: Privileged
<protocol-name>
<protocol-number>
Creates or updates the custom
connection capabilities.
ruckus(config-hotspot20-wlan-
profile)# description
Type: Privileged
<text> Sets the description.
ruckus(config-hotspot20-wlan-
profile)# do
Type: Privileged
Executes the do command.
ruckus(config-hotspot20-wlan-
profile)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-hotspot20-wlan-
profile)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-hotspot20-wlan-
profile)# help
Type: Privileged
Displays the help.
ruckus(config-hotspot20-wlan-
profile)# identity-providers
Type: Privileged
<identityProvider> default Sets the identity providers.
Table 54. Commands related to ruckus(config-hotspot20-wlan-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-wlan-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 165
ruckus(config-hotspot20-wlan-
profile)# internet-option
Type: Privileged
enable Enables the specified WLAN with
Internet connectivity.
ruckus(config-hotspot20-wlan-
profile)# ipv4-address
Type: Privileged
[ port-restrict-address |
single-nated-private-
address | double-nated-
private-address | port-
restricted-
addressdouble-
nated-address | unknown
| public-address | port-
restricted-address-
single-nated-address |
not-available ]>
Sets the IPv4 address.
ruckus(config-hotspot20-wlan-
profile)# ipv6-address
Type: Privileged
[ not-available | unknown
| available ]
Sets the IPv6 address.
ruckus(config-hotspot20-wlan-
profile)# name
Type: Privileged
<name> Sets the hotspot 2.0 WLAN profile
name.
ruckus(config-hotspot20-wlan-
profile)# no
Type: Privileged
asra
asra-dns-redirect
asra-http-redirect
asra-online-signup
asra-terms-conditions
cust-connect-capabilities
identity-providers
internet-option
Disables the commands.
ruckus(config-hotspot20-wlan-
profile)# operator
Type: Privileged
<name> Sets the operator name.
Table 54. Commands related to ruckus(config-hotspot20-wlan-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
hotspot20-wlan-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 166
Table 55 lists the related hotspot20-wlan-profile cust-connect-capabilities configu-
ration commands.
Table 55. Commands related to ruckus(config-hotspot20-wlan-profile-cust-connect-
capabilities)
Syntax and Type Parameters (if any) Description
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)#
do
Type: Privileged
Executes the do command.
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)#
help
Type: Privileged
Displays the help.
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)#
port
Type: Privileged
<port> Set the port number.
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)#
protocol
Type: Privileged
<protocol> Sets the protocol number.
ruckus(config-hotspot20-wlan-
profile-cust-connect-capabilities)
status
Type: Privileged
[ closed | unknown | open] Sets the status.
Configuration Commands
hs20-sslv3
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 167
hs20-sslv3
To enable the SSLv3 profile configuration for Hotspot 2.0, use the following
command.
ruckus(config)# hs20-sslv3
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# hs20-sslv3
identity-provider
To create or update identity provider configuration, use the following command.
ruckus(config)# identity-provider <name>
Syntax Description
This command uses the following syntax:
name: Name of the identity provider
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# identity-provider idwlan
SZ100-Node1(config-identity-provider)#
Related Commands
•Table 56 lists the related identity-provider configuration commands.
•Table 57 lists the related identity-provider-acct-profile configuration commands.
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 168
•Table 58 lists the related identity-provider-acct-profile-realm configuration
commands.
•Table 59 lists the related identity-provider-auth-profile configuration commands
•Table 60 lists the related identity-provider-auth-profile-realm configuration
commands.
•Table 61 lists the related identity-provider-osu-enable configuration commands.
•Table 62 lists the related identity-provider-realms configuration commands.
•Table 63 lists the related identity-provider-realms-eaps configuration commands.
•Table 64 lists the related identity-provider-realms-eaps-auth configuration
commands
Table 56 lists the related identity-provider configuration commands.
Table 56. Commands related to ruckus(config-identity-provider)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider)#
acct-enable
Type: Privileged
Enables accounting.
ruckus(config-identity-provider)#
acct-profile
Type: Privileged
Sets the accounting profile.
ruckus(config-identity-provider)#
auth-profile
Type: Privileged
Sets the authentication profile.
ruckus(config-identity-provider)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-identity-provider)#
do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 169
ruckus(config-identity-provider)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-identity-provider)#
help
Type: Privileged
Displays the help.
ruckus(config-identity-provider)#
home-ois
Type: Privileged
<name> 5-hex <id1>
<id2> <id3> <id4> <hex-
value>
<name> 3-hex <id1>
<id2> <id3>
Sets the Home OIs.
ruckus(config-identity-provider)#
name
Type: Privileged
<name> Sets the identity provider name.
ruckus(config-identity-provider)#
no
Type: Privileged
acct-enable
home-ois
osu-enable
plmns
realms
Disables the commands.
ruckus(config-identity-provider)#
osu-enable
Type: Privileged
Enables the online signup and
provisioning.
ruckus(config-identity-provider)#
plmns
Type: Privileged
<mcc> <mnc> Sets the PLMNs.
ruckus(config-identity-provider)#
realms
Type: Privileged
<name> Sets the realms
Table 56. Commands related to ruckus(config-identity-provider)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 170
Table 57 lists the related identity-provider-acct-profile configuration commands.
Table 57. Commands related to ruckus(config-identity-provider-acct-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
acct-profile)# default
Type: Privileged
no-match-realm acct
<name>
no-realm acct <name>
Sets the default service.
ruckus(config-identity-provider-
acct-profile)# description
Type: Privileged
<text> Sets the description
ruckus(config-identity-provider-
acct-profile)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
acct-profile)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-identity-provider-
acct-profile)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-identity-provider-
acct-profile)# help
Type: Privileged
Displays the help.
ruckus(config-identity-provider-
acct-profile)# no
Type: Privileged
realm <name> Disables the realm command.
ruckus(config-identity-provider-
acct-profile)# realm
Type: Privileged
<realm> Sets the accounting service realm.
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 171
Table 58 lists the related identity-provider-acct-profile-realm configuration
commands.
Table 59 lists the related identity-provider-auth-profile configuration commands.
Table 58. Commands related to ruckus(config-acct-profile-realm)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
acct-profile-realm)# acct-service
Type: Privileged
<name> Sets the accounting service.
ruckus(config-identity-provider-
acct-profile-realm)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
acct-profile-realm)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-identity-provider-
acct-profile-realm)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-identity-provider-
acct-profile-realm)# help
Type: Privileged
Displays the help.
ruckus(config-identity-provider-
acct-profile-realm)# name
Type: Privileged
<name> Sets the realm name.
ruckus(config-identity-provider-
acct-profile)# realm
Type: Privileged
<realm> Sets the accounting service realm.
Table 59. Commands related to ruckus(config-identity-provider-auth-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
auth-profile)# aaa-interim-acct-
interval
Type: Privileged
<seconds> Sets the accounting interim
interval for the hosted AAA server.
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 172
ruckus(config-identity-provider-
auth-profile)# aaa-session-idle-
timeout
Type: Privileged
<seconds> Sets the idle session timeout for
the hosted AAA server.
ruckus(config-identity-provider-
auth-profile)# aaa-session-timeout
Type: Privileged
<seconds> Sets the session timeout for the
hosted AAA server.
ruckus(config-identity-provider-
auth-profile)# aaa-support
Type: Privileged
Enables the hosted AAA server
support.
ruckus(config-identity-provider-
auth-profile)# default
Type: Privileged
no-match-realm acct
<name> - Set to either
RADIUS, local-database,
na (request rejected) or
radius. Set the
authentication service
name.
no-realm acct <name>
Sets the default
authentication service.
Sets the default service.
ruckus(config-identity-provider-
auth-profile)# description
Type: Privileged
<text> Sets the description
ruckus(config-identity-provider-
auth-profile)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
auth- profile)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-identity-provider-
auth-profile)# exit
Type: Privileged
Exits from the EXEC.
Table 59. Commands related to ruckus(config-identity-provider-auth-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 173
Table 60 lists the related identity-provider-auth-profile-realm configuration
commands.
ruckus(config-identity-provider-
auth-profile)# help
Type: Privileged
Displays the help.
ruckus(config-identity-provider-
auth-profile)# gpp-support
Type: Privileged
Sets the PLMN identifier.
ruckus(config-identity-provider-
auth-profile)# no
Type: Privileged
aaa-support
gpp-support
realm
Disables the commands.
ruckus(config-identity-provider-
auth-profile)# realm
Type: Privileged
<realm> Sets the authentication service
realm.
ruckus(config-identity-provider-
auth-profile)# sgsn-mcc
Type: Privileged
<mcc> Sets the mobile country code.
ruckus(config-identity-provider-
auth-profile)# sgsn-mnc
Type: Privileged
<mnc> Sets the mobile network code.
Table 60. Commands related to ruckus(config-identity-provider-auth-profile-realm)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
auth-profile-realm)# auth-method
Type: Privileged
Sets the authorization method.
ruckus(config-identity-provider-
auth-profile-realm)# auth-service
Type: Privileged
<name> Set to either
RADIUS, local-database,
na (request rejected) or
radius. Set the
authentication service
name.
Sets the authentication service.
Table 59. Commands related to ruckus(config-identity-provider-auth-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 174
Table 61 lists the related identity-provider-osu-enable configuration commands.
ruckus(config-identity-provider-
auth-profile-realm)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
auth-profile-realm)# dynamic-vlan
Type: Privileged
<vlan-id> Sets the dynamic VLAN ID.
ruckus(config-identity-provider-
auth- profile-realm)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-identity-provider-
auth-profile-realm)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-identity-provider-
auth-profile-realm)# help
Type: Privileged
Displays the help.
ruckus(config-identity-provider-
auth-profile-realm)# name
Type: Privileged
<name> Sets the authentication service
name.
Table 61. Commands related to ruckus(config-identity-provider-osu-enable)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
osu-enable)# common-icon
Type: Privileged
<ftp-url> Sets the common language icon.
ruckus(config-identity-provider-
osu-enable)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
osu-enable)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
Table 60. Commands related to ruckus(config-identity-provider-auth-profile-realm)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 175
ruckus(config-identity-provider-
osu-enable)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-identity-provider-
osu-enable)# help
Type: Privileged
Displays the help.
ruckus(config-identity-provider-
osu-enable)# no
Type: Privileged
osu-auth-services
service-descr
whitelisted-domains
Disables the commands
Table 61. Commands related to ruckus(config-identity-provider-osu-enable)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 176
ruckus(config-identity-provider-
osu-enable)# osu-auth-services
Type: Privileged
<service-name> local
<realm>
<service-name>:
Authentication services
name
local: Local database
<realm>: Realm server
<service-name> remote
<realm>
remote: Supports only
RADIUS service
<service-name> local
<realm> never
<service-name> local
<realm> hour
<expiration-value> -
Local credential
expiration, between 1 and
175200
<service-name> local
<realm> day <expiration-
value> - Local credential
expiration, between 1 and
7300
<service-name> local
<realm> week
<expiration-value> -
Local credential
expiration, between 1 and
1040
Sets the OSU authentication
services.
...................................continued.
Table 61. Commands related to ruckus(config-identity-provider-osu-enable)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 177
ruckus(config-identity-provider-
osu-enable)# osu-auth-services
Type: Privileged
<service-name> local
<realm> month
<expiration-value> -
Local credential
expiration - between 1
and 240
Sets the OSU authentication
services.
ruckus(config-identity-provider-
osu-enable)# osu-cert
Type: Privileged
${cert} Sets the OSU certificates.
ruckus(config-identity-provider-
osu-enable)# osu-nai-realm
Type: Privileged
Sets the OSU NAI realm.
ruckus(config-identity-provider-
osu-enable)# osu-portal
Type: Privileged
internal <osu-portal-
profile>
external <portal-url>
Sets the OSU portal.
ruckus(config-identity-provider-
osu-enable)# provisioning-format
Type: Privileged
r2-r1-zeroit
r2-r1-zeroit: Hotspot 2.0
R2, Hotspot 2.0 R1
r2-zeroit
Sets the provisioning format.
ruckus(config-identity-provider-
osu-enable)# provisioning-protocol
Type: Privileged
all
oma-dm
soap-xml
Sets the provisioning protocol.
ruckus(config-identity-provider-
osu-enable)# provisioning-service-
url
Type: Privileged
<url> Sets the provisioning service URL.
ruckus(config-identity-provider-
osu-enable)# provisioning-update-
at
Type: Privileged
home-only
home-roaming
any
Sets the provisioning update.
Table 61. Commands related to ruckus(config-identity-provider-osu-enable)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 178
Table 62 lists the related identity-provider-realms configuration commands.
ruckus(config-identity-provider-
osu-enable)# service-descr
Type: Privileged
<language> <name>
<icon-ftp-url>
<language> <name>
<description> <icon-ftp-
url>
Sets the subscription description
ruckus(config-identity-provider-
osu-enable)# whitelisted-domains
Type: Privileged
<domain-name> Sets the whitelisted domains.
Table 62. Commands related to ruckus(config-identity-provider-realms)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
realms)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
realms)# eaps
Type: Privileged
[ #4 | #2 | #3 | #1 ]
#4: EAP method ID
#2: EAP method ID
#3: EAP method ID
#1: EAP method ID
Creates or updates the EAP
configuration.
ruckus(config-identity-provider-
realms)# encoding
Type: Privileged
[ rfc-4282 | utf-8 ] Sets the encoding type.
ruckus(config-identity-provider-
realms)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-identity-provider-
realms)# exit
Type: Privileged
Exits from the EXEC.
Table 61. Commands related to ruckus(config-identity-provider-osu-enable)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 179
Table 63 lists the related identity-provider-realms-eaps configuration commands.
ruckus(config-identity-provider-
realms)# help
Type: Privileged
Displays the help.
ruckus(config-identity-provider-
realms)# name
Type: Privileged
<name> Sets the realm name.
ruckus(config-identity-provider-
realms)# no
Type: Privileged
eaps Disables the command.
Table 63. Commands related to ruckus(config-identity-provider-realms-eaps)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
realms-eaps)# auth
Type: Privileged
[ 4 | 1 | 2 | 3 ]
4: Authentication index
1: Authentication index
2: Authentication index
3: Authentication index
Creates or updates the
authentication information based
on the index.
ruckus(config-identity-provider-
realms-eaps)# do
Type: Privileged
Executes the do command.
ruckus(config-identity-provider-
realms-eaps)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-identity-provider-
realms-eaps)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-identity-provider-
realms-eaps)# help
Type: Privileged
Displays the help.
Table 62. Commands related to ruckus(config-identity-provider-realms)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 180
ruckus(config-identity-provider-
realms-eaps)# method
Type: Privileged
[ eap-aka-23 | eap-tls |
eap-mschap-v2 | na |
eap-aka-50 | md5 | eap-
ttls | reserved | eap-sim |
eap-cisco | peap ]
eap-aka-23: EAP-AKA
eap-tls: EAP-Transport
Layer Security (EAP-TLS)
eap-mschap-v2: EAP-
MSCHAP-V2
na: N/A
eap-aka-50: EAP-AKA
md5: MD5-Challenge
eap-ttls: EAP-Tunneled
Transport Layer Security
(EAP-TTLS)
reserved: Reserved for
the Expanded Type
eap-sim: EAP for GSM
Subscriber Identity
Module (EAP-SIM)
eap-cisco: EAP-Cisco
peap: Protected
Extensible Authentication
Protocol (PEAP)
Sets the EAP method.
ruckus(config-identity-provider-
realms-eaps)# no
Type: Privileged
auth Disables the command.
Table 63. Commands related to ruckus(config-identity-provider-realms-eaps)
Syntax and Type Parameters (if any) Description
Configuration Commands
identity-provider
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 181
Table 64 lists the related identity-provider-realms-eaps-auth configuration
commands.
Table 64. Commands related to ruckus(config-identity-provider-realms-eaps-auth)
Syntax and Type Parameters (if any) Description
ruckus(config-identity-provider-
realms-eaps-auth)# info
Type: Privileged
tunneled | credential |
non-eap-inner | expand-
inner-eap | inner-auth-eap
| expand-eap ]
tunneled: Tunneled EAP
method credential type
credential: Credential
type
non-eap-inner: Non EAP
inner authentication type
expand-inner-eap:
Expanded inner EAP
method
inner-auth-eap: Inner
authentication EAP
method type
expand-eap: Expanded
EAP method
Sets the authentication parameter
type.
ruckus(config-identity-provider-
realms-eaps-auth)# type
Type: Privileged
<type> Sets the authentication type.
ruckus(config-identity-provider-
realms-eaps-auth)# vendor-id
Type: Privileged
<vendor-id> Sets the vendor ID.
ruckus(config-identity-provider-
realms-eaps-auth)# vendor-type
Type: Privileged
<vendor-type> Sets the vendor type.
Configuration Commands
import-zdbackup
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 182
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 183
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 184
Related Commands
•Table 65 lists the related interface-ap-tunnel-data and mgmt-and-ap-control
configuration commands.
•Table 66 lists the related interface-user-defined configuration commands.
Table 65 lists the related interface-ap-tunnel-data and mgmt-and-ap-control config-
uration commands.
Table 65. Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-ap-
control)
Syntax and Type Parameters (if any) Description
ruckus(config-interface)# data-
plane
Type: Privileged
<name> forward-stp
<name>: Data plane
name
forward-stp: Disables the
STP package bridge
Updates the data plane
configuration
ruckus(config-interface)# do
Type: Privileged
Executes the do command.
ruckus(config-interface)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-interface)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-interface)# help
Type: Privileged
Displays the help.
ruckus(config-interface)# interface
Type: Privileged
Sets the physical interface.
Configuration Commands
interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 185
ruckus(config-interface)# ip
Type: Privileged
address dhcp
address: Sets IP address
of interface
dhcp: IP address
negotiated by DHCP
ipv6-address auto
ipv6-address: Sets the
IPv6 address with prefix
lengths of interface
auto: IPv6 address
negotiated by auto
address <ip> <mask>
<gateway>
address: Sets IP address
of interface
<ip>: Static IP address
<mask>: IP Subnet mask
<gateway>: Gateway
ipv6-address <ip>
<gateway>
ipv6-address: Sets IPv6
address of interface
<ip>: Static IPv6 address
<gateway>: Gateway
Sets the IP address.
ruckus(config-interface)# no data-
plane
Type: Privileged
<name> Disables the data-plane
ruckus(config-interface)# service
Type: Privileged
Sets the service.
ruckus(config-interface)# vlan
Type: Privileged
<vlan-id> VLAN ID Sets the VLAN ID.
Table 65. Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-ap-
control)
Syntax and Type Parameters (if any) Description
Configuration Commands
interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 186
Table 66 lists the related interface-user-defined configuration commands.
Table 66. Commands related to ruckus(config-interface-user-defined)
Syntax and Type Parameters (if any) Description
ruckus(config-interface-user-
defined)# do
Type: Privileged
Executes the do command.
ruckus(config-interface-user-
defined)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-interface-user-
defined)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-interface-user-
defined)# help
Type: Privileged
Displays the help.
ruckus(config-interface-user-
defined)# 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-interface-user-
defined)# name
Type: Privileged
Renames the user-define
interface.
ruckus(config-interface-user-
defined)# ip
Type: Privileged
<address> Sets the IP address for the user
defined interface.
ruckus(config-interface-user-
defined)# service
Type: Privileged
<any>
<hotspot>
Sets the service.
ruckus(config-interface-user-
defined)# vlan
Type: Privileged
<vlan-id> Sets the VLAN ID for the interface.
Configuration Commands
ip
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 187
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 control-nat
To set the Control NAT IP address, use the following command.
ruckus(config)# ip control-nat <ip>
Syntax Description
This command uses the following syntax:
<ip> Control NAT IP
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ip control-nat
Configuration Commands
ip name-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 188
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
ip name-server-ipv6
To setup the IPv6 server configuration, use the following command.
ruckus(config)# ip name-server <ipv6-address>
Syntax Description
This command uses the following syntax:
ipv6-address: Primary DNS server
ipv6-address: Secondary DNS server
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ip name-server-ipv6 172.19.13.56
Successful operation
Configuration Commands
ip route
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 189
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
ip route-ipv6
To setup the IPv6 static rule configuration, use the following command.
ruckus(config)# ip route <ip> <ip> <interface> <metric>
Syntax Description
This command uses the following syntax:
<ip> <ip> <interface> <metric>
<ip>: Destination network IPv6 address with prefix length
<ip>: Next hop IPv6 address
<interface>: Interface
<metric>: Distance metric for this route
Default
This command has no default settings.
Configuration Commands
ipsec-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 190
Command Mode
Config
Example
SZ100-Node1(config)# ip route-ipv6 193.12.30.10 193.12.30.20
ipsec-profile
To create or update IPsec profile configuration, use the following command.
ruckus(config)# ipsec-profile <name>
Syntax Description
This command has the following syntax:
<name> : IPsec profile name.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ipsec-profile
Related Commands
Table 67 lists the related ipsec-profile configuration commands
Table 67. Commands related to ruckus(config-ipsec-profile).
Syntax and Type Parameters (if any) Description
ruckus(config-ipsec-profile)# auth-
type
Type: Privileged
Sets the authentication type
rruckus(config-ipsec-profile)#
cara-server
Type: Privileged
Sets Certificate Management
Protocol CA/RA address.
ruckus(config-ipsec-profile)# cara-
server-path
Type: Privileged
Sets Certificate Management
Protocol Server path.
Configuration Commands
ipsec-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 191
ruckus(config-ipsec-profile)# cara-
subject-name
Type: Privileged
Sets the Certificate Management
Protocol subject name of CA/RA
ruckus(config-ipsec-profile)# cmp-
dhcp-opt43-subcode
Type: Privileged
Sets the Certificate Management
Protocol DHCP option 43 sub
code for the CA/RA address
ruckus(config-ipsec-profile)# cmp-
subject-name-dhcp-opt43-
subcode
Type: Privileged
Sets the Certificate Management
Protocol DHCP option 43 sub
code for subject name of CA/RA
ruckus(config-ipsec-profile)#
description
Type: Privileged
Sets the description.
ruckus(config-ipsec-profile)#
dhcp-opt43-subcode
Type: Privileged
Sets the DHCP option 43 sub
code for Security Gateway.
ruckus(config-ipsec-profile)# do
Type: Privileged
Executes the do command.
rruckus(config-ipsec-profile)#
dpd-delay
Type: Privileged
Sets the Dead Peer Detection.
ruckus(config-ipsec-profile)# end
Type: Privileged
End the current configuration
session and return to privileged
EXEC mode
Syntax and Type Parameters (if any) Description
Configuration Commands
ipsec-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 192
ruckus(config-ipsec-profile)# esp-
proposal
Type: Privileged
[3des | aes256 | aes192 |
aes128 | none ] [ md5 |
sha512 | sha384 | sha1 |
sha256 | aesxcbc ] [
modp8192 |modp6144 |
modp1024 | none |
modp3072 | modp2048 |
modp1536 | modp768 |
modp4096]
3des: 3DES
aes256: AES256
aes192: AES192
aes128: AES128
none: NONE
md5: MD5
sha512: SHA512
sha384: SHA384
sha1: SHA1
sha256: SHA256
aesxcbc: AES-XCBC
modp8192: MODP8192
modp6144: MODP6144
modp1024: MODP1024
modp3072: MODP3072
modp2048: MODP2048
modp1536: MODP1536
modp768: MODP768
modp4096: MODP4096
Add ESP proposal.
ruckus(config-ipsec-profile)# esp-
rekeytime
Type: Privileged
Sets the ESP Rekey time.
ruckus(config-ipsec-profile)# esp-
type
Type: Privileged
Set ESP Proposal Type
Syntax and Type Parameters (if any) Description
Configuration Commands
ipsec-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 193
ruckus(config-ipsec-profile)# exit
Type: Privileged
Exits from the EXEC mode.
ruckus(config-ipsec-profile)#
failover-check-interval
Type: Privileged
Sets the Fail Over Checking
Interval
ruckus(config-ipsec-profile)#
failover-retry-interval
Type: Privileged
Sets the Fail Over Retry Interval
ruckus(config-ipsec-profile)#
failover-retry-mode
Type: Privileged
Sets the Fail Over Retry mode.
ruckus(config-ipsec-profile)#
failover-retry-period
Type: Privileged
Sets the Fail Over Retry period.
ruckus(config-ipsec-profile)# help
Type: Privileged
Displays the help.
ruckus(config-ipsec-profile)# ike-
proposal
Type: Privileged
[ 3des | aes256 | aes192
| aes128 ] [ sha1 | md5 |
aesxcbc | sha512 |
sha384 | sha256 ] [
prfsha1 | prfmd5
|prfsha256 | prfaescmac |
prfaesxcbc | prfsha384 |
prfsha512 | use-integrity-
alg ] [ modp1024 |
modp8192 |modp6144 |
modp768 | modp4096 |
modp3072 | modp1536 |
modp2048 ]
Add IKE proposal.
ruckus(config-ipsec-profile)# ike-
rekeytime
Type: Privileged
Sets the IKE Rekey time.
Syntax and Type Parameters (if any) Description
Configuration Commands
ipsec-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 194
ruckus(config-ipsec-profile)# ike-
type
Type: Privileged
Sets the IKE Proposal type.
ruckus(config-ipsec-profile)# ip-
compression
Type: Privileged
Enables IP compression.
ruckus(config-ipsec-profile)#
ipmode
Type: Privileged
Sets the IP mode.
ruckus(config-ipsec-profile)#
keep-alive-interval
Type: Privileged
Sets the NAT-T Keep Alive interval.
ruckus(config-ipsec-profile)#
name
Type: Privileged
Sets the IPsec profile name.
ruckus(config-ipsec-profile)# nat-
traversal
Type: Privileged
Enables force NAT-T.
ruckus(config-ipsec-profile)# no
Type: Privileged
cara-server
cara-server-path
cara-subject-name
dpd-delay
esp-proposal
esp-rekeytime’
ike-proposal
ike-rekeytime
ip-compression
keep-alive-interval
nat-traversal
replay-window
retry-limit
security-gateway
Disables and deletes commands.
Syntax and Type Parameters (if any) Description
Configuration Commands
l2-acl
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 195
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
Example
SZ100-Node1(config)# l2-acl l2
SZ100-Node1(config-l2-acl)#
Related Commands
Table 68 lists the related to l2-acl configuration commands.
ruckus(config-ipsec-profile)#
replay-window
Type: Privileged
Sets the Replay window.
ruckus(config-ipsec-profile)# retry-
limit
Type: Privileged
Sets the Retry limit.
ruckus(config-ipsec-profile)#
security-gateway
Type: Privileged
Sets the Security gateway.
Table 68. 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.
Syntax and Type Parameters (if any) Description
Configuration Commands
lbs-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 196
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
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.
Table 68. Commands related to ruckus(config-l2-acl)
Syntax and Type Parameters (if any) Description
Configuration Commands
ldap-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 197
Example
SZ100-Node1(config)# lbs-service
<name> LBS venue name
SZ100-Node1(config)# lbs-service n3
Related Commands
Table 69 lists the related lbs-service configuration command
.
ldap-service
To create and update the LDAP service configuration, use the following command.
ruckus(config)# ldap-service <name>
Syntax Description
This command uses the following syntax:
Table 69. 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
<host> - Server IP
address
Sets the server address.
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.
Configuration Commands
ldap-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 198
name: LDAP service name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# ldap-service
SZ100-Node1(config-ldap-service)#
Related Commands
Table 70 lists the related ldap-service configuration command
.
Table 70. Commands related to ruckus(config-ldap-service)
Syntax and Type Parameters (if any) Description
ruckus(config-ldap-service)#
admin-domain-name
Type: Privileged
<domain-name> LDAP
admin domain name, To
query multiple
organizational units, enter
an admin domain name
and password with full
search and read
privileges. For example:
uid=admin,dc=ldap,dc=c
om
Sets the LDAP administrator
domain name.
ruckus(config-ldap-service)#
admin-password
Type: Privileged
<password> - LDAP
server admin password.
For example: uid.
Sets the LDAP administrator
password.
ruckus(config-ldap-service)# base-
domain-name
Type: Privileged
<domain-name> LDAP
base domain name. For
example:
dc=ldap,dc=com
Sets the LDAP base domain name.
ruckus(config-ldap-service)#
description
Type: Privileged
<text> Sets the description.
Configuration Commands
ldap-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 199
ruckus(config-ldap-service)# do
Type: Privileged
Sets the do command.
ruckus(config-ldap-service)# end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-ldap-service)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-ldap-service)#
friendly-name
Type: Privileged
<friendly-name> Sets the LDAP service name as
seen by the user.
ruckus(config-ldap-service)#
group-attrs
Type: Privileged
<attr-value> <user-role>
<attr-value>: Group
attribute value
<user-role>: User role
Sets the user traffic profile
mapping.
ruckus(config-ldap-service)# help
Type: Privileged
Displays the help message.
ruckus(config-ldap-service)# ip-
address
Type: Privileged
<ip> Sets the IP address for LDAP
server.
ruckus(config-ldap-service)# key-
attr
Type: Privileged
<attr-value>
For example: uid
Sets the key attribute for LDAP
server.
ruckus(config-ldap-service)# no
Type: Privileged
group-attrs Disables the command.
ruckus(config-ldap-service)# port
Type: Privileged
<port> Sets the port number for LDAP
server.
ruckus(config-ldap-service)#
search-filter
Type: Privileged
<filter>
For example:
(objectClass=Person,
show more...)
Sets the search filter for LDAP
server.
Table 70. Commands related to ruckus(config-ldap-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
license
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 200
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
license cloud
To enable the cloud license server, use the following command.
ruckus(config)# license cloud <enable>
ruckus(config-ldap-service)# test
Type: Privileged
<username>
<password>
Test AAA server.
Table 70. Commands related to ruckus(config-ldap-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
license export
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 201
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
license import
To setup the import licenses, use the following command.
ruckus(config)# license import <ftp-url> | <ftp-url> <name>
Configuration Commands
license local
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 202
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
license sync-now
To synchronize licenses, use the following command.
ruckus(config)# license sync-now
Configuration Commands
lineman
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 203
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
localdb-service
To create or update the local database service configuration, use the following
command.
ruckus(config)# localdb-service
Syntax Description
This command has no arguments or keywords.
Configuration Commands
localdb-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 204
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# localdb-service
SZ100-Node1(config-localdb-service)#
Related Commands
Table 71 lists the related localdb-service configuration command
.
Table 71. Commands related to ruckus(config-localdb-service).
Syntax and Type Parameters (if any) Description
ruckus(config-localdb-service)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-localdb-service)# do
Type: Privileged
Sets the do command
ruckus(config-localdb-service)#
end
Type: Privileged
Ends the current configuration
session and returns to the
privileged EXEC mode.
ruckus(config-localdb-service)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-localdb-service)#
friendly-name
Type: Privileged
<friendly-name> Displays the local database server
name as seen by the user.
ruckus(config-localdb-service)#
group-attrs
Type: Privileged
<attr-value> <user-role>
<attr-value>: Group
attribute value
<user-role>: User role
Sets the user traffic profile
mapping.
ruckus(config-localdb-service)#
help
Type: Privileged
Displays the help message.
Configuration Commands
logging console
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 205
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 206
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 controller configurations, use the following command.
ruckus(config)# lwapp2scg
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# lwapp2scg
Related Commands
Table 72 lists the related lwapp2scg configuration command
.
Table 72. 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.
Configuration Commands
mgmt-acl
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 207
mgmt-acl
To update the Management interface Access Control List (ACL) configuration, use
the following command.
ruckus(config)# mgmt-acl
Syntax Description
This command has no arguments or keywords.
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.
ruckus(config-lwapp2scg)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-lwapp2scg)# help
Type: Privileged
Displays the help message.
ruckus(config-lwapp2scg)#
natIpTranslation
Type: Privileged
NAT IP translation in FTP passive
mode.
ruckus(config-lwapp2scg)# no
Type: Privileged
acl-ap
natIpTranslation
Disables the commands.
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 72. Commands related to ruckus(config-lwapp2scg).
Syntax and Type Parameters (if any) Description
Configuration Commands
no ad-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 208
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# mgmt-acl
Related Commands
Table 73 lists the related config-mgmt-acl configuration commands.
no ad-service
To delete the all active service directories, use the following command.
ruckus(config)# no ad-service <name>
Syntax Description
This command uses the following syntax:
name: Name of the active service directory to be deleted
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ad-service active-orange
Table 73. Commands related to ruckus(config-event-email)
Syntax and Type Parameters (if any) Description
ruckus(config-mgmt-acl)# enable
Type: Privileged
Enables access control of
management interface.
ruckus(config-mgmt-acl)# no
Type: Privileged
enable
rule
Disables the commands.
ruckus(config-mgmt-acl)# rule
Type: Privileged
<name> ACL rule name Create/update management
interface ACL rule configuration.
Configuration Commands
no admin
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 209
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
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.
Configuration Commands
no ap auto-approve
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 210
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
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:
Configuration Commands
no ap-cert-check
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 211
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
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.
Configuration Commands
no ap-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 212
Command Mode
Config
Example
SZ100-Node1(config)# no ap-control-mgmt-tos
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.
Configuration Commands
no ap-sci
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 213
Command Mode
Config
Example
SZ100-Node1(config)# no ap-root-ca
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 ap-snmp
To disable SNMP on AP, use the following command.
ruckus(config)# no ap-snmp
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-snmp
Configuration Commands
no app-denial-policy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 214
no app-denial-policy
To disable the application denial policy, use the following command.
ruckus(config)# no app-denial-policy <name>
Syntax Description
This command has the following syntax:
<name>: Application name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no app-denial-policy abcd
no app-port-mapping
To disable SNMP on AP, use the following command.
ruckus(config)# no app-port-mapping <name>
Syntax Description
This command has the following syntax:
<name>: Application name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no app-port-mapping abcd
no bonjour-gateway
To disable the bonjour gateway configuration, use the following command.
ruckus(config)# no bonjour-gateway
Configuration Commands
no bonjour-policy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 215
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
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 bridge-profile
To delete bridge policy configuration, use the following command.
ruckus(config)# no bridge-policy <name>
Syntax Description
This command uses the following syntax:
name: Name of the bridge policy to be deleted.
Configuration Commands
no cert-store
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 216
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no bridge-profile bridgepool
Do you want to continue to delete (or input 'n
no cert-store
To delete all OSU (Online SignUp) portal profile configuration, use the following
command.
ruckus(config)# no cert-store <name>
ruckus(config)# no csr <name>
Syntax Description
This command uses the following syntax:
cert <name> - Deletes certificate
csr <name> - Deletes Certificates Signing Request (CSR)
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no cert-store cert certpool
Do you want to continue to delete (or input 'n
no control-plane
To remove the control plane from the cluster configuration, use the following
command.
ruckus(config)# no control-plane <name>
Configuration Commands
no data-plane
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 217
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 data plane configuration, use the
following command.
ruckus(config)# no data-plane <name> forward-stp
Syntax Description
This command uses the following syntax:
name: Dataplane name
forward-stp: Disables the STP package bridge
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no data-plane name indus7-d1
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:
Configuration Commands
no diffserv
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 218
<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 diffserv
To delete diffserv configuration, use the following command:
ruckus(config)# diffserv <name> <disable>
Syntax Description
This command uses the following syntax:
name - Name of the differential server to disable
disable - Disables the all differential servers
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no diffserv disable
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.
Configuration Commands
no encrypt-mac-ip
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 219
Command Mode
Config
Example
SZ100-Node1(config)# no dp-group
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 event
Default
This command has no default settings.
Configuration Commands
no ethernet-port-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 220
Command Mode
Config
Example
SZ100-Node1(config)# no event email 305, 214, 11
no ethernet-port-profile
To disable the ethernet port profile, use the following command.
ruckus(config)# no ethernet-port-profile <name>
Syntax Description
This command uses the following syntax:
<name>: Ethernet Port Profile name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ethernet-port-profile abcd
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
Configuration Commands
no guest-access
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 221
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
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
Configuration Commands
no hotspot20-venue-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 222
Example
SZ100-Node1(config)# no hotspot htsp1
no hotspot20-venue-profile
To delete all hotspot 2.0 venue profile, use the following command.
ruckus(config)# no hotspot20-venue-profile ${name}? | <name>
Syntax Description
This command uses the following syntax:
$name?
name: Name of hotspot 2.0 venue profile
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no hotspot20-venue-profile htsp2vp
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
no hotspot20-wlan-profile
To delete all hotspot 2.0 WLAN profile, use the following command.
ruckus(config)# no hotspot20-wlan-profile ${name}? | <name>
Syntax Description
This command uses the following syntax:
$name?
name: Name of hotspot 2.0 WLAN profile
Default
This command has no default settings.
Command Mode
Config
Configuration Commands
no hs20-sslv3
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 223
Example
SZ100-Node1(config)# no hotspot20-wlan-profile htsp2wl
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
no hs20-sslv3
To disable the SSLv3 protocol for Hotspot 2.0, use the following command.
ruckus(config)# no hs20-sslv3
Syntax Description
This command does not have any arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no hs20-sslv3
no identity-provider
To delete all identity provider profile, use the following command.
ruckus(config)# no identity-provider <identity-provider ${name}?> | <name>
Syntax Description
This command uses the following syntax:
$name?
name: Name of identity provider
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no identity-provider ip2wl
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
Configuration Commands
no interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 224
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
no ip
To remove all IP address static routes, use the following command.
ruckus(config)# no ip <route> | route <ip> <mask> <ip> <interface> | route-
ipv6 <ip> <ip> <interface>| name-server secondary| separate-access-core
enable
Syntax Description
This command uses the following syntax:
route: Deletes static routes
route <ip> <mask> <ip> <interface>
route: Deletes static routes
<ip>: Destination network IP address
<mask>: Destination network mask
<ip>: Next hop IP address
<interface>: Interface
route-ipv6 <ip> <ip> <interface>
Configuration Commands
no ipsec-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 225
route-ipv6: Delete IPv6 static routes
<ip>: Destination network IPv6 address
<ip>: Next hop IPv6 address
<interface>: Interface
name-server secondary
name-server: Deletes all name servers
secondary: Deletes secondary name server
separate-access-core enable
separate-access-core: Separates the access and core gateway
enable: Disables the access and core gateway
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ip route ip 193.12.30.10
no ipsec-profile
To delete all IPsec profiles, use the following command.
ruckus(config)# no ipsec-profile <name>
Syntax Description
This command uses the following syntax:
<name> : IPsec profile name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ipsec-profile xyz
Configuration Commands
no l2-acl
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 226
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 lbs-service
To disables the load balance server configuration, use the following command.
ruckus(config)# no lbs-service <name>
Syntax Description
This command uses the following syntax:
<name>: Set the LBS venue name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no lbs-service lbsruckus
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
Configuration Commands
no ldap-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 227
no ldap-service
To delete all LDAP service, use the following command.
ruckus(config)# no ldap-service <name>
Syntax Description
This command uses the following syntax:
<name>: LDAP server name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no ldap-service ldapser
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
no lineman
To disables the lineman application configuration, use the following command.
ruckus(config)# no lineman <workflow-url>
Syntax Description
This command uses the following syntax:
<workflow-url>: Workflow URL
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no lineman workflow-url ftp://
dm:ruckus1!@172.19.7.100
Configuration Commands
no logging
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 228
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 oauth-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 229
no oauth-service
To disable the all OAuth servers, use the following command.
ruckus(config)# no oauth-service <name>
Syntax Description
This command uses the following syntax:
<name>: OAuth server name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no oauth-service nam3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
no operator-profile
To disable all WiFi operator profile settings, use the following command.
ruckus(config)# no operator-profile <operator-profile ${name}?> | <name>
Syntax Description
This command uses the following syntax:
operator-profile ${name}?
<name>: Operator name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no operator-profile ops2
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
Configuration Commands
no osu-portal-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 230
no osu-portal-profile
To disable all OSU portal profile settings, use the following command.
ruckus(config)# no osu-portal <osu-portal-profile ${name}?| <name>
Syntax Description
This command uses the following syntax:
osu-portal ${name}?
<name>: OSU profile name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no osu-portal-profile ops3
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
no outbound firewall
To disable the outbound firewall, use the following command.
ruckus(config)# no outbound firewall
Syntax Description
This command has no keywords or arguments.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1(config)# no outbound firewall
no proxy-aaa
To disable the proxy AAA server settings, use the following command.
Configuration Commands
no report
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 231
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
no role
To delete all administrator roles except the default administrator role, use the
following command.
ruckus(config)# no role <name>
Configuration Commands
no snmp-trap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 232
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]
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:
Configuration Commands
no snmp-v3-user
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 233
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]
no subpackages
To delete subscription packages, use the following command.
ruckus(config)# no subpackages <name>
Syntax Description
This command uses the following syntax:
<name>: Subscription packages name
Configuration Commands
no usb-software
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 234
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no subpackages abcd
no usb-software
To delete the AP USB Software Package configuration, use the following command.
ruckus(config)# no usb-software <name>
Syntax Description
This command uses the following syntax:
<name>: AP USB software name. Format: {VID}-{PID}-{Version}
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no usb-software abcd
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.
Configuration Commands
no user-defined-app
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 235
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-defined-app
To delete all user defined application, use the following command.
ruckus(config)# no user-defined-app <name>
Syntax Description
This command uses the following syntax:
name: Name of the application
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# no user-defined-app xyz1
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
Configuration Commands
no user-traffic-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 236
Example
SZ100-Node1(config)# no user-role userr1
Do you want to continue to delete (or input 'no' to cancel)? [yes/no]
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 vlan-pooling
To delete all VLAN pooling profiles, use the following command.
ruckus(config)# no vlan-pooling <vlan-pooling ${vlanPoolingName}?> |
<name>
Syntax Description
This command uses the following syntax:
vlan-pooling ${vlanPoolingName}?
name: Name of the VLAN pooling profile
Default
This command has no default settings.
Command Mode
Config
Configuration Commands
no web-authentication
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 237
Example
SZ100-Node1(config)# no vlan-pooling vlanservice1
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]
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
Configuration Commands
no wlan-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 238
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]
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
Configuration Commands
non-proxy-aaa
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 239
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)#
Related Commands
Table 74 lists the related non-proxy-aaa configuration commands.
Table 74. 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.
Configuration Commands
non-proxy-aaa
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 240
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.
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.
Table 74. Commands related ruckus(config-non-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
non-proxy-aaa
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 241
ruckus(config-non-proxy-aaa)#
ip6
Type: Privileged
<ipv6> Sets the IPv6 address 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)#
name
Type: Privileged
Sets the RADIUS server name.
ruckus(config-non-proxy-aaa)# no
Type: Privileged
backup
global-catalog
Sets the RADIUS server name.
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.
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.
Table 74. Commands related ruckus(config-non-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
northbound-authtype
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 242
northbound-authtype
Sets the RADIUS authentication type to northbound portal interface, use the
following command.
ruckus(config)# northbound-authtype <PAP>|<CHAP>
Syntax Description
This command uses the following syntax:
PAP: Password authentication protocol
CHAP: Challenge handshake authentication protocol
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# northbound-authtype PAP
SZ100-Node1(config)# northbound-authtype CHAP
northbound-portal
To enable the northbound portal interface and set the password, use the following
command.
ruckus(config-non-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.
ruckus(config-non-proxy-aaa)#
windows-domain
Type: Privileged
<windows-domain> Sets the windows domain.
Table 74. Commands related ruckus(config-non-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
ntp-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 243
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.
Command Mode
Config
Example
SZ100-Node1(config)# ntp-server host 172.19.13.53
Configuration Commands
oauth-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 244
oauth-service
To create or update OAuth service configuration, use the following command.
ruckus(config)# oauth-service <name>
Syntax Description
This command uses the following syntax:
name: OAuth service name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# oauth-service osuauth
SZ100-Node1(config-oauth-service)#
Related Commands
Table 75 lists the related oauth-service configuration commands.
Table 75. Commands related ruckus(config-oauth-service)
Syntax and Type Parameters (if any) Description
ruckus(config-oauth-service)#
app-id
Type: Privileged
<app-id> Sets the application ID.
ruckus(config-oauth-service)#
app-secret
Type: Privileged
<app-secret> Sets the application secret name.
ruckus(config-oauth-service)#
collect-email
Type: Privileged
Enables collecting email
addresses.
ruckus(config-oauth-service)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-oauth-service)# do
Type: Privileged
Executes the do command.
Configuration Commands
operator-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 245
operator-profile
To create or update WiFi operator profile configuration, use the following command.
ruckus(config)# operator-profile <name>
Syntax Description
This command uses the following syntax:
name: Operator profile name
Default
This command has no default settings.
ruckus(config-oauth-service)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-oauth-service)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-oauth-service)#
group-attrs
Type: Privileged
<user-role> Sets the user traffic profile
mapping.
ruckus(config-oauth-service)# help
Type: Privileged
Displays the help.
ruckus(config-oauth-service)#
name
Type: Privileged
<name> Sets the OAuth service name.
ruckus(config-oauth-service)# no
Type: Privileged
collect-email
whitelisted-domain
Disables commands.
ruckus(config-oauth-service)# type
Type: Privileged
[ linkedin | facebook |
google ]
Sets the OAuth provider type.
ruckus(config-oauth-service)#
whitelisted-domains
Type: Privileged
<domain> Sets the whitelisted domains.
Table 75. Commands related ruckus(config-oauth-service)
Syntax and Type Parameters (if any) Description
Configuration Commands
operator-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 246
Command Mode
Config
Example
SZ100-Node1(config)# operator-profile orangewifi
SZ100-Node1(config-operator-profile)#
Related Commands
Table 76 lists the related operator-profile configuration commands.
Table 76. Commands related ruckus(config-operator-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-operator-profile)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-operator-profile)# do
Type: Privileged
Executes the do command.
ruckus(config-operator-profile)#
domain-names
Type: Privileged
<domain-name> Sets the domain name.
ruckus(config-operator-profile)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-operator-profile)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-operator-profile)#
friendly-names
Type: Privileged
<language> <names> Sets the friendly name as seen by
the end user.
ruckus(config-operator-profile)#
help
Type: Privileged
Displays the help.
ruckus(config-operator-profile)#
name
Type: Privileged
<name> Sets the WiFi operator profile
name.
Configuration Commands
osu-portal-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 247
osu-portal-profile
To create or update OSU (Online SignUp) portal profile configuration, use the
following command.
ruckus(config)# osu-portal-profile <name>
Syntax Description
This command uses the following syntax:
name: OSU portal profile name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# osu-portal-profile orangeosu
SZ100-Node1(config-osu-portal-profile)#
ruckus(config-operator-profile)# no
Type: Privileged
domain-names
friendly-names
signup-security
Disables commands.
ruckus(config-operator-profile)#
osen-cert
Type: Privileged
${cert} Uploads the operator certificate.
ruckus(config-operator-profile)#
signup-security
Type: Privileged
Enables OSEN (Support for
Anonymous Authentication)
Table 76. Commands related ruckus(config-operator-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
osu-portal-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 248
Related Commands
Table 77 lists the related osu-portal-profile configuration commands.
Table 77. Commands related ruckus(config-osu-portal-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-osu-portal-profile)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-osu-portal-profile)#
do
Type: Privileged
Executes the do command.
ruckus(config-osu-portal-profile)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-osu-portal-profile)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-osu-portal-profile)#
help
Type: Privileged
Displays the help.
ruckus(config-osu-portal-profile)#
language
Type: Privileged
Sets the portal language.
ruckus(config-osu-portal-profile)#
logo
Type: Privileged
<ftp-url> Sets the operator logo.
ruckus(config-osu-portal-profile)#
name
Type: Privileged
<name> Sets the portal name.
ruckus(config-osu-portal-profile)#
no
Type: Privileged
show-terms-condition Disables the command.
ruckus(config-osu-portal-profile)#
show-terms-conditions
Type: Privileged
Shows the terms and conditions.
Configuration Commands
outbound-firewall
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 249
outbound-firewall
To update the outbound firewall configuration settings, use the following command.
ruckus(config)# outbound-firewall
Syntax Description
This command has no keywords or arguments.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# outbound firewall
Related Commands
Table 78 lists the related outbound-firewall configuration commands.
ruckus(config-osu-portal-profile)#
terms-conditions
Type: Privileged
<terms> Sets the terms and conditions.
ruckus(config-osu-portal-profile)#
title
Type: Privileged
<title> Sets the portal title.
Table 78. Commands related ruckus(config-outbound-firewall)
Syntax and Type Parameters (if any) Description
ruckus(config-outbound-firewall)#
enable
Type: Privileged
Allow the outbound traffic.
Table 77. Commands related ruckus(config-osu-portal-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
proxy-aaa
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 250
proxy-aaa
To create or update the proxy AAA server configuration settings, use the following
command.
ruckus(config-outbound-firewall)#
ip-rule
Type: Privileged
<profileName> out [ udp |
sctp | tcp ] [ dport | sport ]
<port>
<profileName>: profile
name out: Output traffic
udp: UDP
sctp: SCTP
tcp: TCP
dport: Destination port
sport: Source port
<port>: port
<profileName> out [ udp |
sctp | tcp ] [ sport | dport ]
<port> [ src | dst ]
<ipaddress
<profileName>: profile
name out: Output traffic
udp: UDP
sctp: SCTP
tcp: TCP
sport: Source port dport:
Destination port <port>:
port
src: Source
dst: Destination
<ipaddress>: IP address
Allow IP tables profile.
ruckus(config-outbound-firewall)#
no ip-rule
Type: Privileged
<profileName> Profile
Name
Remove IP rule.
Table 78. Commands related ruckus(config-outbound-firewall)
Syntax and Type Parameters (if any) Description
Configuration Commands
proxy-aaa
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 251
ruckus(config)# proxy-aaa <name>
Syntax Description
This command uses the following syntax:
<name>: Proxy AAA server name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# proxy-aaa
SZ100-Node1(config-proxy-aaa)#
Related Commands
Table 79 lists the related proxy-aaa configuration commands.
Table 79. Commands related ruckus(config-proxy-aaa)
Syntax and Type Parameters (if any) Description
ruckus(config-proxy-aaa)# auto-
fallback-disable
Type: Privileged
Disables the auto fallback.
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
<text> Sets the description.
ruckus(config-proxy-aaa)# do
Type: Privileged
Executes the do command.
Configuration Commands
proxy-aaa
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 252
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)# friendly-
name
Type: Privileged
<friendly-name> Sets the RADIUS server friendly
name.
ruckus(config-proxy-aaa)# group-
attrs
Type: Privileged
<attr-value> <user-role> Sets the user traffic profile
mapping.
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
auto-fallback-disable
backup
no group-attrs
no-response-fail
out-of-band
Disables various commands.
ruckus(config-proxy-aaa)# out-of-
band
Type: Privileged
Enables RFC5580 out of band
location delivery for Ruckus AP.
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.
Table 79. Commands related ruckus(config-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
rebalance-aps
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 253
rebalance-aps
To execute control plane and data plane loading and rebalancing, use the following
command.
ruckus(config)# rebalance-aps
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.
ruckus(config-proxy-aaa)#
zombie-period
Type: Privileged
<seconds> Sets the zombie period.
Table 79. Commands related ruckus(config-proxy-aaa)
Syntax and Type Parameters (if any) Description
Configuration Commands
report
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 254
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# rebalance-aps
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 80 lists the related report configuration command.
Table 80. 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.
Configuration Commands
report
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 255
ruckus(config-report)# do
Type: Privileged
Executes the do command.
ruckus(config-report)# email
Type: Privileged
<email> Sets the email notification.
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.
Table 80. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
Configuration Commands
report
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 256
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.
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.
Table 80. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
Configuration Commands
report
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 257
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)# title
Type: Privileged
<title> Sets the report title.
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 80. Commands related to ruckus(config-report)
Syntax and Type Parameters (if any) Description
Configuration Commands
role
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 258
role
To create or update the role configuration, use the following command.
ruckus(config)# role <name>
Syntax Description
This command uses the following syntax:
name: Define the role name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# role admin01
Related Commands
Table 81 lists the related role configuration commands.
Table 81. 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.
Configuration Commands
role
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71021-001 Rev A 259
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.
Table 81. Commands related to ruckus(config-role)
Syntax and Type Parameters (if any) Description
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 260
4
Configuration Commands
This chapter describes the commands that you can use to configure, enable, and
disable various components of the controller. 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 82. Configuration commands
sms-server smtp-server snmp-trap snmp-v2-
community
snmp-v3-user
subpackages support-
admin
syslog-server usb-software user-agent-blacklist
user-defined-
app
user-role user-traffic-
profile
vlan-pooling web-authentication
wechat wlan wlan-group wlan-
scheduler
Configuration Commands
sms-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 261
sms-server
To enable SMS server configurations, use the following command.
ruckus(config)# sms-server <personalname>
Syntax Description
This command has the following syntax:
<personalname>: Set personal name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# sms-server
Related Commands
Table 83 lists the related sms-server configuration commands.
Table 83. Commands related to ruckus(config-sms-server)
Syntax and Type Parameters (if any) Description
ruckus(config-sms-server)#
account-sid
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.
Configuration Commands
smtp-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 262
smtp-server
To update the SMTP server configurations, use the following command.
ruckus(config)# smtp-server
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100(config)# smtp-server
ruckus(config-sms-server)# enable
Type: Privileged
Enables the SMS server.
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 83. Commands related to ruckus(config-sms-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
smtp-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 263
Related Commands
Table 84 lists the related smtp-server configuration commands.
Table 84. 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.
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.
Configuration Commands
snmp-trap
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 264
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)#
personalname
Type: Privileged
<personalname> Sets the name from the display
name.
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.
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 84. Commands related to ruckus(config-smtp-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
snmp-v2-community
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 265
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 85 lists the related snmp-v2-community configuration commands.
.
Table 85. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 266
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 85. Commands related to ruckus(config-snmp-v2-community)
Syntax and Type Parameters (if any) Description
Configuration Commands
snmp-v3-user
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 267
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 86 lists the related snmp-v3-user configuration commands.
.
Table 86. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 268
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 86. Commands related to ruckus(config-snmp-v3-user)
Syntax and Type Parameters (if any) Description
Configuration Commands
subpackages
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 269
subpackages
To create and update the configuration of subscription packages, use the following
command.
ruckus(config)# subpackages <name>
Syntax Description
This command has the following keywords:
<name>: Package Name
Default
This command has no default settings.
Command Mode
Config
ExampleSZ100-Node1(config)# subpackages abcd12
Related Commands
Table 87 lists the related event-email configuration commands.
Table 87. Commands related to ruckus(config-subpackages)
Syntax and Type Parameters (if any) Description
ruckus(config-subpackages)#
description
Type: Privileged
<description> Sets the description.
ruckus(config-subpackages)#
expiration-interval
Type: Privileged
[ week | hour | year | never
| month | day]
week: Set Week
hour: Set Hour
year: Set Year
never: Never
month: Set Month
day: Set Day
Sets the expiration interval.
ruckus(config-subpackages)#
expiration-value
Type: Privileged
<expiration-value> Sets the expiration value.
Configuration Commands
support-admin
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 270
support-admin
To support administrator configuration, use the following command.
ruckus(config)# support-admin
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# support-admin
Related Commands
Table 89 lists the relate support-admin configuration commands.
.
Table 88. Commands related to ruckus(config-support-admin
Syntax and Type Parameters (if any) Description
ruckus(config-support-admin)#
changepassword
Type: Privileged
Change the password.
ruckus(config-support-admin)# do
Type: Privileged
Executes the do command.
ruckus(config-support-admin)#
enable
Type: Privileged
Unlocks the support administrator.
ruckus(config-support-admin)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-support-admin)#
exit
Type: Privileged
Exits from the EXEC.
Configuration Commands
syslog-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 271
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 89 lists the relate syslog-server configuration commands.
.
ruckus(config-support-admin)#
help
Type: Privileged
Displays the help.
ruckus(config-support-admin)# no
Type: Privileged
enable Disables the support
administrator.
Table 89. Commands related to ruckus(config-syslog-server)
Syntax and Type Parameters (if any) Description
ruckus(config-syslog-server)#
appfacility
Type: Privileged
[ Local2 | Local7 | Local0 |
Local6 | Local4 | Local5 |
Local3 | Local1 ]
Remote syslog server to send the
application log files.
ruckus(config-syslog-server)#
auditfaciility
Type: Privileged
[ Local6 | Local4 | Local2 |
Local3 | Local0 | Local5 |
Local7 | Local1 ]
Remote syslog server to send the
audit log files.
Table 88. Commands related to ruckus(config-support-admin
Syntax and Type Parameters (if any) Description
Configuration Commands
syslog-server
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 272
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)#
eventfacility
Type: Privileged
[ Local7 | Local6 | Local3 |
Local4 | Local0 | Local2 |
Local1 | Local5 ]
Remote syslog server to send the
event log files.
ruckus(config-syslog-server)# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-syslog-server)# filter
Type: Privileged
[ severity | exclude-client |
all ]
severity: All events above
a severity
exclude-client: All events
except client associate/
disassociate events
all: All events
Sets the settings for filtering
events.
ruckus(config-syslog-server)#
filter-severity
Type: Privileged
[ Critical | Warning | Major
| Info | Debug | Minor ]
Sets the event severity filter
settings.
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>
secondary-host
Disables the settings and
commands.
ruckus(config-syslog-server)# ping
Type: Privileged
Pings the syslog server.
Table 89. Commands related to ruckus(config-syslog-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
usb-software
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 273
usb-software
To update the USB software configurations, use the following command.
ruckus(config)# usb-software upload <ftp url>
Syntax Description
This command has the following keywords:
upload: Upload AP USB Software Package
<ftp-url>: AP USB Software Package file, FTP URL Format:
ftp://<username>:<password>@<ip>/<file-path>
Default
This command has no default settings.
Command Mode
Config
ruckus(config-syslog-server)#
pingsecondary
Type: Privileged
Pings the secondary syslog server.
ruckus(config-syslog-server)# port
Type: Privileged
<port> Sets the syslog server port.
ruckus(config-syslog-server)#
priority
Type: Privileged
[ Minor | Critical | Debug |
Info | Warning | Major ] [
Debug | Warning | Info |
Error ]
Sets the priority for events. The
event severity and syslog-severity
is based on priority.
ruckus(config-syslog-server)#
redundancy-mode
Type: Privileged
[Primary/Backup | Active/
Active]
Set forwarding syslog server
mode.
ruckus(config-syslog-server)#
secondary-host
Type: Privileged
<ip> IP address Sets the secondary syslog server
IP.
ruckus(config-syslog-server)#
secondary-port
Type: Privileged
<port> Sets the secondary syslog server
port.
Table 89. Commands related to ruckus(config-syslog-server)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-agent-blacklist
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 274
Example
SZ100-Node1(config)# usb software upload ftp://abc:pass-
word@100.20.3.56
user-agent-blacklist
To create and update the user agent blacklisted configuration, use the following
command.
ruckus(config)# user-agent-blacklist <name>
Syntax Description
This command uses the following syntax:
name: Name of the user agent blacklisted
Default
This command has no default settings.
Command Mode
Config
Example
SZ100(config)# user-agent-blacklist user-agent-blacklist
SZ100(config-user-agent-blacklist)#
Related Commands
Table 90 lists the related user-agent-blacklist configuration commands.
Table 90. 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.
Configuration Commands
user-defined-app
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 275
user-defined-app
To create and update the user defined application, use the following command.
ruckus(config)# user-defined-app <name>
Syntax Description
This command uses the following syntax:
<name>: Name of the application
Default
This command has no default settings.
Command Mode
Config
Example
SZ100(config)# user-defined-app test1
ruckus(config-user-agent-
blacklist)# error-message
Type: Privileged
<error message> Sets the error message.
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 90. Commands related to ruckus(config-user-agent-blacklist)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-role
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 276
Related Commands
Table 91 lists the related user-defined-app configuration commands.
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)#
Table 91. Commands related to ruckus(config-subpackages)
Syntax and Type Parameters (if any) Description
ruckus(config-user-defined-app)#
destination-ip
Type: Privileged
<description> Sets the destination IP address.
ruckus(config-user-defined-app)#
destination-port
Type: Privileged
<port> Sets the destination port.
ruckus(config-user-defined-app)#
netmask
Type: Privileged
<mask>: Subnet mask Sets the subnet mask.
ruckus(config-user-defined-app)#
protocol
Type: Privileged
[udp | tcp] Sets the protocol.
Configuration Commands
user-role
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 277
Related Commands
Table 92 lists the related user-role configuration commands.
Table 92. 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
zones - Allows Zero IT
access to all WLANs in the
selected zones
<wlans>: Allows Zero IT
access to selected
WLANs
Sets the allowed resources.
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)# dpsk-
expire-unit
Type: Privileged
Day
Week
Month
Year
Never
Sets the DPSK expiration unit.
ruckus(config-user-role)# dpsk-
expire-value
Type: Privileged
<dpsk-expire-value> Enable DPSK expiration value.
ruckus(config-user-role)# enable-
dpsk-auto-removal
Type: Privileged
Enables DPSK auto removal.
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.
Configuration Commands
user-traffic-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 278
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)#
ruckus(config-user-role)# help
Type: Privileged
Displays the help.
ruckus(config-user-role)# max-
devices
Type: Privileged
<number> - Allows max
devices value
unlimited - Unlimited
devices value
Sets the number for maximum
devices allowed (1-10).
ruckus(config-user-role)# no
Type: Privileged
description
enable-dpsk-auto-
removal
user-traffic-profile
wlan
Disables the override on the
specified settings.
ruckus(config-user-role)# user-
traffic-profile
Type: Privileged
<user-traffic-profile> Sets the user traffic profile.
ruckus(config-user-role)# wlan
Type: Privileged
<name> Adds the WLAN server.
Table 92. Commands related to ruckus(config-user-role)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-traffic-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 279
SZ100-Node1(config-user-traffic-profile)#
Related Commands
•Table 93 lists the related user-traffic-profile configuration commands.
•Table 94 lists the related user-traffic-profile-acl configuration commands.
Table 93 lists the related user-traffic-profile configuration commands.
Table 93. Commands related to (config-user-traffic-profile)
Syntax and Type Parameters (if any) Description
ruckus(config-user-traffic-profile)#
acl
Type: Privileged
${value} Sets the network access control
list.
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)#
downlink
Type: Privileged
Sets the downlink rate limit in
mbps.
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.
Configuration Commands
user-traffic-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 280
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
downlink
uplink
Disables various commands.
ruckus(config-user-traffic-profile)#
uplink
Type: Privileged
Sets the uplink rate limit in mbps.
Table 93. Commands related to (config-user-traffic-profile)
Syntax and Type Parameters (if any) Description
Configuration Commands
user-traffic-profile
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 281
Table 94 lists the related user-traffic-profile-acl configuration commands.
Table 94. 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
${value} 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
vlan-pooling
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 282
vlan-pooling
To create or update the VLAN pooling profile configurations, use the following
command.
ruckus(config)# vlan-pooling <name>
Syntax Description
This command uses the following syntax:
name: Web authentication name
Default
This command has no default settings.
Command Mode
Config
ruckus(config-user-traffic-profile-
acl)# help
Type: Privileged
Displays the help.
ruckus(config-user-traffic-profile-
acl)# protocol
Type: Privileged
<protocol number> 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 94. Commands related to ruckus(config-user-traffic-profile-acl)
Syntax and Type Parameters (if any) Description
Configuration Commands
vlan-pooling
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 283
Example
SZ100-Node1(config)# vlan-pooling vlanorange
SZ100-Node1(config-vlan-pooling)#
Related Commands
Table 96 lists the related vlan-pooling configuration commands.
Table 95. Commands related to ruckus (config-vlan-pooling)
Syntax and Type Parameters (if any) Description
ruckus(config-vlan-pooling)# algo
Type: Privileged
<mac-hash> Sets the algorithm,
ruckus(config-vlan-pooling)#
description
Type: Privileged
<text> Sets the description.
ruckus(config-vlan-pooling)# do
Type: Privileged
Sets the do command.
ruckus(config-vlan-pooling)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-vlan-pooling# exit
Type: Privileged
Exits from the EXEC.
ruckus(config-vlan-pooling)# help
Type: Privileged
Displays the help.
ruckus(config-vlan-pooling)#
name
Type: Privileged
<name> Sets the VLAN pooling name.
ruckus(config-vlan-pooling)# no
Type: Privileged
description
pooling
Disables the commands.
ruckus(config-vlan-pooling)#
pooling
Type: Privileged
range <start-value> <end-
value>
single <value>
Adds the VLAN pooling.
Configuration Commands
web-authentication
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 284
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 96 lists the related web-authentication configuration commands.
Table 96. 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)# do
Type: Privileged
Sets the do command.
ruckus(config-web-
authentication)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-web-authentication)
exit
Type: Privileged
Exits from the EXEC.
Configuration Commands
wechat
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 285
wechat
To create or update the WeChat configurations, use the following command.
ruckus(config)# wechat <name>
Syntax Description
This command uses the following syntax:
<name>: WeChat name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# wechat xyz1
ruckus(config-web-
authentication)# grace-period
Type: Privileged
<minutes> Sets the grace period.
ruckus(config-web-
authentication)# help
Type: Privileged
Displays the help.
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.
ruckus(config-web-
authentication)# start-page
Type: Privileged
original
redirect <start-url>
Sets the start page.
Table 96. Commands related to ruckus (config-web-authentication)
Syntax and Type Parameters (if any) Description
Configuration Commands
wechat
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 286
Related Commands
Table 97 lists the related zone-weçhat and domain-zone-wechat configuration
commands.
Table 97. Commands related to ruckus (config-zone-wechat) and (config-domain-zone-
wechat)
Syntax and Type Parameters (if any) Description
ruckus(config-wechat)#
authentication-url
Type: Privileged
<text>: Authentication
URL
Sets Authentication URL
ruckus(config-wechat)# black-list
Type: Privileged
<text>: Black list Sets black list.
rruckus(config-zone-wechat)#
description
Type: Privileged
<text>: Description Sets description.
ruckus(config-wechat)# dnat-
destination
Type: Privileged
<text>: DNAT destination Sets DNAT destination.
ruckus(config-wechat)# dnat-port-
mapping
Type: Privileged
<source><dest>: Source
and destination ports
Set DNAT port mappings
ruckus(config-wechat)# grace-
period
Type: Privileged
<minutes>: Grace Period
minutes
Set grace period
ruckus(config-wechat)# no
Type: Privileged
dnat-port-mapping
white-list
Disable the options.
ruckus(config-wechat)# whitelist
Type: Privileged
<white-list> Allowed
unauthorized
destinations, comma-
separated IP, IP range,
CIDR and regular
expression Domain name
list
Sets White list.
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 287
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
SZ100-Node1(config-wlan)#
Related Commands
Table 98 lists the related wlan configuration commands.
Table 98. 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
controller.
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.
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 controller as proxy.
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 288
ruckus(config-wlan)# acct-ttg-
session
Type: Privileged
Sets the accounting service.
Enables accounting for TTG
sessions.
ruckus(config-wlan)# app-denial-
policy
Type: Privileged
<name>: Application
Denial Policy name.
Sets application denial policy
ruckus(config-wlan)# app-visibility
Type: Privileged
Sets application visibility
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)# bypass-cna
Type: Privileged
Enables bypass CNA.
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.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 289
ruckus(config-wlan)# description
Type: Privileged
<text> Sets the description.
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
[ subopt-1 | ruckus-gre |
soft-gre ]
Enables DHCP option 82 format
options.
ruckus(config-wlan)# diffserv-
profile
Type: Privileged
<name> Sets the differential server profile.
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.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 290
ruckus(config-wlan)# enable-
rfc5580-support
Type: Privileged
Enables the attribute to deliver
location information only for those
APs where location attributes are
configured.
ruckus(config-wlan)# enable-type
Type: Privileged
Enables the WLAN service type.
ruckus(config-wlan)# enc-
algorithm
Type: Privileged
Sets the encryption algorithm.
ruckus(config-wlan)# enc-method
Type: Privileged
Sets the encryption method.
ruckus(config-wlan)# enc-mfp
Type: Privileged
Sets the MFP.
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.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 291
ruckus(config-wlan)# forwarding-
policy
Type: Privileged
Sets the forwarding policy.
ruckus(config-wlan)# guest-
access
Type: Privileged
<name> Sets the guest access service.
ruckus(config-wlan)# guest-
access-acct-service
Type: Privileged
Sets the accounting server.
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)# hessid
Type: Privileged
<hessid> Sets the WLAN HESSID value.
ruckus(config-wlan)# hide-ssid
Type: Privileged
Hides SSID in beacon broadcast.
ruckus(config-wlan)# hotspot
Type: Privileged
<name> Sets the hotspot service.
ruckus(config-wlan)# hotspot2
Type: Privileged
<name> Sets the hotspot 2.0 configuration.
ruckus(config-wlan)# hotspot20-
osu-support
Type: Privileged
Enables hotspot 2.0 device
registrations from the guest portal.
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.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 292
ruckus(config-wlan)# mac-802-
11x-format
Type: Privileged
Sets the MAC authentication. Sets
the MAC address in 802.1X
format.
uckus(config-wlan)# mac-address-
format
Type: Privileged
Set MAC address 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
[ 48mbps | 2mbps |
36mbps | 1mbps |
18mbps | 12mbps |
11mbps | 5.5mbps |
6mbps | 54mbps | 9mbps
| 24mbps ]
Sets the management Tx rates.
ruckus(config-wlan)# name
Type: Privileged
<name> Sets the WLAN name.
ruckus(config-wlan)# no
Type: Privileged
access-network
acct-delay-time
acct-service
acct-service-use-proxy
acct-ttg-session
app-denial-policy
app-visibility
auth-service-use-proxy
Disables or deletes the
configurations that have been set.
........................continued
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 293
ruckus(config-wlan)# no
Type: Privileged
bss-minrate
bypass-cna
client-fingerprinting
client-tx-rx-statistics
device-policy
dgaf
dhcp-option-82
diffserv-profile
disable-band-balancing
disable-load-balancing
disable-wlan
dnlink-limit
enable-rfc5580-support
force-dhcp
hessid
hide-ssid
hotspot20-osu-support
l2-acl
mac-802-11x-format
mac-auth
ofdm-only
okc-support
onboarding-auth-service
onboarding-auth-service-
use-proxy
pmk-caching-support
proxy-arp
qos-map-enable
roam
support-802-11d
uplink-limit
user-traffic-profile
Disables or deletes the
configurations that have been set
...................................continued.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 294
ruckus(config-wlan)# no
Type: Privileged
vlan-enabled
vlan-pooling
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)# okc-support
Type: Privileged
Enables OKC support.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 295
ruckus(config-wlan)# onboarding-
auth-service
Type: Privileged
<service-name> local
<realm>
<service-name>:
Authentication services
name
local: Local database
<realm>: Realm server
<service-name> remote
<realm>
<service-name> local
<realm> never
<service-name> local
<realm> hour
<expiration-value>
Local credential
expiration, between 1 and
175200
<service-name> local
<realm> day <expiration-
value>
Local credential
expiration, between 1 and
7300
Sets the onboarding
authentication service.
..................................continued
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 296
ruckus(config-wlan)# onboarding-
auth-service
Type: Privileged
<service-name> local
<realm> week
<expiration-value>
Local credential
expiration, between 1 and
1040
<service-name> local
<realm> month
<expiration-value>
Local credential
expiration, between 1 and
240
Sets the onboarding
authentication service.
ruckus(config-wlan)# onboarding-
auth-service-use-proxy
Type: Privileged
Sets the onboarding
authentication service using the
controller proxy server.
ruckus(config-wlan)# onboarding-
portal
Type: Privileged
<name> Sets the onboarding portal.
ruckus(config-wlan)# operator-
realm
Type: Privileged
Sets the operator realm.
ruckus(config-wlan)# pmk-
caching-support
Type: Privileged
Enables PMK caching.
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)# qos-map
Type: Privileged
<priority> Updates the QoS map.
Table 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 297
ruckus(config-wlan)# qos-map-
enable
Type: Privileged
Enables QoS map.
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 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 298
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)# vlan-pooling
Type: Privileged
<name> Sets the VLAN pooling profile.
ruckus(config-wlan)# web-
authentication
Type: Privileged
<name> Sets the web authentication
service.
ruckus(config-wlan)# wechat
Type: Privileged
Sets WeChat services.
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 98. Commands related to ruckus(config-wlan)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan-group
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 299
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 99 lists the related wlan-group configuration commands.
.
Table 99. 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 300
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
ruckus(config-wlan-group)# wlan
Type: Privileged
<name> vlan <vlanTag>
nasid <nasid>
<name> nasid <nasid>
vlan <vlanTag>
<name> vlan <vlanTag>
<name> nasid <nasid>
<name> vlan-pooling
<vlanPooling>
<name> vlan-pooling
<vlanPooling> nasid
<nasid>
<name>
Sets a WLAN in this group, or
overrides the VLAN setting.
Table 99. Commands related to ruckus(config-wlan-group)
Syntax and Type Parameters (if any) Description
Configuration Commands
wlan-scheduler
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 301
Example
SZ100-Node1(config)# wlan-scheduler wan1
Related Commands
Table 100 lists the related wlan-scheduler configuration commands.
.
Table 100. 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)# do
Type: Privileged
Executes the do command.
ruckus(config-wlan-scheduler)#
end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(config-wlan-scheduler)#
exit
Type: Privileged
Exits from the EXEC.
ruckus(config-wlan-scheduler)#
help
Type: Privileged
Displays the help.
ruckus(config-wlan-scheduler)#
name
Type: Privileged
Sets the WLAN scheduler profile
name.
ruckus(config-wlan-scheduler)# no
Type: Privileged
description
schedule-data
Disables the commands.
Configuration Commands
wlan-scheduler
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 302
ruckus(config-wlan-scheduler)#
schedule-data
Type: Privileged
[ <weekday | empty> ] [
<start time value | empty>
] [ <end time value> ]
<weekday | empty>:
Select a weekday or keep
empty. If there is no input
value the default value
enabled is all.
<start time value |
empty>: Start time is from
00:00 to 23:45. The
timing unit is 15 minutes.
(Example: 00:00, 00:15,
00:30 or 00:45). If there is
no input value, whole day
is enabled as the default
value.
<end time value>: End
time is from 00:15 to
24:00. The timing unit is
15 minutes. (Example:
23:00, 23:15, 23:30 or
23:45).
${weekday}
Sets the schedule table.
Table 100. Commands related to ruckus(config-wlan-scheduler)
Syntax and Type Parameters (if any) Description
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 303
5
Debug Commands
This chapter describes the commands that you can use to debug the controller. 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 101. Debug commands
debug all-log-level ap-subnet-
discovery
apcli dataplane
delete diagnostic display-format do dpcli
end exit export log help no all-log-level
no ap-subnet-
discovery
no output-
format
no save no schedule no screen-
pagination
no sslv3 no strict-wfa-
compliance
no web-
backdoor
no web-debug output-format
save screen-
pagination
show ap-
subnet-
discovery-
status
show
diagnostic-
script
show schedule
show sslv3-
state
show strict-
wfa-
compliance-
state
sslv3 strict-wfa-
compliance-
state
Debug Commands
all-log-level
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 304
all-log-level
To enable all log level support, use the following command:
ruckus(debug)# all-log-level
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# all-log-level
Debug Commands
ap-subnet-discovery
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 305
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 306
Related Commands
Table 102 lists the related debug apcli configuration commands.
Table 102. 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
dataplane
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 307
dataplane
To retrieve data plane information, use the following command:
ruckus(debug)# dataplane <name>
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# dataplane dp
SZ100-Node1(debug-dataplane)#
Related Commands
Table 102 lists the related debug dataplane configuration commands.
Table 103. Commands related to ruckus(debug-dataplane)
Syntax and Type Parameters (if any) Description
ruckus(debug-dataplane)# do
Type: Privileged
Executes the do command.
ruckus(debug-dataplane)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
ruckus(debug-dataplane)# exit
Type: Privileged
Exits from the EXEC.
ruckus(debug-dataplane)# help
Type: Privileged
Displays the help.
ruckus(debug-dataplane)# run
Type: Privileged
<dp commands> For
example datacore
dump_ifs
Executes data plane commands.
Debug Commands
delete
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 308
delete
To delete a debug script that has been uploaded to the controller, 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 309
Related Commands
Table 104 lists the related debug diagnostic commands.
Table 104. 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
display-format
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 310
display-format
To enable the default settings, use the following command:
ruckus(debug)# display-format
Syntax Description
This command uses the following syntax:
json: Use JSON as the display format
Default
This command has no default settings.
Command Mode
Debug, Hidden
Example
SZ100-Node1(debug)# display-format
Debug Commands
do
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 311
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
Debug Commands
dpcli
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 312
dpcli
To run DP CLI script management commands:
ruckus(debug)# dpcli
Syntax Description
This command has the following syntax:
• tunnel ${value}
• datacore ${value}
• tunnel ${value} ${param}
• datacore ${value} ${param}
•netif
•routes
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# dpcli
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
Debug Commands
exit
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 313
Example
SZ100-Node1(debug)# end
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
Debug Commands
help
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 314
Example
SZ100-Node1(debug)# export log ftp://mahan:ruckus1!@172.19.7.100
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 all-log-level
To disable all log level support, use the following command:
ruckus(debug)# no all-log-level
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no all-log-level
Debug Commands
no ap-subnet-discovery
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 315
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
no output-format
To disable output formatting, use the following command:
ruckus(debug)# no output-format
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no output-format
no save
To disable save shell passphrase, use the following command:
ruckus(debug)# no save
Syntax Description
This command uses the following syntax:
Debug Commands
no schedule
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 316
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no save
no schedule
To disable a script, use the following command:
ruckus(debug)# no schedule <<name> <cron-time-spec> <args>> |
<name>
Syntax Description
This command uses the following syntax:
name: Script name
cron-time-spec: Scheduled time
args: Arguments. Double quote multi parameters as one. For example, "bux foo"
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no schedule
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.
Debug Commands
no sslv3
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 317
Command Mode
Debug
Example
SZ100-Node1(debug)# no screen-pagination
no sslv3
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
no strict-wfa-compliance
To disable WFA compliance, use the following command:
ruckus(debug)# no strict-wfa-compliance
NOTE: Its is highly recommended that the user contacts Ruckus customer support
before enabling / disabling this CLI command.
NOTE:
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Debug Commands
no web-backdoor
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 318
Command Mode
Debug
Example
SZ100-Node1(debug)# no strict-wfa-compliance
no web-backdoor
To disable web debugging, use the following command:
ruckus(debug)# no web-backdoor
Syntax Description
This command has no keywords or arguments.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no web-backdoor
no web-debug
To disable Cassandra web, use the following command:
ruckus(debug)# no web-debug
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# no web-debug
Debug Commands
output-format
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 319
output-format
To enable output formatting, use the following command:
ruckus(debug)# output-format
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# output-format
save
To enable save shell passphrase, use the following command:
ruckus(debug)# save
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# save
screen-pagination
To enable the screen pagination, use the following command:
ruckus(debug)# screen-pagination <ap-subnet-discovery-status > | diag-
nostic-script <name>| schedule | <sslv3-state> | strict-wfa-compliance-
state
Debug Commands
show ap-subnet-discovery-status
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 320
Syntax Description
This command uses the following syntax:
ap-subnet-discovery-status: Shows the AP subnet discovery service status
diagnostic-script <name>: Shows the diagnostic scripts
schedule: Show the scheduled scripts
sslv3-state: Shows the SSLv3 support state
strict-wfa-compliance-state: Shows the WFA compliance 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
SZ100-Node1(debug)# strict-wfa-compliance-state
NOTE: Its is highly recommended that the user contacts Ruckus customer support
before enabling / disabling the no strict-wfa-compliance CLI command.
show ap-subnet-discovery-status
To show AP subnet discovery service status, use the following command:
ruckus(debug)# show ap-subnet-discovery-status
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Debug Commands
show diagnostic-script
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 321
Example
SZ100-Node1(debug)# show ap-subnet-discovery-status
show diagnostic-script
To show diagnostic scripts, use the following command:
ruckus(debug)# show diagnostic-script <name>
Syntax Description
This command has the following syntax:
<name>: Script name
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# show diagnostic-script xyz
show schedule
To show schedule scripts, use the following command:
ruckus(debug)# show schedule
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# show schedule
Debug Commands
show sslv3-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 322
show sslv3-state
To show the SSLV support state, use the following command:
ruckus(debug)# show sslv3-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# show sslv3-state
show strict-wfa-compliance-state
To show strict WFA compliance state, use the following command:
ruckus(debug)# show strict-wfa-compliance-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# show strict-wfa-compliance-state
sslv3
To enable SSLV3 support, use the following command:
ruckus(debug)# sslv3
Syntax Description
This command has no arguments or keywords.
Debug Commands
strict-wfa-compliance-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 323
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# sslv3
strict-wfa-compliance-state
Kindly contact Ruckus Customer Support before enabling this command. To enable
the strict WFA compliance state, use the following command:
ruckus(debug)# strict-wfa-compliance-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Debug
Example
SZ100-Node1(debug)# strict-wfa-compliance-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 324
6
Setup Commands
This chapter describes the commands that you can use to set up the controller:
•rbd
•rbddump
•setup
rbd
To set up the board data of the controller, use the following command:
ruckus# rbd <board> <model> <serial> <mac> <mac-count> <customer>
Syntax Description
This command has the following arguments or keywords:
<board>: Board name
<model>: Model name
<serial>: Serial number
<mac>: MAC Address
<mac-count>: MAC Count
<customer>: Customer name
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# rbddump
rbddump
To display the board data of the controller, use the following command:
ruckus# rbddump
Setup Commands
rbddump
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 325
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
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
Setup Commands
setup
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 326
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 controller 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
Example
SZ# setup
Stopping crond: [ OK ]
################################################
Start SZ104 setup process:
################################################
************************************
Port Grouping Configuration
************************************
1. One Port Group
[ETH 1-4] Management/AP Tunnel Traffic
Setup Commands
setup
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 327
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
************************************
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
Setup Commands
setup
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 328
************************************
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 329
7
Show Commands
This chapter describes the commands that you can use to view information about
the various components of the controller. 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 105. Show commands
show admin-
activity
show alarm show ap show ap-
certificate-
status
show ap-stats
show backup show backup-
config
show backup-
config-state
show backup-
network
show backup-
schedule
show backup-
state
show backup-
upgrade-state
show client show clock show cluster
show cluster-
node
show cluster-
state
show control-
plane-stats
show counter show cpuinfo
show dhcp-
relay-stats
show diskinfo show event show history show interface
show ip show license show meminfo show ntp show radius-
proxy-stats
show report-
result
show rogue-
aps
show running-
config
show service show snapshot-
disk-state
show upgrade-
history
show
upgrade-state
show version
Show Commands
show admin-activity
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 330
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
SZ100# show admin-activity
No. Datetime Administrator From IP Action
Resource Description
----- ------------------------ -------------- --------------------
1 2015-03-05 09:14:03 GMT admin 10.1.31.105
Log on Administrator Administrator [admin] logged on
from CLI
Show Commands
show alarm
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 331
show alarm
To see the outstanding access point alarms, use the following command:
ruckus# show alarm
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
privileged
Example
SZ100# show alarm
No. Datetime Code Alarm Type Severity
Status Acknowledged On Activity
----- ------------------------ ----- ------------------- -----
1 2015-03-03 10:08:59 GMT 302 AP rebooted by sys Major
Outstanding AP [Ruckus-AP@C0:8A:DE:3A:2A:00] rebooted by the
system because of [application, wsgclient, reboot due to firmware
change].
2 2015-03-03 10:36:53 GMT 804 Cluster in mainten Critical
Cleared Cluster [NMS] is in maintenance state.
3 2015-03-03 10:55:34 GMT 810 Node physical inte Critical
Outstanding Physical network interface [pcap2] interface down
show ap
To display details about a particular access point, use the following command:
ruckus# show ap <mac> mesh [ neighbors | topology ]
Syntax Description
This command uses the following syntax:
mac - Displays the specified MAC address
neighbors - Displays the AP mesh neighbors
topology: Displays the AP mesh topology
Default
This command has no default settings.
Show Commands
show ap-certificate-status
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 332
Command Mode
Privileged
Example
SZ100# show ap 84:18:3A:39:C8:50 mesh
neighbors Show AP Mesh neighbors
topology Show AP Mesh topology
show ap-certificate-status
To display the AP certificate status, use the following command:
ruckus# show ap-certificate-status [ request | update ]
Syntax Description
This command uses the following syntax:
request - Displays AP certificate request status
update - Displays AP certificate update status
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show ap-certificate-status request
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 [ client-count | client-association | ap-traffic ] ap period [ 30-d | 24-
h | 7-d | 8-h ]
<mac>: AP MAC address
type: Statistics data type
client-count: Client count
Show Commands
show ap-stats
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 333
client-association: Client associations
ap-traffic: AP Traffic
ap: Per AP
period: Statistics period
30-d: 30 days
24-h: 24 hours
7-d: 7 days
8-h: 8 hours
<mac> type [ client-association | client-count | ap-traffic ] radio [ 2.4g | 5g ] period
[ 30-d | 7-d | 24-h | 8-h ]
<mac>: AP MAC address
type: Statistics data type
client-association: Client associations
client-count: Client count
ap-traffic: AP Traffic
radio: Per Radio
2.4g: 2.4 GHz radio
5g: 5 GHz radio
period: Statistics period
30-d: 30 days
7-d: 7 days
24-h: 24 hours
8-h: 8 hours
<mac> type [ client-count | client-association | ap-traffic ] wlan <ssid> period [
30-d | 7-d | 24-h | 8-h ]
<mac>: AP MAC address
type: Statistics data type
client-count: Client count
client-association: Client associations
ap-traffic: AP Traffic
wlan: WLAN
<ssid>: WLAN SSID
Show Commands
show ap-stats
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 334
period: Statistics period
30-d: 30 days
7-d: 7 days
24-h: 24 hours
8-h: 8 hours
<mac> type [ client-association | client-count | ap-traffic ] wlan <ssid> radio [
2.4g | 5g ] period [ 7-d | 30-d | 24-h | 8-
h ]
<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
radio: Per Radio
2.4g: 2.4 GHz radio
5g: 5 GHz radio
period: Statistics period
7-d: 7 days
30-d: 30 days
24-h: 24 hours
8-h: 8 hours
<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
Show Commands
show ap-stats
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 335
<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 [ 5g | 2.4g ] period [ 8-h | 30-d | 7-d | 24-h ]
<mac>: AP MAC address
type: Statistics data type
air-time: Air Time
radio: Per Radio
5g: 5 GHz radio
2.4g: 2.4 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
SCG200# show ap-stats 6C:AA:B3:26:68: air-time radio 5g period
7-d
Show Commands
show backup
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 336
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
SZ100# show backup
No. Created on Patch Version File Size
----- ----------------------------- --------------------------
1 2015-03-03 10:36:49 GMT 3.0.0.0.599 869.7MB
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
SZ100# show backup-config
No. Created on Version CP Version DP Version Created
By Type Backup Elapsed File Size
Show Commands
show backup-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 337
---- -------------- ----------- ----------------- ------------
1 2015-03-03 11:14:31 GMT 3.1.0.0.187 3.1.0.0.381
3.1.0.0.33 admin Manual Backup 1 48.1KB
Show Commands
show backup-config-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 338
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
SZ100# 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
Example
SZ100# show backup-network
No. Created on Patch Version File Size
----- ----------------------------- --------------------------
1 2015-02-11 16:53:26 GMT 3.1.0.0.401 1.2KB
Show Commands
show backup-schedule
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 339
show backup-schedule
To display the system backup schedule, use the following command:
ruckus# show backup-schedule
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show backup-schedule
No running configuration
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
SZ100# show backup-state
No running configuration
Show Commands
show backup-upgrade-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 340
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
SZ100# 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
SZ100# 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 341
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
SZ100# show clock
2015-03-05 07:12:42 GMT
Show Commands
show cluster
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 342
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
show cluster ip-list
Cluster Node IPs: 183.238.236.243
show cluster-node
To display the cluster node status, use the following command:
ruckus# show cluster-node
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show cluster-node
<name> Node name
Show Commands
show cluster-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 343
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
SZ100# 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 [ cpu | memory | disk ] period [ 7-d | 8-h | 30-d | 24-h ]
<name>: Control Plane name
type: Statistics data type
cpu: CPU usage
memory: Memory usage
disk: Disk usage
Show Commands
show control-plane-stats
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 344
period: Statistics period
7-d: 7 days
8-h: 8 hours
30-d: 30 days
24-h: 24 hours
<name> type port <name> period [ 24-h | 8-h | 30-d | 7-d ]
<name>: Control Plane name
type: Statistics data type
port: Port usage
<name>: Port name
period: Statistics period
24-h: 24 hours
8-h: 8 hours
30-d: 30 days
7-d: 7 days
<name> type interface <type> period [ 7-d | 24-h | 8-h | 30-d ]
<name>: Control Plane name
type: Statistics data type
interface: Interface usage
<type>: Interface type
period: Statistics period
7-d: 7 days
24-h: 24 hours
8-h: 8 hours
30-d: 30 days
Default
This command has no default settings.
Command Mode
Privileged
Show Commands
show counter
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 345
Example
SZ100# show control-plane-stats INDUS4-C type
cpu CPU usage
disk Disk usage
interface Interface usage
memory Memory usage
port Port usage
SZ100# show control-plane-stats INDUS4-C type cpu period
7-d 7 days
8-h 8 hours
24-h 24 hours
30-d 30 days
SZ100# show control-plane-stats INDUS4-C type cpu period 8-h
No. Time MAX AVG MIN
----- ----------------------------- --------- --------- -----
1 2015-04-05 22:45:00 GMT 6.6% 0.56% 0.13%
2 2015-04-05 23:00:00 GMT 5.68% 0.43% 0.13%
3 2015-04-05 23:15:00 GMT 6.7% 0.53% 0.14%
4 2015-04-05 23:30:00 GMT 5.67% 0.44% 0.13%
5 2015-04-05 23:45:00 GMT 6.61% 0.55% 0.13%
6 2015-04-06 00:00:00 GMT 5.62% 0.44% 0.13%
7 2015-04-06 00:15:00 GMT 6.73% 0.63% 0.13%
8 2015-04-06 00:30:00 GMT 6.12% 0.44% 0.14%
show counter
To display the database counter values, use the following command:
ruckus> show counter
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Show Commands
show cpuinfo
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 346
Example
SZ100# show counter
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
SZ100# 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): 48.1%us, 3.9%sy, 0.0%ni, 46.7%id, 0.6%wa, 0.0%hi,
0.7%si, 0.0%st
Show Commands
show dhcp-relay-stats
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 347
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
SZ100# show dhcp-relay-stats
show diskinfo
To display the current disk usage on the controller, 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
SZ100# show diskinfo
Filesystem Size Used Avail Use% Mounted on
/dev/sda3 20G 2.1G 17G 11% /
/dev/mapper/vg00-lv00 242G 2.6G 227G 2% /data
tmpfs 1.0G 1.2M 1023M 1% /tmp
/dev/sda1 9.9G 151M 9.2G 2% /boot_mbr
Show Commands
show event
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 348
show event
To see events based on staging zones, use the following command:
ruckus# show event
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show event
No. Datetime Event Code Event Type Severity Activity
----- ------------------------ ----------- -------------------
1 2015-03-03 10:35:02 GMT 831 Cluster upload complete
Informational Cluster [NMS] upload completed.
2 2015-03-03 10:59:56 GMT 1007 Configuration updated
Informational Configuration [TTG Event Settings] applied
successfully in [cip ] process at SmartZone [10.1.31.105]
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
SZ100# show history
Show Commands
show history
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 349
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
12. show meminfo
13. show version
Show Commands
show interface
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 350
show interface
To display the interface runtime status, use the following command:
ruckus# show interface <mgmt> <ap-tunnel> | user-defined
Syntax Description
This command uses the following syntax:
mgmt-or-ap-tunnel - Management/AP tunnel traffic
user-defined - User defined interface
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show interface
Interfaces
--------------------------------------------------------------
Interface : Management/AP Tunnel Traffic
IP Mode : Static
IP Address : 10.1.31.105
Subnet Mask : 255.255.255.0
Gateway : 10.1.31.1
Default Gateway Interface : Management/AP Tunnel Traffic
Primary DNS Server : 172.19.0.5
Secondary DNS Server : 4.2.2.2
User Defined Interfaces
--------------------------------------------------------------
IP Address : 10.1.30.48
Subnet Mask : 255.255.255.0
Gateway : 10.1.30.1
VLAN : 30
Physical Interface : Control
Show Commands
show ip
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 351
show ip
To display information about controller 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
SZ100# 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 Commands
show license
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 352
show license
To display information about the current controller 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
Example
SZ100# show license
License Summary
--------------------------------------------------------------
No. License Type #of Units Total #of Units Consumed #of Units
Available
----- ------------------------- ------------------------ -----
1 AP Capacity License 1000 1 (0.1%) 999 (99.9%)
2 AP Direct Tunnel License 1000 0 (0%) 1000 (100%)
--------------------------------------------------------------
License Information
--------------------------------------------------------------
This device is not registered. Please copy/paste the following
URL to get more information -
https://support.ruckuswireless.com/cl
Installed Licenses
--------------------------------------------------------------
No. SZ Node Feature Capacity Description Start Date Expiration
Date
----- -------------- ------------------------ --------- ------
1 NMS SUPPORT-EU-DEFAULT 1 Default End User Support License For
SZ100 2015-03-03 GMT 2015-05-31 GMT
2 NMS CAPACITY-RXGW-DEFAULT 1000 Default AP Direct Tunnel License
for SZ100 2015-03-03 GMT 2015-05-31 GMT
Show Commands
show meminfo
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 353
3 NMS CAPACITY-AP-DEFAULT 1000 Default AP Capacity License for
SZ100 2015-03-03 GMT 2015-05-31 GMT
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
SZ100# show meminfo
MemTotal: 32775708 kB
MemFree: 16150352 kB
Buffers: 163996 kB
Cached: 951708 kB
SwapCached: 0 kB
total used free shared buffers cached
Mem: 32775708 16625356 16150352 0 163996 951708
-/+ buffers/cache: 15509652 17266056
Swap: 0 0 0
Show Commands
show ntp
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 354
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
Example
SZ100# 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 controller, 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
SZ100# 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
Show Commands
show report-result
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 355
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 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
SZ100# show report-result report1
No.Date and Time Title Report Template Result Links Status Time
Taken
---------- ------------- ------------------------------------
1 2015-02-25 09:02:26 GMT Report1Client Number CSV Success 43ms
2 2015-02-25 00:00:02 GMT Report1 Client Number CSV Success 19ms
3 2015-02-24 00:00:02 GMT Report1 Client Number CSV Success 23ms
4 2015-02-23 00:00:02 GMT Report1 Client Number CSV Success 20ms
Show Commands
show rogue-aps
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 356
show rogue-aps
To view the rogue access points, use the following command:
ruckus# show rogue-aps rogueMac ${rogueMac}
ruckus# show rogue-aps type [ MaliciousAP(SSID-spoof) | Ad-hoc | Rogue
| MaliciousAP(Same-Network) | MaliciousAP(MAC-spoof) |
RogueAPtimeout ]
Syntax Description
This command uses the following syntax:
rogue-mac <mac>
rogue-mac: Rogue AP MAC
<mac>: MAC Address
rogue-type [ rogue | same-network | ssid-spoofing | ad-hoc | mac-spoofing ]
rogue-type: Rogue AP Type
rogue: Rogue
same-network: Malicious AP (Same-Network)
ssid-spoofing: Malicious AP (SSID-spoof)
ad-hoc: ad-hoc
mac-spoofing: Malicious AP (MAC-spoof)
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show rogue-aps
rogue-mac Rogue AP MAC
rogue-type Rogue AP Type
SZ100# show rogue-aps rogue-type
ad-hoc ad-hoc
mac-spoofing Malicious AP (MAC-spoof)
rogue Rogue
same-network Malicious AP (Same-Network)
ssid-spoofing Malicious AP (SSID-spoof)
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 357
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 address
ap devname <name>
ap: Show AP configurations
devname: Show AP configurations by AP name
<name>: AP name
ap-approval
ap-approval:
ap
ap: Show AP configurations
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:
bridge-profile <name>
bridge-profile:
<name>: Bridge Profile name
lbs-service ${serviceName}?
lbs-service: Show LBS service
${serviceName}?:
sms-server
sms-server: Show SMS Server configurations
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 358
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
<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}:
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 359
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-threshold
event-threshold: Show Event Threshold
event email
event:
email:
event ${eventCode}
event:
${eventCode}:
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
internal-subnet
internal-subnet: Show internal subnet prefix
proxy-aaa <name>
proxy-aaa: Show Proxy AAA Server configurations
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 360
<name>: Proxy AAA Server name
user-traffic-profile <name>
user-traffic-profile:
<name>: User Traffic Profile name
osu-portal-profile <name>
osu-portal-profile:
<name>: Online Signup Portal Profile Name
operator-profile <name>
operator-profile:
<name>: Wi-Fi Operator Profile name
identity-provider <name>
identity-provider:
<name>: Identity Provider 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
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 361
lwapp2scg
lwapp2scg: Show LWAPP2SCG configuration
encrypt-mac-ip
encrypt-mac-ip:
ap-control-mgmt-tos
ap-control-mgmt-tos:
license
license:
ip-support
ip-support: Show IP Version Support configuration
cert-store setting
cert-store: Show Certificate Store configurations
setting: Show Service Certificates
cert-store cert <name>
cert-store:
cert: Show Installed Certificates
<name>: Certificate name
cert-store csr <name>
cert-store:
csr: Show Certificates Signing Request (CSR)
<name>: CSR name
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
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 362
web-authentication <name>
web-authentication: Show Web Authentication configurations
<name>: Web Authentication name
diffserv <name>
diffserv: Show DiffServ configurations
<name>: DiffServ name
vlan-pooling <name>
vlan-pooling: Show VLAN Pooling configurations
<name>: VLAN Pooling Profile name
wlan <name>
wlan: Show WLAN configurations
<name>: WLAN name
wlan-scheduler <name>
wlan-scheduler: Show WLAN Scheduler Protile configurations
<name>: WLAN Scheduler 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 ]
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
Show Commands
show running-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 363
${apModel}?:
bonjour-gateway
bonjour-gateway: Show Bonjour Gateway
bonjour-policy <name>
bonjour-policy: Show Bonjour Policy
<name>: Policy Name
hotspot20-wlan-profile <name>
hotspot20-wlan-profile:
<name>: Hotspot 2.0 WLAN Profile Name
hotspot20-venue-profile <name>
hotspot20-venue-profile:
<name>: Hotspot 2.0 Venue 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
ad-service <name>
ad-service:
<name>: Active Directory Service name
ldap-service <name>
ldap-service:
<name>: LDAP Service name
oauth-service <name>
oauth-service:
<name>: OAuth Service name
localdb-service
localdb-service:
Default
This command has no default settings.
Show Commands
show service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 364
Command Mode
Privileged
Example
SZ100# show running-config common-settings
General Options
--------------------------------------------------------------
Timezone : Follow the smartZone's time zone setting
AP IP Mode : IPv4 only
AP Firmware Version : 3.1.0.0.280
Country Code : TW
Location :
Location Additional Information :
GPS Coordinates :
AP Admin Logon : Logon ID : admin
Password : ********
Switchover Cluster : Disabled
Syslog Options : Enabled
IP Address : 172.19.7.88
Port : 514
Facility : Keep Original
Priority : Err
Mesh Options
--------------------------------------------------------------
Mesh : Disabled
Radio Options
--------------------------------------------------------------
Channelization (2.4G/5G) : Auto / Auto
Channel (2.4G/5G) : Auto / Auto(indoor), Auto(outdoor)
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
Show Commands
show snapshot-disk-state
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 365
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# 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
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 snapshot-disk-state
To display a snapshot of the disk state, use the following command:
ruckus# show snapshot-disk-state
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Show Commands
show upgrade-history
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 366
Command Mode
Privileged
Example
SZ100# show snapshot-disk-state
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
SZ100# show upgrade-history
No. Start time SmartZone System Version Control Plane version
Data Plane version AP Firmware version File name Elapsed
----- ------------------------ ------------------------- -----
1 2015-03-03 10:41:20 GMT 3.0.0.0.599->3.1.0.0.187
3.0.0.0.1624->3.1.0.0.3 3.0.0.0.157->3.1.0 3.0.0.0.438->3.1.0.
scge-installer_3.1 22m 14s 81 .0.33 0.280 .0.0.187.ximg
2 2015-03-03 09:37:50 GMT 3.0.0.0.599 3.0.0.0.1624
3.0.0.0.157 3.0.0.0.438 resh Installation 15m 11s
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.
Show Commands
show version
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 367
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100# show upgrade-state
No running operation
show version
To view the controller 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
SZ100# ruckus> show version
Model : SZ104
Serial # : 1341B03119
SZ Version : 3.1.0.0.187
Control Plane Software Version : 3.1.0.0.381
Data Plane Software Version : 3.1.0.0.33
AP Firmware Version : 3.1.0.0.280
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 368
8
System Commands
This chapter describes the commands that you can use to configure administrative
and system settings on the controller. 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.
Table 106. System commands
? backup backup config backup network backup
schedule
backup-
upgrade
cluster in-
service
config copy copy ap-
certificate-
request
copy backup copy backup-
config
copy backup-
network
copy client copy report-
result
copy ftp-url delete backup delete backup-
config
delete backup-
network
delete client
diagnostic enable enable <new
password>
exit help
logout no service patches ping ping6
reload reload ap reload now remote ap-cli restore
restore config restore local restore
network
service restart service start
set-factory shutdown shutdown now snapshot disk traceroute
upgrade upload ap-
certificate-
status
System Commands
?
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 369
Default
This command has no default settings.
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 370
backup
To backup the whole cluster system of the controller, 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 controller 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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 371
backup network
To backup controller 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 schedule
To create a schedule for backing up the configuration, use the following command:
ruckus# backup schedule < daily> <disable> <monthly> <weekly>
Syntax Description
This command uses the following syntax:.
monthly <date-of-month> hour <hour> minute <minute>
monthly: Monthly
<date-of-month>: Date of month
hour: Hour (GMT)
<hour>: Hour value (GMT)
minute: Minute
<minute>: Minute value
weekly <day-of-week> hour <hour> minute <minute>
weekly: Weekly
<day-of-week>: Day Of week
System Commands
backup-upgrade
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 372
hour: Hour (GMT)
<hour>: Hour Value (GMT)
minute: Minute
<minute>: Minute value
daily <hour> minute <minute>
daily: Daily
<hour>: Hour value (GMT)
minute: Minute
<minute>: Minute value
disable
disable: Schedule disable
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
backup-upgrade
To backup and upgrade the whole cluster system of the controller, 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
System Commands
cluster in-service
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 373
Example
SZ100-Node1# backup-upgrade ftp://mahan:ruckus1!@172.19.7.100/
backup/AP_ad87453456fe.csv
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
SZ100(config)#
System Commands
copy
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 374
NOTE: To view configuration commands, see Configuration Commands chapters.
copy
To copy the AP certificate request to the external FTP server, to backup, backup-
config, or backup-network file from external FTP server, use the following command:
ruckus# copy ap-certificate-request [all | new] <ftp-url>
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:
all: Copy all AP certificate requests
new: Copy the APs that need to be exported.
<ftp-url>: FTPdir ectory URL, ftp://<username>:<password>@<ftp-host>[/
<dir-path>]
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
re port -re sul t: Cop y Rep ort R esu lt to exte r na l FTP serv er
<ftp-url>: Copy file from external FTP server, Format: ftp://<user-
name>:<password>@<ftp-host>[/<dir-path>]
Default
This command has no default settings.
System Commands
copy ap-certificate-request
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 375
Command Mode
Privileged
Example
SZ100-Node1# copy ap-certificate-request all ftp://
test:testpwd@172.17.22.11
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
copy ap-certificate-request
To copy the AP certificate request to the external FTP server, use the following
command:
ruckus# copy ap-certificate-request [all | new] <ftp-url>
Syntax Description
This command uses the following syntax:
all: Copy all AP certificate requests
new: Copy the APs that need to be exported.
<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 ap-certificate-request all ftp://
test:testpwd@172.17.22.11
copy backup
To copy backup file to external FTP server, use the following command:
ruckus# copy backup <ftp-url>
System Commands
copy backup-config
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 376
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
copy backup-network
To copy backup network configuration file to external FTP server, use the following
command:
ruckus# copy backup-network <ftp-url>
System Commands
copy client
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 377
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
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:
System Commands
copy ftp-url
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 378
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.
Command Mode
Privileged
Example
SZ100-Node1# copy ftp://test:testpwd@172.17.22.11
System Commands
delete backup
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 379
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
Example
SZ100-Node1# delete backup-config
SZ100-Node1# delete backup-config 1
System Commands
delete backup-network
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 380
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
Example
SZ100-Node1# delete client A1:87:45:34:56:FE
diagnostic
To run diagnostic commands, use the following command:
System Commands
diagnostic
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 381
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 107 lists the related diagnostic commands.
Table 107. 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.
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.
System Commands
diagnostic
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 382
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 107. Commands related to ruckus(diagnostic)
Syntax and Type Parameters (If Any) Description
System Commands
enable
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 383
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:
SZ100> enable
SZ100-Node1# config
SZ100-Node1(config)#
enable <new password>
To setup or update the controller administrator password, use the following
command:
ruckus# enable <old password> <new password> <retype password>
Syntax Description
This command uses the following syntax:
old password: The old controller administrator password
new password: The new controller administrator password that you want to set.
retype password: Retype the new controller administrator password.
Default
This command has no default settings.
System Commands
exit
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 384
Command Mode
Privileged
Example
SZ100-Node1# enable
Old Password: ************
New Password: ************
retype: ************
Successful operation
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
System Commands
logout
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 385
Example
SZ100-Node1# help
backup-upgrade Backup and upgrade system
config Enter configuration mode
debug Debug commands
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 controller 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
System Commands
patches
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 386
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.
patches
To manage patch scripts, use the following command:
ruckus# patches <apply | name> <do> <end> <exit> <help> <no> <show>
<upload>
Syntax Description
This command has no arguments or keywords:
Default
This command has no default settings.
Command Mode
User
Example
SZ100-Node1# patches
SZ100-Node1(patches)# show <applied-patches> <uploaded-patches>
Related Commands
Table 108 lists the related patches commands.
Table 108. Commands related to ruckus(patches)
Syntax and Type Parameters (If Any) Description
ruckus(patches)# apply
Type: Privileged
<name> Applies a patch script. Once a
patch is applied is cannot be re-
applied.
ruckus(patches)# do
Type: Privileged
Executes the do command.
ruckus(patches)# end
Type: Privileged
Ends the current configuration
session and returns to privileged
EXEC mode.
System Commands
ping
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 387
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
ruckus(patches)# exit
Type: Privileged
Exits from the EXEC.
ruckus(patches)# help
Type: Privileged
Displays the help.
ruckus(patches)# no
Type: Privileged
patches Delete a patch script, Once the
patch file is applied, it cannot be
deleted
ruckus(patches)# show
Type: Privileged
applied-patches
uploaded-patches
Shows the applied and uploaded
patch list.
ruckus(patches)# show case
Type: Privileged
Shows the case.
ruckus(patches)# upload
Type: Privileged
<ftp-url> Uploads a patch script from a
remote FTP server.
Table 108. Commands related to ruckus(patches)
Syntax and Type Parameters (If Any) Description
System Commands
ping6
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 388
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
ping6
To send an ICMP echo request to the network host, use the following command:
ruckus# ping <options>
Syntax Description
This command uses the following syntax:
<Options>: [-LUdfnqrvVaA] [-c count] [-i interval] [-w deadline]
Default
This command has no default settings.
Command Mode
User
Example
SZ100-Node1# ping6 172.19.10.9
System Commands
reload
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 389
reload
To reload the controller 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 controller reboots itself.
Default
This command has no default settings.
Command Mode
Privileged
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.
System Commands
reload now
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 390
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
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
System Commands
restore
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 391
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
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
----- ----------------------------- --------------------------
System Commands
restore local
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 392
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.
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
System Commands
service restart
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 393
Example
SZ100-Node1# restore network
service restart
To restart all the controller 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
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 controller 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
System Commands
set-factory
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 394
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!
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 controller 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 controller to an FTP server using either the web interface or CLI.
NOTE: For information on how to use the controller 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.
System Commands
set-factory
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 395
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
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 396
shutdown
To shutdown the controller 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 controller 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 controller 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
snapshot disk
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 397
snapshot disk
To g t a snapshot of the disk, use the following command:
ruckus# snapshot disk
Syntax Description
This command has no arguments or keywords.
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# snapshot disk
traceroute
To print the route packets that are taken to the network host, use the following
command:
ruckus# traceroute <options>
ruckus# traceroute6 <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
System Commands
traceroute
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 398
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
-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'
System Commands
upgrade
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 399
--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 -4 10.1.31.105
traceroute to 10.1.31.105 (10.1.31.105), 30 hops max, 60 byte
packets
1 10.1.31.105 (10.1.31.105) 0.014 ms 0.008 ms 0.007 ms
upgrade
To upgrade the controller 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
System Commands
upload ap-certificate-status
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 400
upload ap-certificate-status
To upload the AP certificate to the controller system, use the following command:
ruckus# upload ap-certificate-status <ftp-url>
Syntax Description
This command uses the following syntax:
<ftp-url>: Upload file. FTP URL format is: ftp://<username>:<password>@<ip>[/
<file-path>].
Default
This command has no default settings.
Command Mode
Privileged
Example
SZ100-Node1# upload ap-certificate-status ftp://
mahan:ruckus1!@172.19.7.100
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 401
Index
Symbols
? 368
A
access the SmartZone CLI 16
admin 29
admin configuration 30
admin-radius-service 32
ad-service 27
ap 34
ap profile 35
ap-auto-tagging 47, 49
ap-cli 305
ap-control 184
ap-group 52
ap-group-lldp 59
ap-heartbeat 62
ap-model 44
ap-model-lan1 46
ap-portal-cert 63
ap-root-ca 65
ap-sci |enable 50, 65, 66, 67
B
backup 370
backup config 370
backup network 371
backup-upgrade 371, 372
bonjour-policy 66, 67, 69
bonjour-policy-rule 70
bridge-profile 72
bridge-profile-dhcp-option82 73
C
cert-store 75
clock 78
cluster in-service 373
cluster-ip-list 78
common-settings 80
common-settings-aaa 88
common-settings-ap-group 91
common-settings-ap-model-lan1 106
common-settings-guest-access 111
common-settings-hotspot 112
common-settings-vlan-pooling 114
common-settings-web-authentication
116
common-settings-wlan 117
common-settings-wlan-group 128
common-settings-wlan-scheduler 130
config 373
config-ap-group-port 60
config-ap-portal-cert-generate-csr 64
config-common-settings-ap-model 100,
103
config-common-settings-ap-tunnel-set-
tings 108
config-common-settings-diffserv 110
config-config-common-settings-ap-tun-
nel-settings 108
config-mgmt-and-ap-control 184
config-zone-hotspot 112
copy 374
copy backup 375
copy backup-config 376
copy client 377
copy report-result 377, 378
D
debug 303
debug apcli c 306
debug dataplane 307
debug diagnostic 309
delete 308
delete backup 379
delete backup-config 379
delete backup-network 380
delete client 380
device-policy 131
device-policy-policy-rule 132
dhcp-service 311
diagnostic 308, 380, 381
diffserv 133
Index
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 402
E
enable 383, 383
end 140, 312
event 142, 143, 145, 208, 269, 276
event email 145, 147, 148
event-email 147
event-threshold 148
exit 149, 384
export log 313
F
ftp-server 149, 150
G
guest access 152
H
help 314, 384
hotspot 154, 155, 157, 161
hotspot20-venue-profile 158
hotspot20-wlan-profile 162
hotspot20-wlan-profile cust-connect-ca-
pabilities 166
I
identity-provider 168
identity-provider-acct-profile 170
identity-provider-acct-profile-realm 171
identity-provider-auth-profile 171
identity-provider-osu-enable 174
identity-provider-realms 178
identity-provider-realms-eaps 179
identity-provider-realms-eaps-auth 181
interface management 182
interface-ap-tunnel-data 184
interface-user-defined 186
ip internal-subnet 187
ip name-server 188
ip route 189
L
l2-acl 195
lbs-service 197
ldap-service 198
license import 200, 201, 202
limited privileges 23
lineman 203
localdb-service 204
log on to CLI 22
logging console 205
logout 385
lwapp2scg 206
M
management (Web) interface 16
N
no admin 208, 209
no admin-radius 209
no ap 209
no ap auto-tagging 210
no ap-cert-check 211
no ap-root-ca 212
no ap-sci 213
no control-plane 216
no data-plane 217
no event 219, 220
no ftp-server 220
no interface 224
no ip 224
no logging 228, 229, 230
no report 231
no role 231
no screen-pagination 315, 316, 317
no service 385
no snmp-trap 232
no snmp-v2-community 232
no snmp-v3-user 233
non-proxy-aaa 239
northbound-authtype 242
northbound-portal 242
ntp-server 243
O
oauth-service 244
operator-profile 246
osu-portal-profile 248, 249
overview 16
P
patches 386
ping 387, 388
Index
SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.1.2, 800-71121-001 Rev A 403
proxy-aaa 251
R
rbddump 324
reload 389
reload ap 389
reload now 390
remote ap-cli 390
report 254
restore config 391
restore local 392
restore network 392
rJ45 cable 16
role 258
rS-232 serial 16
S
screen-pagination 319
serial connection 16, 19
service restart 393
service start 393
set-factory 394
setup 326
show admin 330
show admin-activity 330
show alarm 331
show ap 331
show ap-heartbeat 332
show backup 336
show backup-config 336
show backup-network 338
show backup-state 339
show backup-upgrade-state 340
show client 340
show clock 341
show cluster 342
show cluster-state 343
show control-plane-stats 343
show cpuinfo 346
show dhcp-relay-stats 347
show diskinfo 347
show event 348
show history 348
show interface 350
show ip 351
show license 352
show meminfo 353
show ntp 354
show radius-proxy-stats 354
show report-result 355
show running-config 357
show service 364
show upgrade-history 366
show upgrade-state 366
show version 367
shutdown 396
shutdown force 399
shutdown now 396
sms-server 261
smtp-server 261, 262, 263
snmp-trap 264
snmp-v2-community 265
snmp-v3-user 267
sSH client 17
SSH connection 18
sSH connection 16
support-admin 270
syslog 271
syslog server 271
syslog-server 271
U
upgrade 399
user-agent-blacklist 274
user-role 277
user-traffic-profile 279
user-traffic-profile-acl 281
V
vlan-pooling 283
W
web-authentication 284
web-cert 284
wlan 287
wlan-group 299
wlan-scheduler 301
Z
zone-web-authentication 115, 286
Copyright © 2006-2015. Ruckus Wireless, Inc.
350 West Java Dr. Sunnyvale, CA 94089. USA
www.ruckuswireless.com

Navigation menu