Ruckus SZ™ 100 And VSZ E™ Command Line Interface Reference Guide For SmartZone 3.5 Smart Zone (GA) (SZ100/v SZ E) Sz100Vsze 35 CLIGuide20170410

SmartZone 3.5 (GA) Command Line Interface Reference Guide (SZ100/vSZ-E) Sz100Vsze-35-CLIGuide20170410

2017-04-25

User Manual: Ruckus SmartZone 3.5 (GA) Command Line Interface Reference Guide (SZ100/vSZ-E)

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

DownloadRuckus SZ™ 100 And VSZ-E™ Command Line Interface Reference Guide For SmartZone 3.5 Smart Zone (GA) (SZ100/v SZ-E) Sz100Vsze-35-CLIGuide20170410
Open PDF In BrowserView PDF
Ruckus Wireless
SmartZone 100 and Virtual SmartZone
Essentials
™

™

Command Line Interface Reference Guide for
SmartZone 3.5

Part Number 800-71293-001
Published April 2017
www.ruckuswireless.com

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

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

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

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

Trademarks
Ruckus Wireless, Ruckus, the bark logo, ZoneFlex, FlexMaster, ZoneDirector, SmartMesh, Channelfly, Smartcell,
Dynamic PSK, and Simply Better Wireless are trademarks of Ruckus Wireless, Inc. in the United States and other
countries. All other product or company names may be trademarks of their respective owners.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

2

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 (a - d)
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-heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
app-denial-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
app-port-mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
cert-store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
changepassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
clock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
cluster-ip-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

3

cluster-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
cluster-redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
dns-server-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

3

Configuration Commands (e-r)
encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
encrypt-zone-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
eth-port-validate-one-trunk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
event db-persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
event email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
event snmp-notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
event-email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
event-threshold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
ftp-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
identity-provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
ip control-nat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ip name-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ip name-server-ipv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ip route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ip route-ipv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
ipsec-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ldap-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
license cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
license export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
license import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
license local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
license sync-now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

4

lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
localdb-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
logging console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
lwapp2scg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
mgmt-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
no ad-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
no admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
no admin-radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
no ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
no ap auto-approve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
no ap auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
no ap-cert-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
no ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
no ap-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
no block-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
no bonjour-fencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
no bonjour-fencing-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
no bonjour-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
no bonjour-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
no cert-store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
no control-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
no data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
no device-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
no diffserv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
no dns-server-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
no dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
no encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
no encrypt-zone-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
no ethernet-port-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
no event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
no ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
no guest-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
no hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
no hotspot20-venue-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
no hotspot20-wlan-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
no identity-provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
no interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
no ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
no ipsec-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

5

no l2-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
no lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
no ldap-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
no lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
no logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
no oauth-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
no operator-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
no osu-portal-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
no outbound firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
no proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
no report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
no role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
no sci-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
no snmp-notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
no snmp-v2-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
no snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
no snmp-v2-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
no snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
no subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
no user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
no user-group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
no user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
no user-traffic-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
no vlan-pooling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
no web-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
no wlan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
no wlan-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
no wlan-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
no zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
northbound-authtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
northbound-portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
ntp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
oauth-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
operator-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
outbound-firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
proxy-aaa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
rebalance-aps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
rks-gre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

6

role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

4

Configuration Commands (s-z)
sci-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
sci-setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
sms-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
smtp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
snmp-notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
snmp-v2-community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
soft-gre. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
support-admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
syslog-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
user-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
user-traffic-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
vlan-pooling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
zone-template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

5

Debug Commands
debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
ap-subnet-discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
apcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
dp-customized-config. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
export log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
no ap-subnet-discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
no dp-customized-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
no output-format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
no save. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
no schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

7

no screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
no strict-wfa-compliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
no sha1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
no tlsv1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
no web-backdoor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
no web-debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
output-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
reindex-elasticsearch-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
sha1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
show ap-subnet-discovery-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
show dp-customized-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
show sha1-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
show strict-wfa-compliance-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
show tlsv1-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
strict-wfa-compliance-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
tlsv1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

6

Setup Commands
rbd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
rbddump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

7

Show Commands
show admin-activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
show alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
show ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
show ap-certificate-status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
show ap-stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
show backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
show backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
show backup-config-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
show backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
show backup-schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
show backup-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
show backup-upgrade-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
show client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
show clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
show cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

8

show cluster-node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
show cluster-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
show control-plane-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
show counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
show cpuinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
show dhcp-relay-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
show diskinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
show event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
show ip. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
show license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
show logs-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
SZ100# show logs-filter client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
show md-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
show meminfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
show radius-proxy-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
show report-result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
show rogue-aps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
show run cluster-redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
show running-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
show run sci-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
show run sci-setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
show run user-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
show run zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
show run zone-template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
show service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
show upgrade-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
show upgrade-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
show version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
show zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

8

System Commands
?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
backup config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
backup network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
backup schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

344
345
345
346
346

9

backup-upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
cluster in-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
copy ap-certificate-request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
copy backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
copy backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
copy backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
copy client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
copy report-result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
copy ftp-url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
delete backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
delete backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
delete backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
delete client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
log-diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
no service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
ping6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
reload ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
reload now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
remote ap-cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
restore config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
restore local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
restore network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
service restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
service start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
set-factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
shutdown now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

10

snapshot disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
traceroute6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
upload ap-certificate-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Index

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

11

About This Guide
This SmartZone™ (SZ) 100 and Virtual SmartZone Essentials (vSZ-E) Command
Line Interface Reference Guide contains the syntaxes and commands for configuring and managing the 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.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

12

Document Conventions

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

Text conventions

Convention

Description

monospace

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

monospace bold

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

default font bold

Keyboard keys, software
buttons, and field names

On the Start menu, click All
Programs.

italics

Screen or page names

Click Advanced Settings.
The Advanced Settings page
appears.

Table 2.

Example

Notice conventions

Notice Type

Description

NOTE

Information that describes important features or instructions

CAUTION!

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

WARNING!

Information that alerts you to potential personal injury

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

13

Documentation Feedback

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

14

Introduction to the Controller
Command Line Interface

1

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

15

Overview of the Controller Command Line Interface
What You Will Need

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

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

What You Will Need
To access the controller CLI, you will need the following:
1 A computer that you want to designate as administrative computer
2 A network connection to the controller (if you want to use an SSH connection)
or an RS-232 serial to RJ45 cable (if you want to use a serial connection)
3 An SSH (secure shell) client

Connect the Administrative Computer to the Controller
Connect the administrative computer to the controller either through the network
or directly using an RS-232 serial to RJ45 cable.
1 If you want to use an SSH connection, connect the administrative computer to
the same subnet or broadcast domain as the Management (Web) interface of
the controller.
2 If you want to use a serial connection, make sure that both the administrative
computer and the controller are both powered on. And then, do the following:
• Connect the RJ45 end of the cable to the port labeled |O|O| (console port)
on the controller. See 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.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

16

Accessing the Command Line Interface
Start and Configure the SSH Client

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

17

Accessing the Command Line Interface
Start and Configure the SSH Client

Using SSH Connection
If you have connected the administrative computer to the same subnet or broadcast
domain as the Management (Web) interface of the controller, follow these steps to
start and configure the SSH client.
1 Start PuTTY. The PuTTY configuration dialog box appears, showing the Session
screen as seen in Figure 2.
2 In Connection type, select SSH.
Figure 2. Selecting SSH as a connection type

3 Enter the IP address of the Management (Web) interface of the controller in the
Host Name (or IP address) field as seen in Figure 2.
4 Click Open. The PuTTY console appears and displays the login prompt. See
Figure 6.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

18

Accessing the Command Line Interface
Start and Configure the SSH Client

Using Serial Connection
If you have connected the administrative computer to the console port on the
controller using an RS-232 serial to RJ45 cable, follow these steps to start and
configure the SSH client.
1 Start PuTTY. The PuTTY Configuration dialog box appears, showing the Session
screen as seen in Figure 3.
2 In Connection type, select Serial if you are connecting via serial cable.
Figure 3. Selecting serial as a connection type

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

19

Accessing the Command Line Interface
Start and Configure the SSH Client

Figure 4. PuTTy’s default serial connection setting

4 Configure the serial connection settings as follows. See Figure 5.
• Serial line to connect to: Type the COM port name to which you connected
the RS-232 cable.
• Bits per second: 115200
• Data bits: 8
• Stop bits: 1
• Parity: None
• Flow control: None

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

20

Accessing the Command Line Interface
Start and Configure the SSH Client

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

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

21

Accessing the Command Line Interface
Log On to CLI

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.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

22

Accessing the Command Line Interface
Log On to CLI

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.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

23

Accessing the Command Line Interface
Log On to CLI

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.

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

24

Accessing the Command Line Interface
Log On to CLI

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.5, 800-71293-001

25

2

Configuration Commands (a - d)

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.
Table 3.

Configuration commands

config

ad-service

admin

admin-radius

ap-autoapprove

ap-autotagging

ap-cert-check ap-certificate- ap-control-mgmtreset
tos

ap-heartbeat

cert-store

changepasswo clock
rd

cluster-ip-list

cluster-name

clusterredundancy

dns-serverservice

dp-group

do

ap

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

26

Configuration Commands (a - d)
ad-service

ad-service
To create or update the active directory service configuration, use the following
command:
ruckus(config)# ad-service 
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)

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



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

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

27

Configuration Commands (a - d)
ad-service

Table 4.

Commands related to ruckus(config-ad-service)

Syntax and Type

Parameters (if any)

ruckus(config-ad-service)# do

Description
Executes the do command.

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



Sets the user’s email details.

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

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

ruckus(config-ad-service)# exit

Exits from the EXEC.

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



Sets friendly name for the active
service directory.

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

Enables the global catalog
support

Type: Privileged
ruckus(config-ad-service)# group- : Group
attrs
attribute value
Type: Privileged

Sets the user traffic profile
mapping.

: User Role

ruckus(config-ad-service)# help

Displays help.

Type: Privileged
 - Sets the primary
server IP address

Sets the primary service IP
address.



Sets the active directory service
name.

ruckus(config-ad-service)# no



Disables the commands.

Type: Privileged

 

ruckus(config-ad-service)# port



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

Sets the primary server port.

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

28

Configuration Commands (a - d)
admin

Table 4.

Commands related to ruckus(config-ad-service)

Syntax and Type

Parameters (if any)

Description

ruckus(config-ad-service)#
windows-domain-name


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

Sets the windows domain name



Sets the user’s job title.

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

admin
To create or update the administrator’s profile (including the email address, login ID
and password), use the following command:
ruckus(config)# admin 
Once you enter the config-admin context, you can configure the rest of the
administrator’s profile (see example below).
Syntax Description
This command uses the following syntax:
name: Administrator user name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config)# admin joe
SZ100-Node1(config-admin)# email joe@company.com
SZ100-Node1(config-admin)# password admin!234
SZ100-Node1(config-admin)# phone 22870001
SZ100-Node1(config-admin)# real-name "Joe Admin"
SZ100-Node1(config-admin)# title CTO
SZ100-Node1(config-admin)# radius radius-1
SZ100-Node1(config-admin-radius)# ip 1.1.1.1
SZ100-Node1(config-admin-radius)# port 1813
SZ100-Node1(config-admin-radius)# realm tw1
SZ100-Node1(config-admin-radius)# shared-secret 11

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

29

Configuration Commands (a - d)
admin

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)

ruckus(config-admin)# do

Description
Executes the do command.

Type: Privileged
ruckus(config-admin)# email



Sets the user’s email details.

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

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

ruckus(config-admin)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-admin)# help

Displays help.

Type: Privileged
ruckus(config-admin)# name



Sets the account name.



Sets the password for user.



Sets the phone number of the user.

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

Sets the real name.

Type: Privileged
ruckus(config-admin)# role



Sets the user role.



Sets the user’s job title.

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

30

Configuration Commands (a - d)
admin-radius

admin-radius
To configure the RADIUS server for administrators use the following command:
ruckus(config)# admin-radius
Syntax Description
This command uses the following syntax:
name: RADIUS server name
Default
This command has no default settings.
Command Mode
Config
Example
SZ100-Node1(config-admin)# radius
SZ100-Node1(config-admin-radius)#
SZ100-Node1(config-admin-radius)#
SZ100-Node1(config-admin-radius)#
SZ100-Node1(config-admin-radius)#
Retype: **
SZ100-Node1(config-admin-radius)#

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

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

31

Configuration Commands (a - d)
admin-radius

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

ip : Sets the IP
address of secondary
RADIUS server

Enables backup of RADIUS server.

Type: Privileged

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

Executes the do command.

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

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

ruckus(config-admin-radius)# exit

Exits from the EXEC.

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

Displays help.

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

32

Configuration Commands (a - d)
admin-radius

Table 6.

Commands related to ruckus(config-radius-service)

Syntax and Type

Parameters (if any)

Description

ruckus(config-admin-radius)# ip



Sets the IP addresses of the
primary RADIUS server.



Sets the RADIUS server name.

backup

Disables the backup RADIUS
support.

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

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

Sets the port addresses of the
primary RADIUS server.

 Multiple realms Sets the realms.
supported. Use a comma
(,) to separate realms
(example:home1,home2)
: Multiple
Sets the services.
services supported. Use a
comma (,) to separate
services
(example:home1,home2)
 Shared Sets the shared secret of the
primary RADIUS server.
secret between 1 and
255.

ruckus(config-admin-radius)# test 
 [CHAP |
Type: Privileged
PAP]

Tests the RADIUS server based on
the user credentials.

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

Sets the admin authentication
type,

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

33

Configuration Commands (a - d)
ap

ap
To update the AP configuration, use the following commands:
ruckus(config)# ap 
ruckus(config)# ap pre-prov > >
ruckus(config)# ap swap > >
Syntax Description
This command uses the following syntax:
 lock
: AP MAC address
lock: Lock AP
 pre-prov
: AP MAC address
pre-prov: Update Pre-provision configuration
 swap
: AP MAC address
swap: Update Swap configuration
 trigger-swap
: AP MAC address
trigger-swap: Trigger swap action
 approve
: 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 >

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

34

Configuration Commands (a - d)
ap

SZ100-Node1(config)# ap pre-prov import ftp://
ruckus:ruckus1!@172.19.7.100/backup/AP_ad8745345
ruckus(config)# ap swap >
SZ100-Node1(config)# ap swap export ftp://
ruckus:ruckus1!@172.19.7.100

Related Commands
• Table 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

 

Sets the administrative logon
credentials.

 

Sets the administrative mode to
either locked or unlocked.



Sets the access point
administration login credentials.



Sets the model specification
(overrides the zone configuration).



Sets the access point
administrative password.



Sets the user location information
of LAC or TAC.

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

Sets the AP SNMP options.

Type: Privileged
ruckus(config-ap)# bonjourgateway

Enables the bonjour gateway.

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

Enables the bonjour policy.

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

35

Configuration Commands (a - d)
ap

Table 7.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# channelevaluation-interval

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

Sets the channel evaluation
interval.

Type: Privileged

ruckus(config-ap)# channel-select- 2.4g ${value}: 2.4GHz
mode
radio

Sets a mode to automatically
adjust AP channels.

Type: Privileged

5g ${value}: 5GHz radio

ruckus(config-ap)# channelflymtbc

2.4g : 2.4GHz Set MTBC value of ChannelFly
radio

Type: Privileged

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

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

36

Configuration Commands (a - d)
ap

Table 7.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# clientadmission-control

2.4g

Enables the client admission
control.

Type: Privileged

2.4g minClientCount


5g

Min Client Count (Default:
10)
2.4g maxRadioLoad

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

Min Client Count (Default:
20)
5g maxRadioLoad

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

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



Sets the model specification
(overrides the zone configuration).

[ ipv6 | ipv4 ]

Sets the device IP mode.

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

Executes the do command.

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

37

Configuration Commands (a - d)
ap

Table 7.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

ruckus(config-ap)# end

Description

Type: Privileged

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

ruckus(config-ap)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-ap)# gps

 

Sets the GPS coordinates to
latitude and longitude values.



Sets the GPS coordination
latitude.



Type: Privileged

Sets the GPS coordination
longitude.

ruckus(config-ap)# help

Displays help.

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

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

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

ruckus(config-ap)# ip
Type: Privileged

address   
and secondary DNS servers.
name-server  secondary

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

38

Configuration Commands (a - d)
ap

Table 7.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

ruckus(config-ap)# ip6

[ keep | auto ]: Retains the Sets the AP IPv6 address.
AP settings

Type: Privileged

Description

static  



Sets the location.



Sets the additional information for
location.

[ disable | mesh | root |
auto ]

Sets the mesh mode to either:

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

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

ruckus(config-ap)# model

Sets the model specifications. It
overrides the zone configuration.

Type: Privileged
ruckus(config-ap)# name



Sets the AP name.

Type: Privileged

SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001

39

Configuration Commands (a - d)
ap

Table 7.

Commands related to ruckus(config-ap).

Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# no

admin

Disables the configuration.

Type: Privileged

bonjour-gateway
channel-evaluationinterval
channel-select-mode
client-admission-control
description
gps

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

hotspot20
ip 
ip6
location location-additional-info ruckus(config-ap)# no model Type: Privileged override-ap-mgmt-vlan Disables the configuration. channel-select-mode override-clientadmission-control override-smart-mon override-syslog-opt override-zone-location override-zone-locationadditional-info radio smart-mon swap-in-ap syslog uplink-ap venue-profile SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 40 Configuration Commands (a - d) ap Table 7. Commands related to ruckus(config-ap). Syntax and Type Parameters (if any) Description ruckus(config-ap)# override-apmgmt-vlan Override AP Management VLAN. <2.4g> : 2.4 GHz radio Type: Privileged Overrides the auto channel selection mode and channelFly MTBC. ruckus(config-ap)# override-client- <2.4g> <5g> admission-control Overrides the client admission control. Type: Privileged ruckus(config-ap)# overridechannel-select-mode <5g> : 5 GHz radio Type: Privileged ruckus(config-ap)# override-smartmon Overrides the smart monitor. Type: Privileged ruckus(config-ap)# overridesyslog-opt Override Syslog options Type: Privileged ruckus(config-ap)# override-zonelocation Overrides the zone location settings. Type: Privileged ruckus(config-ap)# override-zonelocation-additional-info Overrides the zone’s additional information setting on location. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 41 Configuration Commands (a - d) ap Table 7. Commands related to ruckus(config-ap). Syntax and Type Parameters (if any) Description ruckus(config-ap)# radio 2.4g channel Sets the radio channels. Type: Privileged 5g channel 2.4g channelization 5g channelization 2.4g tx-power 5g tx-power 2.4g wlan-service 5g wlan-service 2.4g wlan-group 5g wlan-group 2.4g roam [ enable | disable ] 5g roam [ enable | disable ] ruckus(config-ap)# smart-mon interval Enables the smart monitor. Type: Privileged threshold ruckus(config-ap)# swap-in-ap Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the AP Mac IP address for swap-in. 42 Configuration Commands (a - d) ap Table 7. Commands related to ruckus(config-ap). Syntax and Type Parameters (if any) ruckus(config-ap)# syslog enable Sets the syslog server. Enable the syslog server Type: Privileged Description enable [ Local2 | Keep Original | Local1 | Local5 | Local6 | Local0 | Local7 | Local3 | Local4 ] [ Error | Critical | Warning | All | Alert | Notice | Info | Emergency ] disable - Disables the syslog server ruckus(config-ap)# uplink [ smart | manual ] Type: Privileged ruckus(config-ap)# uplink-ap Sets the uplink to manual access point. Type: Privileged ruckus(config-ap)# venue-profile Sets the uplink selection to either smart or manual. Sets the venue profile Moves the access point to another zone. Type: Privileged ruckus(config-ap)# zone Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 43 Configuration Commands (a - d) ap 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) ruckus(config-ap-model)# do Description Executes the do command. Type: Privileged ruckus(config-ap-model)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ap-model)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-model)# ext-ant 2.4g - 2.4 with Enables the external antenna. DBI number Type: Privileged 2.4gg [ 3 | 2 ] 3/2 antennas 5g - 5g with DBI number 5gg [ 2 | 3 ] 5gg with 2/3 antennas ruckus(config-ap-model)# help Displays help. Type: Privileged ruckus(config-ap-model)# internalheater Enables the internal heater. Type: Privileged ruckus(config-ap-model)# lan1 ruckus(config-ap-model)# lan2 Sets the LAN configurations from 1 to 5. ruckus(config-ap-model)# lan3 ruckus(config-ap-model)# lan4 ruckus(config-ap-model)# lan5 Type: Privileged ruckus(config-ap-model)# led Enables the status of LEDs. Type: Privileged ruckus(config-ap-model)# ledmode Sets the LED mode. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 44 Configuration Commands (a - d) ap Table 8. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) ruckus(config-ap-model)# lldp Description Enables link layer discovery protocol. Type: Privileged ruckus(config-ap-model)# lldp-ad- interval Sets the LLDP advertise interval. Type: Privileged ruckus(config-ap-model)# lldphold-time Sets the LLDP hold time. Type: Privileged ruckus(config-ap-model)# lldpmgmt Enables LLDP management IP TLV. Type: Privileged ruckus(config-ap-model)# no ext-ant Type: Privileged internal-heater Disables or deletes the settings that have been configured. lan1 lan2 lan3 lan4 lan5 led lldp lldp-mgmt poe-operating-mode poe-out-port radio-band usb ruckus(config-ap-model)# poeoperating-mode Switches the PoE mode. Type: Privileged ruckus(config-ap-model)# poeout-port Enables the PoE out port. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 45 Configuration Commands (a - d) ap Table 8. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-ap-model)# radioband ${value} Switches the radio band. [ enable | disable] Sets the USB port for a specific AP model. Type: Privileged ruckus(config-ap-model)# usb Type: Privileged Table 9 lists the related to ap-model-lan1 configuration commands. Table 9. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-ap-model-lan1)# 8021x <802.1x-type> Sets 802.1x. Sets the authentication service configurations. Sets the authentication service configurations. Type: Privileged ruckus(config-ap-model-lan1)# acct-service Type: Privileged ruckus(config-ap-model-lan1)# auth-service Type: Privileged ruckus(config-ap-model-lan1)# do Executes the do command. Type: Privileged ruckus(config-ap-model-lan1)# end Type: Privileged ruckus(config-ap-model-lan1)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-ap-model-lan1)# help Displays help. Type: Privileged ruckus(config-ap-model-lan1)# no overwrite Does not permit overwriting. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 46 Configuration Commands (a - d) ap-auto-approve Table 9. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) ruckus(config-ap-model-lan1)# mac-bypass Description Sets the MAC bypass. Type: Privileged ruckus(config-ap-model-lan1)# members Sets the AP model configurations. Type: Privileged ruckus(config-ap-model-lan1)# no acct-service Disables or deletes the settings that have been configured. Type: User mac-bypass ruckus(config-ap-model-lan1)# profile : Ethernet port profile. Sets the Ethernet port profile. ruckus(config-ap-model-lan1)# supplicant mac Sets the supplicant. Type: Privileged custom ruckus(config-ap-model-lan1)# type [trunk-port | access-port | Sets the port type. general-port] Type: Privileged Type: Privileged ruckus(config-ap-model-lan1)# vlan-untag-id Sets the VLAN untag ID. : VLAN members Sets the VLAN members. Type: Privileged ruckus(config-ap-model-lan1)# vlan-members Type: Privileged ap-auto-approve To enable auto approve, use the following command: ruckus(config)# ap-auto-approve Syntax Description This command has no arguments or keywords SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 47 Configuration Commands (a - d) ap-auto-approve Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-auto-approve Successful operation SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 48 Configuration Commands (a - d) ap-auto-tagging ap-auto-tagging To setup critical access point auto tagging rules or to enable auto tagging critical access points, use the following command: ruckus(config)# ap-auto-tagging Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-auto-tagging SZ100-Node1(config-ap-auto-tagging)# Related Commands 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) ruckus(config-ap-auto-tagging)# do Description Executes the do command. Type: Privileged ruckus(config-ap-auto-tagging)# enable Enables the auto tagging for critical APs. Type: Privileged ruckus(config-ap-auto-tagging)# end Type: Privileged ruckus(config-ap-auto-tagging)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 49 Configuration Commands (a - d) ap-cert-check Table 10. Commands related to ruckus(config-ap-auto-tagging) Syntax and Type Parameters (if any) ruckus(config-ap-auto-tagging)# help Description Displays help. Type: Privileged ruckus(config-ap-auto-tagging)# no Disables the auto tagging for critical APs. Type: Privileged ruckus(config-ap-auto-tagging)# rule Type: Privileged ruckus(config-ap-auto-tagging)# threshold - Traffic Selects the auto tagging rule. To bytes exceeds threshold view this command the ap-autorule tagging should be enabled. Disables the auto tagging for critical APs. To view this command the ap-auto-tagging should be enabled. [m|g] Sets the unit to either mega bytes or giga bytes. Type: Privileged ruckus(config-ap-auto-tagging)# unit Type: Privileged ap-cert-check To enable the access point certificate check, use the following command: ruckus(config)# ap-cert-check Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-cert-check Successful operation SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 50 Configuration Commands (a - d) ap-certificate-reset ap-certificate-reset To the AP certificate request which failed to update the certificate, use the following command: ruckus(config)# ap-certificate-reset Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ap-certificate-reset ap-control-mgmt-tos To enable the access control and management traffic type of service and values, use the following command: ruckus(config)# ap-control-mgmt-tos Syntax Description This command has no arguments or keywords. Default This command uses the following syntax: value: TOS value Command Mode Config Example SZ100-Node1(config)# ap-control-mgmt-tos 10 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 51 Configuration Commands (a - d) ap-heartbeat ap-heartbeat To setup the access point heartbeat, use the following command: ruckus(config)# ap-heartbeat Syntax Description This command uses the following syntax: seconds: Interval in seconds, which the AP sends the heartbeat to the 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 app-denial-policy To create or update an Application Denial Policy, use the following command: ruckus(config)# app-denial-policy Syntax Description This command has the following parameter: : application name Default This command has no default settings. Command Mode Privileged Example SZ100-Node1(config)# app-denial-policy xyz SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 52 Configuration Commands (a - d) app-port-mapping Related Commands Table 11 lists the related app-denial-policy configuration commands. Table 11. Commands related to ruckus(config-app-denial-policy) Syntax and Type Parameters (if any) ruckus(config-app-denial-policy)# description Description Sets the description. Type: Privileged ruckus(config-app-denial-policy)# rule Creates/Updates Application Denial Policy rule Type: Privileged ruckus(config-app-denial-policy)# rule no Removes Application Denial Policy rule. Type: Privileged Table 12 lists the related app-denial-policy-rule configuration commands. Table 12. Commands related to ruckus(config-app-denial-policy-rule) Syntax and Type Parameters (if any) Description ruckus(config-app-denial-policyrule)# applicationtype [ port | http-domain-name Sets the application type. ] Type: Privileged port: Port http-domain-name: HTTP domain name ruckus(config-app-denial-policyrule)# content Sets the content. Type: Privileged app-port-mapping To create or update application port mapping, use the following command: ruckus(config)# app-port-mapping Syntax Description This command has the following parameter: : application name SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 53 Configuration Commands (a - d) app-port-mapping Default This command has no default settings. Command Mode Privileged Example SZ100-Node1(config)# app-port-mapping abc Related Commands Table 13 lists the related app-port-mapping configuration commands. Table 13. Commands related to ruckus(config-app-port-mapping) Syntax and Type Parameters (if any) Description ruckus(config-app-portmapping)# port : Port Sets the port. [tcp | udp] Sets the protocol Type: Privileged ruckus(config-app-portmapping)# protocol Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 54 Configuration Commands (a - d) cert-store cert-store To create or update certificate configurations, use the following command: ruckus(config)# cert-store ap-cert ruckus(config)# cert-store cert ruckus(config)# cert-store csr ruckus(config)# cert-store hotspot-cert ruckus(config)# cert-store web-cert Syntax Description This command uses the following syntax: ap-cert : Create / updates the AP port certificate cert : Create / updates the certificate configuration csr : Create / updates CSR (Certificate Signing Request) configuration hotspot-cert : Sets the hotspot certificate web-cert : 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 14 lists the related cert-store configuration commands. Table 14. Commands related to ruckus(config-cert-store) configuration Syntax and Type Parameters (if any) Description ruckus(config-cert-store)# cert Uploads the certificate file. Type: Privileged append ruckus(config-cert-store)# city Sets the city Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 55 Configuration Commands (a - d) cert-store Table 14. Commands related to ruckus(config-cert-store) configuration Syntax and Type Parameters (if any) Description ruckus(config-cert-store)# common-name Sets the domain name Type: Privileged ruckus(config-cert-store)# country Sets the country. Type: Privileged ruckus(config-cert-store)# description Sets the description Type: Privileged ruckus(config-cert-store# do Executes the do command. Type: Privileged ruckus(config-cert-store)# email Sets the email address. Type: Privileged Type: Privileged ruckus(config-cert-store)# end Ends the current configuration session and return to privileged EXEC mode. ruckus(config-cert-store)# exit Exits from the EXEC. Type: Privileged ruckus(config-cert-store)# help Displays help. Type: Privileged ruckus(config-cert-store)#intercert :FTP URL Upload intermediate CA certificate. Type: Privileged format: ftp:// : @/ ruckus(config-cert-store)# no inter-cert Type: Privileged root-cert ruckus(config-cert-store)# organization Sets the organization. Sets the key passphrase. Disables all commands. Type: Privileged ruckus(config-cert-store)# passphrase Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 56 Configuration Commands (a - d) changepassword Table 14. Commands related to ruckus(config-cert-store) configuration Syntax and Type Parameters (if any) ruckus(config-cert-store)# private- upload key Type: Privileged csr ruckus(config-cert-store)# rootcert :FTP URL format: ftp:// : @/ Type: Privileged Description Sets the private key. Select the root certificate. Sets the certificate type to trusted root certificate. ruckus(config-cert-store)# rootcert-type Type: Privileged ruckus(config-cert-store)# server- :FTP URL cert format: ftp:// Upload server certificates. Type: Privileged : @/ ruckus(config-cert-store)# state Sets the state Sets the organization unit. Type: Privileged ruckus(config-cert-store)# unit Type: Privileged changepassword To change the administrative password, use the following command: ruckus(config)# changepassword Syntax Description This command uses the following syntax: old password: Existing password new password: Changed password. The password must contain at least eight characters with at least one number, one letter, and one special character (~ ! @ # $ % ^ & * ( ) - _ = + [ ] { } \ | ; : ' " , . < > / ?) except ` or $(. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 57 Configuration Commands (a - d) clock 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 Syntax Description This command uses the following syntax: timezone: Sets the system clock timezone : Timezone name of the domain Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# clock timezone Africa/Nairobi SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 58 Configuration Commands (a - d) cluster-ip-list cluster-ip-list To update the node IP address mapping list of the cluster configuration, use the following command: ruckus(config)# cluster-ip-list Syntax Description This command uses the following syntax: ip-mappings: Node IP mapping list, which is space separated. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# cluster-ip-list : : SZ100-Node1(config)# cluster-ip-list 172.19.18.96:172.19.13.56 172.19.15.67:172.19.10.07 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 59 Configuration Commands (a - d) cluster-name cluster-name To change the cluster name, use the following command: ruckus(config)# cluster-name Syntax Description This command uses the following syntax: cluster-name: Change the cluster name. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# cluster-name cls1 cluster-redundancy To create or update a cluster redundancy configuration, use the following command: ruckus(config)# cluster-redundancy Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# cluster-redundancy Related Commands • Table 15 lists the related cluster redundancy configuration commands. • Table 16 lists the related cluster redundancy cluster configuration commands. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 60 Configuration Commands (a - d) cluster-redundancy Table 15 lists the related cluster redundancy configuration commands. Table 15. Commands related to ruckus(config-cluster-redundancy) Syntax and Type Parameters (if any) Description ruckus(config-clusterredundancy)# cluster Create or update the cluster redundancy configuration. Type: Privileged priority [ up | down ] ruckus(config-clusterredundancy)# do Executes the do command. Type: Privileged ruckus(config-clusterredundancy)# enable Enables the cluster redundancy configuration. Type: Privileged ruckus(config-clusterredundancy)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-clusterredundancy# exit Exits from the EXEC. Type: Privileged ruckus(config-clusterredundancy)# help Displays the help. Type: Privileged ruckus(config-clusterredundancy)# no cluster Deletes cluster redundancy configurations. Disables cluster redundancy. Type: Privileged ruckus(config-clusterredundancy)# no enable Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 61 Configuration Commands (a - d) cluster-redundancy Table 16 lists the related cluster redundancy cluster configuration commands. Table 16. Commands related to ruckus(config-cluster-redundancy-cluster) Syntax and Type Parameters (if any) ruckus(config-cluster-redundancycluster)# do Description Executes the do command. Type: Privileged ruckus(config-cluster-redundancycluster)# dual-list Type: Privileged ruckus(config-cluster-redundancycluster)# end Sets the dual address list. List format: IPv4 address/IPv6 address,IPv4 address,IPv6 address Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-cluster-redundancycluster)# exit Exits from the EXEC. Type: Privileged ruckus(config-cluster-redundancycluster)# help Displays the help. Type: Privileged ruckus(config-cluster-redundancycluster)# name Sets the cluster name. Type: Privileged ruckus(config-cluster-redundancycluster)# ip-list Type: Privileged : Control IPs. Sets the Control IP list. Comma separated IP list. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 62 Configuration Commands (a - d) dns-server-service dns-server-service To create or update DNS server services, use the following command. ruckus(config)# dns-server-service Syntax Description This command has the following keywords: : DNS server service name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# dns-server-service xy Related Commands Table 17 lists the related dns-server-service configuration commands. Table 17. Commands related to ruckus(dns-server-service) Syntax and Type Parameters (if any) ruckus(config-dns-server-service)# description Description Sets description. Type: Privileged ruckus(config-dns-server-service)# do Executes the do command. Type: Privileged ruckus(config-dns-server-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-dns-server-service)# end Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Ends the current configuration session and returns to the privileged EXEC mode. 63 Configuration Commands (a - d) do Table 17. Commands related to ruckus(dns-server-service) Syntax and Type Parameters (if any) ruckus(config-dns-server-service)# help Description Displays help. Type: Privileged ruckus(config-dns-server-service)# name Sets the DNS server services name. Type: Privileged ruckus(config-dns-serverservice)## no Disable and delete commands. Type: Privileged ruckus(config-dns-server-service)# primary-ip Sets the primary IP address. Type: Privileged ruckus(config-dns-serverservice)## secondary-ip Type: Privileged Sets the secondary IP address. ruckus(config-dns-server-service)# no description Delete the description. Type: Privileged ruckus(config-dns-server-service)# no primary-ip Deletes the primary IP address. Type: Privileged ruckus(config-dns-serverservice)## no secondary-ip Type: Privileged Deletes the secondary IP address. do To setup the do command, use the following command. ruckus(config)# do Syntax Description This command has no arguments or keywords. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 64 Configuration Commands (a - d) dp-group Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# do dp-group To enable and sets the data plane grouping, use the following command. ruckus(config)# dp-group Syntax Description This command uses the following syntax: : 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.5, 800-71293-001 65 3 Configuration Commands (e-r) 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 18. Configuration commands encrypt-mac-ip encrypt-zone- end name eth-portvalidate-onetrunk event event dbpersistence event email event snmpnotification event-email event-threshold exit ftp-server ftp-test help hostname identity-provider interface ip ip control-nat ip name-server ip name-server- ip route ipv6 ip route-ipv6 ipsec-profile lbs-service ldap-service license license cloud license export license local license syncnow lineman localdb-service logging console lwapp2scg mgmt-acl no ad-service no admin no admin-radius no ap no ap autoapprove no ap autotagging no ap-controlmgmt-tos no ap-group no block-client no bonjourfencing no bonjour-fencingpolicy no bonjourgateway no bonjourpolicy no cert-store no data-plane license import no device-policy no diffserv no controlplane no dns-server- no dp-group service SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 no ap-cert-check no encrypt-mac-ip 66 Configuration Commands (e-r) Table 18. Configuration commands no encryptzone-name no ethernetport-profile no event no hotspot no hotspot20- no hotspot20- no identityvenue-profile wlan-profile provider no ip no ipsecprofile no l2-acl no lbs-service no ldap-service no lineman no logging no oauthservice no operatorprofile no osu-portalprofile no outbound firewall no proxy-aaa no report no role no sci-profile no snmpnotification no snmp-v2community no snmp-v3user no user-agent- no user-group blacklist no user-role no user-traffic- no vlan-pooling no webno wlan profile authentication no wlan-group no wlanscheduler ntp-server oauth-service operator-profile outboundfirewall rebalance-aps report no zone no ftp-server northboundauthtype no guest-access no interface northbound-portal proxy-aaa rks-gre SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 67 Configuration Commands (e-r) encrypt-mac-ip encrypt-mac-ip To enable encryption of MAC and IP address for Wireless Internet Service Provider roaming (WISPr) enriched URL, use the following command. ruckus(config)# encrypt-mac-ip Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# encrypt-mac-ip Successful operation encrypt-zone-name To enable AP Zone name encryption for Wireless Internet Service Provider roaming (WISPr) enriched URL, use the following command. ruckus(config)# encrypt-zone-name Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# encrypt-zone-name Successful operation SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 68 Configuration Commands (e-r) eth-port-validate-one-trunk eth-port-validate-one-trunk To update the validator for an AP with at least one trunk port, use the following command. ruckus(config)# eth-port-validate-one-trunk Syntax Description This command has the following keywords: disable: Disable the validator for the AP with at least one trunk port enable: Enable the validator for the AP with at least one trunk port Default This command has no default settings. Command Mode Config Example ruckus(config)# eth-port-validate-one-trunk 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 69 Configuration Commands (e-r) event event To update the event notification configuration, use the following command. ruckus(config)# event Syntax Description This command uses the following syntax: : Single configuration event notification Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# event 1002 Related Commands Table 19 lists the related event configuration commands. Table 19. Commands related to ruckus(config-event) Syntax and Type Parameters (if any) ruckus(config-event)# dbpersistence Description Enables the data blade persistence for the event. Type: Privileged ruckus(config-event)# do Executes the do command. Type: Privileged ruckus(config-event)# email Enables the email notification. Type: Privileged ruckus(config-event)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-event)# exit Exits from the EXEC. Type: Privileged ruckus(config-event)# help Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 70 Configuration Commands (e-r) event db-persistence Table 19. Commands related to ruckus(config-event) Syntax and Type Parameters (if any) Description ruckus(config-event)# no db-persistence Enables the SNMP trap. Type: Privileged email snmp-trap ruckus(config-event)# snmp-trap Enables the SNMP trap. Type: Privileged event db-persistence To enable data base persistence for the event, use the following command. ruckus(config)# event db-persistence Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# event db-persistence No. Event Code Category Type Description Severity SNMP Email DB Persistence ----- ----------- ------------------------ ---------------------1 103 AP Communication AP managed This event occurs when AP is approved by the SmartZone. Informational Disabled Disabled Enabled 2 105 AP Communication AP rejected This event occurs when AP is rejected by the SmartZone.Minor Enabled Disabled Enabled 3 106 AP Communication AP firmware updated This event occurs when AP successfully updates its firmware. Informational Disabled Disabled Enabled SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 71 Configuration Commands (e-r) event email event email To enable event triggers for selected email notification, use the following command. ruckus(config)# event email 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: SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 72 Configuration Commands (e-r) event snmp-notification Related Commands Table 20 lists the related event-email configuration commands. Table 20. Commands related to ruckus(config-event-email) Syntax and Type Parameters (if any) ruckus(config-event-email)# enable Description Enables notification email for events. Type: Privileged ruckus(config-event-email)# mail- email address to Email address configuration. Type: Privileged ruckus(config-event-email)# no enable Disables the email notification for events. Type: Privileged ruckus(config-event-email)# no mail-to Disables email address configuration. Type: Privileged event snmp-notification To enable selected SNMP notification, use the following command. ruckus(config)# event snmp-notification Syntax Description This command has no arguments or keywords. Command Mode Config Example SZ100-Node1(config)# event snmp-notification No. Event Code Category Type Description Severity SNMP Email DB Persistence ----- ----------- ------------------------ ---------------------1 103 AP Communication AP managed This event occurs when AP is approved by the SmartZone Informational Enabled Enabled Enabled . SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 73 Configuration Commands (e-r) event-email event-email To setup the event to email services, use the following command. ruckus(config)# event-email 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 21 lists the related event-email configuration commands. Table 21. Commands related to ruckus(config-event-email) Syntax and Type Parameters (if any) ruckus(config-event-email)# do Description Enables the do command. Type: Privileged ruckus(config-event-email)# enable Enables the email notifications for events. Type: Privileged ruckus(config-event-email)# end: Privileged End the current configuration session and returns to the privileged EXEC mode. ruckus(config-event-email)# exit Privileged Exit from the EXEC. ruckus(config-event-email)# help Privileged Display the help message. ruckus(config-event)# mail-to Sets the email address configuration. ruckus(config-event)# no enable Disables various options. Type: Privileged mail-to Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 74 Configuration Commands (e-r) event-threshold event-threshold To update the event threshold configuration, use the following command. ruckus(config)# event-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 22 lists the related event-threshold configuration commands. Table 22. Commands related to ruckus(config-event-threshold) Syntax and Type Parameters (if any) ruckus(config-event-threshold)# do Description Enables the do command. Type: Privileged ruckus(config-event-threshold)# end: Privileged End the current configuration session and returns to the privileged EXEC mode. ruckus(config-event-threshold)# exit Exit from the EXEC. Type: Privileged ruckus(config-event-threshold)# help Display the help message. Type: Privileged ruckus(config-threshold)# unit Sets the threshold unit. Type: Privileged ruckus(config-threshold)# value Sets the threshold value. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 75 Configuration Commands (e-r) exit exit To exit from the EXEC, use the following command. ruckus(config)# exit Syntax Description This command has no arguments or keywords. Command Mode Config Example SZ100-Node1(config)# exit ftp-server To update the FTP server for uploading reports configuration, use the following command. ruckus(config)# ftp-server Once you enter the config-ftp-server context, you can configure the rest of the FTP server settings (see example below). Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode config Example SZ100-Node1(config)# ftp-server 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: **** SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 76 Configuration Commands (e-r) ftp-server Retype: **** SZ100-Node1(config-ftp-server)# exit SZ100-Node1(config)# Related Commands Table 23 lists the related ftp-server commands. Table 23. Commands related to ruckus(config-ftp-server) Syntax and Type Parameters (if any) ruckus(config-ftp-server)# do Description Executes the do command. Type: Privileged ruckus(config-ftp-server)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ftp-server)# exit Exits from the EXEC. Type: Privileged ruckus(config-ftp-server)# help Displays the help. Type: Privileged ruckus(config-ftp-server)# host Sets the FTP server IP address. Sets the FTP password. Sets the FTP server port. Type: Privileged ruckus(config-ftp-server)# password Type: Privileged ruckus(config-ftp-server)# port Type: Privileged ruckus(config-ftp-server)# protocol Sets the protocol. Type: Privileged ruckus(config-ftp-server)# remote- directory Sets the FTP remote directory. Type: Privileged ruckus(config-ftp-server)# test Test the FTP settings. Type: Privileged ruckus(config-ftp-server)# username Sets the user name. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 77 Configuration Commands (e-r) ftp-test ftp-test To test the FTP server connection, use the following command. ruckus(config)# ftp-test Syntax Description This command uses the following syntax: : 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 help To display the help message, use the following command. ruckus(config)# help Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# help admin Create/Update Administrator account configuration admin-radius Create/Update RADIUS server for Administrators ap-auto-approve Enable AP auto approve SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 78 Configuration Commands (e-r) hostname hostname To change the hostname, use the following command. ruckus(config)# 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 identity-provider To create or update identity provider configuration, use the following command. ruckus(config)# identity-provider 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)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 79 Configuration Commands (e-r) identity-provider Related Commands • Table 24 lists the related identity-provider configuration commands. • Table 25 lists the related identity-provider-acct-profile configuration commands. • Table 26 lists the related identity-provider-acct-profile-realm configuration commands. • Table 27 lists the related identity-provider-auth-profile configuration commands • Table 28 lists the related identity-provider-auth-profile-realm configuration commands. • Table 29 lists the related identity-provider-osu-enable configuration commands. • Table 30 lists the related identity-provider-realms configuration commands. • Table 31 lists the related identity-provider-realms-eaps configuration commands. • Table 32 lists the related identity-provider-realms-eaps-auth configuration commands Table 24 lists the related identity-provider configuration commands. Table 24. Commands related to ruckus(config-identity-provider) Syntax and Type Parameters (if any) ruckus(config-identity-provider)# acct-enable Description Enables accounting. Type: Privileged ruckus(config-identity-provider)# acct-profile Sets the accounting profile. Type: Privileged ruckus(config-identity-provider)# auth-profile Sets the authentication profile. Type: Privileged ruckus(config-identity-provider)# description Sets the description. Type: Privileged ruckus(config-identity-provider)# do Executes the do command. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 80 Configuration Commands (e-r) identity-provider Table 24. Commands related to ruckus(config-identity-provider) Syntax and Type Parameters (if any) ruckus(config-identity-provider)# end Description Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-identity-provider)# exit Exits from the EXEC. Type: Privileged Displays the help. ruckus(config-identity-provider)# help Type: Privileged ruckus(config-identity-provider)# home-ois Type: Privileged 5-hex Sets the Home OIs. 3-hex ruckus(config-identity-provider)# name Sets the identity provider name. ruckus(config-identity-provider)# no acct-enable Disables the commands. Type: Privileged osu-enable Type: Privileged home-ois plmns realms ruckus(config-identity-provider)# osu-enable Enables the online signup and provisioning. Type: Privileged ruckus(config-identity-provider)# plmns Sets the PLMNs. Sets the realms Type: Privileged ruckus(config-identity-provider)# realms Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 81 Configuration Commands (e-r) identity-provider Table 25 lists the related identity-provider-acct-profile configuration commands. Table 25. Commands related to ruckus(config-identity-provider-acct-profile) Syntax and Type Parameters (if any) Description ruckus(config-identity-provideracct-profile)# default no-match-realm acct Sets the default service. Type: Privileged no-realm acct ruckus(config-identity-provideracct-profile)# description Sets the description Type: Privileged Executes the do command. ruckus(config-identity-provideracct-profile)# do Type: Privileged ruckus(config-identity-provideracct-profile)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-identity-provideracct-profile)# exit Exits from the EXEC. Type: Privileged ruckus(config-identity-provideracct-profile)# help Displays the help. Type: Privileged ruckus(config-identity-provideracct-profile)# no realm Disables the realm command. Sets the accounting service realm. Type: Privileged ruckus(config-identity-provideracct-profile)# realm Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 82 Configuration Commands (e-r) identity-provider Table 26 lists the related identity-provider-acct-profile-realm configuration commands. Table 26. Commands related to ruckus(config-acct-profile-realm) Syntax and Type Parameters (if any) Description ruckus(config-identity-provideracct-profile-realm)# acct-service Sets the accounting service. Type: Privileged ruckus(config-identity-provideracct-profile-realm)# do Executes the do command. Type: Privileged ruckus(config-identity-provideracct-profile-realm)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-identity-provideracct-profile-realm)# exit Exits from the EXEC. Type: Privileged ruckus(config-identity-provideracct-profile-realm)# help Displays the help. Type: Privileged ruckus(config-identity-provideracct-profile-realm)# name Sets the realm name. Sets the accounting service realm. Type: Privileged ruckus(config-identity-provideracct-profile)# realm Type: Privileged Table 27 lists the related identity-provider-auth-profile configuration commands. Table 27. Commands related to ruckus(config-identity-provider-auth-profile) Syntax and Type Parameters (if any) ruckus(config-identity-provider auth-profile)# aaa-interim-acct-interval Description Sets the accounting interim interval for the hosted AAA server. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 83 Configuration Commands (e-r) identity-provider Table 27. Commands related to ruckus(config-identity-provider-auth-profile) Syntax and Type Parameters (if any) Description ruckus(config-identity-providerauth-profile)# aaa-session-idletimeout Sets the idle session timeout for the hosted AAA server. ruckus(config-identity-provider auth-profile)# aaa-session-timeout Sets the session timeout for the hosted AAA server. Type: Privileged Type: Privileged ruckus(config-identity-providerauth-profile)# aaa-support Enables the hosted AAA server support. Type: Privileged ruckus(config-identity-providerauth-profile)# default Type: Privileged no-match-realm acct Sets the default service. - Set to either RADIUS, local-database, na (request rejected) or radius. Set the authentication service name. no-realm acct Sets the default authentication service. ruckus(config-identity-providerauth-profile)# description Sets the description Type: Privileged ruckus(config-identity-providerauth-profile)# do Executes the do command. Type: Privileged ruckus(config-identity-providerauth- profile)# end Type: Privileged ruckus(config-identity-providerauth-profile)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 84 Configuration Commands (e-r) identity-provider Table 27. Commands related to ruckus(config-identity-provider-auth-profile) Syntax and Type Parameters (if any) ruckus(config-identity-providerauth-profile)# help Description Displays the help. Type: Privileged ruckus(config-identity-providerauth-profile)# gpp-support Sets the PLMN identifier. Type: Privileged Disables the commands. ruckus(config-identity-providerauth-profile)# no aaa-support Type: Privileged realm ruckus(config-identity-providerauth-profile)# realm Sets the authentication service realm. Sets the mobile country code. Sets the mobile network code. gpp-support Type: Privileged ruckus(config-identity-providerauth-profile)# sgsn-mcc Type: Privileged ruckus(config-identity-providerauth-profile)# sgsn-mnc Type: Privileged Table 28 lists the related identity-provider-auth-profile-realm configuration commands. Table 28. Commands related to ruckus(config-identity-provider-auth-profile-realm) Syntax and Type Parameters (if any) ruckus(config-identity-providerauth-profile-realm)# auth-method Description Sets the authorization method. Type: Privileged ruckus(config-identity-providerauth-profile-realm)# auth-service Type: Privileged Set to either RA- Sets the authentication service. DIUS, local-database, na (request rejected) or radius. Set the authentication service name. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 85 Configuration Commands (e-r) identity-provider Table 28. Commands related to ruckus(config-identity-provider-auth-profile-realm) Syntax and Type Parameters (if any) ruckus(config-identity-providerauth-profile-realm)# do Description Executes the do command. Type: Privileged ruckus(config-identity-provider auth-profile-realm)# dynamic-vlan Sets the dynamic VLAN ID. Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-identity-providerauth- profile-realm)# end Type: Privileged ruckus(config-identity-providerauth-profile-realm)# exit Exits from the EXEC. Type: Privileged ruckus(config-identity-providerauth-profile-realm)# help Displays the help. Type: Privileged ruckus(config-identity-providerauth-profile-realm)# name Sets the authentication service name. Type: Privileged Table 29 lists the related identity-provider-osu-enable configuration commands. Table 29. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) Description ruckus(config-identity-providerosu-enable)# common-icon Sets the common language icon. Type: Privileged ruckus(config-identity-providerosu-enable)# do Executes the do command. Type: Privileged ruckus(config-identity-providerosu-enable)# end Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Ends the current configuration session and returns to privileged EXEC mode. 86 Configuration Commands (e-r) identity-provider Table 29. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) ruckus(config-identity-providerosu-enable)# exit Description Exits from the EXEC. Type: Privileged ruckus(config-identity-providerosu-enable)# help Displays the help. Type: Privileged ruckus(config-identity-providerosu-enable)# no osu-auth-services Type: Privileged whitelisted-domains ruckus(config-identity-providerosu-enable)# osu-auth-services local Type: Privileged : Authentication services name Disables the commands service-descr Sets the OSU authentication services. local: Local database : Realm server remote remote: Supports only RADIUS service local never local hour - Local credential expiration, between 1 and 175200 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 ...................................continued. 87 Configuration Commands (e-r) identity-provider Table 29. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) ruckus(config-identity-providerosu-enable)# osu-auth-services local Sets the OSU authentication ser day - Local credential expiration, between 1 and 7300 Type: Privileged Description local week - Local credential expiration, between 1 and 1040 local month Local credential expiration - between 1 and 240 ruckus(config-identity-providerosu-enable)# osu-cert ${cert} Sets the OSU certificates. Type: Privileged ruckus(config-identity-providerosu-enable)# osu-nai-realm Sets the OSU NAI realm. Type: Privileged ruckus(config-identity-providerosu-enable)# osu-portal internal Type: Privileged external ruckus(config-identity-providerosu-enable)# provisioning-format r2-r1-zeroit Type: Privileged Sets the provisioning format. r2-r1-zeroit: Hotspot 2.0 R2, Hotspot 2.0 R1 r2-zeroit all ruckus(config-identity-providerosu-enable)# provisioning-protocol oma-dm Type: Privileged soap-xml SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the provisioning protocol. 88 Configuration Commands (e-r) identity-provider Table 29. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) ruckus(config-identity-provider osu-enable)# provisioning-serviceurl Description Sets the provisioning service URL. Type: Privileged ruckus(config-identity-providerhome-only osu-enable)# provisioning-update- home-roaming at any Type: Privileged Sets the provisioning update. ruckus(config-identity-providerosu-enable)# service-descr Sets the subscription description Type: Privileged ruckus(config-identity-provider osu-enable)# whitelisted-domains Sets the whitelisted domains. Type: Privileged Table 30 lists the related identity-provider-realms configuration commands. Table 30. Commands related to ruckus(config-identity-provider-realms) Syntax and Type Parameters (if any) ruckus(config-identity-providerrealms)# do Description Executes the do command. Type: Privileged ruckus(config-identity-providerrealms)# eaps [ #4 | #2 | #3 | #1 ] Type: Privileged #2: EAP method ID #4: EAP method ID Creates or updates the EAP configuration. #3: EAP method ID #1: EAP method ID ruckus(config-identity-providerrealms)# encoding [ rfc-4282 | utf-8 ] Sets the encoding type. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 89 Configuration Commands (e-r) identity-provider Table 30. Commands related to ruckus(config-identity-provider-realms) Syntax and Type Parameters (if any) ruckus(config-identity-providerrealms)# end Description Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-identity-providerrealms)# exit Exits from the EXEC. Type: Privileged Displays the help. ruckus(config-identity-providerrealms)# help Type: Privileged ruckus(config-identity-providerrealms)# name Sets the realm name. eaps Disables the command. Type: Privileged ruckus(config-identity-providerrealms)# no Type: Privileged Table 31 lists the related identity-provider-realms-eaps configuration commands. Table 31. Commands related to ruckus(config-identity-provider-realms-eaps) Syntax and Type Parameters (if any) Description ruckus(config-identity-providerrealms-eaps)# auth [4|1|2|3] Type: Privileged 1: Authentication index Creates or updates the authentication information based on the index. 4: Authentication index 2: Authentication index 3: Authentication index ruckus(config-identity-providerrealms-eaps)# do Executes the do command. Type: Privileged ruckus(config-identity-providerrealms-eaps)# end Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Ends the current configuration session and returns to privileged EXEC mode. 90 Configuration Commands (e-r) identity-provider Table 31. Commands related to ruckus(config-identity-provider-realms-eaps) Syntax and Type Parameters (if any) ruckus(config-identity-providerrealms-eaps)# exit Description Exits from the EXEC. Type: Privileged ruckus(config-identity-providerrealms-eaps)# help Displays the help. Type: Privileged ruckus(config-identity-providerrealms-eaps)# method Type: Privileged [ eap-aka-23 | eap-tls | Sets the EAP method. eap-mschap-v2 | na | eap-aka-50 | md5 | eapttls | reserved | eap-sim | eap-cisco | peap ] eap-aka-23: EAP-AKA eap-tls: EAP-Transport Layer Security (EAP-TLS) eap-mschap-v2: EAPMSCHAP-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) SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 91 Configuration Commands (e-r) identity-provider Table 31. Commands related to ruckus(config-identity-provider-realms-eaps) Syntax and Type Parameters (if any) Description ruckus(config-identity-providerrealms-eaps)# no auth Disables the command. Type: Privileged Table 32 lists the related identity-provider-realms-eaps-auth configuration commands. Table 32. Commands related to ruckus(config-identity-provider-realms-eaps-auth) Syntax and Type Parameters (if any) ruckus(config-identity-providerrealms-eaps-auth)# info tunneled | credential | Sets the authentication parameter non-eap-inner | expand- type. inner-eap | inner-auth-eap | expand-eap ] Type: Privileged Description 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 ruckus(config-identity-providerrealms-eaps-auth)# type Sets the authentication type. Sets the vendor ID. Type: Privileged ruckus(config-identity-providerrealms-eaps-auth)# vendor-id Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 92 Configuration Commands (e-r) interface Table 32. Commands related to ruckus(config-identity-provider-realms-eaps-auth) Syntax and Type Parameters (if any) Description ruckus(config-identity-providerrealms-eaps-auth)# vendor-type Sets the vendor type. Type: Privileged interface To setup the interface configuration, use the following command. ruckus(config)# interface ruckus(config)# interface ruckus(config)# interface > Syntax Description This command has no arguments or keywords. Default cluster cluster: Cluster interface control control: Control interface management management: Management interface mgmt-and-ap-control mgmt-and-ap-control: Management & AP Control ap-tunnel-data ap-tunnel-data: AP Tunnel Data mgmt-or-ap-tunnel mgmt-or-ap-tunnel: Management/AP Tunnel Traffic user-defined user-defined: User defined interface : User defined interface name. Command Mode Config SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 93 Configuration Commands (e-r) interface Example SZ100-Node1(config)# interface ap-tunnel-data AP Tunnel Data mgmt-and-ap-control Management and 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 exit Exit from the EXEC help Display this help message ip Update IP configuration no Disable and delete commands ned UD1 Related Commands • Table 33 lists the related interface-ap-tunnel-data and mgmt-and-ap-control configuration commands. • Table 34 lists the related interface-user-defined configuration commands. • Table 35 lists the related interface-user-defined configuration commands. Table 33 lists the related interface-ap-tunnel-data and mgmt-and-ap-control configuration commands. Table 33. Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-apcontrol) Syntax and Type Parameters (if any) Description ruckus(config-interface)# dataplane forward-stp Updates the data plane configuration Type: Privileged : Data plane name forward-stp: Disables the STP package bridge ruckus(config-interface)# do Executes the do command. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 94 Configuration Commands (e-r) interface Table 33. Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-apcontrol) Syntax and Type Parameters (if any) ruckus(config-interface)# end Description Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-interface)# exit Exits from the EXEC. Type: Privileged Displays help. ruckus(config-interface)# help Type: Privileged ruckus(config-interface)# interface Sets the physical interface. Type: Privileged ruckus(config-interface)# ip address dhcp Type: Privileged address: Sets IP address of interface Sets the IP address. 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 address: Sets IP address of interface : Static IP address : IP Subnet mask : Gateway SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 95 Configuration Commands (e-r) interface Table 33. Commands related to ruckus(config-interface-ap-tunnel-data and mgmt-and-apcontrol) Syntax and Type Parameters (if any) Description ruckus(config-interface)# ip ipv6-address Sets the IP address. Type: Privileged ipv6-address: Sets IPv6 address of interface : Static IPv6 address : Gateway ruckus(config-interface)# no data- plane Disables the data-plane Type: Privileged ruckus(config-interface)# service Sets the service. Type: Privileged ruckus(config-interface)# vlan VLAN ID Sets the VLAN ID. Type: Privileged Table 34 lists the related interface-user-defined configuration commands. Table 34. Commands related to ruckus(config-interface-user-defined) Syntax and Type Parameters (if any) ruckus(config-interface-userdefined)# do Description Executes the do command. Type: Privileged ruckus(config-interface-userdefined)# end Type: Privileged ruckus(config-interface-userdefined)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-interface-userdefined)# help Displays help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 96 Configuration Commands (e-r) interface Table 34. Commands related to ruckus(config-interface-user-defined) Syntax and Type Parameters (if any) Description ruckus(config-interface-userdefined)# interface [ control | management ] Sets the physical interface such as control and management interface. Executed in conjunction with user defined sub command. Type: Privileged ruckus(config-interface-userdefined)# name Renames the user-define interface. Type: Privileged ruckus(config-interface-userdefined)# ip
Sets the IP address for the user defined interface. Sets the service. Type: Privileged ruckus(config-interface-userdefined)# service Type: Privileged ruckus(config-interface-userdefined)# vlan Sets the VLAN ID for the interface. Type: Privileged Table 35 lists the related interface-user-defined configuration commands. Table 35. Commands related to ruckus(config-interface-user-defined) Syntax and Type Parameters (if any) Description ruckus(config-if)# data-plane Type: Privileged Updates the data plane configurations. ruckus(config-if)# do Executes the do command. Type: Privileged ruckus(config-if)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-if)# exit Exits from the EXEC. Type: Privileged ruckus(config-if)# help Displays help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 97 Configuration Commands (e-r) ip Table 35. Commands related to ruckus(config-interface-user-defined) Syntax and Type Parameters (if any) ruckus(config-if)# ip address: Sets IP address Updates the IP address configuration. of interface Type: Privileged Description ipv6-address: Sets the IPv6 address with prefix lengths of interface ruckus(config-if)# no Disables and deletes commands. Type: Privileged 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 98 Configuration Commands (e-r) ip control-nat ip control-nat To set the Control NAT IP address, use the following command. ruckus(config)# ip control-nat Syntax Description This command uses the following syntax: Control NAT IP Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ip control-nat ip name-server To setup the name server configuration, use the following command. ruckus(config)# ip name-server 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 99 Configuration Commands (e-r) ip name-server-ipv6 ip name-server-ipv6 To setup the IPv6 server configuration, use the following command. ruckus(config)# ip name-server 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 ip route To setup the static rule configuration, use the following command. ruckus(config)# ip route Syntax Description This command uses the following syntax: : Destination network IP address : Destination network mask : Next hop IP address : Interface : Distance metric for this route Default This command has no default settings. Command Mode Config SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 100 Configuration Commands (e-r) ip route-ipv6 Example SZ100-Node1(config)# ip route ip 193.12.30.10 255.255.255 10.9.0.254 management ip route-ipv6 To setup the IPv6 static rule configuration, use the following command. ruckus(config)# ip route Syntax Description This command uses the following syntax: : Destination network IPv6 address with prefix length : Next hop IPv6 address : Interface : Distance metric for this route Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ip route-ipv6 193.12.30.10 193.12.30.20 ipsec-profile To create or update IPsec profile configuration, use the following command. ruckus(config)# ipsec-profile Syntax Description This command has the following syntax: : IPsec profile name. Default This command has no default settings. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 101 Configuration Commands (e-r) ipsec-profile Command Mode Config Example SZ100-Node1(config)# ipsec-profile Related Commands Table 36 lists the related ipsec-profile configuration commands Table 36. Commands related to ruckus(config-ipsec-profile). Syntax and Type Parameters (if any) ruckus(config-ipsec-profile)# authtype Description Sets the authentication type Type: Privileged rruckus(config-ipsec-profile)# cara-server Sets Certificate Management Protocol CA/RA address. Type: Privileged ruckus(config-ipsec-profile)# caraserver-path Sets Certificate Management Protocol Server path. Type: Privileged ruckus(config-ipsec-profile)# carasubject-name Sets the Certificate Management Protocol subject name of CA/RA Type: Privileged ruckus(config-ipsec-profile)# cmpdhcp-opt43-subcode Type: Privileged Sets the Certificate Management Protocol DHCP option 43 sub code for the CA/RA address ruckus(config-ipsec-profile)# cmpsubject-name-dhcp-opt43subcode Sets the Certificate Management Protocol DHCP option 43 sub code for subject name of CA/RA Type: Privileged ruckus(config-ipsec-profile)# description Sets the description. Type: Privileged ruckus(config-ipsec-profile)# dhcp-opt43-subcode Sets the DHCP option 43 sub code for Security Gateway. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 102 Configuration Commands (e-r) ipsec-profile Syntax and Type Parameters (if any) ruckus(config-ipsec-profile)# do Description Executes the do command. Type: Privileged Sets the Dead Peer Detection. rruckus(config-ipsec-profile)# dpd-delay Type: Privileged ruckus(config-ipsec-profile)# end End the current configuration session and return to privileged EXEC mode Type: Privileged ruckus(config-ipsec-profile)# esp- [3des | aes256 | aes192 | Add ESP proposal. aes128 | none ] [ md5 | proposal sha512 | sha384 | sha1 | Type: Privileged 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 103 Configuration Commands (e-r) ipsec-profile Syntax and Type Parameters (if any) ruckus(config-ipsec-profile)# esprekeytime Description Sets the ESP Rekey time. Type: Privileged ruckus(config-ipsec-profile)# esptype Set ESP Proposal Type Type: Privileged ruckus(config-ipsec-profile)# exit Exits from the EXEC mode. Type: Privileged ruckus(config-ipsec-profile)# failover-check-interval Sets the Fail Over Checking Interval Type: Privileged ruckus(config-ipsec-profile)# failover-retry-interval Sets the Fail Over Retry Interval Type: Privileged ruckus(config-ipsec-profile)# failover-retry-mode Sets the Fail Over Retry mode. Type: Privileged ruckus(config-ipsec-profile)# failover-retry-period Sets the Fail Over Retry period. Type: Privileged ruckus(config-ipsec-profile)# help Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 104 Configuration Commands (e-r) ipsec-profile Syntax and Type Parameters (if any) ruckus(config-ipsec-profile)# ikeproposal [ 3des | aes256 | aes192 Add IKE proposal. | aes128 ] [ sha1 | md5 | aesxcbc | sha512 | sha384 | sha256 ] [ prfsha1 | prfmd5 |prfsha256 | prfaescmac | prfaesxcbc | prfsha384 | prfsha512 | use-integrityalg ] [ modp1024 | modp8192 |modp6144 | modp768 | modp4096 | modp3072 | modp1536 | modp2048 ] Type: Privileged ruckus(config-ipsec-profile)# ikerekeytime Description Sets the IKE Rekey time. Type: Privileged ruckus(config-ipsec-profile)# iketype Sets the IKE Proposal type. Type: Privileged ruckus(config-ipsec-profile)# ipcompression Enables IP compression. Type: Privileged ruckus(config-ipsec-profile)# ipmode Sets the IP mode. Type: Privileged ruckus(config-ipsec-profile)# keep-alive-interval Sets the NAT-T Keep Alive interval. Type: Privileged ruckus(config-ipsec-profile)# name Sets the IPsec profile name. Type: Privileged ruckus(config-ipsec-profile)# nattraversal Enables force NAT-T. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 105 Configuration Commands (e-r) ipsec-profile Syntax and Type Parameters (if any) Description ruckus(config-ipsec-profile)# no cara-server Disables and deletes commands. Type: Privileged 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 ruckus(config-ipsec-profile)# replay-window Sets the Replay window. Type: Privileged ruckus(config-ipsec-profile)# retrylimit Sets the Retry limit. Type: Privileged ruckus(config-ipsec-profile)# security-gateway Sets the Security gateway. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 106 Configuration Commands (e-r) lbs-service lbs-service To create and update the Location Based Service (LBS) configuration, use the following command. ruckus(config)# lbs-service Syntax Description This command uses the following syntax: name: LBS venue name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# lbs-service LBS venue name SZ100-Node1(config)# lbs-service n3 Related Commands Table 37 lists the related lbs-service configuration command . Table 37. Commands related to ruckus(config-lbs-service) Syntax and Type Parameters (if any) ruckus(config-lbs-service)# do Description Sets the do command. Type: Privileged ruckus(config-lbs-service)# end Type: Privileged Ends the current configuration session and returns to the privileged EXEC mode. ruckus(config-lbs-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-lbs-service)# help Displays the help message. Type: Privileged ruckus(config-lbs-service)# host Type: Privileged - Server IP address SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the server address. 107 Configuration Commands (e-r) ldap-service Table 37. Commands related to ruckus(config-lbs-service) Syntax and Type Parameters (if any) Description ruckus(config-lbs-service)# password Sets the password. Sets the port number. Type: Privileged ruckus(config-lbs-service)# port Type: Privileged ruckus(config-lbs-service)# venue Sets the LBS venue. Type: Privileged ldap-service To create and update the LDAP service configuration, use the following command. ruckus(config)# ldap-service Syntax Description This command uses the following syntax: name: LDAP service name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# ldap-service SZ100-Node1(config-ldap-service)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 108 Configuration Commands (e-r) ldap-service Related Commands Table 38 lists the related ldap-service configuration command . Table 38. Commands related to ruckus(config-ldap-service) Syntax and Type Parameters (if any) ruckus(config-ldap-service)# admin-domain-name LDAP Sets the LDAP administrator admin domain name, To domain name. 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 Type: Privileged ruckus(config-ldap-service)# admin-password Type: Privileged - LDAP server admin password. For example: uid. Description Sets the LDAP administrator password. ruckus(config-ldap-service)# base- LDAP domain-name base domain name. For example: Type: Privileged dc=ldap,dc=com Sets the LDAP base domain name. ruckus(config-ldap-service)# description Sets the description. Type: Privileged ruckus(config-ldap-service)# do Sets the do command. Type: Privileged ruckus(config-ldap-service)# end Type: Privileged Ends the current configuration session and returns to the privileged EXEC mode. ruckus(config-ldap-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-ldap-service)# friendly-name Sets the LDAP service name as seen by the user. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 109 Configuration Commands (e-r) ldap-service Table 38. Commands related to ruckus(config-ldap-service) Syntax and Type Parameters (if any) Description ruckus(config-ldap-service)# group-attrs Sets the user traffic profile mapping. Type: Privileged : Group attribute value : User role ruckus(config-ldap-service)# help Displays the help message. Type: Privileged ruckus(config-ldap-service)# ipaddress Sets the IP address for LDAP server. Type: Privileged ruckus(config-ldap-service)# key- attr For example: uid Type: Privileged Sets the key attribute for LDAP server. ruckus(config-ldap-service)# no group-attrs Disables the command. Sets the port number for LDAP server. Sets the search filter for LDAP server. Type: Privileged ruckus(config-ldap-service)# port Type: Privileged ruckus(config-ldap-service)# search-filter Type: Privileged ruckus(config-ldap-service)# test Type: Privileged For example: (objectClass=Person, show more...) SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Test AAA server. 110 Configuration Commands (e-r) license license To enable the cloud license server, use the following command. ruckus(config)# license cloud ruckus(config)# license import ruckus(config)# license export ruckus(config)# license local ruckus(config)# license sync-now Syntax Description This command uses the following syntax: enable: Enables the cloud license server Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# license cloud Enable Cloud License Server export Export Licenses import Import Licenses local Enable Local License Server, Format: sync-now Sync License with Server SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 111 Configuration Commands (e-r) license cloud license cloud To enable the cloud license server, use the following command. ruckus(config)# license cloud 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 | Syntax Description This command uses the following syntax: ftp-url: License file. FTP URL format is, ftp://:@/ : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 112 Configuration Commands (e-r) license import license import To setup the import licenses, use the following command. ruckus(config)# license import | Syntax Description This command uses the following syntax: ftp-url: License file. FTP URL format is, ftp://:@/ : 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 Syntax Description This command uses the following syntax: : Sets the local license server IP address or the domain name : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 113 Configuration Commands (e-r) license sync-now license sync-now To synchronize licenses, use the following command. ruckus(config)# license sync-now Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# license sync-now lineman To setup the workflow URL, use the following command. ruckus(config)# lineman | Syntax Description This command uses the following syntax: : Uploads the workflow file : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 114 Configuration Commands (e-r) localdb-service localdb-service To create or update the local database service configuration, use the following command. ruckus(config)# localdb-service Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# localdb-service SZ100-Node1(config-localdb-service)# Related Commands Table 39 lists the related localdb-service configuration command . Table 39. Commands related to ruckus(config-localdb-service). Syntax and Type Parameters (if any) Description ruckus(config-localdb-service)# description Sets the description. Type: Privileged ruckus(config-localdb-service)# do Sets the do command Type: Privileged ruckus(config-localdb-service)# end Ends the current configuration session and returns to the privileged EXEC mode. Type: Privileged ruckus(config-localdb-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-localdb-service)# friendly-name Displays the local database server name as seen by the user. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 115 Configuration Commands (e-r) logging console Table 39. Commands related to ruckus(config-localdb-service). Syntax and Type Parameters (if any) Description ruckus(config-localdb-service)# group-attrs Sets the user traffic profile mapping. Type: Privileged : Group attribute value : User role ruckus(config-localdb-service)# help Displays the help message. Type: Privileged logging console To enable service logging on the console, use the following command. ruckus(config)# logging console cli [ error | info ] | cli debug | 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 : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 116 Configuration Commands (e-r) lwapp2scg 2014-11-14 11:17:24,683 wsg.cli[CliSessionTimeout] INFO c.r.w.c.Context[-1] - sleep interrupted 2014-11-14 11:17:24,684 wsg.cli[main] INFO c.r.w.c.g.Shell[-1] Input command: help logging console 2014-11-14 11:17:24,684 wsg.cli[main] INFO c.r.w.c.g.Shell[-1] Executing command (help): com.ruckuswireless.wsg.cli.command.HelpCommand; options: [logging, console] 2014-11-14 11:17:24,687 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-1] - Starting to cache validation status 2014-11-14 11:17:24,689 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-1] - Finished to cache validation status 2014-11-14 11:17:24,690 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-1] - Starting to cache validation status 2014-11-14 11:17:24,700 wsg.cli[main] INFO c.r.w.c.c.CommandOptionsMixin[-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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 117 Configuration Commands (e-r) lwapp2scg Related Commands Table 40 lists the related lwapp2scg configuration command . Table 40. Commands related to ruckus(config-lwapp2scg). Syntax and Type Parameters (if any) Description ruckus(config-lwapp2scg)# acl-ap mac : Sets the Sets the ACL AP. AP MAC address. Use Type: Privileged commas to separate the addresses. For example: 1a:2b:3c:4d:5f:60,11:22: 33:44:55:66 serial : Sets the serial number. Use commas to separate the serial numbers. For example: 123456789012,9876543 21021 ruckus(config-lwapp2scg)# do Sets the do command Type: Privileged ruckus(config-lwapp2scg)# end Type: Privileged Ends the current configuration session and returns to the privileged EXEC mode. ruckus(config-lwapp2scg)# exit Exits from the EXEC. Type: Privileged ruckus(config-lwapp2scg)# help Displays the help message. Type: Privileged NAT IP translation in FTP passive mode. ruckus(config-lwapp2scg)# natIpTranslation Type: Privileged ruckus(config-lwapp2scg)# no acl-ap Type: Privileged natIpTranslation Disables the commands. ruckus(config-lwapp2scg)# pasv- - Sets it to Set the dynamic data transmission minimum and maximum port range to minimum and port port. maximum. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 118 Configuration Commands (e-r) mgmt-acl Table 40. Commands related to ruckus(config-lwapp2scg). Syntax and Type Parameters (if any) Description ruckus(config-lwapp2scg)# policy Accept by ACL Sets the ACL policy. AP list Type: Privileged Accept all Deny by ACL AP list Deny all mgmt-acl To update the Management interface Access Control List (ACL) configuration, use the following command. ruckus(config)# mgmt-acl Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# mgmt-acl Related Commands Table 41 lists the related config-mgmt-acl configuration commands. Table 41. Commands related to ruckus(config-event-email) Syntax and Type Parameters (if any) ruckus(config-mgmt-acl)# enable Description Enables access control of management interface. Type: Privileged ruckus(config-mgmt-acl)# no enable Type: Privileged rule SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Disables the commands. 119 Configuration Commands (e-r) no ad-service Table 41. Commands related to ruckus(config-event-email) Syntax and Type Parameters (if any) Description ruckus(config-mgmt-acl)# rule ACL rule name Create/update management interface ACL rule configuration. Type: Privileged no ad-service To delete the all active service directories, use the following command. ruckus(config)# no ad-service 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 Related Commands Table 42 lists the related config-mgmt-acl configuration commands. Table 42. Commands related to ruckus(config-event-email) Syntax and Type Parameters (if any) ruckus(config-mgmt-acl)# enable Description Enables access control of management interface. Type: Privileged ruckus(config-mgmt-acl)# no enable Type: Privileged rule ruckus(config-mgmt-acl)# rule ACL rule name Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Disables the commands. Create/update management interface ACL rule configuration. 120 Configuration Commands (e-r) no admin no admin To delete the administrator, use the following command. ruckus(config)# no admin 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 121 Configuration Commands (e-r) no ap no ap To delete the lock or unlock the access point, use the following command. ruckus(config)# no ap 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 122 Configuration Commands (e-r) no ap auto-tagging no ap auto-tagging To disable auto tagging of critical access points, use the following command. ruckus(config)# no ap auto-tagging Syntax Description This command uses the following syntax: enable: Disable the auto tagging for critical access point Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no ap-auto-tagging enable 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 123 Configuration Commands (e-r) no ap-control-mgmt-tos no ap-control-mgmt-tos To disable the access point control management traffic type of service, use the following command. ruckus(config)# no ap-control-mgmt-tos Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no ap-control-mgmt-tos no ap-group To disable or delete the AP group, use the following command. ruckus(config)# no ap-group ${apGroupName} | Syntax Description This command uses the following syntax: ap-group ${apGroupName}? ap-group: ${apGroupName}?: : 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 124 Configuration Commands (e-r) no block-client no block-client To delete all blocked clients profiles, use the following command. ruckus(config)# no block-client ${value} Syntax Description This command uses the following syntax: block-client ${value}? : blocked client MAC Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no block-client 84:18:3A:39:C8:50 no bonjour-fencing To delete bonjour fencing settings, use the following command. ruckus(config)# no bonjour-fencing Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no bonjour-fencing no bonjour-fencing-policy To delete bonjour fencing policy settings, use the following command. ruckus(config)# no bonjour-fencing-policy SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 125 Configuration Commands (e-r) no bonjour-gateway Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no bonjour-fencing-policy no bonjour-gateway To disable bonjour gateway settings, use the following command. ruckus(config)# no bonjour-gateway Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no bonjour-gateway SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 126 Configuration Commands (e-r) no bonjour-policy no bonjour-policy To disable bonjour policy, use the following command. ruckus(config)# no bonjour-policy Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no bonjour-policy bonj1 no cert-store To delete all OSU (Online SignUp) portal profile configuration, use the following command. ruckus(config)# no cert-store ruckus(config)# no csr Syntax Description This command uses the following syntax: cert - Deletes certificate csr - 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 127 Configuration Commands (e-r) no control-plane no control-plane To remove the control plane from the cluster configuration, use the following command. ruckus(config)# no control-plane 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 128 Configuration Commands (e-r) no device-policy no device-policy To delete a device policy, use the following command. ruckus(config)# no device-policy Syntax Description This command uses the following syntax: name: device policy name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no device-policy dp1 no diffserv no diffserv To delete the Diffserv profile, use the following command. ruckus(config)# no diffserv ${diffservName}? Syntax Description This command uses the following syntax: $diffservname: diffserv value name: diffserv profile name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no diffserv ds1 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 129 Configuration Commands (e-r) no dns-server-service no dns-server-service To delete all DNS server services, use the following command. ruckus(config)# no dns-server-service Syntax Description This command uses the following syntax: name: DNS server service name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no dns-server-service dns1 no dp-group To disable the data plane grouping, use the following command. ruckus(config)# no dp-group Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no dp-group SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 130 Configuration Commands (e-r) no encrypt-mac-ip no encrypt-mac-ip To disable the encryption of MAC and IP address, use the following command. ruckus(config)# no encrypt-mac-ip Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no encrypt-mac-ip Do you want to continue to disable (or input 'no' to cancel)? [yes/ no] no encrypt-zone-name To disable AP Zone name encryption for Wireless Internet Service Provider roaming (WISPr) enriched URL, use the following command. ruckus(config)# no encrypt-zone-name Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no encrypt-zone-name SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 131 Configuration Commands (e-r) no ethernet-port-profile no ethernet-port-profile To delete Eternet port services, use the following command. ruckus(config)# no ethernet-port-profile Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no ethernet-port-profile et2 no event To disable the trigger to SNMP trap/email configuration, use the following command. ruckus(config)# no event Syntax Description This command uses the following syntax: snmp-trap: Disables the trigger to SNMP trap email: Disables the to trigger email db-persistence: Disables DB persistence for the event Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no event email 305, 214, 11 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 132 Configuration Commands (e-r) no ftp-server no ftp-server To delete FTP server, use the following command. ruckus(config)# no ftp-server Syntax Description This command uses the following syntax: : Name of the FTP server Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no ftp-server ftp1 no guest-access To delete the guest access configuration, use the following command. ruckus(config)# guest-access ${guestAccessName}? | Syntax Description This command uses the following syntax: : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 133 Configuration Commands (e-r) no hotspot no hotspot To delete the hotspot (Wireless Internet Service Provider roaming (WISPr)) configuration, use the following command. ruckus(config)# no hotspot ${hotspotName}? | Syntax Description This command uses the following syntax: hotspot ${hotspotName}? name: Name of the WISPr hotspot profile Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no hotspot htsp1 no hotspot20-venue-profile To delete all hotspot 2.0 venue profile, use the following command. ruckus(config)# no hotspot20-venue-profile ${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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 134 Configuration Commands (e-r) no hotspot20-wlan-profile no hotspot20-wlan-profile To delete all hotspot 2.0 WLAN profile, use the following command. ruckus(config)# no hotspot20-wlan-profile ${name}? | Syntax Description This command uses the following syntax: $name? name: Name of hotspot 2.0 WLAN profile Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no hotspot20-wlan-profile htsp2wl Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no identity-provider To delete all identity provider profile, use the following command. ruckus(config)# no identity-provider | 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 135 Configuration Commands (e-r) no interface no interface To disable an interface configuration, use the following command. ruckus(config)# no interface > 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 | routeipv6 | name-server secondary| separate-access-core enable Syntax Description This command uses the following syntax: route: Deletes static routes route route: Deletes static routes : Destination network IP address : Destination network mask : Next hop IP address : Interface route-ipv6 route-ipv6: Delete IPv6 static routes : Destination network IPv6 address SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 136 Configuration Commands (e-r) no ipsec-profile : Next hop IPv6 address : 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 255.255.255 10.9.0.254 management no ipsec-profile To delete all IPsec profiles, use the following command. ruckus(config)# no ipsec-profile Syntax Description This command uses the following syntax: : IPsec profile name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no ipsec-profile xyz SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 137 Configuration Commands (e-r) no l2-acl no l2-acl To disables the layer 2 Access Control List (ACL) configuration, use the following command. ruckus(config)# no l2-acl Syntax Description This command uses the following syntax: : 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 Syntax Description This command uses the following syntax: : 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 138 Configuration Commands (e-r) no ldap-service no ldap-service To delete all LDAP service, use the following command. ruckus(config)# no ldap-service Syntax Description This command uses the following syntax: : 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 Syntax Description This command uses the following syntax: : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 139 Configuration Commands (e-r) no logging no logging To disable service logging settings, use the following command. ruckus(config)# no logging 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 oauth-service To disable the all OAuth servers, use the following command. ruckus(config)# no oauth-service Syntax Description This command uses the following syntax: : 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 140 Configuration Commands (e-r) no operator-profile no operator-profile To disable all WiFi operator profile settings, use the following command. ruckus(config)# no operator-profile | Syntax Description This command uses the following syntax: operator-profile ${name}? : Operator name Default This command has no default settings. Command Mode Config Example SZ100-Node1# no operator-profile ops2 Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no osu-portal-profile To disable all OSU portal profile settings, use the following command. ruckus(config)# no osu-portal Syntax Description This command uses the following syntax: osu-portal ${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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 141 Configuration Commands (e-r) no outbound firewall no outbound firewall To disable the outbound firewall, use the following command. ruckus(config)# no outbound firewall Syntax Description This command has no keywords or arguments. Default This command has no default settings. Command Mode Privileged Example SZ100-Node1(config)# no outbound firewall no proxy-aaa To disable the proxy AAA server settings, use the following command. ruckus(config)# no proxy-aaa Syntax Description This command uses the following syntax: : 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 142 Configuration Commands (e-r) no role 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 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 sci-profile To delete an sci-profile, use the following command. ruckus(config)# no sci-profile Syntax Description This command has no keywords or arguments. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 143 Configuration Commands (e-r) no snmp-notification Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no sci-profile Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no snmp-notification To disable SNMP notification, use the following command. ruckus(config)# no snmp-notification Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no snmp-notification 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 Syntax Description This command uses the following syntax: community: Community name Default This command has no default settings. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 144 Configuration Commands (e-r) no snmp-v2-community 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 145 Configuration Commands (e-r) no snmp-v3-user no snmp-v3-user To delete SNMPv3 user configuration, use the following command. ruckus(config)# no snmp-v3-user 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 snmp-v2-community To delete SNMPv2 community, use the following command. ruckus(config)# no snmp-v2-community Syntax Description This command uses the following syntax: community: Community name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)#snmpno snmp-v2-community cm2 Do you want to continue to delete (or input 'no' to cancel)? [yes/no] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 146 Configuration Commands (e-r) no snmp-v3-user no snmp-v3-user To delete SNMPv3 user configuration, use the following command. ruckus(config)# no snmp-v3-user 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 Syntax Description This command uses the following syntax: : Subscription packages name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no subpackages abcd SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 147 Configuration Commands (e-r) no user-agent-blacklist no user-agent-blacklist To delete the user agent blacklisted, use the following command. ruckus(config)# no user-agent-blacklist Syntax Description This command uses the following syntax: name: Name of the user agent which is blacklisted Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no user-agent-blacklist userb1 Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no user-group To delete a user group, use the following command. ruckus(config)# no user-group Syntax Description This command uses the following syntax: group: user group name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no user-group Do you want to continue to delete (or input 'no' to cancel)? [yes/no] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 148 Configuration Commands (e-r) no user-role no user-role To delete all users except the default user, use the following command. ruckus(config)# no user-role Syntax Description This command uses the following syntax: name: Name of the user role Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no user-role userr1 Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no user-traffic-profile To delete all users traffic profiles, use the following command. ruckus(config)# no user-traffic-profile 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 149 Configuration Commands (e-r) no vlan-pooling no vlan-pooling To delete all VLAN pooling profiles, use the following command. ruckus(config)# no vlan-pooling | Syntax Description This command uses the following syntax: vlan-pooling ${vlanPoolingName}? name: Name of the VLAN pooling profile Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no vlan-pooling vlanservice1 Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no web-authentication To delete all web authentication, use the following command. ruckus(config)# no web-authentication ${webAuthenticationName}?| 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 150 Configuration Commands (e-r) no wlan no wlan To delete all WLAN, use the following command. ruckus(config)# no wlan ${wlanName}?| Syntax Description This command uses the following syntax: name: WLAN name wlan ${wlanName}? Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no wlan Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no wlan-group To delete all WLAN group, use the following command. ruckus(config)# no wlan-group ${wlanGroupName}?| 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] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 151 Configuration Commands (e-r) no wlan-scheduler no wlan-scheduler To delete all WLAN group, use the following command. ruckus(config)# no wlan-scheduler ${wlanSchedulerName}? Syntax Description This command uses the following syntax: wlan-scheduler ${wlanSchedulerName}? Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no wlan-scheduler Do you want to continue to delete (or input 'no' to cancel)? [yes/no] no zone To delete all zones except the stagging zone, use the following command. ruckus(config)# no zone Syntax Description This command uses the following syntax: Need Input Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# no zone Do you want to continue to delete (or input 'no' to cancel)? [yes/no] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 152 Configuration Commands (e-r) northbound-authtype northbound-authtype Sets the RADIUS authentication type to northbound portal interface, use the following command. ruckus(config)# northbound-authtype | 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)# northbound-portal 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! SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 153 Configuration Commands (e-r) ntp-server ntp-server To update the NTP server configuration, use the following command. ruckus(config)# 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 oauth-service To create or update OAuth service configuration, use the following command. ruckus(config)# oauth-service 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)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 154 Configuration Commands (e-r) oauth-service Related Commands Table 43 lists the related oauth-service configuration commands. Table 43. Commands related ruckus(config-oauth-service) Syntax and Type Parameters (if any) Description ruckus(config-oauth-service)# app-id Sets the application ID. Sets the application secret name. Type: Privileged ruckus(config-oauth-service)# app-secret Type: Privileged ruckus(config-oauth-service)# collect-email Enables collecting email addresses. Type: Privileged ruckus(config-oauth-service)# description Sets the description. Type: Privileged ruckus(config-oauth-service)# do Executes the do command. Type: Privileged ruckus(config-oauth-service)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-oauth-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-oauth-service)# group-attrs Sets the user traffic profile mapping. Type: Privileged ruckus(config-oauth-service)# help Displays the help. Type: Privileged ruckus(config-oauth-service)# name Sets the OAuth service name. ruckus(config-oauth-service)# no collect-email Disables commands. Type: Privileged whitelisted-domain Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 155 Configuration Commands (e-r) operator-profile Table 43. Commands related ruckus(config-oauth-service) Syntax and Type Parameters (if any) ruckus(config-oauth-service)# type [ linkedin | facebook | google ] Type: Privileged ruckus(config-oauth-service)# whitelisted-domains Description Sets the OAuth provider type. Sets the whitelisted domains. Type: Privileged operator-profile To create or update WiFi operator profile configuration, use the following command. ruckus(config)# operator-profile Syntax Description This command uses the following syntax: name: Operator profile name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# operator-profile orangewifi SZ100-Node1(config-operator-profile)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 156 Configuration Commands (e-r) operator-profile Related Commands Table 44 lists the related operator-profile configuration commands. Table 44. Commands related ruckus(config-operator-profile) Syntax and Type Parameters (if any) Description ruckus(config-operator-profile)# description Sets the description. Type: Privileged ruckus(config-operator-profile)# do Executes the do command. Type: Privileged ruckus(config-operator-profile)# domain-names Sets the domain name. Type: Privileged ruckus(config-operator-profile)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-operator-profile)# exit Exits from the EXEC. Type: Privileged ruckus(config-operator-profile)# friendly-names Sets the friendly name as seen by the end user. Type: Privileged ruckus(config-operator-profile)# help Displays the help. Type: Privileged ruckus(config-operator-profile)# name Sets the WiFi operator profile name. Type: Privileged ruckus(config-operator-profile)# no domain-names Type: Privileged Disables commands. friendly-names signup-security ruckus(config-operator-profile)# osen-cert ${cert} Uploads the operator certificate. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 157 Configuration Commands (e-r) outbound-firewall Table 44. Commands related ruckus(config-operator-profile) Syntax and Type Parameters (if any) ruckus(config-operator-profile)# signup-security Description Enables OSEN (Support for Anonymous Authentication) Type: Privileged 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 158 Configuration Commands (e-r) outbound-firewall Related Commands Table 45 lists the related outbound-firewall configuration commands. Table 45. Commands related ruckus(config-outbound-firewall) Syntax and Type Parameters (if any) ruckus(config-outbound-firewall)# enable Description Allow the outbound traffic. Type: Privileged ruckus(config-outbound-firewall)# out [ udp | Allow IP tables profile. ip-rule sctp | tcp ] [ dport | sport ] Type: Privileged : profile name out: Output traffic udp: UDP sctp: SCTP tcp: TCP dport: Destination port sport: Source port : port out [ udp | sctp | tcp ] [ sport | dport ] [ src | dst ] : profile name out: Output traffic udp: UDP sctp: SCTP tcp: TCP sport: Source port dport: Destination port : port src: Source dst: Destination : IP address SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 159 Configuration Commands (e-r) proxy-aaa Table 45. Commands related ruckus(config-outbound-firewall) Syntax and Type Parameters (if any) ruckus(config-outbound-firewall)# Profile no ip-rule Name Description Remove IP rule. Type: Privileged proxy-aaa To create or update the proxy AAA server configuration settings, use the following command. ruckus(config)# proxy-aaa Syntax Description This command uses the following syntax: : 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)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 160 Configuration Commands (e-r) proxy-aaa Related Commands Table 46 lists the related proxy-aaa configuration commands. Table 46. Commands related ruckus(config-proxy-aaa) Syntax and Type Parameters (if any) ruckus(config-proxy-aaa)# autofallback-disable Description Disables the auto fallback. Type: Privileged ruckus(config-proxy-aaa)# backup ip : Sets the IP address of secondary Type: Privileged RADIUS server Enables backup of the RADIUS support. port : Sets the port of secondary RADIUS server shared-secret: Sets the shared secret of secondary RADIUS server ruckus(config-proxy-aaa)# description Sets the description. Type: Privileged ruckus(config-proxy-aaa)# do Executes the do command. Type: Privileged ruckus(config-proxy-aaa)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-proxy-aaa)# exit Exits from the EXEC. Type: Privileged ruckus(config-proxy-aaa)# friendly- name Sets the RADIUS server friendly name. Type: Privileged ruckus(config-proxy-aaa)# group- attrs Sets the user traffic profile mapping. Type: Privileged ruckus(config-proxy-aaa)# help Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 161 Configuration Commands (e-r) proxy-aaa Table 46. Commands related ruckus(config-proxy-aaa) Syntax and Type Parameters (if any) Description ruckus(config-proxy-aaa)# ip Sets the IP addresses of the primary RADIUS server. Type: Privileged [ <0 or 10-4096>] Maximum outstanding requests per server Sets the maximum outstanding requests per server. ruckus(config-proxy-aaa)# no auto-fallback-disable Disables various commands. Type: Privileged backup Type: Privileged ruckus(config-proxy-aaa)# mor no group-attrs no-response-fail out-of-band ruckus(config-proxy-aaa)# out-ofband Enables RFC5580 out of band location delivery for Ruckus AP. Type: Privileged ruckus(config-proxy-aaa)# name Sets the RADIUS server name. Type: Privileged ruckus(config-aaa)# port Sets the port number of the primary RADIUS server. Sets the response window. Type: Privileged ruckus(config-proxy-aaa)# response-window Type: Privileged ruckus(config-proxy-aaa)# revive- interval Sets the revive interval. Type: Privileged ruckus(config-proxy-aaa)# sanity- timer Sets the sanity timer. Type: Privileged Sets the shared secret of the primary RADIUS server. ruckus(config-proxy-aaa)# sharedsecret Type: Privileged ruckus(config-proxy-aaa)# test Type: Privileged [PAP | CHAP] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the RADIUS server using login credentials. 162 Configuration Commands (e-r) rebalance-aps Table 46. Commands related ruckus(config-proxy-aaa) Syntax and Type Parameters (if any) ruckus(config-proxy-aaa)# threshold [ <10-90 %> ] Percentage Sets the percentage of maximum of maximum number of number of outstanding requests. outstanding requests. Type: Privileged ruckus(config-proxy-aaa# type Type: Privileged [ radius | radius-acct | LDAP | AD ] Description Sets the RADIUS type. radius: RADIUS type radius-acct: RADIUS accounting type LDAP: LDAP AD: Active Directory ruckus(config-proxy-aaa)# zombie-period Sets the zombie period. Type: Privileged rebalance-aps To execute control plane and data plane loading and rebalancing, use the following command. ruckus(config)# rebalance-aps Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# rebalance-aps SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 163 Configuration Commands (e-r) report report To create or update the report configurations, use the following command. ruckus(config)# report 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 47 lists the related report configuration command. Table 47. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) ruckus(config-report)# csv-format Description Type: Privileged Sets the output of the report in CSV format. ruckus(config-report)# description <text> Sets the description. Type: Privileged ruckus(config-report)# do Executes the do command. Type: Privileged ruckus(config-report)# email <email> Sets the email notification. Type: Privileged ruckus(config-report)# enableexport Enables the export report results to the FTP server. Type: Privileged ruckus(config-report)# end Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Ends the current configuration session and returns to privileged EXEC mode. 164 Configuration Commands (e-r) report Table 47. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) ruckus(config-report)# exit Description Exits from the EXEC. Type: Privileged ruckus(config-report)# export Type: Privileged <ftp-url> - FTP URL format Sets the export report results to FTP server. is: ftp:// <username>:<password> @<ftp-host>[/<dir-path>] ruckus(config-report)# export-test Tests the FTP server. Type: Privileged ruckus(config-report)# help Displays the help. Type: Privileged ruckus(config-report)# no csv-format Type: Privileged email Disables and deletes commands. enable export export pdf-format resource-filter schedule ruckus(config-report)# pdf-format Sets the outputs of the report in a PDF format. Type: Privileged ruckus(config-report)# resourcefilter ggsn <ggsn-ip> Type: Privileged radio ${value} Sets the resource filter criteria. ssid <ssid> device plane <name> device domain <name> device zone <name> device ap <name> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 165 Configuration Commands (e-r) report Table 47. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) ruckus(config-report)# schedule monthly <date-of-month> Sets the schedule. hour <hour> minute <minute> Type: Privileged Description weekly <date-of-week> hour <hour> minute <minute> daily <hour> minute <minute> hourly <minute> ruckus(config-report)# time-filter Type: Privileged monthly months <months> Sets the time filter. daily days <days> hourly days <days> hourly hours <hours> 15min hours <hours> 5min hours <hours> time-period hours <hours> ruckus(config-report)# title <title> Sets the report title. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 166 Configuration Commands (e-r) report Table 47. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) Description ruckus(config-report)# type <client-number> Sets the report type. Type: Privileged < client-number-vs-airtime> <continuouslydisconnected-aps> <failed-clientassociations> <new-clientassociations> <system-resourceutilization> <tx-rx-bytes> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 167 Configuration Commands (e-r) rks-gre rks-gre To create or update the Ruckus GRE, use the following command. ruckus(config)# rks-gre <name> Syntax Description This command uses the following syntax: name: Ruckus GRE name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# rks-gre ruckusgre1 Related Commands Table 48 lists the related role configuration commands. Table 48. Commands related to ruckus (config-rks-gre) Syntax and Type Parameters (if any) Description ruckus(config-rks-gre)# description <description> Sets the description for teh Ruckus GRE. Type: Privileged ruckus(config-rks-gre)# do Executes the do command. Type: Privileged ruckus(config-rks-gre)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-rks-gre)# exit Exits from the EXEC. Type: Privileged ruckus(config-rks-gre)# gatewaymtu Sets the WAN Interface MTU. Type: Privileged ruckus(config-rks-gre)# help Displays this help message. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 168 Configuration Commands (e-r) role Table 48. Commands related to ruckus (config-rks-gre) Syntax and Type Parameters (if any) Description ruckus(config-rks-gre)# name <name> Sets Ruckus GRE profile name. Type: Privileged ruckus(config-rks-gre)# no Type: Privileged ruckus(config-rks-gre)# tunnelencryption Disables and deletes the commands. Enables tunnel encryptions. Type: Privileged ruckus(config-rks-gre)# tunnelmode Sets Ruckus tunnel modes. Type: Privileged 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 169 Configuration Commands (e-r) role Related Commands Table 48 lists the related role configuration commands. Table 49. Commands related to ruckus(config-role) Syntax and Type Parameters (if any) Description ruckus(config-role)# capabilities administration Sets the capabilities details. Type: Privileged configuration device monitor reports <capabilities-depth-1> ruckus(config-role)# description <text> Type: Privileged Sets the description for the assigned role. ruckus(config-role)# do Executes the do command. Type: Privileged ruckus(config-role)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-role)# exit Exits from the EXEC. Type: Privileged ruckus(config-role)# help Displays the help. Type: Privileged ruckus(config-role)# no administration Type: Privileged configuration Disables the capabilities assigned. device monitor reports <capabilities-depth-1> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 170 Configuration Commands (s-z) 4 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.sms-server NOTE: For easy access and reading, the configuration chapter has been split into 3 chapters based on the alphabetical order of commands. Table 50. Configuration commands sci-profile sci-setting sms-server snmp-v2community snmp-v3-user soft-gre subpackages support-admin syslog-server user-agentblacklist user-group user-role vlan-pooling zone zone-template SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 smtp-server snmp-notification user-traffic-profile 171 Configuration Commands (s-z) sci-profile sci-profile To configure an SCI profile, use the following command. ruckus(config)# sci-setting Syntax Description This command has the following syntax: <name>: The SCI profile name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# sci-profile SZ100-Node1(config-sci-profile)# Related Commands Table 51 lists the related sci-profile configuration commands. Table 51. Commands related to ruckus(config-sci-profile) Syntax and Type Parameters (if any) ruckus(config-sci-profile)# Description Enables the do command. do Type: Privileged Type: Privileged Ends the current configuration session and return to privileged EXEC mode. ruckus(config-sci-profile)# Exits from the EXEC. ruckus(config-sci-profile)# end exit Type: Privileged ruckus(config-sci-profile)# Display this help message. help Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 172 Configuration Commands (s-z) sci-profile Table 51. Commands related to ruckus(config-sci-profile) Syntax and Type Parameters (if any) Description ruckus(config-sci-profile)# <host> Sets the host. <name> Sets the SCI profile name. <password> Sets password. <port> Sets the port. <system-id> Sets the system ID. <user> Sets user. host Type: Privileged ruckus(config-sci-profile)# name Type: Privileged ruckus(config-sci-profile)# password Type: Privileged ruckus(config-sci-profile)# port Type: Privileged ruckus(config-sci-profile)# system-id Type: Privileged ruckus(config-sci-profile)# user Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 173 Configuration Commands (s-z) sci-setting sci-setting To enable SCI settings, use the following command. ruckus(config)# sci-setting Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# sci-setting ruckus(config-sci-setting)# Related Commands Table 52 lists the related sci-setting configuration commands. Table 52. Commands related to ruckus(config-sci-setting) Syntax and Type Parameters (if any) ruckus(config-sci-setting)# do Description Enables the do command. Type: Privileged ruckus(config-sci-setting)# enable Enables the SCI server. Type: Privileged ruckus(config-sci-setting)# end Type: Privileged Ends the current configuration session and return to privileged EXEC mode. ruckus(config-sci-setting)# exit Exits from the EXEC. Type: Privileged ruckus(config-sci-setting)# help Displays this help message. Type: Privileged ruckus(config-sci-setting)# no <enable> Disables SCI server commands. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 174 Configuration Commands (s-z) sms-server sms-server To enable SMS server configurations, use the following command. ruckus(config)# sms-server <personalname> Syntax Description This command has the following syntax: <personalname>: Set personal name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# sms-server Related Commands Table 53 lists the related sms-server configuration commands. Table 53. Commands related to ruckus(config-sms-server) Syntax and Type Parameters (if any) Description ruckus(config-sms-server)# account-sid <sid> Sets the account SID, which is a 34 character string that uniquely identifies this account. The enable commands set this command. <token> Type: Privileged Sets the authorization token identifier. The enable commands set this command. ruckus(config-sms-server)# do Executes the do command. Type: Privileged ruckus(config-sms-server)# authtoken Type: Privileged ruckus(config-sms-server)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-sms-server)# exit Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 175 Configuration Commands (s-z) smtp-server Table 53. Commands related to ruckus(config-sms-server) Syntax and Type Parameters (if any) ruckus(config-sms-server)# enable Description Enables the SMS server. Type: Privileged ruckus(config-sms-server)# from <from> Sets the sender’s mail address. Type: Privileged ruckus(config-sms-server)# help Displays the help. Type: Privileged ruckus(config-sms-server)# no enable Disables the SMS server. Type: Privileged ruckus(config-sms-server)# server- <server-name> name Sets the server name. Type: Privileged 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 176 Configuration Commands (s-z) smtp-server Related Commands Table 54 lists the related smtp-server configuration commands. Table 54. Commands related to ruckus(config-smtp-server) Syntax and Type Parameters (if any) ruckus(config-smtp-server)# do Description Executes the do command. Type: Privileged ruckus(config-smtp-server)# enable Enables the SMTP server. Type: Privileged ruckus(config-smtp-server)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(diagnostic)# exit Exits from the EXEC. Type: Privileged ruckus(config-smtp-server)# from <mail> Sets the sender’s mail address. Type: Privileged ruckus(config-smtp-server)# help Displays the help. Type: Privileged ruckus(config-smtp-server)# host <host> Type: Privileged ruckus(config-smtp-server)# no Type: Privileged enable: Disables SMTP Server Sets the SMTP server IP address or domain name. Disables TLS or STARTTLS encryption commands. password: Removes password start-tls: Disables STARTTLS encryption tls: Disables TLS encryption username: Removes the username ruckus(config-smtp-server)# password <password> Sets the password. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 177 Configuration Commands (s-z) smtp-server Table 54. Commands related to ruckus(config-smtp-server) Syntax and Type Parameters (if any) Description ruckus(config-smtp-server)# personalname <personalname> Sets the name from the display name. <port> Sets the port number. Type: Privileged ruckus(config-smtp-server)# port Type: Privileged ruckus(config-smtp-server)# starttls Enables STARTTLS encryption. The TLS commands set this command. Type: Privileged ruckus(config-smtp-server)# test Type: Privileged Tests the SMTP settings. The TLS commands set this command. ruckus(config-smtp-server)# tls Enables TLS encryption. Type: Privileged ruckus(config-smtp-server)# to <mail> Sets the receiver’s email address. <username> Sets the logon name. Type: Privileged ruckus(config-smtp-server)# username Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 178 Configuration Commands (s-z) snmp-notification snmp-notification To enable SNMP notification, use the following command. ruckus(config)# snmp-notification Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# snmp-notification 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 179 Configuration Commands (s-z) snmp-v2-community Related Commands Table 55 lists the related snmp-v2-community configuration commands. . Table 55. Commands related to ruckus(config-snmp-v2-community) Syntax and Type Parameters (if any) ruckus(config-snmp-v2community)# do Description Executes the do command. Type: Privileged ruckus(config-snmp-v2community)# end Ends the current configuration session and return to privileged EXEC mode. Type: Privileged ruckus(config-snmp-v2community)# exit Exits from the EXEC. Type: Privileged ruckus(config-snmp-v2community)# help Displays the help. Type: Privileged ruckus(config-snmp-v2community)# no notification: Disables notification privileges Type: Privileged notification-target: Deletes the notification target Disables various options read: Disables read privilege write: Disables write privilege Enables notification privilege. To get notification-target and notification-type, you need to execute this command first. ruckus(config-snmp-v2community)# notification Type: Privileged ruckus(config-snmp-v2community)# notification-target <ip> Adding the notification target IP address. <inform> <trap> Set the notification type by setting a trap or through information. Type: Privileged ruckus(config-snmp-v2community)# notification-type Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 180 Configuration Commands (s-z) snmp-v3-user Table 55. Commands related to ruckus(config-snmp-v2-community) Syntax and Type Parameters (if any) ruckus(config-snmp-v2community)# read Description Enables read privileges Type: Privileged ruckus(config-snmp-v2community)# write Enables write privileges Type: Privileged 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)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 181 Configuration Commands (s-z) snmp-v3-user Related Commands Table 56 lists the related snmp-v3-user configuration commands. . Table 56. Commands related to ruckus(config-snmp-v3-user) Syntax and Type Parameters (if any) Description ruckus(config-snmp-v3-user)# auth none Sets SNMPv3 user authentication. Type: Privileged md5 <auth-password> sha <auth-password> ruckus(config-snmp-v3-user)# do Executes the do command. Type: Privileged ruckus(config-snmp-v3-user)# end Type: Privileged Ends the current configuration session and return to privileged EXEC mode. ruckus(config-snmp-v3-user)# exit Exits from the EXEC. Type: Privileged ruckus(config-snmp-v3-user)# help Displays the help. Type: Privileged ruckus(config-snmp-v3-user)# no notification: Disables notification privileges Type: Privileged Disables various options notification-target: Deletes the notification target read: Disables read privileges write: Disables write privileges ruckus(config-snmp-v3-user)# notification Enables notification privilege. To get notification-target and notification-type, you need to execute this command first. Type: Privileged ruckus(config-snmp-v3-user)# notification-target <ip> Adding the notification target IP address. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 182 Configuration Commands (s-z) soft-gre Table 56. Commands related to ruckus(config-snmp-v3-user) Syntax and Type Parameters (if any) Description ruckus(config-snmp-v3-user)# notification-type <inform> <trap> Set the notification type by setting a trap or through information. Type: Privileged ruckus(config-snmp-v3-user)# read Enables read privileges Type: Privileged ruckus(config-snmp-v3-user)# write Enables write privileges Type: Privileged soft-gre To configure soft GRE, use the following command. Syntax Description This command has the following syntax: <name>: soft GRE name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# soft-gre SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 183 Configuration Commands (s-z) soft-gre Related Commands Table 53 lists the related sci-profile configuration commands. Table 57. Commands related to ruckus (config-soft-gre) Syntax and Type Parameters (if any) ruckus(config-soft-gre)# description Description Sets the description. Type: Privileged Set Soft GRE Name Disable SoftGRE Settings ruckus(config-soft-gre)# device-ipmode Sets Gateway IP mode. Type: Privileged ruckus(config-soft-gre)# do Executes the do command. Type: Privileged ruckus(config-soft-gre)# end Type: Privileged End the current configuration session and return to privileged EXEC mode. ruckus(config-soft-gre)# exit Exits from the EXEC. Type: Privileged ruckus(config-soft-gre)# forcedisassociate-client Forces Disassociate clients. Type: Privileged ruckus(config-soft-gre)# gateway Sets the gateway address. Type: Privileged ruckus(config-soft-gre)# gatewaymtu Sets the gateway path MTU. Type: Privileged ruckus(config-soft-gre)# help Displays this help message. Type: Privileged ruckus(config-soft-gre)# icmpperiod Sets the ICMP keepalive period. Type: Privileged ruckus(config-soft-gre)# icmp-retry Sets the ICMP keepalive retry. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 184 Configuration Commands (s-z) soft-gre Table 57. Commands related to ruckus (config-soft-gre) Syntax and Type Parameters (if any) ruckus(config-soft-gre)# name Description Sets the soft GRE name. Type: Privileged ruckus(config-soft-gre)# no Disables the softGRE settings. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 185 Configuration Commands (s-z) subpackages subpackages To create and update the configuration of subscription packages, use the following command. ruckus(config)# subpackages <name> Syntax Description This command has the following keywords: <name>: Package Name Default This command has no default settings. Command Mode Config ExampleSZ100-Node1(config)# subpackages abcd12 Related Commands Table 58 lists the related event-email configuration commands. Table 58. Commands related to ruckus(config-subpackages) Syntax and Type Parameters (if any) Description ruckus(config-subpackages)# description <description> Sets the description. Type: Privileged ruckus(config-subpackages)# expiration-interval [ week | hour | year | never Sets the expiration interval. | month | day] Type: Privileged week: Set Week hour: Set Hour year: Set Year never: Never month: Set Month day: Set Day ruckus(config-subpackages)# expiration-value <expiration-value> Sets the expiration value. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 186 Configuration Commands (s-z) support-admin support-admin To support administrator configuration, use the following command. ruckus(config)# support-admin Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# support-admin Related Commands Table 60 lists the relate support-admin configuration commands. . Table 59. Commands related to ruckus(config-support-admin Syntax and Type Parameters (if any) ruckus(config-support-admin)# changepassword Description Change the password. Type: Privileged ruckus(config-support-admin)# do Executes the do command. Type: Privileged ruckus(config-support-admin)# enable Unlocks the support administrator. Type: Privileged ruckus(config-support-admin)# end Type: Privileged ruckus(config-support-admin)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 187 Configuration Commands (s-z) syslog-server Table 59. Commands related to ruckus(config-support-admin Syntax and Type Parameters (if any) ruckus(config-support-admin)# help Description Displays the help. Type: Privileged ruckus(config-support-admin)# no enable Type: Privileged Disables the support administrator. 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 60 lists the relate syslog-server configuration commands. . Table 60. Commands related to ruckus(config-syslog-server) Syntax and Type Parameters (if any) ruckus(config-syslog-server)# appfacility [ Local2 | Local7 | Local0 | Remote syslog server to send the Local6 | Local4 | Local5 | application log files. Local3 | Local1 ] Type: Privileged ruckus(config-syslog-server)# auditfaciility Type: Privileged Description [ Local6 | Local4 | Local2 | Remote syslog server to send the Local3 | Local0 | Local5 | audit log files. Local7 | Local1 ] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 188 Configuration Commands (s-z) syslog-server Table 60. Commands related to ruckus(config-syslog-server) Syntax and Type Parameters (if any) ruckus(config-syslog-server)# do Description Executes the do command. Type: Privileged Enables sending events to the remote syslog server. ruckus(config-syslog-server)# enable Type: Privileged ruckus(config-syslog-server)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-syslog-server)# eventfacility Type: Privileged [ Local7 | Local6 | Local3 | Remote syslog server to send the Local4 | Local0 | Local2 | event log files. Local1 | Local5 ] ruckus(config-syslog-server)# exit Exits from the EXEC. Type: Privileged ruckus(config-syslog-server)# filter [ severity | exclude-client | Sets the settings for filtering events. all ] Type: Privileged severity: All events above a severity exclude-client: All events except client associate/ disassociate events all: All events ruckus(config-syslog-server)# filter-severity [ Critical | Warning | Major Sets the event severity filter settings. | Info | Debug | Minor ] Type: Privileged ruckus(config-syslog-server)# help Displays the help. Type: Privileged ruckus(config-syslog-server)# host <ip> Sets the syslog server IP address. Type: Privileged ruckus(config-syslog-server)# no <enable> Type: Privileged secondary-host ruckus(config-syslog-server)# ping Disables the settings and commands. Pings the syslog server. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 189 Configuration Commands (s-z) syslog-server Table 60. Commands related to ruckus(config-syslog-server) Syntax and Type Parameters (if any) ruckus(config-syslog-server)# pingsecondary Description Pings the secondary syslog server. Type: Privileged ruckus(config-syslog-server)# port <port> Sets the syslog server port. Type: Privileged ruckus(config-syslog-server)# priority Type: Privileged [ Minor | Critical | Debug | Sets the priority for events. The Info | Warning | Major ] [ event severity and syslog-severity Debug | Warning | Info | is based on priority. Error ] Sets the protocol for the primary syslog server ruckus(config-syslog-server)# protocol [ udp | tcp ] Type: Privileged tcp: TCP protocol ruckus(config-syslog-server)# redundancy-mode [Primary/Backup | Active/ Set forwarding syslog server mode. Active] udp: UDP protocol Type: Privileged ruckus(config-syslog-server)# secondary-host <ip> IP address Sets the secondary syslog server IP. <port> Sets the secondary syslog server port. ruckus(config-syslog-server)# secondary-protocol [ tcp | udp ] Sets the protocol for the secondary syslog server. Type: Privileged udp: UDP protocol Type: Privileged ruckus(config-syslog-server)# secondary-port Type: Privileged tcp: TCP protocol SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 190 Configuration Commands (s-z) user-agent-blacklist user-agent-blacklist To create and update the user agent blacklisted configuration, use the following command. ruckus(config)# user-agent-blacklist <name> Syntax Description This command uses the following syntax: name: Name of the user agent blacklisted Default This command has no default settings. Command Mode Config Example SZ100(config)# user-agent-blacklist user-agent-blacklist SZ100(config-user-agent-blacklist)# Related Commands Table 61 lists the related user-agent-blacklist configuration commands. Table 61. Commands related to ruckus(config-user-agent-blacklist) Syntax and Type Parameters (if any) ruckus(config-user-agentblacklist)# do Description Sets the do command. Type: Privileged ruckus(config-user-agentblacklist)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-user-agentblacklist)# error <error> Sets the error code between 400 and 599. <error message> Sets the error message. Type: Privileged ruckus(config-user-agentblacklist)# error-message Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 191 Configuration Commands (s-z) user-agent-blacklist Table 61. Commands related to ruckus(config-user-agent-blacklist) Syntax and Type Parameters (if any) ruckus(config-user-agentblacklist)# exit Description Exits from the EXEC. Type: Privileged ruckus(config-user-agentblacklist)# help Displays the help. Type: Privileged ruckus(config-user-agentblacklist)# name <name> Sets the user agent name who is blacklisted. <pattern> Sets the user agent pattern Type: Privileged ruckus(config-user-agentblacklist)# pattern Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 192 Configuration Commands (s-z) user-group user-group To create and update the user group, use the following command. ruckus(config)# user-group <name> Syntax Description This command uses the following syntax: <name>: User group name. Default This command has no default settings. Command Mode Config Example SZ100(config)# user-group ag1 SZ100(config-user-group)# Related Commands Table 62 lists the related ruckus(config-user-group) configuration commands. Table 62. Commands related to user-group Syntax and Type Parameters (if any) Description ruckus(config)# user-group <group> Sets the user group name. Type: Privileged ruckus(config-user-group)# do Executes the do command. Type: Privileged ruckus(config-user-group)# end Type: Privileged Ends the current configuration session and return to privileged EXEC mode. ruckus(config-user-group)# exit Type: Privileged Exits from the EXEC. ruckus(config-user-group)# help Type: Privileged Displays help. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 193 Configuration Commands (s-z) user-role Table 62. Commands related to user-group Syntax and Type Parameters (if any) ruckus(config-user-group)# name Description Sets user group name. Type: Privileged ruckus(config-user-group)# no Type: Privileged <user> ruckus(config-user-group)# permission Deletes the user. Sets permission. Type: Privileged ruckus(config-user-group)# user Sets user. Type: Privileged 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-admin SZ100-Node1(config-user-role)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 194 Configuration Commands (s-z) user-role Related Commands Table 63 lists the related user-role configuration commands. Table 63. Commands related to ruckus(config-user-role) Syntax and Type Parameters (if any) Description ruckus(config-user-role)# allowwlan-type <all>: Allows Zero IT access to all WLANs Sets the allowed resources. Type: Privileged zones - Allows Zero IT access to all WLANs in the selected zones <wlans>: Allows Zero IT access to selected WLANs ruckus(config-user-role)# description <description> Sets the description. Type: Privileged ruckus(config-user-role)# do Sets the do command. Type: Privileged ruckus(config-user-role)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-user-role)# exit Exits from the EXEC. Type: Privileged ruckus(config-user-role)# help Displays the help. Type: Privileged ruckus(config-user-role)# maxdevices <number> - Allows max Sets the number for maximum devices value devices allowed (1-10). Type: Privileged unlimited - Unlimited devices value ruckus(config-user-role)# no description Type: Privileged user-traffic-profile Disables the override on the specified settings. ruckus(config-user-role)# usertraffic-profile <user-traffic-profile> Sets the user traffic profile. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 195 Configuration Commands (s-z) user-traffic-profile user-traffic-profile To create and update the user traffic profile configuration, use the following command. ruckus(config)# user-traffic-profile <name> Syntax Description This command uses the following syntax: name: Name of the user traffic profile Default This command has no default settings. Command Mode Config Example SZ100-Node1(config-user-traffic-profile)# SZ100-Node1(config-user-traffic-profile)# Related Commands • Table 64 lists the related user-traffic-profile configuration commands. • Table 65 lists the related user-traffic-profile-acl configuration commands. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 196 Configuration Commands (s-z) user-traffic-profile Table 64 lists the related user-traffic-profile configuration commands. Table 64. Commands related to (config-user-traffic-profile) Syntax and Type Parameters (if any) ruckus(config-user-traffic-profile)# ${value} acl Description Sets the network access control list. Type: Privileged ruckus(config-user-traffic-profile)# default-action <default-action> Sets the default action. Type: Privileged ruckus(config-user-traffic-profile)# <description> description Sets the description. Type: Privileged ruckus(config-user-traffic-profile)# do Sets the do command. Type: Privileged ruckus(config-user-traffic-profile)# downlink Sets the downlink rate limit in mbps. Type: Privileged ruckus(config-user-traffic-profile)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-user-traffic-profile)# exit Exits from the EXEC. Type: Privileged Displays the help. ruckus(config-user-traffic-profile)# help Type: Privileged ruckus(config-user-traffic-profile)# name <name> Sets the number for maximum devices allowed. Type: Privileged ruckus(config-user-traffic-profile)# acl no downlink Type: Privileged uplink SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Disables various commands. 197 Configuration Commands (s-z) user-traffic-profile Table 64. Commands related to (config-user-traffic-profile) Syntax and Type Parameters (if any) ruckus(config-user-traffic-profile)# uplink Description Sets the uplink rate limit in mbps. Type: Privileged Table 65 lists the related user-traffic-profile-acl configuration commands. Table 65. Commands related to ruckus(config-user-traffic-profile-acl) Syntax and Type Parameters (if any) Description ruckus(config-user-traffic-profileacl)# action ${value} Sets the handling action. <description> Sets the description. Type: Privileged ruckus(config-user-traffic-profileacl)# description Type: Privileged ruckus(config-user-traffic-profileacl)# destination-ip Type: Privileged network [ <Network Sets the destination IP address. Address> ] subnet-mask <subnet-mask> - Sets the destination subnet host [ <Host IP Address> ] - Sets the destination host ruckus(config-user-traffic-profileacl)# destination-port Type: Privileged [ <Port Number> ] - Sets the destination port number Sets the destination port number. range [ <Port Number> ] [ <Port Number> ] - Sets the destination port range ruckus(config-user-traffic-profileacl)# direction ${value} Sets the traffic direction. Type: Privileged ruckus(config-user-traffic-profileacl)# do Sets the do command. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 198 Configuration Commands (s-z) user-traffic-profile Table 65. Commands related to ruckus(config-user-traffic-profile-acl) Syntax and Type Parameters (if any) ruckus(config-user-traffic-profileacl)# end Description Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-user-traffic-profileacl)# exit Exits from the EXEC. Type: Privileged Displays the help. ruckus(config-user-traffic-profileacl)# help Type: Privileged ruckus(config-user-traffic-profileacl)# protocol Type: Privileged ruckus(config-user-traffic-profileacl)# source-ip Type: Privileged <protocol number> Value Sets the protocol. should be in the range of 1 to 255 network [ <Network Sets the matching source IP Address> ] subnet-mask address. <subnet-mask> - Sets the source subnet host [ <Host IP Address> ] - Sets the source host ruckus(config-user-traffic-profileacl)# source-port Type: Privileged [ <Port Number> ] - Sets Sets the source port number. the destination port number range [ <Port Number> ] [ <Port Number> ] - Sets the destination port range SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 199 Configuration Commands (s-z) vlan-pooling vlan-pooling To create or update the VLAN pooling profile configurations, use the following command. ruckus(config)# vlan-pooling <name> Syntax Description This command uses the following syntax: name: Web authentication name Default This command has no default settings. Command Mode Config Example SZ100-Node1(config)# vlan-pooling vlanorange SZ100-Node1(config-vlan-pooling)# Related Commands Table 66 lists the related vlan-pooling configuration commands. Table 66. Commands related to ruckus (config-vlan-pooling) Syntax and Type Parameters (if any) ruckus(config-vlan-pooling)# algo <mac-hash> Description Sets the algorithm, Type: Privileged ruckus(config-vlan-pooling)# description <text> Sets the description. Type: Privileged ruckus(config-vlan-pooling)# do Sets the do command. Type: Privileged ruckus(config-vlan-pooling)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-vlan-pooling# exit Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 200 Configuration Commands (s-z) zone Table 66. Commands related to ruckus (config-vlan-pooling) Syntax and Type Parameters (if any) ruckus(config-vlan-pooling)# help Description Displays the help. Type: Privileged <name> Sets the VLAN pooling name. ruckus(config-vlan-pooling)# no description Disables the commands. Type: Privileged pooling ruckus(config-vlan-pooling)# name Type: Privileged ruckus(config-vlan-pooling)# pool- range <start-value> <end- Adds the VLAN pooling. ing value> Type: Privileged single <value> zone To create or update the AP zone configurations, use the following command. ruckus(config)# zone Syntax Description This command uses the following syntax: <name>: AP zone name <name> template <name> <name>: AP zone name template: Creates a AP zone from the template <name>: Name of the zone template <name> clone <name> <name>: AP zone name clone: Creates a clone AP zone from an existing AP zone <name>: Name of the zone template <name> ap-firmware <ap-firmware> <name>: AP zone name ap-firmware: Changes the AP firmware <ap-firmware>: Version of the AP firmware <name> cluster-switch-over <name> <name>: AP zone name SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 201 Configuration Commands (s-z) zone cluster-switch-over: Enables the cluster switchover <name>: Cluster redundancy name <name> template-apply <name> <name>: AP zone name template-apply: Apply the zone template <name>: Zone template name <name> trigger-prefer-node <name>: AP zone name trigger-prefer-node: Apply the trigger preference for the node Default This command has no default settings. Command Mode Config Example ruckus(config)# zone indus3-ap3 Related Commands • Table 67 lists the related zone configuration commands. • Table 68 lists the related zone-aaa configuration commands. • Table 69 lists the related zone-ap-group configuration commands. • Table 70 lists the related zone-ap-group-lldp configuration commands. • Table 71 lists the related zone-ap-group-lldp configuration commands. • Table 72 lists the related zone-ap-group-port-setting configuration commands. • Table 73 lists the commands related zone-ap-model configuration commands. • Table 74 lists the related zone-ap-model-lan1 configuration commands. • Table 75 lists the related zone-ap-registration-rule configuration commands. • Table 76 lists the related zone-ap-snmp-options configuration commands. • Table 77 lists the related zone-ap-snmp-options-snmp-v2-community configuration commands. • Table 78 lists the related config-zone-ap-snmp-options-snmp-v3-user configuration commands. • Table 79 lists the related zone-block-client configuration commands. • Table 80 lists the related zone-bonjour-fencing-policy configuration commands. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 202 Configuration Commands (s-z) zone • Table 81 lists the related zone-bonjour-policy configuration commands. • Table 82 lists the related zone-bonjour-policy-rule configuration commands. • Table 83 lists the related zone-client-isolation-whitelist configuration commands. • Table 84 lists the related zone-device-policy configuration commands. • Table 85 lists the related zone-device-policy-policy-rule configuration commands. • Table 86 lists the related zone-diffserv configuration commands. • Table 87 lists the related config-zone-ethernet-port-profile configuration commands. • Table 88 lists the related guest access configuration commands. • Table 89 lists the related zone-hotspot configuration commands. • Table 90 lists the related zone-hotspot20-venue-profile configuration commands. • Table 91 lists the related zone-hotspot20-wlan-profile configuration commands. • Table 92 lists the related zone-hotspot20-wlan-profile cust-connect-capabilities configuration commands. • Table 93 lists the related zone-l2-acl configuration commands. • Table 94 lists the related zone-web-authentication configuration commands. • Table 95 lists the related zone-weçhat configuration commands. • Table 96 lists the related zone-wlan configuration commands. • Table 97 lists the related zone-wlan-qos-map configuration commands.. • Table 98 lists the related zone-wlan-group configuration commands. • Table 99 lists the related zone-wlan-scheduler configuration commands. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 203 Configuration Commands (s-z) zone Table 67 lists the related zone configuration commands. Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# aaa <name> Creates or updates the AAA server configuration. ruckus(config-zone)# adjthreshold 2.4g ${value} Sets the adjacent radio threshold of the client load balancing. Type: Privileged Value is minimum = 1 and maximum = 100 ruckus(config-zone)# apfirmware <ap-firmware> Type: Privileged 5g ${value} Sets the AP firmware version. Type: Privileged ruckus(config-zone)# ap-group <name> Type: Privileged ruckus(config-zone)# ap-ipmode [ ipv4 | ipv6 | dual] Creates or updates the AP group configuration. Sets the AP IP mode to either IPv4 or IPv6 version. Type: Privileged ruckus(config-zone)# ap-logon <logon-id> Type: Privileged Sets the login ID for the AP administrator. ruckus(config-zone)# ap-mgmt- <vlanTag>: VLAN Tag (1vlan 4094); enter ‘keep’to keep APs setting Type: Privileged Sets AP management VLAN. ruckus(config-zone)# ap-model <name> Sets the AP model name. Type: Privileged ruckus(config-zone)# appassword Sets the password for the AP administrator. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 204 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# apreboot-timeout default-gateway [ <hours and minutes> ] Sets the AP reboot timeout. Type: Privileged default-gateway: Sets the default gateway timeout in hours and minutes. control-interface <hours> Sets the control interface timeout in hours. ruckus(config-zone)# apregistration-rule <priority> Creates or updates the AP registration rule configuration. Type: Privileged ruckus(config-zone)# ap-snmpoptions Sets the AP SNMP options. Type: Privileged ruckus(config-zone)# background-scan 2.4g <seconds> Sets the background scanning. 5g <seconds> Type: Privileged ruckus(config-zone)# bandbalancing 2.4g <int> 2.4g Sets the band balance. Type: Privileged <int>: Percentage of clients on 2.4G band ruckus(config-zone)# blockclient <mac> Sets to block the client by specifying the MAC address. <name>: Bonjour fencing policy name to apply Enables bonjour fencing policy. <name>: Bonjour fencing policy name Creates or updates the bonjour fencing policy. 2.4G band Type: Privileged ruckus(config-zone)# bonjourfencing Type: Privileged ruckus(config-zone)# bonjourfencing-policy Type: Privileged ruckus(config-zone)# bonjourgateway Enables the bonjour gateway. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 205 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# bonjourpolicy <name> Creates or updates the bonjour policy. ruckus(config-zone)# channel 2.4g <channel> Sets the channel. Type: Privileged 5g indoor <channel> Type: Privileged 5g outdoor <channel> ruckus(config-zone)# channelevaluation-interval Sets the channel evaluation interval. Type: Privileged ruckus(config-zone)# channelrange • 2.4g [ <channels | all> ] Type: Privileged <channels | all>: Channels (ex: 1,2,3,4,5 or all) Sets the channel range. 2.4g: 2.4 GHz radio • 5g indoor [ <channels | all> ] 5g: 5 GHz radio indoor: indoor <channels | all>: Channels (ex: 36,40,44 or all) • 5g outdoor [ <channels | all> ] 5g: 5 GHz radio outdoor: outdoor <channels | all>: Channels (ex: 149,153,161 or all) ruckus(config-zone)# channelselect-mode Selects the channel. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 206 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# channelfly-mtbc • 2.4g <number> Sets MTBC value of ChannelFly. Type: Privileged <number>: MTBC value (Range: 100~1440) 2.4g: 2.4 GHz radio • 5g <number> 5g: 5 GHz radio <number>:MTBC value (Range: 100~1440) ruckus(config-zone)# channelization 2.4g [ 20 | 40 ] Sets the channelization. 5g [ 40 | 20 ] Type: Privileged ruckus(config-zone)# clientadmission-control 2.4g Type: Privileged 2.4g minClientCount <minClientCount> 5g Enables the client admission control. 2.4g maxRadioLoad <maxRadioLoad> 2.4g minClientThroughput <minClientThroughput>5g minClientCount <minClientCount> 5g maxRadioLoad <maxRadioLoad> 5g minClientThroughput <minClientThroughput> ruckus(config-zone)# clientisolation-whitelist <name>: Client isolation whitelist name Creates or updates the client isolation whitelist. <country-code> Sets the country code. Type: Privileged ruckus(config-zone)# countrycode Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 207 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# description <text> Sets the description, <name> Sets the device policy. Type: Privileged ruckus(config-zone)# devicepolicy Type: Privileged Sets the DFS channels for the US country code. ruckus(config-zone)# dfschannel Type: Privileged ruckus(config-zone)# diffserv <name> Type: Privileged Creates or updates the diff server profile. ruckus(config-zone)# do Executes the do command. Type: Privileged ruckus(config-zone)# dosprotection <dosBarringPeriod>: DoS protection period Type: Privileged <dosBarringThreshold>: DoS protection threshold Enables DoS (Denial-of-service) protection. <dosBarringCheckPeriod>: DoS protection checkperiod ruckus(config-zone)# end Type: Privileged Ends the current configuration session and return to privileged EXEC mode. ruckus(config-zone)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone)# ethernet- <name>: Ethernet Port port-profile Profile name Sets the Ethernet Port profile. Type: Privileged ruckus(config-zone)# gps <latitude> <longitude> Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 208 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# gpsaltitude <altitude> [ floor | meters ] Sets the GPS altitude. Type: Privileged floor altitude value meters ruckus(config-zone)# guestaccess <name> Sets the guest access. Type: Privileged ruckus(config-zone)# help Sets the GPS coordinates. Type: Privileged ruckus(config-zone)# headroom 2.4g <client> 5g <client> 2.4g: 2.4 GHz radio 5g: 5 GHz radio Sets the headroom (# of clients) of client load balancing. You need to access the load-balancing submenu first for this command to work. <client>: Number of clients ruckus(config-zone)# hotspot <name> Creates or updates the hotspot (WISPr) configuration. <name> Creates or updates the venue profile for hotspot release 2 configuration. <name> Creates or updates the WLAN profile for hotspot release 2 configuration. Type: Privileged ruckus(config-zone)# hotspot20-venue-profile Type: Privileged ruckus(config-zone)# hotspot20-wlan-profile Type: Privileged ruckus(config-zone)# indoorchannel Enables the indoor channels. Type: Privileged ruckus(config-zone)# ipsectunnel-profile $<ipsec-profile-name> Sets the IPsec Tunnel profile. <name> Sets the layer 2 access control list. Type: Privileged ruckus(config-zone)# l2-acl Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 209 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) ruckus(config-zone)# lbs Description Enables the location based service. Type: Privileged Sets the location based service. ruckus(config-zone)# lbsservice Type: Privileged ruckus(config-zone)# location Sets the location. Type: Privileged ruckus(config-zone)# locationadditional-info <text> Sets the additional information location. Type: Privileged ruckus(config-zone)# mesh Enables mesh networking. Type: Privileged ruckus(config-zone)# meshname <name> Sets the mesh name (ESSID). <mesh-passphrase> Sets the mesh passphrase. domain <name> Moves the zone to another domain. <name> Sets the AP zone name. Type: Privileged ruckus(config-zone)# meshpassphrase Type: Privileged ruckus(config-zone)# move Type: Privileged ruckus(config-zone)# name Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 210 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# no aaa <name> Type: Privileged ap-group <name> Disables and deletes command configuration. ap-registration-rule <priority> ap-snmp-options background-scan <2.4g> <5g> band-balancing block-client bonjour-fencing bonjour-fencing-policy bonjour-gateway bonjour-policy channel-select-mode client-admission-control client-isolation-whitelist description device-policy diffserv dos-protection dfs-channel ethernet-port-profile SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 ..................................continued 211 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# no gps Type: Privileged gps-altitude Disables and deletes command configuration. guest-access hotspot <name> hotspot20-venue-profile <name> hotspot20-wlan-profile <name> indoor-channel l2-acl lbs load-balancing location location-additional-info mesh roam smart-mon smart-roam-disconnectevent syslog-enabled timezone-dst venue-code venue-profile vlan-overlapping web-authentication wechat wlan <name> wlan-group <name> wlan-scheduler <name> ruckus(config-zone)# roam 2.4g Type: Privileged 5g SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the smart roam 212 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# rogue-ap- enable | disable ] - Enables or Sets the report rogue access point. detection disables malicious rogue devices which have same Type: Privileged network report-all [ disable | enable ] : Sets to report all rogue devices report-only-malicious [ enable | disable ] - Reports only malicious rogue device type. report-ssid-spoofing [ disable | enable ] - Reports only malicious rogue devices of SSID spoofing. ....................................continue ruckus(config-zone)# rogue-ap- report-same-network [ Sets the report rogue access detection enable | disable ] - Reports point. only malicious rogue devices Type: Privileged of the same network. report-mac-spoofing [ disable | enable ] - Enables or disables malicious rogue devices which have MAC IP address spoofing protect-from-malicious [ disable | enable ] - Enables or disables the network from malicious rogue access points ruckus(config-zone)# smartmon interval <between 5-60> Sets the smart monitor interval. threshold <between 1-10 Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 213 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) ruckus(config-zone)# smartroam-disconnect-event Description Enables smart roam disconnect event. Type: Privileged ruckus(config-zone)# syslogenabled Enables the external syslog server for APs in this zone. Type: Privileged ruckus(config-zone)# syslogfacility Type: Privileged [ Local6 | Keep Original | Local0 | Local5 | Local7 | Local1 | Local4 | Local3 | Local2 ] ruckus(config-zone)# syslog-ip <ip> Sets the syslog server facility, Sets the syslog server IP address. Type: Privileged ruckus(config-zone)# syslog-ip6 <ipv6> Type: Privileged ruckus(config-zone)# syslogport <port> Sets the IPv6 address for the syslog server. Sets the syslog server port. Type: Privileged ruckus(config-zone)# syslogpriority Type: Privileged [ Alert | Info | Critical | Warning Sets the syslog server priority. | Notice | Emergency | All | Error ] ruckus(config-zone)# timezone System - Follows the Sets the timezone for zone. controller time zone setting Type: Privileged 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) ruckus(config-zone)# timezone- [ <Start | End> ] <order> dst <weekday> <month> <hour> Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the user defined timezone for daylight savings. 214 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# timezone- [ <hour | hour: minute>] For Sets the user defined timezone for GMT offset. gmt-offset example, 8, -7:45 Type: Privileged ruckus(config-zone)# tunnelprofile <profile-name> Sets the AP GRE tunnel profile. [ gre | gre-udp ] Sets the tunnel type. Type: Privileged ruckus(config-zone)# tunneltype Type: Privileged ruckus(config-zone)# tx-power 2.4g ${value} Type: Privileged Sets the TX power adjustment. 5g ${value} Value is minimum = 1 and maximum = 100 ruckus(config-zone)# venuecode <code> Sets the venue code. <name> Sets the venue profile. Type: Privileged ruckus(config-zone)# venueprofile Type: Privileged ruckus(config-zone)# vlanoverlapping Enables the overlapping of VLAN pooling. Type: Privileged ruckus(config-zone)# weakbypass 2.4g ${threshold} Type: Privileged Value is minimum = 1 and maximum = 100 ruckus(config-zone)# webauthentication <name> Sets the web authentication. <name>: WeChat name Creates/updates WeChat configuration. 5g ${threshold} Sets the weak bypass threshold of the client load balancing. Type: Privileged ruckus(config-zone)# wechat Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 215 Configuration Commands (s-z) zone Table 67. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# wlan <name> Creates or updates the WLAN configuration. <name> Creates or updates the WLAN group configuration. <name> Creates or updates the WLAN scheduler configuration. Type: Privileged ruckus(config-zone)# wlangroup Type: Privileged ruckus(config-zone)# wlanscheduler Type: Privileged Table 68 lists the related zone-aaa configuration commands. Table 68. Commands related ruckus(config-zone-aaa) Syntax and Type Parameters (if any) ruckus(config-zone-aaa)# admindomain <admin-domain>: Admin Enables the admin domain name. domain name, example: admin@domain.ruckuswi reless.com Type: Privileged ruckus(config-zone-aaa)# admindomain-name Type: Privileged ruckus(config-zone-aaa)# adminpassword Description <admin-domain> - Admin Creates or updates the admin domain name, To query domain. multiple organizational units, enter an admin domain name and password with full search and read privileges.(example: uid=admin,dc=ldap,dc=c om) <admin-password> Creates or updates the admin password. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 216 Configuration Commands (s-z) zone Table 68. Commands related ruckus(config-zone-aaa) Syntax and Type Parameters (if any) ruckus(config-zone-aaa)# backup ip <ip> Type: Privileged ipv6 <ipv6> Description Enables backup of RADIUS support and set related settings. port <port> shared-secret <sharedsecret> ruckus(config-zone-aaa)# basedomain <base-domain> Set the base domain. <description> Sets the description. Type: Privileged ruckus(config-zone-aaa)# description Type: Privileged ruckus(config-zone-aaa)# do Executes the do command. Type: Privileged ruckus(config-zone-aaa)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-zone-aaa)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-aaa)# globalcatalog Enables the global catalog support. Type: Privileged ruckus(config-zone-aaa)# help Displays the help. Type: Privileged ruckus(config-zone-aaa)# ip <ip> Set IP addresses of primary RADIUS server. <ipv6> Set IPv6 addresses of primary RADIUS server. <key-attribute> Sets the key attributes for the primary RADIUS server. Type: Privileged ruckus(config-zone-aaa)# ip6 Type: Privileged ruckus(config-zone-aaa)# keyattribute Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 217 Configuration Commands (s-z) zone Table 68. Commands related ruckus(config-zone-aaa) Syntax and Type Parameters (if any) Description ruckus(config-zone-aaa)# no backup Type: Privileged global-catalog Disables or deletes configuration settings. ruckus(config-zone-aaa)# password <password> Sets the password for the primary RADIUS server. <port> Sets the port number of the primary RADIUS server. Type: Privileged ruckus(config-zone-aaa)# port Type: Privileged ruckus(config-zone-aaa)# search- <search-filter> filter Sets the search filter. Type: Privileged ruckus(config-zone-aaa)# shared- <shared-secret> secret Sets the shared secret of the primary RADIUS server. Type: Privileged ruckus(config-zone-aaa)# test Type: Privileged <username> <password> Tests the connectivity of the AAA server using protocol settings. [PAP | CHAP] ruckus(config-zone-aaa)# testacct Tests the accounting server. Type: Privileged ruckus(config-zone-aaa)# type Type: Privileged ruckus(config-zone-aaa)# windows-domain [ radius | radius-acct | LDAP | AD ] Sets the RADIUS type. <windows-domain> Sets the windows domain name. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 218 Configuration Commands (s-z) zone Table 69 lists the related zone-ap-group configuration commands. Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) ruckus(config-zone-ap-group)# ap-snmp-options Description Enables AP SNMP options. Type: Privileged ruckus(config-zone-ap-group)# channel 2.4g ${value} Type: Privileged 5g outdoor ${value} ruckus(config-zone-ap-group)# channel-evaluation-interval <seconds> The interval value (Range: 60~3600 secs) Type: Privileged Sets the channel. 5g indoor ${value} Sets the channel evaluation interval. ruckus(config-zone-ap-group)# channel-range • 2.4g [ <channels | all> ] Sets the channel range. Type: Privileged <channels | all>: Channels (ex: 1,2,3,4,5 or all) 2.4g: 2.4 GHz radio • 5g indoor [ <channels | all> ] 5g: 5 GHz radio indoor: indoor <channels | all>: Channels (ex: 36,40,44 or all) • 5g outdoor [ <channels | all> ] 5g: 5 GHz radio outdoor: outdoor <channels | all>: Channels (ex: 149,153,161 or all) ruckus(config-zone-ap-group)# channel-select-mode Selects the channel. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 219 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# channelfly-mtbc • 2.4g <number> Sets MTBC value of ChannelFly. Type: Privileged <number>:MTBC value (Range: 100~1440) 2.4g: 2.4 GHz radio • 5g <number> 5g: 5 GHz radio <number>:MTBC value (Range: 100~1440) ruckus(config-zone-ap-group)# channelization 2.4g [ 20 | 40 ] Sets the channelization. 5g [ 40 | 20 ] Type: Privileged ruckus(config-zone-ap-group)# client-admission-control 2.4g Type: Privileged 2.4g minClientCount <minClientCount> 5g Enables the client admission control. 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: ..................continued 20) SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 220 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# client-admission-control 5g maxRadioLoad <maxRadioLoad> Enables the client admission control. Type: Privileged Max Radio Load (Default: 75%) 5g minClientThroughput <minClientThroughput> Min Client Throughput (Default: 0.0Mbps) ruckus(config-zone-ap-group)# description <text> Sets the description. Type: Privileged ruckus(config-zone-ap-group)# do Executes the do command. Type: Privileged ruckus(config-zone-ap-group)# end Type: Privileged ruckus(config-zone-ap-group)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 221 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# external-antenna <ap-model> 5g [ disable | Sets the external antenna for enable ] specific AP model. Type: Privileged <ap-model> 5g gain <gain> <ap-model> 2.4g gain <gain> <ap-model> 2.4g [ enable | disable ] <ap-model> gain <gain> <ap-model> [ disable | enable ] <ap-model> 2.4g [ 3antennas | 2-antennas ] <ap-model> 5g [ 3antennas | 2-antennas ] ruckus(config-zone-ap-group)# gps <latitude> <longitude> Displays the help. Type: Privileged ruckus(config-zone-ap-group)# gps-altitude <altitude> [ floor | meters ] Sets the GPS altitude. Type: Privileged ruckus(config-zone-ap-group)# help Displays the help. Type: Privileged ruckus(config-zone-ap-group)# internal-heater <ap-model> [ enable | disable ] Sets the internal heater for specific AP model. Type: Privileged ruckus(config-zone-ap-group)# lbs Enables the location based service. Type: Privileged ruckus(config-zone-ap-group)# lbs-service Sets the location based service. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 222 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# led-mode <ap-model> Sets the LED mode for specific AP model. <ap-model> [ enable | disable ] Sets the LLDP for a specific AP model. Type: Privileged ruckus(config-zone-ap-group)# lldp Type: Privileged Sets the location. ruckus(config-zone-ap-group)# location Type: Privileged ruckus(config-zone-ap-group)# location-additional-info <text> Sets the additional information location. add <ap-mac> Sets the AP group member. move-to <apgroupname> <ap-mac> It adds a new access point to current AP group. remove <mac> The AP Mac address removes the access point from the current AP group and moves it to other AP group. Type: Privileged ruckus(config-zone-ap-group)# member Type: Privileged ruckus(config-zone-ap-group)# no channel 2.4g Type: Privileged channel 5g indoor Disables / deletes the configuration settings. channel 5g outdoor channel-evaluationinterval channel-range channel-select-mode client-admission-control channelization 2.4g channelization 5g client-admission-control description external-antenna <apmodel> 5g SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 ..................continued 223 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) ruckus(config-zone-ap-group)# no external-antenna <apmodel> 2.4g Type: Privileged Description Disables / deletes the configuration settings. gps gps-altitude internal heater lbs led-mode lldp location location-additional-info override-ap-mgmt-vlan override-ap-snmpoptions override-channel-selectmode override-clientadmission-control override-lbs override-venue-code override-zone-location override-zone-locationadditional-info poe-operating-mode poe-out port-setting radio-band secondary-channel status-leds tx-power 2.4g tx-power 5g SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 224 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) ruckus(config-zone-ap-group)# no usb-port Type: Privileged usb-software Description Disables / deletes the configuration settings. venue-profile wlan-group 2.4g wlan-group 5g ruckus(config-zone-ap-group)# override-ap-mgmt-vlan <vlanTag>: VLAN tag Overrides the AP Management VLAN. Type: Privileged ruckus(config-zone-ap-group)# override-ap-snmp-options Overrides the AP SNMP options. Type: Privileged ruckus(config-zone-ap-group)# override-channel-select-mode 2.4g 5g Overrides auto channel selection mode and ChannelFly MTBC. Type: Privileged ruckus(config-zone-ap-group)# override-client-admission-control 2.4g 5g Overrides the client admission control settings. Type: Privileged ruckus(config-zone-ap-group)# override-lbs Overrides the location based service to zone settings. Type: Privileged ruckus(config-zone-ap-group)# override-venue-code Overrides the venue code. Type: Privileged ruckus(config-zone-ap-group)# override-zone-location Overrides the zone location setting. Type: Privileged ruckus(config-zone-ap-group)# override-zone-location-additionalinfo Overrides the zone location additional information setting Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 225 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# poe-operating-mode <ap-model>: AP model name Switch the PoE Operating Mode for a specific AP model. <ap-model> [ enable | disable ] Sets the PoE out port for a specific AP model. <ap-model> Sets the port settings for specific AP model. <ap-model> [ 2.4g | 5g ] Switches the radio band for a specific AP model. 5g indoor [ <secondary channel> ] Sets the secondary channel. Type: Privileged ruckus(config-zone-ap-group)# poe-out Type: Privileged ruckus(config-zone-ap-group)# port-setting Type: Privileged ruckus(config-zone-ap-group)# radio-band Type: Privileged ruckus(config-zone-ap-group)# secondary-channel Type: Privileged 5g outdoor [ <secondary channel> ] ruckus(config-zone-ap-group)# status-leds <ap-model> [ enable | disable ] Sets the status LED for specific AP model. Type: Privileged ruckus(config-zone-ap-group)# tx- 2.4g ${value} power Sets the TX power adjustment. Type: Privileged 5g ${value} ruckus(config-zone-ap-group)# usb-port <ap-model> [ enable | disable ] Enables USB port. <ap-model> <name> Sets the AP USB software package for a specific AP model. Type: Privileged ruckus(config-zone-ap-group)# usb-software Type: Privileged ruckus(config-zone-ap-group)# venue-code Sets the venue code. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 226 Configuration Commands (s-z) zone Table 69. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# venue-profile <name> Sets the venue profile 2.4g Sets the WLAN group configurations. Type: Privileged ruckus(config-zone-ap-group)# wlan-group 5g Type: Privileged Table 70 lists the related zone-ap-group-lldp configuration commands. Table 70. Commands related to ruckus(config-zone-ap-group-lldp configuration) Syntax and Type Parameters (if any) ruckus(config-zone-ap-grouplldp)# do Description Executes the do command. Type: Privileged ruckus(config-zone-ap-grouplldp)# end Ends the current configuration session and return to privileged EXEC mode. Type: Privileged ruckus(config-zone-ap-grouplldp)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-ap-grouplldp)# help Displays the help. Type: Privileged ruckus(config-zone-ap-grouplldp)# lldp-ad-interval <seconds> Sets the LLDP advertise interval in seconds from the range 1 to 300. <seconds> Type: Privileged Sets the LLDP hold time in seconds from the range 60 to 1200. ruckus(config-zone-ap-grouplldp)# lldp-mgmt Enables the LLDP management IP TLV. Type: Privileged ruckus(config-zone-ap-grouplldp)# lldp-hold-time Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 227 Configuration Commands (s-z) zone Table 71 lists the related zone-ap-group-ap-snmp-options configuration commands. Table 71. Commands related to ruckus (zone-ap-group-ap-snmp-options) configuration) Syntax and Type Parameters (if any) ruckus(config-zone-ap-groupap-snmp-options)# ap-snmp Description Enables AP SNMP. Type: Privileged ruckus(config-zone-ap-groupap-snmp-options)# no Type: Privileged snmp-v2-community Disables and deletes commands. snmp-v3-user ruckus(config-zone-ap-groupap-snmp-options)# snmp-v2community Adds or update AP SNMPv2 community. Type: Privileged ruckus(config-zone-ap-groupap-snmp-options)# snmp-v3user Adds or updates AP SNMPv3 users. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 228 Configuration Commands (s-z) zone Table 72 lists the related zone-ap-group-port-setting configuration commands. Table 72. Commands related to ruckus(config-zone-ap-group-port-setting) Syntax and Type Parameters (if any) ruckus(config-zone-ap-groupport-setting)# do Description Executes the do command. Type: Privileged ruckus(config-zone-ap-groupport-setting)# dot1x authsvr [ <Authenticator Server Name> ] Sets the 802.1x role Type: Privileged accsvr <name> mac-auth-bypass [ true | false ] supplicant user-name [ <user name> password <password> supplicant mac ruckus(config-zone-ap-groupport-setting)# end Type: Privileged ruckus(config-zone-ap-groupport-setting)# exit Ends the current configuration session and return to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-zone-ap-groupport-setting)# help Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 229 Configuration Commands (s-z) zone Table 72. Commands related to ruckus(config-zone-ap-group-port-setting) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-groupport-setting)# lan <port> Enables or disable specific port. Type: Privileged <port> uplink [ general | access | trunk ] <port> untag <vlan> <port> member <vlanmembers> <port> dot1x [ auth-macbased | disabled | authport-based | supplicant ] ruckus(config-zone-ap-groupport-setting)# no dot1x accsvr lan <port> Disables or deletes the configuration settings. Type: Privileged Table 73 lists the commands related zone-ap-model configuration commands. Table 73. Commands related to ruckus(config-zone-ap-model) configuration commands Syntax and Type Parameters (if any) ruckus(config-zone-ap-model)# do Description Executes the do command. Type: Privileged ruckus(config-zone-ap-model)# end Ends the current configuration session and return to privileged EXEC mode. Type: Privileged ruckus(config-zone-ap-model)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-ap-model)# 2.4g <number> ext-ant 2.4gg <number> [ 3 | 2 ] Type: Privileged 5g <number> Sets the external antenna. 5gg <number> [ 2 | 3 ] SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 230 Configuration Commands (s-z) zone Table 73. Commands related to ruckus(config-zone-ap-model) configuration commands Syntax and Type Parameters (if any) ruckus(config-zone-ap-model)# help Description Displays the help. Type: Privileged ruckus(config-zone-ap-model)# internal-heater Enables international heater. Type: Privileged ruckus(config-zone-ap-model)# lan1 Sets the LAN configurations from 1 to 5. ruckus(config-zone-ap-model)# lan2 ruckus(config-zone-ap-model)# lan3 ruckus(config-zone-ap-model)# lan4 ruckus(config-zone-ap-model)# lan5 Type: Privileged ruckus(config-zone-ap-model)# led Enables the status of led. Type: Privileged ruckus(config-zone-ap-model)# led-mode Sets the led mode description Type: Privileged ruckus(config-zone-ap-model)# lldp Enables the Link Layer Discovery Protocol (LLDP). Type: Privileged ruckus(config-zone-ap-model)# <seconds> lldp-ad-interval Sets the LLDP advertise interval. Type: Privileged ruckus(config-zone-ap-model)# <seconds> lldp-hold-time Sets the LLDP hold time. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 231 Configuration Commands (s-z) zone Table 73. Commands related to ruckus(config-zone-ap-model) configuration commands Syntax and Type Parameters (if any) ruckus(config-zone-ap-model)# lldp-mgmt Description Enables the LLDP management IP TLV. Type: Privileged ruckus(config-zone-ap-model)# ext-ant no internal-heater Type: Privileged lan1 Disables or deletes the settings that have been configured. lan2 lan3 lan4 lan5 led lldp lldp-mgmt poe-out-port radio-band usb usb-software ruckus(config-zone-ap-model)# ${value} poe-operating-mode Switch PoE mode. Type: Privileged ruckus(config-zone-ap-model)# poe-out-port Enables the PoE out port Type: Privileged ruckus(config-zone-ap-model)# ${value} radio-band Switches the radio band. Type: Privileged ruckus(config-zone-ap-model)# <ap-model> [ enable | disable] usb Sets the USB port for a specific AP model. Type: Privileged ruckus(config-zone-ap-model)# <ap-model> [ enable | usb-software disable] Sets the AP USB software package. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 232 Configuration Commands (s-z) zone Table 74 lists the related zone-ap-model-lan1 configuration commands. Table 74. Commands related to ruckus(config-zone-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-modellan1)# 8021x <8021x-type> Sets the 802.1x. <acct-service> Sets the accounting service configurations. <auth-service> Sets the authentication service configurations. Type: Privileged ruckus(config-zone-ap-modellan1)# acct-service Type: Privileged ruckus(config-zone-ap-modellan1)# auth-service Type: Privileged ruckus(config-zone-ap-modellan1)# do Executes the do command. Type: Privileged ruckus(config-zone-ap-modellan1)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-ap-modellan1)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-ap-modellan1)# help Displays the help. Type: Privileged Sets the MAC authentication bypass. ruckus(config-zone-ap-modellan1)# mac-bypass Type: Privileged ruckus(config-zone-ap-modellan1)# members <members> Sets the members. acct-service Disables or deletes the settings that have been configured. Type: Privileged ruckus(config-zone-ap-modellan1)# no mac-bypass Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 233 Configuration Commands (s-z) zone Table 74. Commands related to ruckus(config-zone-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-modellan1)# profile <profile>: Ethernet port profile. Sets the Ethernet port profile. mac Sets the supplicant. Type: Privileged ruckus(config-zone-ap-modellan1)# supplicant Type: Privileged custom <username> <password> ruckus(config-zone-ap-modellan1)# type [ trunk-port | access-port | Sets the port type. general-port ] Type: Privileged ruckus(config-zone-ap-modellan1)# vlan-untag-id <vlan-untag-id> Sets the VLAN untag ID. Type: Privileged Table 75 lists the related zone-ap-registration-rule configuration commands. Table 75. Commands related to ruckus(config-zone-ap-registration-rule) Syntax and Type Parameters (if any) Description ruckus(config-zone-apregistration-rule)# description <text> Sets the description. Type: Privileged ruckus(config-zone-apregistration-rule)# do Executes the do command. Type: Privileged ruckus(config-zone-apregistration-rule)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-apregistration-rule)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-apregistration-rule)# gps <latitude> <longitude> <distance> Sets the GPS coordinates. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 234 Configuration Commands (s-z) zone Table 75. Commands related to ruckus(config-zone-ap-registration-rule) Syntax and Type Parameters (if any) ruckus(config-zone-apregistration-rule)# help Description Displays the help. Type: Privileged ruckus(config-zone-apregistration-rule)# ip-range <ip> <ip> Sets the IP address range from and to IP address. <tag> Sets the provision tags. <ip> <mask> Sets the subnet IP address and subnet mask. Type: Privileged ruckus(config-zone-apregistration-rule)# provision-tag Type: Privileged ruckus(config-zone-apregistration-rule)# subnet Type: Privileged ruckus(config-zone-apregistration-rule)# type [ gps | provision-tag | ip- Sets the rule type. range | subnet ] Type: Privileged Table 76 lists the related zone-ap-snmp-options configuration commands. Table 76. Commands related to ruckus(config-zone-ap-snmp-options configuration) Syntax and Type Parameters (if any) ruckus(config-zone-ap-snmpoptions)# ap-snmp Description Enables AP SNMP. Type: Privileged ruckus(config-zone-ap-snmpoptions)# no Type: Privileged ap-snmp snmp-v2-community <name> Disables the settings that have been configured with these commands. snmp-v3-user <name> ruckus(config-zone-ap-snmpoptions)# snmp-v2-community <name> Adds or updates the AP SNMPv2 community. <name> Adds or updates the AP SNMPv3 user. Type: Privileged ruckus(config-zone-ap-snmpoptions) # snmp-v3-user Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 235 Configuration Commands (s-z) zone Table 77 lists the related zone-ap-snmp-options-snmp-v2-community configuration commands. Table 77. Commands related to ruckus(config-zone-ap-snmp-options-snmp-v2-community configuration) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-snmpoptions-snmp-v2-community)# no Type: Privileged snmp-v2-community <name> Disables the settings that have been configured with these commands. snmp-v3-user <name> ruckus(config-zone-ap-snmpoptions-snmp-v2-community)# read Type: Privileged Enable the read privilege. ruckus(config-zone-ap-snmpoptions-snmp-v2-community)# write Type: Privileged Enable the write privilege. ruckus(config-zone-ap-snmpoptions-snmp-v2-community)# notification Type: Privileged Enable notification privilege. ruckus(config-zone-ap-snmpoptions-snmp-v2-community)# notification-target Type: Privileged Enables notification target configuration commands. ruckus(config-zone-ap-snmpoptions-snmp-v2-community)# notification-type Type: Privileged Sets the notification type. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 236 Configuration Commands (s-z) zone Table 78 lists the related config-zone-ap-snmp-options-snmp-v3-user configuration commands. Table 78. Commands related to ruckus(config-zone-ap-snmp-options-snmp-v3-user configuration) Syntax and Type Parameters (if any) ruckus(config-zone-ap-snmpoptions-snmp-v3-user)# auth Type: Privileged ruckus(config-zone-ap-snmpoptions-snmp-v3-user)# no Type: Privileged Description Sets SNMPv3 user authentication. snmp-v3-user <name> ruckus(config-zone-ap-snmpoptions-snmp-v3-user)# read Disables the settings that have been configured with these commands. Enable the read privilege. Type: Privileged ruckus(config-zone-ap-snmpoptions-snmp-v3-user)# write Type: Privileged Enable the write privilege. ruckus(config-zone-ap-snmpoptions-snmp-v3-user)# notification Type: Privileged Enable notification privilege. Table 79 lists the related zone-block-client configuration commands. Table 79. Commands related to ruckus(config-zone-block-client) Syntax and Type Parameters (if any) ruckus(config-zone-block-client)# <text> description Description Sets the description. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 237 Configuration Commands (s-z) zone Table 80 lists the related zone-bonjour-fencing-policy configuration commands. Table 80. Commands related to ruckus(config-zone-bonjour-fencing-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjourfencing-policy)# description <text> Sets the description. description Sets to delete sub commands. Type: Privileged ruckus(config-zone-bonjourfencing-policy)# no rule <rule index> Type: Privileged ruckus(config-zone-bonjourfencing-policy)# rule <index> - rule index Sets the bonjour fencing rule. Type: Privileged Table 81 lists the related zone-bonjour-policy configuration commands. Table 81. Commands related to ruckus(config-zone-bonjour-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjourpolicy)# description <text> Sets the description. Type: Privileged ruckus(config-zone-bonjourpolicy)# do Executes the do command. Type: Privileged ruckus(config-zone-bonjourpolicy)# end Type: Privileged ruckus(config-zone-bonjourpolicy)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-zone-bonjourpolicy)# help Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 238 Configuration Commands (s-z) zone Table 81. Commands related to ruckus(config-zone-bonjour-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjourpolicy)# name <name> Sets the bonjour policy name. <priority> Deletes the rules based on the rule priority. <priority> Sets the bonjour policy set of rules based on the rule priority. Type: Privileged ruckus(config-zone-bonjourpolicy)# no rule Type: Privileged ruckus(config-zone-bonjourpolicy)# rule Type: Privileged Table 82 lists the related zone-bonjour-policy-rule configuration commands. Table 82. Commands related to ruckus(config-zone-bonjour-policy-rule) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjourpolicy-rule)# bridge-service airdisk Sets the bridge service. Type: Privileged airport-management airplay airprint airtunes apple-file-sharing apple-mobile-devices (Allows sync with iTunes over Wi-Fi) appletv icloud-sync itunes-remote itunes-sharing open-directory-master optical-disk-sharing other SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 239 Configuration Commands (s-z) zone Table 82. Commands related to ruckus(config-zone-bonjour-policy-rule) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjourpolicy-rule)# bridge-service screen-sharing Sets the bridge service. Type: Privileged secure-shell secure-file-sharing workgroup-manager www-http www-https xgrid ruckus(config-zone-bonjourpolicy-rule)# do Executes the do command. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# from-vlan <int> Sets the from VLAN. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# help Exits from the EXEC. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# notes <text> Sets the notes. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# protocol Sets the bridge service when it is 'other'. Type: Privileged ruckus(config-zone-bonjourpolicy-rule)# to-vlan <int> Sets the VLAN. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 240 Configuration Commands (s-z) zone Table 83 lists the related zone-client-isolation-whitelist configuration commands. Table 83. Commands related to ruckus(config-zone-client-isolation-whitelist) Syntax and Type Parameters (if any) ruckus(config-zone-client-isolationwhitelist)# auto Description Enables the auto whitelist. Each entry must have an IP address in order to enable auto whitelist. Type: Privileged ruckus(config-zone-client-isolation- <text> whitelist)# description Sets the description. Type: Privileged ruckus(config-zone-client-isolation- <index> - entry index whitelist)# entry Sets the client isolation entry. Type: Privileged ruckus(config-zone-bonjour-policy- auto rule)# no description Type: Privileged entry Sets to delete sub command Table 84 lists the related zone-device-policy configuration commands. Table 84. Commands related to ruckus(config-zone-device-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-devicepolicy)# default-action [ allow | block ] Sets the default action to either allow or block. <text> Sets the description. Type: Privileged ruckus(config-zone-devicepolicy)# description Type: Privileged ruckus(config-zone-devicepolicy)# do Executes the do command. Type: Privileged ruckus(config-zone-devicepolicy)# exit Exits from the EXEC. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 241 Configuration Commands (s-z) zone Table 84. Commands related to ruckus(config-zone-device-policy) Syntax and Type Parameters (if any) ruckus(config-zone-devicepolicy)# end Description Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-devicepolicy)# help Displays the help. Type: Privileged ruckus(config-zone-devicepolicy# no policy-rule [ <device type> ] Deletes the device policy rules. Type: Privileged ruckus(config-zone-devicepolicy)# policy-rule Sets the device policy. Type: Privileged Table 85 lists the related zone-device-policy-policy-rule configuration commands. Table 85. Commands related to ruckus (config-zone-device-policy-policy rule) Syntax and Type Parameters (if any) ruckus(config-zone-device-policy- [ allow | block ] policy-rule)# action Description Sets the default action to either allow or block. Type: Privileged ruckus(config-zone-device-policy- <text> policy-rule)# description Sets the description. Type: Privileged ruckus(config-zone-device-policy- [ <Rate Limiting> ] policy-rule)# downlink Rate limiting (mbps) Type: Privileged Sets the downlink rate limiting. ruckus(config-zone-device-policypolicy-rule)# no vlan Resets the VLAN number. Type: Privileged ruckus(config-zone-device-policy- [ <Device Type> ] policy-rule)# type Sets the device type. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 242 Configuration Commands (s-z) zone Table 85. Commands related to ruckus (config-zone-device-policy-policy rule) Syntax and Type Parameters (if any) Description ruckus(config-zone-device-policy- [ <Rate Limiting> ] policy-rule)# uplink Rate limiting (mbps) Type: Privileged Sets the uplink rate limiting. ruckus(config-zone-device-policy- [ <VLAN Number> ]] policy-rule)# vlan Sets the VLAN number. Type: Privileged Table 86 lists the related zone-diffserv configuration commands. Table 86. Commands related to ruckus(config-zone-diffserv) Syntax and Type Parameters (if any) Description ruckus(config-zone-diffserv)# description <text> Sets the description. Type: Privileged ruckus(config-zone-diffserv)# do Executes the do command. Type: Privileged ruckus(config-zone-diffserv)# downlink-diffserv <value> Type: Privileged Enables the tunnel diffserv downlink and sets the diffserv number. ruckus(config-zone-diffserv)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-diffserv)# end Type: Privileged Ends the current configuration session and returns to the privileged EXEC mode. ruckus(config-zone-diffserv)# help Displays the help. Type: Privileged ruckus(config-zone-diffserv)# no description Type: Privileged downlink-diffserv Disables various options. preserved-diffserv uplink-diffserv SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 243 Configuration Commands (s-z) zone Table 86. Commands related to ruckus(config-zone-diffserv) Syntax and Type Parameters (if any) Description ruckus(config-zone-diffserv)# preserved-diffserv <value> Adds the preserved diffserv number. <value> Enables the tunnel diffserv uplink and sets the diffserv number. Type: Privileged ruckus(config-zone-diffserv)# uplink-diffserv Type: Privileged Table 87 lists the related config-zone-ethernet-port-profile configuration commands. Table 87. Commands related to ruckus(config-zone-ethernet-port-profile) Syntax and Type Parameters (if any) ruckus(config-zone-ethernet-portprofile)# 8021x Description Sets 802.1x. Type: Privileged ruckus(config-zone-ethernet-port- <acct-service> profile)# acct-service Accounting service. Type: Privileged ruckus(config-zone-ethernet-port- <auth-service> profile)# auth-service Authentication service. Type: Privileged ruckus(config-zone-ethernet-portprofile)# dvlan Enable dynamic VLAN Type: Privileged ruckus(config-zone-ethernet-port- <guest-vlan-id> profile)# guest-vlan Guest VLAN Type: Privileged ruckus(config-zone-ethernet-portprofile)# mac-bypass Enable MAC authentication bypass Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 244 Configuration Commands (s-z) zone Table 87. Commands related to ruckus(config-zone-ethernet-port-profile) Syntax and Type Parameters (if any) ruckus(config-zone-ethernet-port- acct-service profile)# no dvlan Type: Privileged mac-bypass Description Disables the various options. proxy-acct proxy-auth tunnel ruckus(config-zone-ethernet-portprofile)# proxy-acct Enables Proxy Accounting service. Type: Privileged ruckus(config-zone-ethernet-portprofile)# proxy-auth Enables Proxy Authentication service. Type: Privileged ruckus(config-zone-ethernet-port- • mac profile)# supplicant • custom <username> Type: Privileged <password> Set the supplicant. ruckus(config-zone-ethernet-portprofile)# tunnel Enable tunnel Type: Privileged ruckus(config-zone-ethernet-portprofile)# type Set port type Type: Privileged ruckus(config-zone-ethernet-portprofile)# vlan-members Describe VLAN members. Type: Privileged ruckus(config-zone-ethernet-port- <vlan-untag-id> profile)# vlan-untag-id Set the VLAN untag ID. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 245 Configuration Commands (s-z) zone Table 88 lists the related guest access configuration commands. Table 88. Commands related to ruckus (config-guest-access) Syntax and Type Parameters (if any) Description ruckus(config-domain-guestaccess)# description <text> Sets the description. Type: Privileged ruckus(config-domain-guestaccess)# do Executes the do command. Type: Privileged ruckus(config-domain-guestaccess)# enable-terms-andconditions Enables the web portal terms and conditions. Type: Privileged ruckus(config-domain-guestaccess)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-domain-guestaccess)# exit Exits from the EXEC. Type: Privileged ruckus(config-domain-guestaccess)# grace-period <minutes> Sets the grace period. Type: Privileged ruckus(config-domain-guestaccess)# help Displays the help. Type: Privileged Sets the language. ruckus(config-domain-guestaccess)# language Type: Privileged ruckus(config-domain-guestaccess)# logo Type: Privileged Sets the logo by setting the FTP URL. format: ftp:// <username>:<password >@<ip>/<file-path> <ftp-url> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 246 Configuration Commands (s-z) zone Table 88. Commands related to ruckus (config-guest-access) Syntax and Type Parameters (if any) Description ruckus(config-domain-guestaccess)# name <name> Sets the guess access service name. ruckus(config-domain-guestaccess)# no enable-terms-andconditions Disables the web portal terms and conditions. Type: Privileged sms-gateway Type: Privileged terms-and-conditions ruckus(config-domain-guestaccess)# session-timeout <minutes> Sets the session timeout as per the specified minutes. <disabled> Sets the guest pass for the SMS gateway. original Sets the start page. Type: Privileged ruckus(config-domain-guestaccess)# sms-gateway Type: Privileged ruckus(config-domain-guestaccess)# start-page redirect <start-url> Type: Privileged ruckus(config-domain-guestaccess)# terms-and-conditions Sets the web portal terms and conditions. Type: Privileged ruckus(config-domain-guestaccess)# title Sets the title for the web portal. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 247 Configuration Commands (s-z) zone Table 89 lists the related zone-hotspot configuration commands. Table 89. Commands related to ruckus(config-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot)# description <text> Sets the description. Type: Privileged ruckus(config-zone-hotspot)# do Executes the do command. Type: Privileged ruckus(config-zone-hotspot)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-zone-hotspot)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-hotspot)# grace-period <minutes> Sets the EAP-SIM MAP version. Type: Privileged ruckus(config-zone-hotspot)# help Displays the help. Type: Privileged ruckus(config-zone-hotspot)# language Sets the portal language. Type: Privileged ruckus(config-zone-hotspot)# location-id <location-id> Sets the location ID. <location-name> Sets the location name. Type: Privileged ruckus(config-zone-hotspot)# location-name Type: Privileged ruckus(config-zone-hotspot)# logo <ftp-url> Sets the logo. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 248 Configuration Commands (s-z) zone Table 89. Commands related to ruckus(config-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot)# logon-url internal Sets the logon model. Type: Privileged external <logon-url> <logon-url>: Redirects unauthenticated user to the URL for authentication ruckus(config-zone-hotspot)# mac-address-format Sets the MAC address format. Type: Privileged ruckus(config-zone-hotspot)# name Renames the hotspot profile. Type: Privileged ruckus(config-zone-hotspot)# no show-terms-conditions Type: Privileged walled-garden <walledgarden-list> ruckus(config-zone-hotspot)# session-timeout <minutes> Disables the commands. Sets the session timeout. Defined in minutes. Type: Privileged ruckus(config-zone-hotspot)# show-terms-conditions Shows the terms and conditions. Type: Privileged ruckus(config-zone-hotspot)# smart-client-support enable Type: Privileged only <instructions> Only smart client allowed with instructions for enabling users to log on using the smart client application ruckus(config-zone-hotspot)# start-page original Type: Privileged <start-url>: Redirects to the defined URL Sets the smart client support. none Sets the start page. redirect <start-url> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 249 Configuration Commands (s-z) zone Table 89. Commands related to ruckus(config-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot)# terms-conditions <terms> Sets the terms and conditions. Type: Privileged ruckus(config-zone-hotspot)# title <title> Sets the title. Type: Privileged ruckus(config-zone-hotspot)# walled-garden <walled-garden-list> Type: Privileged Enables walled garden. Allows unauthorized destinations. Comma-separated IP, IP range, CIDR and regular expression domain name list. Table 90 lists the related zone-hotspot20-venue-profile configuration commands. Table 90. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20venue-profile)# description <text> Sets the description. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# do Executes the do command. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# end Ends the current configuration session and returns to the privileged EXEC mode. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# help Displays the help. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# no venue-name Type: Privileged wan-sym-link Disables the commands. wan-at-capacity SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 250 Configuration Commands (s-z) zone Table 90. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20venue-profile)# venue-category unspecified unspecified Sets the venue category Type: Privileged assembly [ coffee-shop | passenger-terminal | restaurant | bar | arena | library | place-of-worship | emergencycoordinationcenter | museum | stadium | convention-center | unspecified | amphitheater | amusement-park | theater | zoo-or-aquarium ] business [ unspecified | police-station | attorneyoffice | professional-office | research-anddevelopment-facility |doctor-or-dentist-office | fire-station | post-office | bank ] factory-andindustrial [ unspecified | factory ] educational [ unspecified | school-primary | university-or-college | school-secondary ] factory-and-industrial [ unspecified | factory ] ...................................continued SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 251 Configuration Commands (s-z) zone Table 90. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) ruckus(config-zone-hotspot20venue-profile)# venue-category institutional [ hospital | Sets the venue category group-home | unspecified | prison-or-jail | long-termcare-facility | alcohol-anddrugrehabilitation- Type: Privileged Description center ] mercantile [ grocerymarket | automotiveservice-station | unspecified | retail-store | gas-station | shoppingmall ] residential [ unspecified | private-residence | hotelor-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 ] ruckus(config-zone-hotspot20venue-profile)# venue-names <language> <names> Sets the venue-names. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 252 Configuration Commands (s-z) zone Table 90. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) ruckus(config-zone-hotspot20venue-profile)# wan-at-capacity Description Sets the WAN capacity. Type: Privileged ruckus(config-zone-hotspot20<downlink-load> - Load venue-profile)# wan-downlink-load between 1 and 255 Sets the WAN downlink load. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# wan-downlinkspeed <speed> Sets the WAN downlink speed in (kbps). [ link-up | link-test | linkdown ] Sets the link status. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# wan-link-status Type: Privileged ruckus(config-zone-hotspot20<duration> venue-profile)# wan-load-duration Sets the load measurement duration. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# wan-sym-link Enables symmetric link. Type: Privileged ruckus(config-zone-hotspot20venue-profile)# wan-uplink-load <uplink-load> Sets the WAN uplink load. Type: Privileged <speed> - Uplink speed in Sets the WAN uplink speed. ruckus(config-zone-hotspot20venue-profile)# wan-uplink-speed kbps Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 253 Configuration Commands (s-z) zone Table 91 lists the related zone-hotspot20-wlan-profile configuration commands. Table 91. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) ruckus(config-zone-hotspot20wlan-profile)# access-networktype Description Sets the access network type. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# asra Sets the ASRA profile. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# asra-dns-redirect <url> Sets the ASRA DNS redirection. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# asra-http-redirect Sets the ASRA HTTP redirection. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# asra-online-signup <ssid> Sets the ASRA online signup. <url> Sets the ASRA terms and conditions. Type: Privileged ruckus(config-hotspot20-wlanprofile)# asra-terms-conditions Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 254 Configuration Commands (s-z) zone Table 91. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) ruckus(config-zone-hotspot20[ pptp | http | voip-6 | wlan-profile)# connect-capabilities ipsec-vpn | ikev2 | ftp | tls | voip-17 | icmp | ssh | esp Type: Privileged ] [ open | unknown | closed ] Description 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 255 Configuration Commands (s-z) zone Table 91. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) ruckus(config-zone-hotspot20[ pptp | http | voip-6 | wlan-profile)# connect-capabilities ipsec-vpn | ikev2 | ftp | tls | voip-17 | icmp | ssh | esp Type: Privileged ] [ open | unknown | closed ] Description 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-zone-hotspot20wlan-profile)# cust-connectcapabilities <protocol-name> <protocol-number> Creates or updates the custom connection capabilities. <text> Sets the description. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# description Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# do Executes the do command. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged Exits from the EXEC. ruckus(config-zone-hotspot20wlan-profile)# exit Type: Privileged Displays the help. ruckus(config-zone-hotspot20wlan-profile)# help Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# identity-providers <identityProvider> default Sets the identity providers. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 256 Configuration Commands (s-z) zone Table 91. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20wlan-profile)# internet-option enable Enables the specified WLAN with Internet connectivity. Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# ipv4-address Type: Privileged [ port-restrict-address | Sets the IPv4 address. single-nated-privateaddress | double-natedprivate-address | portrestrictedaddressdoublenated-address | unknown | public-address | portrestricted-addresssingle-nated-address | not-available ]> ruckus(config-zone-hotspot20wlan-profile)# ipv6-address [ not-available | unknown Sets the IPv6 address. | available ] Type: Privileged ruckus(config-zone-hotspot20wlan-profile)# name <name> Sets the hotspot 2.0 WLAN profile name. ruckus(config-zone-hotspot20wlan-profile)# no asra Disables the commands. Type: Privileged asra-http-redirect Type: Privileged asra-dns-redirect asra-online-signup asra-terms-conditions cust-connect-capabilities identity-providers internet-option ruckus(config-zone-hotspot20wlan-profile)# operator <name> Sets the operator name. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 257 Configuration Commands (s-z) zone Table 92 lists the related zone-hotspot20-wlan-profile cust-connect-capabilities configuration commands. Table 92. Commands related to ruckus(config-zone-hotspot20-wlan-profile-cust-connectcapabilities) Syntax and Type Parameters (if any) ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities)# do Description Executes the do command. Type: Privileged ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities)# help Displays the help. Type: Privileged ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities)# port <port> Set the port number. <protocol> Sets the protocol number. Type: Privileged ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities)# protocol Type: Privileged ruckus(config-zone-hotspot20wlan-profile-cust-connectcapabilities) status [ closed | unknown | open] Sets the status. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 258 Configuration Commands (s-z) zone Table 93 lists the related zone-l2-acl configuration commands. Table 93. Commands related to ruckus(config-zone-l2-acl) Syntax and Type Parameters (if any) ruckus(config-zone-l2-acl)# action [ allow | block ] Type: Privileged ruckus(config-zone-l2-acl)# description Description Sets the handling action to allow or block. <text> Sets the description. ${value} Sets the MAC value. ${value} Disables the MAC value. Type: Privileged ruckus(config-zone-l2-acl)# mac Type: Privileged ruckus(config-zone-l2-acl)# no mac Type: Privileged Table 94 lists the related zone-web-authentication configuration commands. Table 94. Commands related to ruckus (config-zone-web-authentication) Syntax and Type Parameters (if any) Description ruckus(config-zone-webauthentication)# description <text> Sets the description. <minutes> Sets the grace period. Type: Privileged ruckus(config-zone-webauthentication)# grace-period Type: Privileged ruckus(config-zone-webauthentication)# language Sets the language. Type: Privileged ruckus(config-zone-webauthentication)# session-timeout <minutes> Sets the session timeout as per the specified minutes. original Sets the start page. Type: Privileged ruckus(config-zone-webauthentication)# start-page redirect <start-url> Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 259 Configuration Commands (s-z) zone Table 95 lists the related zone-weçhat configuration commands. Table 95. Commands related to ruckus (config-zone-wechat) and (config-domain-zonewechat) Syntax and Type Parameters (if any) Description ruckus(config-zone-wechat)# authentication-url <text>: Authentication URL Sets Authentication URL <text>: Black list Sets black list. <text>: Description Sets description. Type: Privileged ruckus(config-zone-wechat)# black-list Type: Privileged rruckus(config-zone-wechat)# description Type: Privileged ruckus(config-zone-wechat)# dnat-destination <text>: DNAT destination Sets DNAT destination. Type: Privileged ruckus(config-zone-wechat)# dnat-port-mapping <source><dest>: Source Set DNAT port mappings and destination ports Type: Privileged ruckus(config-zone-wechat)# grace-period <minutes>: Grace Period Set grace period minutes Type: Privileged ruckus(config-zone-wechat)# no dnat-port-mapping Type: Privileged white-list ruckus(config-zone-wechat)# whitelist <white-list> Allowed Sets White list. unauthorized destinations, commaseparated IP, IP range, CIDR and regular expression Domain name list Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Disable the options. 260 Configuration Commands (s-z) zone Table 96 lists the related zone-wlan configuration commands. Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# aaavlan-override Description Enables AAA VLAN override. Type: Privileged ruckus(config-zone-wlan)# access-network Enables tunnel WLAN traffic to the controller. Type: Privileged ruckus(config-zone-wlan)# acctdelay-time Enables the acct-delay time. Type: Privileged ruckus(config-zone-wlan)# acctinterval <minutes> Set the authentication service. Enables accounting interval to send interim updates. <name> Sets the accounting service. Type: Privileged ruckus(config-zone-wlan)# acctservice Type: Privileged ruckus(config-zone-wlan)# acctservice-use-proxy Set the accounting service: Uses the controller as proxy. Type: Privileged ruckus(config-zone-wlan)# acctttg-session Sets the accounting service. Enables accounting for TTG sessions. Type: Privileged Sets the authentication method. ruckus(config-zone-wlan)# authmethod Type: Privileged ruckus(config-zone-wlan)# authservice <name> Sets the authentication service. Type: Privileged ruckus(config-zone-wlan)# authservice-use-proxy Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Sets the authentication service. Enables accounting for TTG sessions. 261 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# authtype Description Sets the authentication type. Type: Privileged ruckus(config-zone-wlan) #bssminrate Type: Privileged [ 5.5mbps | 24mbps | Sets the BSS minimum rate. 12mbps | 1mbps | 2mbps ] Enable to bypass CNA server. ruckus(config-zone-wlan) #bypass-cna Type: Privileged ruckus(config-zone-wlan)# called- [bssid | apmac | none | sta apgroup] Sets the called STA ID. Type: Privileged ruckus(config-zone-wlan)# clea Enables CALEA. Type: Privileged ruckus(config-zone-wlan)# clientfingerprinting Sets the client fingerprinting. Type: Privileged ruckus(config-zone-wlan)# clienttx-rx-statistics Enables ignore statistics from unauthorized clients. Type: Privileged ruckus(config-zone-wlan)# description <text> Sets the description, Type: Privileged ruckus(config-zone-wlan)# device- [ <Policy Name> ] policy Sets the device policy. Type: Privileged ruckus(config-zone-wlan)# dgaf Type: Privileged ruckus(config-zone-wlan)# dhcpoption-82 Disables downstream groupaddress frame forwarding. Enables DHCP option 82. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 262 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# dhcp- [ subopt-1 | ruckus-gre | option-82-format soft-gre ] Type: Privileged Description Enables DHCP option 82 format options. Subopt-1 with format (Circuit-ID [WLAN:IFNAME:VLAN:S SID:MODEL:HOSTNAME :DEVMAC]) ruckus-gre: Ruckus default (Circuit-ID [WLAN:IFNAME:VLAN:S SID:MODEL:HOSTNAME :DEVMAC:LOCATION]) soft-gre: SoftGRE customized (Circuit-ID [DEVMAC;SSID;PRIVACY TYPE]. Remote-ID [STAMAC]) ruckus(config-zone-wlan)# diffserv-profile <name> Sets the Diffserv profile Type: Privileged ruckus(config-zone-wlan)# disable-band-balancing Disables radio band balancing on WLAN. Type: Privileged ruckus(config-zone-wlan)# disable-load-balancing Disables client load balancing on WLAN. Type: Privileged ruckus(config-zone-wlan)# disable-wlan Disables this WLAN service. Type: Privileged ruckus(config-zone-wlan)# dnlinklimit Sets the downlink rate limiting. Type: Privileged ruckus(config-zone-wlan)# do Executes the do command. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 263 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# dpskeffective-type Sets the DPSK expiration effective type. ruckus(config-zone-wlan)# dpskenable Enables DPSK. ruckus(config-zone-wlan)# dpskexpiration Sets DPSK expiration. ruckus(config-zone-wlan)# dpsklength Sets DPSK length. ruckus(config-zone-wlan)# dpsktype Sets DPSK type. ruckus(config-zone-wlan)# end Type: Privileged Ends the current configuration session and returns to the privileged EXEC mode. ruckus(config-zone-wlan)# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-wlan)# enable-rfc5580-support Type: Privileged ruckus(config-zone-wlan)# enable-type Enables this attribute to deliver the location information only for those APs where location attribute is configured. Enables the WLAN service type. Type: Privileged ruckus(config-zone-wlan)# encalgorithm Sets the encryption algorithm. Type: Privileged ruckus(config-zone-wlan)# encmethod Sets the encryption method. Type: Privileged ruckus(config-zone-wlan)# encmfp Sets the MFP. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 264 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# encpassphrase <password> Sets the encryption passphrase. Type: Privileged ruckus(config-zone-wlan)# encwep-key <wep-key-index> <wep- Sets WEP key (HEX). key> Type: Privileged WEP key (HEX), length should be 10 (WEP-64) or 26 (WEP-128) ruckus(config-domain-zonewlan)# external-nas Enables the external NAS IP address. Type: Privileged ruckus(config-zone-wlan)# force- timeout <seconds> Sets the timeout for DHCP in seconds. dhcp timeout: Sets the Type: Privileged disconnect client timeout interval <seconds>: Sets the disconnect client timeout in intervals of 5 - 15 seconds ruckus(config-zone-wlan)# forwarding-policy Sets the forwarding policy configurations. Type: Privileged ruckus(config-zone-wlan)# guest- <name> access Sets the guest access service. Type: Privileged ruckus(config-zone-wlan)# guestaccess-acct-service Sets the accounting server. Type: Privileged ruckus(config-zone-wlan)# guestaccess-auth-service Sets the authentication server. Type: Privileged ruckus(config-zone-wlan)# help Displays the help. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 265 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# hessid <hessid> Description Sets the WLAN HESSID value. Type: Privileged Hides SSID in beacon broadcast. ruckus(config-zone-wlan)# hidessid Type: Privileged ruckus(config-zone-wlan)# hotspot <name> Sets the hotspot service. <name> Sets the hotspot 2.0 configuration. Type: Privileged ruckus(config-zone-wlan)# hotspot2 Type: Privileged ruckus(config-zone-wlan)# hotspot20-osu-support Enables the hotspot 2.0 device registration from the guest portal. Type: Privileged ruckus(config-zone-wlan)# inactivity-timeout <number> Sets the inactivity timeout. Terminates idle user sessions after the specified seconds of inactivity. [ <ACL Name> ] Sets the layer 2 access control list. Type: Privileged ruckus(config-zone-wlan)# l2-acl Type: Privileged ruckus(config-zone-wlan)# macaddress-format Sets the MAC address format. Type: Privileged ruckus(config-zone-wlan)# macauth <password> Sets the MAC authentication. <number> Sets the maximum clients. Allows clients per AP radio to associate with this WLAN. Range is between 1 and 512. Type: Privileged ruckus(config-zone-wlan)# maxclients Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 266 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# mgmt- [[ 48mbps | 2mbps | Sets the management Tx rates. tx-rate 36mbps | 1mbps | 18mbps | 12mbps | Type: Privileged 11mbps | 5.5mbps | 6mbps | 54mbps | 9mbps | 24mbps ] ruckus(config-zone-wlan)# mobility-domain-id <number>: ID number (1-65535) Sets the mobility domain identifier (for 802.11r). ruckus(config-zone-wlan)# no aaa-vlan-override Type: Privileged access-network Disables or deletes the configuration settings. Type: Privileged acct-delay-time acct-service acct-service-use-proxy acct-ttg-session auth-service-use-proxy bss-minrate bypass-cna calea client-fingerprinting client-tx-rx-statistics device-policy dgaf dhcp-option-82 diffserv-profile disable-band-balancing disable-load-balancing disable-wlan dnlink-limit SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 ......................................continue 267 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# no enable-rfc5580-support Type: Privileged force-dhcp Disables or deletes the configuration settings. hessid hide-ssid hotspot20-osu-support l2-acl mac-auth ofdm-only (Orthogonal Frequency Division Multiplexing) okc-support onboarding-auth-service onboarding-auth-serviceuse-proxy pmk-caching proxy-arp qinq-vlan qos-map-enable roam support-802-11d uplink-limit user-traffic-profile vlan-enabled vlan-pooling wireless-client-isolation wispr-ttg-support zero-it-activation zero-it-onboarding ruckus(config-domain-zonewlan)# ofdm-only Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 ......................................continue Enables OFDM (Orthogonal Frequency Division Multiplexing) rates. 268 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# okcsupport Description Enables OKC support. Type: Privileged ruckus(config-zone-wlan)# onboarding-auth-service <service-name> local <realm> Sets the onboarding authentication service. Type: Privileged <service-name> remote <realm> <service-name> local <realm> never <service-name> local <realm> hour <expirationvalue> - Expiration value between 1 and 175200. <service-name> local <realm> day <expirationvalue> - 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. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 269 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# onboarding-auth-service-useproxy Description Sets the onboarding authentication service using the controller proxy server. Type: Privileged ruckus(config-zone-wlan)# onboarding-portal <name> Sets the onboarding portal. Type: Privileged ruckus(config-zone-wlan)# operator-realm Sets the operator realm. Type: Privileged ruckus(config-zone-wlan)# pmkcaching-support Enables the PMK caching support. Type: Privileged ruckus(config-zone-wlan)# priority Sets the priority as either low or high. Type: Privileged ruckus(config-zone-wlan)# proxyarp Enables proxy ARP. Type: Privileged ruckus(config-zone-wlan)# qinqvlan <s-vlan-id> Enables Q-in-Q VLAN. <priority> Updates the QoS map. Type: Privileged ruckus(config-zone-wlan)# qosmap Type: Privileged ruckus(config-zone-wlan)# qosmap-enable Enables the QoS map. Type: Privileged ruckus(config-zone-wlan)# radius- <number> nas-id Sets the RADIUS NAS ID. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 270 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# radius- <times> nas-max-retries Description Sets the maximum number of retries for RADIUS NAS. Type: Privileged ruckus(config-zone-wlan)# radius- <minutes> nas-reconnect-primary Sets the reconnection to the primary RADIUS NAS. Type: Privileged ruckus(config-zone-wlan)# radius- <seconds> nas-request-timeout Sets the RADIUS NAS request timeout. Type: Privileged ruckus(config-zone-wlan)# radiusnas-type Sets the RADIUS NAS type. Type: Privileged ruckus(config-zone-wlan)# roam Enables roaming. Type: Privileged ruckus(config-zone-wlan)# roam- 2.4g <value> factor 5g <value> Type: Privileged Sets the roam factor. ruckus(config-zone-wlan)# scheduler <profile-name> Sets the WLAN scheduler profile. <ssid> Sets the WLAN SSID configuration. <uplink> <downlink> Sets the SSID rate limit as either uplink or downlink with the range 1-200 mbps. Type: Privileged ruckus(config-zone-wlan)# ssid Type: Privileged ruckus(config-zone-wlan)# ssidrate-limiting Type: Privileged ruckus(config-zone-wlan)# support-802-11d Enables support for 802.11d. Type: Privileged ruckus(config-zone-wlan)# support-802-11k Enables support for 802.11k neighbor reports. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 271 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# support-802-11r Description Enables 802.11r fast BSS transition. Type: Privileged ruckus(config-zone-wlan)# uplinklimit Sets the uplink rate limiting. Type: Privileged Sets the user traffic profile. ruckus(config-zone-wlan)# usertraffic-profile Type: Privileged ruckus(config-zone-wlan)# venuecode Enables venue code. Type: Privileged ruckus(config-zone-wlan)# vlanenabled Enables dynamic VLAN. Type: Privileged ruckus(config-zone-wlan)# vlan-id <vlan-id> Sets the VLAN ID Type: Privileged ruckus(config-zone-wlan)# vlanpooling <name> Enables and sets the VLAN pooling profile. <name> Sets the web authentication service. <name> Sets the WeChat services. Type: Privileged ruckus(config-zone-wlan)# webauthentication Type: Privileged ruckus(config-zone-wlan)# wechat Type: Privileged Sets the wireless client Isolation. ruckus(config-zone-wlan)# wireless-client-isolation Type: Privileged ruckus(config-zone-wlan)# wireless-client-isolation-whitelist [ <Whitelist Name> ] Sets the wireless client Isolation whitelist. Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 272 Configuration Commands (s-z) zone Table 96. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) ruckus(config-zone-wlan)# zero-itactivation Description Enables zero-it activation (WLAN users are provided with wireless configuration installer after they log in). Type: Privileged ruckus(config-zone-wlan)# zero-itonboarding Enables zero-it device registration from the guest portal. Type: Privileged Table 97 lists the related zone-wlan-qos-map configuration commands. Table 97. Commands related to ruckus(config-zone-wlan-qos-map) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan-qosmap)# dscp-range <dscp-low-value> <dscp- Sets the range as either high or low values for DSCP. high-value> Type: Privileged ruckus(config-zone-wlan-qosmap)# enable Enables the QoS map setting. Type: Privileged ruckus(config-zone-wlan-qosmap)# excp-dscp-values Sets the exception values for DSCP. Type: Privileged ruckus(config-zone-wlan-qosmap)# no enable Disables the commands. excp-dscp-values Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 273 Configuration Commands (s-z) zone Table 98 lists the related zone-wlan-group configuration commands. . Table 98. Commands related to ruckus(config-zone-wlan-group). Syntax and Type Parameters (if any) ruckus(config-zone-wlan-group)# <text> description Description Sets the description, Type: Privileged ruckus(config-zone-wlan-group# do Executes the do command. Type: Privileged ruckus(config-zone-wlan-group)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-zone-wlan-group# exit Exits from the EXEC. Type: Privileged ruckus(config-zone-wlan-group)# help Displays the help. Type: Privileged ruckus(config-zone-wlan-group)# wlan <name> no Disables or removes WLAN from this group. Type: Privileged ruckus(config-zone-wlan-group)# <name> vlan <vlanTag> wlan nasid <nasid> Type: Privileged Sets a WLAN in this group or overrides VLAN setting. <name> nasid <nasid> vlan <vlanTag> <name> vlan <vlanTag> <name> nasid <nasid> <name> vlan-pooling <vlanPooling> <name> vlan-pooling <vlanPooling> <nasid> <name> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 274 Configuration Commands (s-z) zone-template Table 99 lists the related zone-wlan-scheduler configuration commands. . Table 99. Commands related to ruckus (config-zone-wlan-scheduler) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlanscheduler)# description <text> Sets the description, description Disables the commands. Type: Privileged ruckus(config-zone-wlanscheduler)# no Type: Privileged ruckus(config-zone-wlanscheduler)# schedule-data Type: Privileged schedule-data [ <weekday | empty> ] [ <start time value | empty> ] [ <end time value> ] | ${weekday} <weekday | empty> ] [ Sets the schedule table. <start time value | empty> ] [ <end time value> ] ${weekday} zone-template To create or update the zone template configurations, use the following command. ruckus(config)# zone-template Syntax Description This command uses the following syntax: import <ftp-url> import: Import AP Zone Template from FTP server <ftp-url>: FTP URL, format: ftp://<username>:<password>@<ftp-host>/ <file-path> <name> extract <name> <name>: AP Zone Template name extract: Extract AP Zone Template from an existing AP Zone <name>: AP Zone name <name> export <ftp-url> <name>: AP Zone Template name export: Export AP Zone Template to FTP server SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 275 Configuration Commands (s-z) zone-template <ftp-url>: FTP URL, format: ftp://<username>:<password>@<ftp-host>[/ <dir-path> ]P URL, format: ftp://:@[/] Default This command has no default settings. Command Mode Config Example ruckus(config)# zone-template acct-profile SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 276 5 Debug Commands This chapter describes the commands that you can use to debug the controller. The following table lists the commands. Table 100. Debug commands debug ap-subnetdiscovery apcli data-plane diagnostic do dpcustomizedconfig end exit export log help no ap-subnet- no dpdiscovery customizedconfig no outputformat no save no schedule no screenpagination no sha1 no tlsv1 no webbackdoor no web-debug output-format reindexscreen-pagination elasticsearchall sha1 show apsubnetdiscoverystatus show dpcustomizedconfig show sha1state show tlsv1state strict-wfacompliancestate tlsv1 no strict-wfacompliance SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 show strict-wfacompliance-state 277 Debug Commands debug debug To execute commands in debug mode, you need to change the mode to: ruckus(debug)# Example SZ100-Node1# debug SZ100-Node1(debug)# 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 278 Debug Commands apcli 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)# Related Commands Table 101 lists the related debug apcli configuration commands. Table 101. Commands related to ruckus(debug-apcli) Syntax and Type Parameters (if any) ruckus(debug-apcli)# do Description Executes the do command. Type: Privileged ruckus(debug-apcli)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(debug-apcli)# execute Executes the API CLI script. Type: Privileged ruckus(debug-apcli)# exit Exits from the EXEC. Type: Privileged ruckus(debug-apcli)# help Displays help. Type: Privileged ruckus(debug-apcli)# show diagnostic-script Type: Privileged schedule SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Shows the diagnostic script or the schedule script. 279 Debug Commands data-plane Table 101. Commands related to ruckus(debug-apcli) Syntax and Type Parameters (if any) ruckus(debug-apcli)# showexecution-status Description Shows the script execution summary. Type: Privileged ruckus(debug-apcli)# upload <ftp-url> Type: Privileged Uploads the API CLI script from a remote FTP server. data-plane To retrieve data plane information, use the following command: ruckus(debug)# data-plane <name> Syntax Description This command uses the following syntax: name: Enter the data plane name or the existing data planes. Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# dataplane dp SZ100-Node1(debug-dataplane)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 280 Debug Commands diagnostic Related Commands Table 101 lists the related debug dataplane configuration commands. Table 102. Commands related to ruckus(debug-dataplane) Syntax and Type Parameters (if any) ruckus(debug-dataplane)# do Description Executes the do command. Type: Privileged ruckus(debug-dataplane)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(debug-dataplane)# exit Exits from the EXEC. Type: Privileged ruckus(debug-dataplane)# help Displays help. Type: Privileged ruckus(debug-dataplane)# run Type: Privileged <dp commands> For example datacore dump_ifs Executes data plane commands. 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)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 281 Debug Commands diagnostic Related Commands Table 103 lists the related debug diagnostic commands. Table 103. Commands related to ruckus(debug-diagnostic) Syntax and Type Parameters (If Any) ruckus(debug-diagnostic)# delete <name> Description Type: Privileged Deletes a diagnostic script. Specify the script name. ruckus(debug-diagnostic)# do Executes the do command. Type: Privileged ruckus(debug-diagnostic)# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(debug-diagnostic)# execute <name> <params> Executes a diagnostic script. Specify the script name. Type: Privileged ruckus(debug-diagnostic)# exit Exits from the EXEC. Type: Privileged ruckus(debug-diagnostic)# help Displays help. Type: Privileged ruckus(debug-diagnostic)# no <schedule> Disables the scheduled script. <name> Schedules a script to run with arguments. ruckus(debug-diagnostic)# show diagnostic-script Type: Privileged schedule Shows the diagnostic or the schedule script. Specify the script name and its parameters. Type: Privileged ruckus(debug-diagnostic)# schedule Type: Privileged ruckus(debug-diagnostic)# upload <ftp-url>: FTP URL format Uploads a diagnostic script from a is: ftp:// remote FTP server. Type: Privileged <username>:<password >@<ftp-host>/<file-path> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 282 Debug Commands do 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 dp-customized-config To run DP CLI script management commands: ruckus(debug)# dp-customized-config 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)# dp-customized-config SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 283 Debug Commands end end To end the current configuration session and returns to privileged exec mode, use the following command: ruckus(debug)# end Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# end 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 284 Debug Commands export log 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>[/<dirpath>]] app: Application <name>: Application name Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# export log ftp://mahan:ruckus1!@172.19.7.100 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 285 Debug Commands no ap-subnet-discovery no ap-subnet-discovery To disable the AP subnet discovery service, use the following command: SZ100-Node1(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 dp-customized-config To disable the dataplane customized configuration, use the following command: SZ100-Node1(debug)# no dp-customized-config Syntax Description This command has the following arguments or keywords: all: All dataplanes <name>: Dataplane name Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# no dp-customized-config all SZ100-Node1(debug)# dp-customized-config <name> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 286 Debug Commands no output-format 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: Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# no save SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 287 Debug Commands no schedule 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. Command Mode Debug Example SZ100-Node1(debug)# no screen-pagination SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 288 Debug Commands no strict-wfa-compliance 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. Command Mode Debug Example SZ100-Node1(debug)# no strict-wfa-compliance no sha1 To disable the Secure Hash Algorithm 1 (SHA1) support, use the following command: ruckus(debug)# no sha1 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# no sha1 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 289 Debug Commands no tlsv1 no tlsv1 To disable the Transport Layer Security version 1 (TLSv1) support, use the following command: ruckus(debug)# no tslv1 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# no tlsv1 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 290 Debug Commands no web-debug 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 291 Debug Commands reindex-elasticsearch-all reindex-elasticsearch-all To reindex all Elasticsearch data, use the following command: ruckus(debug)# reindex-elasticsearch-all Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# reindex-elasticsearch-all screen-pagination To enable the screen pagination, use the following command: ruckus(debug)# screen-pagination <ap-subnet-discovery-status > | diagnostic-script <name>| schedule | strict-wfa-compliance-state 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 292 Debug Commands sha1 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. sha1 To enable Secure Hash Algorithm 1 (SHA1) support, use the following command: ruckus(debug)# sha1 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# sha1 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 293 Debug Commands show ap-subnet-discovery-status 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 Example SZ100-Node1(debug)# show ap-subnet-discovery-status show dp-customized-config To display the dataplane customized configuration, use the following command: ruckus(debug)# show dp-customized-config Syntax Description This command has the following arguments or keywords: all: All dataplanes <name>: Dataplane name Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# show dp-customized-config all SZ100-Node1(debug)# show dp-customized-config <name> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 294 Debug Commands show sha1-state show sha1-state To show the Secure Hash Algorithm 1 (SHA1) support state, use the following command: ruckus(debug)# show sha1-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 sha1-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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 295 Debug Commands show tlsv1-state show tlsv1-state To show the Transport Layer Security version 1 (TLSv1) support state, use the following command: ruckus(debug)# show tlsv1-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 tlsv1-state 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.5, 800-71293-001 296 Debug Commands tlsv1 tlsv1 To enable the Transport Layer Security version 1 (TLSv1) support, use the following command: ruckus(debug)# tlsv1 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example SZ100-Node1(debug)# tlsv1 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 297 Setup Commands 6 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 298 Setup Commands rbddump Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example SZ100-Node1# rbddump name: Gallus magic: 35333131 cksum: b19 rev: 5.4 Serial#: 531336000194 Customer ID: ruckus Model: sz124 V54 Board Type: Undef V54 Board Class: AP71 Random#: 0000 0000 0000 0000 0000 0000 0000 0000 symimgs: no ethport: 0 V54 MAC Address Pool: yes, size 32, base 24:C9:A1:3F:06:10 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 299 Setup Commands setup 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 300 Setup Commands setup 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 301 Setup Commands setup ************************************ 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.5, 800-71293-001 302 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 104. Show commands show adminactivity show alarm show ap show backup show backup- show backupconfig config-state show backup- show backupnetwork schedule show backupstate show backup- show client upgrade-state show clock show cluster show clusternode show cluster- show controlstate plane-stats show counter show cpuinfo show dhcprelay-stats show diskinfo show event show history show interface show ip show license show logs-filter show md-stats show meminfo show ntp show radiusproxy-stats show reportresult show rogueaps show runningconfig show service show upgradehistory show upgradestate show version show zone SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 show apcertificatestatus show ap-stats 303 Show Commands show admin-activity 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 304 Show Commands show alarm 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. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 305 Show Commands show ap-certificate-status 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 | 24h | 7-d | 8-h ] <mac>: AP MAC address type: Statistics data type client-count: Client count SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 306 Show Commands show ap-stats 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 307 Show Commands show ap-stats 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 | 8h] <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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 308 Show Commands show ap-stats <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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 309 Show Commands show backup 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 By Type Backup Elapsed File Size SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 DP Version Created 310 Show Commands show backup-config-state ---- -------------- ----------- ----------------- -----------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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 311 Show Commands show backup-schedule 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 312 Show Commands show backup-upgrade-state 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 : SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 313 Show Commands show clock 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 314 Show Commands show cluster 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 315 Show Commands show cluster-state 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 316 Show Commands show control-plane-stats 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 317 Show Commands show counter 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 318 Show Commands show cpuinfo 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) processor : 1 model name : Intel(R) processor : 2 model name : Intel(R) processor : 3 model name : Intel(R) processor : 4 model name : Intel(R) processor : 5 model name : Intel(R) processor : 6 model name : Intel(R) processor : 7 model name : Intel(R) Cpu(s): 48.1%us, 3.9%sy, 0.7%si, 0.0%st Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz Core(TM) i7-3770 CPU @ 3.40GHz 0.0%ni, 46.7%id, 0.6%wa, 0.0%hi, SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 319 Show Commands show dhcp-relay-stats 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 /dev/sda3 /dev/mapper/vg00-lv00 tmpfs /dev/sda1 Size 20G 242G 1.0G 9.9G Used Avail Use% Mounted on 2.1G 17G 11% / 2.6G 227G 2% /data 1.2M 1023M 1% /tmp 151M 9.2G 2% /boot_mbr SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 320 Show Commands show event 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 321 Show Commands show interface 0. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. en config helop help exit help ping host ping 172.19.10.9 setup show clock show cpuinfo show diskinfo show meminfo show version 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 322 Show Commands show ip 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 323 Show Commands show license 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 324 Show Commands show logs-filter 3 NMS CAPACITY-AP-DEFAULT 1000 Default AP Capacity License for SZ100 2015-03-03 GMT 2015-05-31 GMT show logs-filter To display client logs, use the following command: ruckus# show logs-filter Syntax Description This command has the following arguments or keywords: client <mac> • client: Client MAC • <mac>: STA MAC Address client <mac> copy <ftp-url> • client: Client MAC • <mac>: STA MAC Address • copy: Copy STA real-time tracing log to external FTP server • <ftp-url>: FTP directory URL, Format:ftp://<username>:<password>@<ftphost>[</dir-path>] Default This command has no default settings. Command Mode Privileged Example SZ100# show logs-filter client SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 325 Show Commands show md-stats show md-stats To display MD-statistics captured on this controller, use the following command: ruckus# show md-stats Syntax Description This command has the following arguments or keywords: scg: Displays the Local MD shared memory stats peer-scg-mac ${scgMac} • peer-scg-mac: Display the other SCG-MD connection stats at SCG • ${scgMac}: ap-mac ${apMac} • ap-mac: Display the stats for Connected AP at SCG • ${apMac}: [ scg-app-name ] ${appName} scg-app-name : Display the local application stats; Application Names must be among • (scg_md/scg_sessmgr/md_proxy/scg_hip/scg_cnr/scg_communicator/ scg_sciagent/scg_web/scg_eventreader/scg_nbi/scg_publicapi/scg_memproxy/scg_observer/scg_logmgr/logclient/scg_idm/scg_ccd/scg_push/ scg_greyhound/scg_snmp/scg_cached) • ${appName}: node-id ${nodeId} • node-id: Display nodeId's stats; Valid value: Actual node id + 1 • ${nodeId}: remote mac app-name ${apMac} app-name ${appName} • remote: Get the stats from remote AP/DP; Valid value: ap / dp • mac: Provide MAC of AP/DP • app-name: Provide app-name from AP/DP; Valid value: ap_md / dp_md • ${apMac}: • app-name: • ${appName}: SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 326 Show Commands show meminfo Default This command has no default settings. Command Mode Privileged Example SZ100# show logs-filter client 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 Mem: 32775708 16625356 16150352 -/+ buffers/cache: 15509652 17266056 Swap: 0 0 0 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 buffers cached 0 163996 951708 327 Show Commands show ntp 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 On Last Modified On NAS Type Accounting ACCESS Request ACCESS Challenge SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Created Auth ACCESS Accept 328 Show Commands show report-result 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 201404-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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 329 Show Commands show rogue-aps 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) SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 330 Show Commands show run cluster-redundancy show run cluster-redundancy To view cluster redundancy configurations, use the following command: ruckus# show run cluster-redundancy <name> Syntax Description This command uses the following syntax: name: Cluster name Default This command has no default settings. Command Mode Privileged Example SZ100# show run cluster-redundancy Cluster Redundancy : Disabled 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: ad-service ad-service: Shows active directory service configurations admin admin: Shows Administrator configurations admin-radius admin-radius: Shows RADIUS server configurations for administrators ap ap: Shows AP configurations ap-auto-approve ap-auto-approve: Shows the current AP approval policies ap-auto-tagging ap-auto-tagging: Shows critical AP Auto tagging rules configurations SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 331 Show Commands show running-config ap-cert-check ap-cert-check: Shows AP certificate check configurations ap-control-mgmt-tos ap-control-mgmt-tos: Shows AP control and management traffic TOS configurations ap-heartbeat ap-heartbeat: Shows AP heartbeat interval configurations bridge-profile bridge-profile: Shows bridge service profile configurations cert-store cert-store: Shows certificate store configurations cluster-node cluster-node: Shows cluster node configurations cluster-redundancy cluster-redundancy: Shows cluster redundancy configurations dns-server-service dns-server-service dns-server-service: Shows DNS server service configurations dp-group dp-group: Shows data plane grouping configurations encrypt-mac-ip: encrypt-mac-ip: Shows MAC and IP encryption for WISPr enriched URL configurations encrypt-zone-name encrypt-zone-name: Shows AP zone name encryption for WISPr enriched URL configurations eth-port-validate-one-trunk eth-port-validate-one-trunk: Shows validator for AP with at least one trunk port configurations event event: Shows events configurations event-threshold event-threshold: Shows event threshold ftp-server SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 332 Show Commands show running-config ftp-server: Shows FTP server configurations identity-provider identity-provider: Shows identity provider configurations interface interface: Shows interface configurations internal-subnet internal-subnet: Shows internal subnet prefix ip ip: Shows control plane IP configurations ip-support ip-support: Shows IP version support configuration ipsec-profile ipsec-profile: Shows IPsec profile configurations lbs-service lbs-service: Shows LBS service ldap-service ldap-service: Shows LDAP Service configurations license license: Shows license server configuration lineman lineman: Shows Lineman application configuration localdb-service localdb-service: Shows LOCAL DB service configurations lwapp2scg lwapp2scg: Shows LWAPP2SCG configuration mgmt-acl mgmt-acl: Shows management interface access control list configurations northbound-portal northbound-portal: Shows northbound portal interface configurations ntp-server ntp-server: Shows NTP server configurations oauth-service oauth-service: Shows OAuth service configurations SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 333 Show Commands show running-config operator-profile operator-profile: Shows Wi-Fi operator profile configurations outbound-firewall: outbound-firewall: Shows outbound firewall configurations proxy-aaa proxy-aaa: Shows Proxy AAA server configurations report: report: Shows report configurations rks-gre: rks-gre: Shows Ruckus GRE configurations sci-profile: sci-profile: Shows SCI profile configurations sci-setting sci-setting: Shows SCI server configurations sms-server sms-server: Shows SMS server configurations smtp-server smtp-server: Shows SMTP server configurations snmp-notification snmp-notification: Shows SNMP notification configurations snmp-v2-community snmp-v2-community: Shows SNMPv2 community configurations snmp-v3-user snmp-v3-user: Shows SNMPv3 user configurations soft-gre soft-gre: Shows soft GRE configurations subpackages subpackages: Shows subscription packages configurations syslog-server syslog-server: Shows Syslog server configurations user-agent-blacklist user-agent-blacklist: Shows user agent black list configurations user-role SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 334 Show Commands show running-config user-role: Shows user Role configurations user-traffic-profile user-traffic-profile: Shows user traffic profile configurations web-cert: web-cert: Shows web certificate configurations wlan-template wlan-template: Shows WLAN template configurations zone zone: Shows AP zone configurations zone-global zone-global: Shows zone global configurations zone-template zone-template: Shows AP Zone template configurations Default This command has no default settings. 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 335 Show Commands show run sci-profile Priority : Err Mesh Options -------------------------------------------------------------Mesh : Disabled Radio Options -------------------------------------------------------------Channelization (2.4G/5G) : Auto / Auto Channel (2.4G/5G) : Auto / Auto(indoor), Auto(outdoor) show run sci-profile To view the SmartCell Insight (SCI) profile configurations, use the following command: ruckus# show run sci-profile <name> Syntax Description This command uses the following syntax: name: SCI profile name Default This command has no default settings. Command Mode Privileged Example SZ100# show run sci-profile SCI Configuration -------------------------------------------------Enable SCI : Disabled SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 336 Show Commands show run sci-setting show run sci-setting To view the SmartCell Insight (SCI) server configurations, use the following command: ruckus# show run sci-setting Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example SZ100#1# show run sci-setting SCI Configuration -------------------------------------------------Enable SCI : Disabled show run user-group To view the user-group information, use the following command: ruckus# show run user-group Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example SZ100#1# show run user-group No. Name Manage By Description Permission Resources Users ----- ------------------- ------------------------ --------- SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 337 Show Commands show run zone 1 Administration_Dom Administration Domain of SUPER_ADMIN SZ,AP,WLAN,User/Device/ admin ain_Super_Admin tenant(Sup App,Admin,MVNO er) has same permission as before The user show run zone To view AP zone configurations, use the following command: ruckus# show run zone <name> Syntax Description This command uses the following syntax: 3.5 Zone: Default zone name: AP Zone name Default This command has no default settings. Command Mode Privileged Example SZ100# show run zoneNODE111# show run user-group No. Zone Name Description Management Domain AP Firmware # of APs # of WLANs Mesh Tunnel Type AP IP Mode Created By Created On ------------------ ------------------------ -------------- 1 R720_Zone_1162 Administration Domain 3.5.0.99.1162 0 0 Disabled Ruckus GRE (GRE+UDP) IPv4 admin 2017-0222 06:46:31 GMT 2 Zone-2 Domain 3.5.0.99.1063 0 Ruckus GRE (GRE+UDP) IPv4 27 09:59:34 GMT 3 3.5.Zone Domain 3.5.0.99.1160 0 Ruckus GRE (GRE+UDP) IPv4 30 08:48:36 GMT SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 0 Administration Disabled admin 2017-01- 2 Administration Disabled admin 2017-01- 338 Show Commands show run zone-template show run zone-template To view AP Zone template configurations, use the following command: ruckus# show run zone-template <name> Syntax Description This command uses the following syntax: name: AP Zone Template name Default This command has no default settings. Command Mode Privileged Example SZ100# show run zone-template show service To view the system service state, use the following command: ruckus# show service Syntax Description This command uses the following syntax: name: System service name Default This command has no default settings. Command Mode Privileged Example 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 339 Show Commands show upgrade-history 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 340 Show Commands show upgrade-state show upgrade-state To display the system upgrade state, use the following command: ruckus# show upgrade-state Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example 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 Serial # SZ Version Control Plane Software Version Data Plane Software Version AP Firmware Version SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 : : : : : : SZ104 1341B03119 3.1.0.0.187 3.1.0.0.381 3.1.0.0.33 3.1.0.0.280 341 Show Commands show zone show zone To view the AP zone states, use the following command: ruckus# show zone <name> Syntax Description This command uses the following syntax: <name> ap <mac> <name>: AP zone name ap: Shows the AP list of a specific AP zone <mac>: AP MAC address <name> client <client-mac> <name>: AP zone name client: Shows the client list of a specific AP zone <client-mac>: Client MAC address <name> ttg-client <client-mac> <name>: AP zone name ttg-client: Shows the TTG client list of a specific AP zone <client-mac>: Client MAC address <zone-name>: AP zone name Default This command has no default settings. Command Mode Privileged Example ruckus# show zone No. Zone Name Management Domain Description AP Firmware # of Alarms # of APs # of WLANs # of Clients --------- --------------------------------------------------1 INDUS7-WISP Administration Domain INDUS7-WISP 2.5.0.0.497 0/1/0/0 1 (1/0) 2 0 2 P1_ZONE_01 Deployment_Demo_DOMAIN phase1 Zone 01 1.1.2.0.100 0/1000/0/0 1000 (0/1000) 1 0 3 WISPR Administration Domain WISPR 2.5.0.0.497 0/1/0/0 0 (0/0) 2 0 4 INDUS7-MVNO Administration Domain INDUS7-MVNO 2.5.0.0.497 0/0/0/0 0 (0/0) 1 0 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 342 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. Table 105. System commands ? backup backup config backup network backup schedule backupupgrade cluster inservice config copy apcertificaterequest copy backup copy backup- copy backup- copy client config network copy reportresult copy ftp-url delete backup delete backup- delete backupconfig network delete client diagnostic enable logout copy exit help log-diagnostic no service patches ping ping6 reload reload now remote ap-cli restore restore config restore network service restart service start set-factory shutdown upgrade upload apcertificatestatus enable <new password> reload ap shutdown now traceroute SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 traceroute6 343 System Commands ? ? To display commands that are available on the command line, use the following command: ruckus# ? Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example SZ100-Node1# backup backup-upgrade cluster config copy curl debug delete diagnostic enable exit help log-diagnostic logout no patches ping ping6 rbddump reload remote Backups the system or configuration Backups and upgrades the system Cluster commands Enter configuration mode Copy commands Curl commands Debug commands Delete commands Diagnostic commands Change the password Turn off privileged commands Displays help Logs diagnostic feature CLI commands Exits from the EXEC Disable commands Patch management commands Sends ICMP echo request to network host Sends ICMP echo request to network host Dumps Rbd board data Reloads the system Remote commands SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 344 System Commands backup 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 345 System Commands backup network 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 346 System Commands backup-upgrade 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>:<password>@<ftp-host>[/<dir-path>] Default This command has no default settings. Command Mode Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 347 System Commands cluster in-service 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)# SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 348 System Commands copy NOTE: To view configuration commands, see Configuration Commands (a - d) chapters. copy To copy the AP certificate request to the external FTP server, to backup, backupconfig, 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>@<ftphost>[/<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 report-result: Copy Report Result to external FTP server <ftp-url>: Copy file from external FTP server, Format: ftp://<username>:<password>@<ftp-host>[/<dir-path>] Default This command has no default settings. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 349 System Commands copy ap-certificate-request 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/SmartZoneconfig backup-config SZ100-Node1# copy ftp://test:testpwd@172.17.22.11/SmartZonenetwork 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>:<password>@<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> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 350 System Commands copy backup-config Syntax Description This command uses the following syntax: <ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftphost>[/<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>@<ftphost>[/<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> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 351 System Commands copy client Syntax Description This command uses the following syntax: <ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftphost>[/<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>:<password>@<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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 352 System Commands copy report-result copy report-result To copy report result to external FTP server, use the following command: ruckus# copy report-result <name> <ftp-url> Syntax Description The command uses the following syntax: <name> <ftp-url> <name>: Report name <ftp-url>: FTP directory, FTP URL format: ftp://<username>:<password>@<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>@<ftphost>[/<dir-path>]] Default This command has no default settings. Command Mode Privileged Example SZ100-Node1# copy ftp://test:testpwd@172.17.22.11 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 353 System Commands delete backup 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 354 System Commands delete backup-network 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 355 System Commands diagnostic diagnostic To run diagnostic commands, use the following command: ruckus# diagnostic Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Privileged Example SZ100-Node1# diagnostic SZ100-Node1(diagnostic)# Related Commands Table 106 lists the related diagnostic commands. Table 106. Commands related to ruckus(diagnostic) Syntax and Type Parameters (If Any) ruckus(diagnostic)# copy snapshot <ftp-url>: Type: Privileged FTP directory URL, Format: ftp:// <username>:<password >@<ftp-host>[/<dirpath>] ruckus(diagnostic)# delete snapshot ${snapshotName} Description Copy snapshot to external FTP server. Deletes all snapshot. Type: Privileged ruckus(diagnostic)# do Executes the do command. Type: Privileged ruckus(diagnostic)# end Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Ends the current configuration session and returns to privileged EXEC mode. 356 System Commands diagnostic Table 106. Commands related to ruckus(diagnostic) Syntax and Type Parameters (If Any) ruckus(diagnostic)# execute all Description Executes all cases. Type: Privileged ruckus(diagnostic)# execute case <name>: Case name Executes the specified case. Type: Privileged ruckus(diagnostic)# exit Exits from the EXEC. Type: Privileged ruckus(diagnostic)# help Displays help. Type: Privileged ruckus(diagnostic)# remotepacket-capture-disable Disables the remote packet capture. Type: Privileged ruckus(diagnostic)# remotepacket-capture-enable Enables the remote packet capture. Type: Privileged ruckus(diagnostic)# show case Shows the case. Type: Privileged ruckus(diagnostic)# show ipmi [ health | sensors | sel ] Type: Privileged health: Shows the BMC basic health Shows IPMI information. sensors: Shows the hardware sensors, fru, LEDs information sel: Shows the system event log records Show snapshot files. ruckus(diagnostic)# show snapshot Type: Privileged ruckus(diagnostic)# show version Shows the version. Type: Privileged ruckus(diagnostic)# trigger-apbinary-log <ap-mac> Triggers AP binary log Type: Privileged SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 357 System Commands diagnostic Table 106. Commands related to ruckus(diagnostic) Syntax and Type Parameters (If Any) Description ruckus(diagnostic)# trigger-trap all: Trigger all traps Triggers specified traps Type: Privileged <event-code>: Multiple traps separated by commas. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 358 System Commands enable 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. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 359 System Commands exit 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 360 System Commands logout 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 log-diagnostic To access the log-diagnostic feature-related commands, use the following command: ruckus# log-diagnostic Syntax Description This command uses the following syntax: ap-log-level-set: Sets log level at the AP for log diagnostic. set-offline-filter: Sets the offline log analysis filter options. Default This command has no default settings. Command Mode User SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 361 System Commands no service Example SZ100-Node1# log-diagnostic set-offline-filter SCG 03/01/2017/ 00:00:01 03/17/2017/00:00:01 00:0C:29:fc:32:3d 1.2.3.4 DBG Message 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 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 362 System Commands ping Example SZ100-Node1# patches SZ100-Node1(patches)# show <applied-patches> <uploaded-patches> Related Commands Table 107 lists the related patches commands. Table 107. Commands related to ruckus(patches) Syntax and Type Parameters (If Any) Description ruckus(patches)# apply <name> Type: Privileged Applies a patch script. Once a patch is applied is cannot be reapplied. ruckus(patches)# do Executes the do command. Type: Privileged ruckus(patches)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(patches)# exit Exits from the EXEC. Type: Privileged ruckus(patches)# help Displays help. Type: Privileged ruckus(patches)# no patches Delete a patch script, Once the patch file is applied, it cannot be deleted ruckus(patches)# show applied-patches Type: Privileged uploaded-patches Shows the applied and uploaded patch list. Type: Privileged ruckus(patches)# show case Shows the case. Type: Privileged ruckus(patches)# upload <ftp-url> Type: Privileged Uploads a patch script from a remote FTP server. ping To send an ICMP echo request to the network host, use the following command: ruckus# ping <host> SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 363 System Commands ping6 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 PING 172.19.10.9 (172.19.10.9) 56(84) 64 bytes from 172.19.10.9: icmp_seq=1 64 bytes from 172.19.10.9: icmp_seq=2 64 bytes from 172.19.10.9: icmp_seq=3 times... bytes of data. ttl=64 time=0.016 ms ttl=64 time=0.014 ms 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 364 System Commands reload 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. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 365 System Commands reload now 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 366 System Commands restore 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 ----- ----------------------------- -------------------------- SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 367 System Commands restore local 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 368 System Commands service restart 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 369 System Commands set-factory 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,freeradius,memcached,monitor,northbound,repcached,scheduler,tomcat) Up! wait for (cassandra,communicator,eventreader,freeradius,memcached,monitor,northbound,repcached,scheduler,tomcat) Up! wait for (communicator,eventreader,freeradius,memcached,monitor,northbound,repcached,scheduler,tomcat) Up! wait for (communicator,eventreader,monitor,northbound,repcached,scheduler,tomcat) Up! wait for (communicator,eventreader,monitor,northbound,repcached,scheduler,tomcat) Up! wait for (communicator,eventreader,monitor,northbound,repcached,scheduler,tomcat) Up! wait for (communicator,eventreader,monitor,northbound,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. SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 370 System Commands set-factory 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 371 System Commands shutdown 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 372 System Commands snapshot disk snapshot disk To get a snapshot of the disk, use the following command (available only with vSZ-E): 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 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 373 System Commands traceroute 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). Noninteger (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' SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 374 System Commands traceroute6 --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 traceroute6 To print the route that packets take to the network host, use the following command: ruckus# traceroute6 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example SZ100-Node1# traceroute6 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 375 System Commands upgrade 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 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.5, 800-71293-001 376 Index Symbols D ? 344 debug 278 debug apcli c 279 debug dataplane 281 debug diagnostic 282 delete backup 354 delete backup-config 354 delete backup-network 355 delete client 355 dhcp-service 283 diagnostic 281, 356 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 278, 279 ap-control 94 ap-heartbeat 52 ap-model 44 ap-model-lan1 46 app-denial-policy-rule 53 ap-sci |enable 50, 52, 53 B backup 345 backup config 345 backup network 346 backup-upgrade 346, 347 bonjour-policy 53, 54 E enable 359, 359 end 69, 284 eth-port-validate-one-trunk 69 event 70, 73, 119, 120, 186 event email 72, 74, 75 event-email 74 event-threshold 75 exit 76, 360 export log 285 F ftp-server 76, 77 G C cert-store 55 clock 58 cluster in-service 348 cluster redundancy 61 cluster redundancy cluster 62 cluster-ip-list 59, 60 cluster-redundancy 60 config 348 config-mgmt-and-ap-control 94 copy 349 copy backup 350 copy backup-config 351 copy client 352 copy report-result 353 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 guest access 246 H help 285, 360 I identity-provider 80 identity-provider-acct-profile 82 identity-provider-acct-profile-realm 83 identity-provider-auth-profile 83 identity-provider-osu-enable 86 identity-provider-realms 89 identity-provider-realms-eaps 90 377 identity-provider-realms-eaps-auth 92 interface management 93 interface-ap-tunnel-data 94 interface-user-defined 94, 96, 97 ip internal-subnet 98 ip name-server 99, 100 ip route 100, 101 no snmp-v2-community 144, 146 no snmp-v3-user 146, 147 no user-group 148 no zone 152 northbound-authtype 153 northbound-portal 153 ntp-server 154 L O lbs-service 107 ldap-service 109 license import 111, 112, 113, 114 limited privileges 23 lineman 114 localdb-service 115 log on to CLI 22 log-diagnostic 361 logging console 116 logout 361 lwapp2scg 118 oauth-service 155 operator-profile 157 osu-portal-profile 159 overview 16 P patches 363 ping 363, 364 proxy-aaa 161 R M management (Web) interface 16 N no admin 120, 121 no admin-radius 121 no ap 122 no ap auto-tagging 122, 123 no ap-cert-check 123 no ap-group 124 no control-plane 128 no data-plane 128, 129 no diffserv 129 no dns-server-service 130 no encrypt-zone-name 131, 132 no event 132 no ftp-server 133 no interface 136 no ip 136 no logging 140, 141, 142 no report 142 no role 143 no sci-profile 143 no screen-pagination 286, 288 no service 362 no snmp-notification 144 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Rev C rbddump 298 reindex-elasticsearch-all 292 reload 365 reload ap 365 reload now 366 remote ap-cli 366 report 164 restore config 367 restore local 368 restore network 368 rJ45 cable 16 role 168, 169, 170 rS-232 serial 16 S sci-profile 172 sci-setting 174 screen-pagination 292 serial connection 16, 19 service restart 369 service start 369 set-factory 370 setup 300 sha1 293 show admin 304 show admin-activity 304 show alarm 305 378 show ap 305 show ap-heartbeat 306 show backup 310 show backup-config 310 show backup-network 311 show backup-state 312 show backup-upgrade-state 313 show client 313 show clock 314 show cluster 315 show cluster-state 316 show control-plane-stats 316 show cpuinfo 319 show dhcp-relay-stats 320 show diskinfo 320 show event 321 show history 321 show interface 322 show ip 323 show license 324 show md-stats 326 show meminfo 327 show ntp 328 show radius-proxy-stats 328 show report-result 329 show run sci-profile 331, 336, 338, 339 show run sci-setting 337 show run user-group 337 show running-config 331 show service 339 show sha1-state 295 show upgrade-history 340 show upgrade-state 341 show version 341 show zone 342 shutdown 372 shutdown force 376 shutdown now 372 sms-server 172, 174, 175, 184 smtp-server 175, 176, 177 snmp-notification 179 snmp-v2-community 179, 180 snmp-v3-user 181, 182 soft-gre 183 sSH client 17 SSH connection 18 sSH connection 16 support-admin 187 syslog 188 syslog server 188 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Rev C syslog-server 188 T tlsv1 297 U upgrade 376 user-agent-blacklist 191 user-group 193 user-role 195 user-traffic-profile 197 user-traffic-profile-acl 198 V vlan-pooling 200 Z zone 204 zone-aaa 216 zone-ap-group 219 zone-ap-group-group-ap-snmp-options 228 zone-ap-group-lldp 227 zone-ap-group-port-setting 229 zone-ap-model 230 zone-ap-model-lan1 233 zone-ap-registration-rule 234, 235, 236, 237 zone-ap-snmp-options-snmp-v2-community 236 zone-block-client 237 zone-bonjour-fencing-policy 238 zone-bonjour-policy 238 zone-bonjour-policy-rule 239 zone-device-policy 241 zone-device-policy-policy-rule 242 zone-diffserv 243 zone-hotspot 248 zone-hotspot20-venue-profile 250 zone-hotspot20-wlan-profile 254 zone-hotspot20-wlan-profile cust-connect-capabilities 258 zone-l2-acl 259 zone-template 275 zone-web-authentication 259, 260 zone-wlan 261 zone-wlan-group 274 379 zone-wlan-qos-map 273 zone-wlan-scheduler 275 SZ-100 and vSZ-E CLI Reference Guide for SmartZone 3.5, 800-71293-001 Rev C 380 Copyright © 2006-2017. Ruckus Wireless, Inc. 350 West Java Dr. Sunnyvale, CA 94089. USA www.ruckuswireless.com </pre><hr>Source Exif Data: <br /><pre>File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.6 Linearized : Yes Author : Ruckus Wireless™, Inc. Create Date : 2017:04:10 15:50:39Z Modify Date : 2017:04:25 12:21:58-07:00 Subject : SZ™ 100 and vSZ-E™ Command Line Interface Reference Guide for SmartZone 3.5 Language : en XMP Toolkit : Adobe XMP Core 5.2-c001 63.139439, 2010/09/27-13:37:26 Format : application/pdf Title : SZ™ 100 and vSZ-E™ Command Line Interface Reference Guide for SmartZone 3.5 Creator : Ruckus Wireless™, Inc. Description : SZ™ 100 and vSZ-E™ Command Line Interface Reference Guide for SmartZone 3.5 Creator Tool : FrameMaker 11.0.2 Metadata Date : 2017:04:25 12:21:58-07:00 Producer : Acrobat Distiller 11.0 (Windows) Document ID : uuid:fe73b2bf-59cf-4e8f-b129-8aab45326664 Instance ID : uuid:b8683c0a-6c0b-4213-8521-7fbe6bd3091a Page Mode : UseOutlines Page Count : 381 </pre> <small>EXIF Metadata provided by <a href="https://exif.tools/">EXIF.tools</a></small> <div id="ezoic-pub-ad-placeholder-110"> <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script> <!-- usermanual link ad --> <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-0545639743190253" data-ad-slot="6172135303" data-ad-format="link"></ins> <script> (adsbygoogle = window.adsbygoogle || []).push({}); </script> </div> </div> <div id="catlinks" class="catlinks catlinks-allhidden" data-mw="interface"></div> <div class="visualClear"></div> </div> </div> <div id="mw-navigation"> <h2>Navigation menu</h2> <div id="mw-head"> <div id="p-personal" role="navigation" class="" aria-labelledby="p-personal-label"> <!-- <div id="p-search" role="search"> <form action="https://usermanual.wiki/search.php" id="searchform"> <div id="simpleSearch"> <input type="search" name="search" placeholder="Search UserManual.wiki" title="Search UserManual.wiki [ctrl-option-f]" accesskey="f" id="searchInput" tabindex="1" autocomplete="off"><input type="hidden" value="Special:Search" name="title"><input type="submit" name="go" value="Go" title="Find a User Manual" id="searchButton" class="searchButton"> </div> </form> </div>--> <ul> <li id="pt-mycontris"><a href="https://usermanual.wiki/upload" title="Upload User Manual" accesskey="y">Upload a User Manual</a></li> </ul> </div> <div id="left-navigation"> <div id="p-namespaces" role="navigation" class="vectorTabs" aria-labelledby="p-namespaces-label"> <h3 id="p-namespaces-label">Versions of this User Manual:</h3> <ul> <li id="ca-nstab-main"><span><a href="https://usermanual.wiki/Ruckus/Sz100Vsze35CLIGuide20170410.492255472" title="User Manual Wiki" accesskey="c">Wiki Guide</a></span></li> <li id="ca-nstab-main"><span><a href="https://usermanual.wiki/Ruckus/Sz100Vsze35CLIGuide20170410.492255472/html" title="HTML" accesskey="c">HTML</a></span></li> <li id="ca-nstab-main"><span><a href="https://usermanual.wiki/Ruckus/Sz100Vsze35CLIGuide20170410.492255472/amp" title="Mobile AMP" accesskey="c">Mobile</a></span></li> <li id="ca-nstab-main" class="selected" ><span><a href="https://usermanual.wiki/Ruckus/Sz100Vsze35CLIGuide20170410.492255472/help" title="Discussion / FAQ / Help" accesskey="c">Download & Help</a></span></li> </ul> </div> </div> <div id="right-navigation"> <div id="p-views" role="navigation" class="vectorTabs" aria-labelledby="p-views-label"> <h3 id="p-views-label">Views</h3> <ul> <li id="ca-view"><span><a href="#">User Manual</a></span></li> <li class="selected" id="ca-edit"><span><a href="https://usermanual.wiki/Ruckus/Sz100Vsze35CLIGuide20170410.492255472/help" title="Ask a question" accesskey="e">Discussion / Help</a></span></li> </ul> </div> </div> </div> <div id="mw-panel"> <div id="p-logo" role="banner"><a class="mw-wiki-logo" href="https://usermanual.wiki/Main_Page" title="Visit the main page"></a></div> <div class="portal" role="navigation" id="p-navigation" aria-labelledby="p-navigation-label"> <h3 id="p-navigation-label">Navigation</h3> </div> <div class="portal" role="navigation" id="p-tb" aria-labelledby="p-tb-label"> </div> </div> </div> <div id="footer" role="contentinfo"> <ul id="footer-info"> <li id="footer-info-lastmod">© 2022 UserManual.wiki</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://usermanual.wiki/ContactUs" title="UserManual.wiki:Contact Us">Contact Us</a></li> <li id="footer-places-about"><a href="https://usermanual.wiki/DMCA" title="UserManual.wiki:DMCA">DMCA</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-poweredbyico"> </li> </ul> </div> </div></body></html>