Ruckus SmartCell Gateway™ 200 Command Line Interface Reference Guide For RuckOS 3.0 SCG Ruck OS 3 0 Cli Rg 20141203

SCG-200 Command Line Interface Reference Guide for RuckOS 3.0 scg-3-0-cli-rg--20141203

2014-12-03

User Manual: Ruckus SCG-200 Command Line Interface Reference Guide for RuckOS 3.0

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

DownloadRuckus SmartCell Gateway™ 200 Command Line Interface Reference Guide For RuckOS 3.0 SCG-200 Ruck OS Scg-3-0-cli-rg--20141203
Open PDF In BrowserView PDF
Ruckus Wireless
SmartCell Gateway 200
™

™

Command Line Interface Reference Guide for
RuckOS 3.0

Part Number 800-70675-001 Rev A
Published November 2014
www.ruckuswireless.com

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

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

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

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

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

2

Contents

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

1

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

2

Configuration Commands
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3rd-zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
acct-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
config-admin-radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
adv-forwarding-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
ap-auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
ap-cert-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ap-heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
ap-portal-cert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
ap-root-ca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
ap-sci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
auth-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
cgf-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
changepassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

3

Contents

clock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
cluster-ip-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
cluster-redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dhcp-service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3

67
67
68
70
72
73
74
75

Configuration Commands
eap-aka . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
eap-sim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
event db-persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
event email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
event snmp-trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
event-email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ftp-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
ggsn-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
hlr-mnc-ndc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
hlr-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
hlr-system-wide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
hotspot-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
ip default-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
ip internal-subnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
ip name-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
ip route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
ip separate-access-core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
l2ogre-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
l3ogre-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
license import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

4

Contents

lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
logging console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
lwapp2scg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
mgmt-acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
mvno . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
network-traffic-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
no 3rd-zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
no acct-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
no admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
no admin-radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
no adv-forwarding-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
no ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
no ap auto-tagging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
no ap-cert-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
no ap-control-mgmt-tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
no ap-root-ca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
no ap-sci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
no auth-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
no cgf-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
no cls-sess msisdn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
no cls-sess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
no control-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
no data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
no dhcp-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
no domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
no dp-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
no eap-aka . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
no eap-sim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
no encrypt-mac-ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
no event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
no ftp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
no ggsn-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
no hlr-mnc-ndc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
no hlr-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
no hotspot-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
no interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
no ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
no l2ogre-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
no l3ogre-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

5

Contents

no lbs-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
no lineman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
no logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
no mvno . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
no network-traffic-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
no pmipv6-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
no radius-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
no report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
no rks-gre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
no role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
no snmp-trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
no snmp-v2-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
no snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
no soft-gre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
no subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
no ttg-pdg-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
no user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
no user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
no user-traffic-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
no zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
northbound-authtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
northbound-portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
ntp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
pmipv6-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
q-in-q-ethertype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
radius-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
rks-gre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

4

Configuration Commands
sms-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
smtp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
snmp-trap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
snmp-v2-community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
snmp-v3-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
soft-gre. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
stats-upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

6

Contents

syslog-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
ttg-pdg-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
user-agent-blacklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
user-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
user-traffic-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
web-cert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
zone-template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
zone-zd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

5

Debug Commands
debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
ap-cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
export log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
no screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
screen-pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

6

Setup Commands
rbddump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

7

Show Commands
show 3rd zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
show admin-activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
show alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
show ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
show ap-stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
show backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
show backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
show backup-config-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
show backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
show backup-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

7

Contents

show backup-upgrade-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
show cgf-cnxn-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
show cgf-tx-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
show client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
show clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
show cls-sess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
show cls-sess-range. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
show cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
show cluster-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
show control-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
show control-plane-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
show cpuinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
show data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
show data-plane-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
show dhcp-relay-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
show dhcp-server-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
show diskinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
show event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
show ggsn-cnxn-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
show ggsn-gtpc-stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
show hlr-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
show hlr-sctp-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
show internal-subnet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
show ip. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
show license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
show lma-connectivity-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
show lma-signaling-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
show meminfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
show radius-proxy-stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
show radius-server-stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
show report-result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
show rogue-aps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
show running-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
show service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
show ttg-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
show upgrade-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

8

Contents

show upgrade-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
show version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
show zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

8

System Commands
? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
backup config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
backup network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
backup-upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
cluster in-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
copy backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
copy backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
copy backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
copy client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
copy report-result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
delete backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
delete backup-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
delete backup-network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
delete client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
enable  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
no service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
reload ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
reload data-plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
reload now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
remote ap-cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
restore config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
restore local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
restore network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
service restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

9

Contents

service start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
set-factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
shutdown now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Index

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

10

About This Guide
This SmartCell Gateway™ (SCG) 200 Command Line Interface Reference Guide
contains the syntaxes and commands for configuring and managing the SCG from
the command line interface.
This guide is written for service operators and system administrators who are
responsible for managing, configuring, and troubleshooting Ruckus Wireless
devices. Consequently, it assumes a basic working knowledge of local area
networks, wireless networking, and wireless devices.
NOTE: This guide assumes that the SmartCell Gateway has already been installed
as described in Getting Started Guide.
Most user guides and release notes are available in Adobe Acrobat Reader Portable
Document Format (PDF) or HTML on the Ruckus Wireless Support Web site at
https://support.ruckuswireless.com/documents.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

11

About This Guide
Document Conventions

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

Text conventions

Convention

Description

monospace

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

monospace bold

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

default font bold

Keyboard keys, software
buttons, and field names

On the Start menu, click All
Programs.

italics

Screen or page names

Click Advanced Settings.
The Advanced Settings page
appears.

Table 2.

Example

Notice conventions

Notice Type

Description

NOTE

Information that describes important features or instructions

CAUTION!

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

WARNING!

Information that alerts you to potential personal injury

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

12

About This Guide
Documentation Feedback

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

13

Introduction to the SCG Command
Line Interface

1

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

14

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

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

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

Connect the Administrative Computer to SCG
Connect the administrative computer to SCG 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 SCG.
2 If you want to use a serial connection, make sure that both the administrative
computer and the SCG 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 SCG. 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.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

15

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Figure 1. Location of console port

Start and Configure the SSH Client
Before starting this procedure, make sure that the SSH client is already installed on
the administrative computer.
NOTE: The following procedure describes how to use PuTTY, a free and open
source telnet/SSH client, to access the SCG 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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

16

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Using SSH Connection
If you have connected the administrative computer to the same subnet or broadcast
domain as the Management (Web) interface of the SCG, 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 SCG 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.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

17

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Using Serial Connection
If you have connected the administrative computer to the console port on the SCG
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.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

18

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Figure 4. PuTTy’s default serial connection setting

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

19

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

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

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

20

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Figure 6. PuTTY console displaying the login prompt

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

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

21

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Figure 7. Welcome to SCG

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

22

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

Figure 8. Using Show Commands

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

23

Introduction to the SCG Command Line Interface
Accessing the Command Line Interface

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

24

2

Configuration Commands

This chapter describes the commands that you can use to configure, enable, and
disable various SCG 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

3rd-zone

acct-profile

admin

ap

ap-autotagging

ap-cert-check ap-controlmgmt-tos

ap-heartbeat

ap-portal-cert

ap-root-ca

ap-sci

auth-profile

cgf-service

changepasswor clock
d

cluster-ip-list

clusterredundancy

data-plane

dhcp-service

dp-group

domain

do

config-admin- adv-forwardingradius
profile

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

25

Configuration Commands
3rd-zone

3rd-zone
To create or update the third party AP zone configuration, use the following
command.
ruckus(config)# 3rd-zone 
Syntax Description
This command uses the following syntax:
name: AP zone name
Default
This command has no default settings.
Command Mode
Config
Example
SCG30(config)# 3rd-zone indus-ap

Related Commands
Table 4 lists the related to 3rd-zone configuration commands.
Table 4.

Commands related to ruckus(config-3rd-zone).

Syntax and Type

Parameters (if any)

Description

ruckus(config-3rd-zone)# accessnetwork

[qinq-l2 | l2ogre]

Sets the access network to Qin-Q layer 2 or L2oGRE.

Type: Privileged
ruckus(config-3rd-zone)# acct-interval : Interval to
send interim update
Type: Privileged

Sets the accounting interval.

ruckus(config-3rd-zone)# acct-server
Type: Privileged

Sets the accounting service.

ruckus(config-3rd-zone)# acctservice-profile



Sets the accounting service
profile.



Sets the accounting for TTG
session.

Type: Privileged
ruckus(config-3rd-zone)# acct-ttgsession
Type: Privileged

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

26

Configuration Commands
3rd-zone

Table 4.

Commands related to ruckus(config-3rd-zone).

Syntax and Type

Parameters (if any)

ruckus(config-3rd-zone)# auth-server
Type: Privileged
ruckus(config-3rd-zone)# authservice-profile

Description
Sets the authentication
service.



Sets the authentication service
profile.

Type: Privileged
ruckus(config-3rd-zone)# auth-type

Sets the authentication service
type.

Type: Privileged
ruckus(config-3rd-zone)# corenetwork

Sets the core network.

Type: Privileged
ruckus(config-3rd-zone)# description



Sets the description,

Type: Privileged
ruckus(config-3rd-zone)# do

Executes the do command.

Type: Privileged
ruckus(config-3rd-zone)# end
Type: Privileged

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

ruckus(config-3rd-zone)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-3rd-zone)# forwarding- 
service-profile

Sets the core network
forwarding profile.

Type: Privileged
ruckus(config-3rd-zone)# help

Displays the help.

Type: Privileged
ruckus(config-3rd-zone)# hotspotprofile



Sets the hotspot (WISPr)
service profile.

ruckus(config-3rd-zone)# ip

single-ip 

Type: Privileged

ip-range  

Sets the access network
source IP address.

Type: Privileged

subnet  

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

27

Configuration Commands
3rd-zone

Table 4.

Commands related to ruckus(config-3rd-zone).

Syntax and Type

Parameters (if any)

Description

ruckus(config-3rd-zone)# move

domain 

Moves the zone to another
domain.



Sets the 3rd party zone name.



Sets the access network traffic
profile.

ruckus(config-3rd-zone)# no

acct-server

Type: Privileged

acct-service-profile

Disables and deletes
commands.

Type: Privileged
ruckus(config-3rd-zone)# name
Type: Privileged
ruckus(config-3rd-zone)# networktraffic-profile
Type: Privileged

acct-ttg-session
ip
radius-client
vlan-tag
ruckus(config-3rd-zone)# radius-client default-share-secret

Type: Privileged

Sets the RADIUS client
options.

single-ip 

ip-range  

subnet  

ruckus(config-3rd-zone)# vlan-tag
Type: Privileged

s-vlan   c-vlan  
s-vlan   c-vlan   vlanmapping 


SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

28

Configuration Commands
acct-profile

Table 4.

Commands related to ruckus(config-3rd-zone).

Syntax and Type

Parameters (if any)

Description

ruckus(config-3rd-zone)# vlan-type

qinq

Type: Privileged

strip-qinq

Sets the core network VLAN
mapping type.

strip-svlan-preservecvlan
strip-qinq-add-vlan

map-svlan-preservecvlan
qinq 
strip-all
preserve-all
strip-all-add-vlan 

acct-profile
To create or update the accounting service profile configuration, use the following
command:
ruckus(config)# acct-profile 
Syntax Description
This command uses the following syntax:
name: Accounting service profile name
Default
This command has no default settings.
Command Mode
Config
Example
SCG30(config)# acct-profile rad-profile

Related Commands
• Table 5 lists the related acct-profile configuration commands.
• Table 6 lists the related acct-profile-realm configuration commands.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

29

Configuration Commands
acct-profile

Table 5 lists the related acct-profile configuration commands.
Table 5.

Commands related to ruckus(config-acct-profile).

Syntax and Type

Parameters (if any)

Description

ruckus(config-acct-profile)# default

no-match-realm acct


Set the default service.

no-realm acct 

No matching or no realm found
based on the default accounting
service and accounting service
name.



Set the description.

Type: Privileged

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

Executes the do command.

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

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

ruckus(config-acct-profile)# exit

Exits from the EXEC.

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

Displays the help.

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



Sets the accounting service
profile name.

realm 

Disables the realm based on the
realm name.



Set the accounting service
realm.

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

30

Configuration Commands
admin

Table 6 lists the related acct-profile-realm configuration commands.
.

Table 6.

Commands related to ruckus(config-acct-profile-realm)

Syntax and Type

Parameters (if any)

ruckus(config-acct-profile-realm)# acct-service 

Description
Sets the accounting service.

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

Executes the do command.

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

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

ruckus(config-acct-profile-realm# exit

Exits from the EXEC.

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

Displays the help.

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



Sets the realm name.

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

31

Configuration Commands
admin

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

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

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



Set the user’s email details.

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

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

ruckus(config-admin)# exit

Exits from the EXEC.

Type: Privileged
ruckus(config-admin)# help

Displays the help.

Type: Privileged
ruckus(config-admin)# password



Set the password for user.



Set the phone number of the
user.

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

32

Configuration Commands
config-admin-radius

Table 7.

Commands related to ruckus(config-admin)

Syntax and Type

Parameters (if any)

Description

ruckus(config-admin)# real-name



Set the real name of the user.



Set the user’s job title.

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

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

33

Configuration Commands
config-admin-radius

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

Commands related to ruckus(config-radius-service)

Syntax and Type

Parameters (if any)

ruckus(config-admin-radius)# do

Description
Executes the do command.

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

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

ruckus(config-admin-radius)# exit

Exits from the EXEC.

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

Displays the help.

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



Sets the IP addresses of the
primary RADIUS server.

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



Sets the RADIUS server name.

ruckus(config-admin-radius)# port



Sets the port addresses of the
primary RADIUS server.

Type: Privileged

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

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

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

Sets the realms.
 Multiple
realms supported.
Use a comma (,) to
separate realms
(example:home1,hom
e2)
: Multiple Sets the services.
services supported.
Use a comma (,) to
separate services
(example:home1,hom
e2)

Shared secret
between 1 and 255.

Sets the shared secret of the
primary RADIUS server.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

34

Configuration Commands
adv-forwarding-profile

Table 8.

Commands related to ruckus(config-radius-service)

Syntax and Type

Parameters (if any)

Description

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




Tests the RADIUS server based
on the user credentials.

ruckus(config-admin-radius)# type

[ radius | tacacs ]]

Sets the admin authentication
type,

Type: Privileged

adv-forwarding-profile
To enter the advanced (mixed mode) profile configuration, use the following
command:
ruckus(config)# adv-forwarding-profile 
Syntax Description
This command uses the following syntax:
name: Profile name
Default
This command has no default settings.
Command Mode
Config
Example
SCG30(config)# adv-forwarding-profile ttg-pdg

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

35

Configuration Commands
adv-forwarding-profile

Related Commands
• Table 9 lists related adv-forwarding-profile configuration commands.
• Table 10 lists the related adv-forwarding-profile-apn configuration commands.
Table 9 lists commands related to adv-forwarding-profile configuration commands.
Table 9.

Commands related to ruckus(config-adv-forwarding-profile)

Syntax and Type

Parameters (if any)

Description

ruckus(config-adv-forwardingprofile)# apn

nioi 

Creates or updates the
forwarding policy for APN
configuration commands.

ni 

Type: Privileged
ruckus(config-adv-forwardingprofile)# default

Sets the APN default settings.

Type: Privileged
ruckus(config-adv-forwardingprofile)# description



Sets the description. Length is
between 1 and 128.

apn 

Delete forwarding policies for
APN or default APNs for realm.

Type: Privileged
ruckus(config-adv-forwardingprofile)# no

realm 

Type: User
ruckus(config-adv-forwardingprofile)# realm

Creates or updates the default
APN for realm.

Type: Privileged
ruckus(config-adv-forwardingprofile)# do

Executes the do command.

Type: Privileged
ruckus(config-adv-forwardingprofile)# end
Type: Privileged
ruckus(config-adv-forwardingprofile)# exit

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

Type: Privileged
ruckus(config-adv-forwardingprofile)# help

Displays the help.

Type: Privileged

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

36

Configuration Commands
adv-forwarding-profile

Table 10 lists the related adv-forwarding-profile-apn configuration commands.
Table 10.

Commands related to ruckus(config-adv-forwarding-profile-apn)

Syntax and Type

Parameters (if any)

ruckus(config-adv-forwarding-profileapn)# profile

Description
Sets the forwarding service
profile.

Type: Privileged
ruckus(config-adv-forwarding-profileapn)# route-type

[ bridge | l3ogre ]

Sets the route type to either
bridge or L3oGRE.

Type: Privileged
ruckus(config-adv-forwarding-profileapn)# do

Executes the do command.

Type: Privileged
ruckus(config-adv-forwarding-profileapn)# end
Type: Privileged
ruckus(config-adv-forwarding-profileapn)# exit

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

Type: Privileged
ruckus(config-adv-forwarding-profileapn)# help

Displays the help.

Type: Privileged

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

37

Configuration Commands
ap

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

38

Configuration Commands
ap

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

Related Commands
• Table 11 lists the related ap profile configuration commands.
• Table 12 lists the related ap model configuration commands.
• Table 13 lists the related ap model lan1 configuration commands.
Table 11 lists the related ap profile configuration commands.
Table 11. Commands related to ruckus(config-ap).
Syntax and Type

Parameters (if any)

ruckus(config-ap)# admin

  Sets the administrative logon
credentials.

Type: Privileged

Description

ruckus(config-ap)# admin-mode   Sets the administrative mode to either
locked or unlocked.
Type: Privileged
ruckus(config-ap)# ap-logon



Sets the access point administration
login credentials.



Sets the model specification (overrides
the zone configuration).

Type: Privileged
ruckus(config-ap)# ap-model
Type: Privileged
ruckus(config-ap)# ap-password 
Type: Privileged
ruckus(config-ap)# bonjourgateway

Sets the access point administrative
password.
Enables the bonjour gateway.

Type: Privileged
ruckus(config-ap)# bonjourpolicy

Enables the bonjour policy.

Type: Privileged

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

39

Configuration Commands
ap

Table 11. 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
Type: Privileged
ruckus(config-ap)# gps
Type: Privileged



Sets the model specification (overrides
the zone configuration).

  Sets the GPS coordinates to latitude
and longitude values.

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

40

Configuration Commands
ap

Table 11. Commands related to ruckus(config-ap).
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# gps-latitude



Sets the GPS coordination latitude.



Sets the GPS coordination longitude.

Type: Privileged
ruckus(config-ap)# gpslongitude
Type: Privileged
ruckus(config-ap)# do

Executes the do command.

Type: Privileged
ruckus(config-ap)# end
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)# help

Displays the help.

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

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

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

41

Configuration Commands
ap

Table 11. Commands related to ruckus(config-ap).
Syntax and Type

Parameters (if any)

Description

ruckus(config-ap)# ip

address 



Sets the IP address and primary and
secondary DNS servers.

Type: Privileged

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



Sets the location.

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

[ root | disable | auto | Sets the mesh mode to either:
mesh ]
• root: Root AP
• disable: Disable
• auto: Auto
• mesh: Mesh AP

ruckus(config-ap)# model

Sets the model specifications. It
overrides the zone configuration.

Type: Privileged
ruckus(config-ap)# name



Sets the AP name.

Type: Privileged

SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A

42

Configuration Commands
ap

Table 11. 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
client-admissioncontrol
description
hotspot20
ip 
location model override-clientadmission-control override-smart-mon radio smart-mon swap-in-ap syslog uplink-ap ruckus(config-ap)# overrideclient-admission-control <2.4g> <5g> Overrides the client admission control. Type: Privileged ruckus(config-ap)# overridesmart-mon Overrides the smart monitor. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 43 Configuration Commands ap Table 11. 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 Type: Privileged interval Enables the smart monitor. threshold ruckus(config-ap)# swap-in-ap Type: Privileged Sets the AP Mac IP address for swapin. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 44 Configuration Commands ap Table 11. Commands related to ruckus(config-ap). Syntax and Type Parameters (if any) Description ruckus(config-ap)# syslog enable Enable the syslog server Sets the syslog server. Type: Privileged 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 Sets the uplink selection to either smart or manual. ruckus(config-ap)# uplink-ap Sets the uplink to manual access point. Type: Privileged ruckus(config-ap)# zone Move the access point to another zone. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 45 Configuration Commands ap Table 12 lists the related to ap-model configuration commands. Table 12. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) ruckus(config-ap-model)# ext-ant 2.4g - 2.4 with DBI number Type: Privileged Description Enables the external antenna. 2.4gg [ 3 | 2 ] - 3/2 antennas 5g - 5g with DBI number 5gg [ 2 | 3 ] - 5gg with 2/3 antennas ruckus(config-ap-model)# internal-heater Enables the internal heater. Type: Privileged ruckus(config-ap-model)# lan1 Sets the LAN configurations from 1 to 5. ruckus(config-ap-model)# lan2 ruckus(config-ap-model)# lan3 ruckus(config-ap-model)# lan4 ruckus(config-ap-model)# lan5 Type: Privileged ruckus(config-ap-model)# led Enables the status of LEDs. Type: Privileged ruckus(config-ap-model)# ledmode Sets the LED mode. Type: Privileged ruckus(config-ap-model)# lldp Enables link layer discovery protocol. Type: Privileged ruckus(config-ap-model)# lldpad-interval Sets the LLDP advertise interval. Sets the LLDP hold time. Type: Privileged ruckus(config-ap-model)# lldphold-time Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 46 Configuration Commands ap Table 12. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) ruckus(config-ap-model)# lldpmgmt Description Enables LLDP management IP TLV. Type: Privileged ruckus(config-ap-model)# no ext-ant Type: Privileged internal-heater Disables or deletes the settings that have been configured. lan1 lan2 lan3 lan4 lan5 led lldp lldp-mgmt poe-out-port radio-band ruckus(config-ap-model)# poeout-port Enables the PoE out port. Type: Privileged ruckus(config-ap-model)# radioband ${value} Switches the radio band. Type: Privileged ruckus(config-ap-model)# do Executes the do command. Type: Privileged ruckus(config-ap-model)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ap-model)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-model)# help Displays the help. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 47 Configuration Commands ap Table 13 lists the related to ap-model-lan1 configuration commands. Table 13. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-ap-model-lan1)# 8021x <802.1x-type> Sets 802.1x. Sets the authentication service configurations. Sets the authentication service configurations. Type: Privileged ruckus(config-ap-model-lan1)# acct-service Type: Privileged ruckus(config-ap-model-lan1)# auth-service Type: Privileged ruckus(config-ap-model-lan1)# mac-bypass Sets the MAC bypass. Type: Privileged ruckus(config-ap-model-lan1)# members Sets the AP model configurations. Type: Privileged ruckus(config-ap-model-lan1)# no acct-service Type: User mac-bypass Disables or deletes the settings that have been configured. ruckus(config-ap-model-lan1)# supplicant mac Sets the supplicant. Type: Privileged custom ruckus(config-ap-model-lan1)# type [trunk-port | access- Sets the port type. port | general-port] Type: Privileged ruckus(config-ap-model-lan1)# vlan-untag-id Sets the VLAN untag IID. Type: Privileged ruckus(config-ap-model-lan1)# do Executes the do command. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 48 Configuration Commands ap-auto-tagging Table 13. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) ruckus(config-ap-model-lan1)# end Description Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-ap-model-lan1)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-model-lan1)# help Displays the help. Type: Privileged 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 ruckus(config)# ap-auto-tagging rule [ g | m ]>> Syntax Description This command uses the following syntax: enable: Enable the auto tagging critical APs rule: Select the auto tagging rule daily-threshold: Daily traffic bytes that exceeds the threshold rule g: Threshold value in gigabytes m: Threshold value in megabytes Default This command has no default settings. Command Mode Config Example SCG30(config)# ap-auto-tagging enable SCG30(config)# ap-auto-tagging rule daily-threshold 90 g SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 49 Configuration Commands ap-auto-tagging Related Commands Table 14 lists the related to ap-auto-tagging configuration commands. Table 14. Commands related to ruckus(config-ap-auto-tagging) Syntax and Type Parameters (if any) ruckus(config-ap-auto-tagging)# enable Description Enables the auto tagging for critical APs. Type: Privileged ruckus(config-ap-auto-tagging)# no Disables the auto tagging for critical APs. Sets the auto tagging rule to daily traffic bytes, which exceeds the threshold rule. Sets the threshold value. [m|g] Sets the unit to either megabytes or gigabytes. Type: Privileged ruckus(config-ap-auto-tagging)# rule Type: Privileged ruckus(config-ap-auto-tagging)# threshold Type: Privileged ruckus(config-ap-auto-tagging)# unit Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 50 Configuration Commands ap-cert-check ap-cert-check To enable the access point certificate check, use the following command: ruckus(config)# ap-cert-check Syntax Description This command has no arguments or keywords. Default This command has the default settings of enable. Command Mode Config Example SCG30(config)# ap-cert-check Successful operation 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 SCG30(config)# ap-control-mgmt-tos 10 SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 51 Configuration Commands ap-heartbeat ap-heartbeat To setup the access point heartbeat, use the following command: ruckus(config)# ap-heartbeat Syntax Description This command uses the following syntax: seconds: Interval in seconds, which the AP sends the heartbeat to the SCG such as: 30, 60, 150 and 300 Default This command has no default settings. Command Mode Config Example SCG30(config)# ap-heartbeat 30 ap-portal-cert To update the AP portal certificate configuration, use the following command: ruckus(config)# ap-portal-cert Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SCG30SCG30(config)# ap-portal-cert Related Commands • Table 15 lists the related to ap-portal-cert configuration commands. • Table 16 lists the related to ap-portal-cert-generate-csr configuration commands. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 52 Configuration Commands ap-portal-cert Table 15 lists the related to ap-portal-cert configuration commands. Table 15. Commands related to ruckus(config-ap-portal-cert) Syntax and Type Parameters (if any) ruckus(config-ap-portal-cert)# generate-csr Type: Privileged ruckus(config-ap-portal-cert)# upload-cert Type: Privileged ruckus(config-ap-portal-cert)# do Description Generates the certificate signing FTP URL, format: ftp:/ request. :@[/ ] Uploads the certificate. FTP URL, format: ftp:/ :@[/ ] Executes the do command. Type: Privileged ruckus(config-ap-portal-cert)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-ap-portal-cert)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap-portal-cert)# help Displays the help. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 53 Configuration Commands ap-portal-cert Table 16 lists the related to ap-portal-cert-generate-csr configuration commands. Table 16. Commands related to ruckus(config-ap-portal-cert-generate-csr) Syntax and Type Parameters (if any) Description ruckus(config-ap-portal-certgenerate-csr)# city Sets the city name. Sets the domain name. Sets the county. Sets the email address. Sets the organization name. Sets the state name. Sets the unit name. Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# common-name Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# country Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# email Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# organization Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# state Type: Privileged ruckus(config-ap-portal-certgenerate-csr)# unit Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 54 Configuration Commands ap-root-ca ap-root-ca To update the AP root CA, use the following command: ruckus(config)# ap-root-ca Syntax Description This command uses the following syntax: ftp-url: AP Root CA file, FTP URL Format: ftp://:@/ ) Default This command has no default settings. Command Mode Config Example SCG30(config)# ap-root-ca ftp://mahan:ruckus1!@172.19.7.100/ backup/AP_ad87453456fe.csv ap-sci To enable the access point sci, use the following command: ruckus(config)# ap-sci enable Syntax Description This command uses the following syntax: enable: Enables the AP SCI. Default This command has no default settings. Command Mode Config Example SCG30(config)# ap-sci enable SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 55 Configuration Commands auth-profile auth-profile To enter authentication service profile configuration, use the following command: ruckus(config)# auth-profile Syntax Description This command uses the following syntax: name: Authentication service profile name Default This command has no default settings. Command Mode Config Example SCG30(config)# auth-profile aaa-auth Related Commands • Table 17 lists the related auth profile configuration commands. • Table 18 lists the related auth profile realm configuration commands. Table 17 lists the related auth-profile configuration commands. Table 17. Commands related to ruckus(config-auth-profile) Syntax and Type Parameters (if any) Description ruckus(config-auth-profile)# aaainterim-acct-interval Sets the interim accounting interval for hosted AAA server. Set the session idle timeout for hosted AAA server. Set the session timeout for hosted AAA server Type: Privileged ruckus(config-auth-profile)# aaasession-idle-timeout Type: Privileged ruckus(config-auth-profile)# aaasession-timeout Type: Privileged ruckus(config-auth-profile)# aaasupport Enables hosted AAA support. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 56 Configuration Commands auth-profile Table 17. Commands related to ruckus(config-auth-profile) Syntax and Type Parameters (if any) ruckus(config-auth-profile)# default Description Sets default services. Type: Privileged ruckus(config-auth-profile)# description Sets the descriptions. Type: Privileged ruckus(config-auth-profile)# do Executes the do command. Type: Privileged ruckus(config-auth-profile)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-auth-profile)# exit Exits from the EXEC. Type: Privileged ruckus(config-auth-profile)# help Displays the help. Type: Privileged ruckus(config-auth-profile)# gppsupport Enables 3GPP support. Type: Privileged ruckus(config-auth-profile)# no gpp-support Type: Privileged aaa-support Disables GPP, AAA or Realm support. realm ruckus(config-auth-profile)# realm Sets the realm. Sets the mobile country code. Sets the mobile network code. Type: Privileged ruckus(config-auth-profile)# sgsnmcc Type: Privileged ruckus(config-auth-profile)# sgsnmnc Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 57 Configuration Commands auth-profile Table 18 lists the related auth-profile-realm configuration commands. Table 18. Commands related to ruckus(config-auth-profile-realm) Syntax and Type Parameters (if any) ruckus(config-auth-profile-realm)# auth-method Description Sets the authorization method. Type: Privileged ruckus(config-auth-profile-realm)# auth-service Sets the authentication service. Sets the dynamic VLAN ID. Type: Privileged ruckus(config-auth-profile-realm)# dynamic-vlan Type: Privileged ruckus(config-auth-profile-realm# do Executes the do command. Type: Privileged ruckus(config-auth-profile-realm)# end Type: Privileged ruckus(config-auth-profile-realm)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged ruckus(config-auth-profile-realm)# help Displays the help. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 58 Configuration Commands cgf-service cgf-service To setup the CGF service configuration, use the following command: ruckus(config)# cgf-service Syntax Description This command uses the following syntax: name: CGF service name Default This command has no default settings. Command Mode Config Example SCG30(config)# cgf-service charge-ser Related Commands • Table 19 lists the related cgf service profile configuration commands. • Table 20 lists the related cgf service ftp server configuration commands. • Table 21 lists the related cgf service server configuration commands. Table 19 lists the related cgf-service profile configuration commands. Table 19. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) ruckus(config-cgf-service)# autoexport-ftp Description Enables the auto export through FTP. Type: Privileged ruckus(config-cgf-service)# cdrnode-id Enables the node ID. The length range is between 1 and 20. Sets the CDR response timeout. Type: Privileged ruckus(config-cgf-service)# cdrresponse-timeout Type: Privileged ruckus(config-cgf-service)# cdr-retry Sets the CDR retries. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 59 Configuration Commands cgf-service Table 19. Commands related to ruckus(config-cgf-service) profile Syntax and Type ruckus(config-cgf-service)# cdrsend-apn-network-id Parameters (if any) Description Enables in sending the APN network identifier to the CDR. Type: Privileged ruckus(config-cgf-service)# cdrsend-apn-op-id Enables sending the APN operator identifier. Type: Privileged ruckus(config-cgf-service)# cdrsend-apn-sel-mode Enables sending the APN selection mode. Type: Privileged ruckus(config-cgf-service)# cdrsend-charging-sel-mode Enables sending the charging characteristic selection mode. Type: Privileged ruckus(config-cgf-service)# cdrsend-diag Enables sending the diagnostic to the CDR. Type: Privileged ruckus(config-cgf-service)# cdrsend-dyn-addr-flag Enables in sending the dynamic mode address flag. Type: Privileged ruckus(config-cgf-service)# cdrsend-local-record-sn Enables in sending the local record sequence number. Type: Privileged ruckus(config-cgf-service)# cdrsend-msisdn Enables in sending the MSISDN. Type: Privileged ruckus(config-cgf-service)# cdrsend-node-id Enables in sending the node ID to the CDR. Type: Privileged ruckus(config-cgf-service)# cdrsend-pdp-addr Enables in sending the PDF address to the CDR. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 60 Configuration Commands cgf-service Table 19. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) ruckus(config-cgf-service)# cdrsend-pdp-type Description Enables in sending the PDF type to the CDR. Type: Privileged ruckus(config-cgf-service)# cdrsend-rat-type Enables in sending the RAT type. Type: Privileged ruckus(config-cgf-service)# cdrsend-sgsn-addr Enables in sending the SGSN address to the CDR. Type: Privileged ruckus(config-cgf-service)# cdrsgsn-plmn-id Enables the SGSN/WAG PLMN identifier Type: Privileged ruckus(config-cgf-service)# cdrtraffic-vol Enables listing traffic volumes. Type: Privileged ruckus(config-cgf-service)# cdr-ttg Sets the CDR for TTG. Type: Privileged ruckus(config-cgf-service)# cdr-type [s-cdr | w-cdr] Type: Privileged Sets the CDR type as S-CDR or W-CDR. ruckus(config-cgf-service)# charging-mode [ local-binary-file | server | Sets the charging service type. both ] Type: Privileged local-binary-file: Local Binary File server: Server both: Both ruckus(config-cgf-service)# description Sets the CGF service description. Type: Privileged ruckus(config-cgf-service)# do Executes the do command. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 61 Configuration Commands cgf-service Table 19. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) ruckus(config-cgf-service)# end Description Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-cgf-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-cgf-service)# help Displays the help. Type: Privileged ruckus(config-cgf-service)# exportschedule daily hour Sets the export schedule based on hours and minutes or daily. Sets the file lifetime. Type: Privileged ruckus(config-cgf-service)# file-lifetime Type: Privileged ruckus(config-cgf-service)# file-time- limit Sets the file timer interval. Type: Privileged ruckus(config-cgf-service)# ftpserver Sets the FTP server setting by defining the host server. Type: Privileged ruckus(config-cgf-service)# ftpserver-test Tests the FTP settings. Type: Privileged ruckus(config-cgf-service)# gtpecho-retry Set the retries of GTP echo response. Sets the retries of GTP echo timeout. Type: Privileged ruckus(config-cgf-service)# gtpecho-timeout Type: Privileged ruckus(config-cgf-service)# lbo Type: Privileged Enables CDR for direct IP access (LBO). SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 62 Configuration Commands cgf-service Table 19. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# lbonode-id Enables the node ID. The length range is between 1 and 20. Type: Privileged ruckus(config-cgf-service)# lbosend-local-record-sn Enables in sending the local record sequence number. Type: Privileged ruckus(config-cgf-service)# lbosend-node-id Enables the node identifier. Type: Privileged ruckus(config-cgf-service)# max-cdr- request Sets the maximum CDRs per request. Type: Privileged ruckus(config-cgf-service)# no auto-export-ftp Type: Privileged cdr-send-apn-network-id Disable various options. cdr-send-apn-sel-mode cdr-send-apn-op-id cdr-send-charging-selmode cdr-send-diag cdr-send-dyn-addr-flag cdr-send-local-record-sn cdr-send-msisdn cdr-send-node-id cdr-send-pdp-addr cdr-send-pdp-type cdr-send-rat-type .................................continued SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 63 Configuration Commands cgf-service Table 19. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# no cdr-send-sgsn-addr Disables various options. Type: Privileged cdr-sgsn-plmn-id cdr-traffic-vol cdr-ttg lbo lbo-send-local-record-sn lbo-send-node-id server ruckus(config-cgf-service)# recordlimit Sets the record limit. ruckus(config-cgf-service)# server priority [up | down] Type: Privileged Sets the server’s IP address. The DNS server’s priority can also be changed by moving the priority either up or down. Type: Privileged Table 20 lists the related cgf-service-ftp-server configuration commands. Table 20. Commands related to ruckus(config-cgf-service-ftp-server) Syntax and Type Parameters (if any) Description ruckus(config-cgf-service-ftpserver)# password Sets the username for the FTP server. Sets the FTP server port. Sets the remote directory for the FTP server. Type: Privileged ruckus(config-cgf-service-ftpserver)# port Type: Privileged ruckus(config-cgf-service-ftpserver)# remote-dir Type: Privileged ruckus(config-cgf-service-ftpserver)# test Tests the FTP settings. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 64 Configuration Commands cgf-service Table 20. Commands related to ruckus(config-cgf-service-ftp-server) Syntax and Type Parameters (if any) Description ruckus(config-cgf-service-ftpserver)# username Sets the username for the FTP server. Type: Privileged ruckus(config-cgf-service-ftpserver)# do Executes the do command. Type: Privileged ruckus(config-cgf-service-ftpserver))# end Ends the current configuration session and returns to privileged EXEC mode. Type: Privileged ruckus(config-cgf-service-ftpserver)# exit Exits from the EXEC. Type: Privileged ruckus(config-cgf-service-ftpserver)# help Displays the help. Type: Privileged Table 21 lists the related cgf-service-server configuration commands. Table 21. Commands related to ruckus(config-cgf-service-server) Syntax and Type Parameters (if any) Description ruckus(config-cgf-service-server)# port Sets the server port. Type: Privileged ruckus(config-cgf-service-server)# do Executes the do command. Type: Privileged ruckus(config-cgf-service-server)# end Type: Privileged ruckus(config-cgf-service-server)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 65 Configuration Commands changepassword Table 21. Commands related to ruckus(config-cgf-service-server) Syntax and Type Parameters (if any) ruckus(config-cgf-service-server)# help Description Displays the help. 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 $(. Default This command has no default settings. Command Mode Config Example SCG30(config)# changepassword Old Password: ruckus1! New Password:ruckus2! SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 66 Configuration Commands clock 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 SCG30(config)# clock timezone Africa/Nairobi cluster-ip-list To update the node IP address mapping list of the cluster configuration, use the following command: ruckus(config)# cluster-ip-list Syntax Description This command uses the following syntax: ip-mappings: Node IP mapping list, which is space separated. Default This command has no default settings. Command Mode Config Example SCG30(config)# cluster-ip-list : : SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 67 Configuration Commands cluster-redundancy SCG30(config)# cluster-ip-list 172.19.18.96:172.19.13.56 172.19.15.67:172.19.10.07 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 SCG30(config)# cluster-redundancy Related Commands • Table 22 lists the related cluster redundancy configuration commands. • Table 23 lists the related cluster redundancy cluster configuration commands. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 68 Configuration Commands cluster-redundancy Table 22 lists the related cluster redundancy configuration commands. Table 22. Commands related to ruckus(config-cluster-redundancy) Syntax and Type Parameters (if any) Description ruckus(config-cluster-redundancy)# cluster Create or update the cluster redundancy configuration. Type: Privileged priority [ up | down ] ruckus(config-cluster-redundancy)# do Executes the do command. Type: Privileged ruckus(config-cluster-redundancy)# enable Enables the cluster redundancy configuration. Type: Privileged ruckus(config-cluster-redundancy)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-cluster-redundancy)# exit Exits from the EXEC. Type: Privileged ruckus(config-cluster-redundancy)# help Displays the help. Type: Privileged ruckus(config-cluster-redundancy)# no Type: Privileged Disables the enable option. Table 23 lists the related cluster redundancy cluster configuration commands. Table 23. Commands related to ruckus(config-cluster-redundancy-cluster) Syntax and Type Parameters (if any) Description ruckus(config-cluster-redundancycluster)# ip-list Sets the control IP address list. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 69 Configuration Commands data-plane data-plane To update the dataplane configuration, use the following command: ruckus(config)# data-plane < forward-stp> Syntax Description This command uses the following syntax: : Name of the dataplane forward-stp: Disables the STP package bridge Default This command has no default settings. Command Mode Config Example SCG30(config)# data-plane indus4d1 Related Commands Table 24 lists the related data plane configuration commands Table 24. Commands related to ruckus(config-data-plane) Syntax and Type Parameters (if any) Description ruckus(config-data-plane)# ip route Sets the IP configuration commands. Type: Privileged address dhcp address secondary name-server secondary route SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 70 Configuration Commands data-plane Table 24. Commands related to ruckus(config-data-plane) Syntax and Type Parameters (if any) Description ruckus(config-data-plane)# no ip secondary Disables / deletes options. Type: Privileged ip name-server secondary ip route ip route vlan ruckus(config-data-plane)# do Executes the do command. Type: Privileged ruckus(config-data-plane)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-data-plane)# exit Exits from the EXEC. Type: Privileged ruckus(config-data-plane)# help Displays the help. Type: Privileged ruckus(config-data-plane)# vlan secondary Updates the VLAN configuration. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 71 Configuration Commands dhcp-service dhcp-service To setup the DHCP service configuration, use the following command. ruckus(config)# dhcp-service Syntax Description This command uses the following syntax: name: HCP service name Default This command has no default settings. Command Mode Config Example SCG30(config)# dhcp-service dhcp1 Related Commands Table 25 lists the related dhcp service profile configuration commands. Table 25. Commands related to ruckus(config-dhcp-service) Syntax and Type Parameters (if any) Description ruckus(config-dhcp-service)# description Sets the description. server secondary Disables the secondary DHCP server. [secondary | primary] Sets the IP address for DHCP secondary and primary servers. Type: Privileged ruckus(config-dhcp-service)# no Type: Privileged ruckus(config-dhcp-service)# server Type: Privileged ruckus(config-dhcp-service)# do Executes the do command. Type: Privileged ruckus(config-dhcp-service)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-dhcp-service)# exit Exits from the EXEC. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 72 Configuration Commands do Table 25. Commands related to ruckus(config-dhcp-service) Syntax and Type Parameters (if any) ruckus(config-dhcp-service)# help Description Displays the help. Type: Privileged do To setup the do command, use the following command. ruckus(config)# do Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example SCG30(config)# do SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 73 Configuration Commands dp-group dp-group To enable and set the dataplane 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 SCG30(config)# dp-group dp1-172.19.7.100 dp2-172.19.8.120 SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 74 Configuration Commands domain domain To create or update the domain configuration, use the following command: ruckus(config)# domain Syntax Description This command uses the following syntax: name: Name of the domain Default This command has no default settings. Command Mode Config Example SCG30(config)# domain indusap1 Related Commands • Table 26lists the related to domain configuration commands. • Table 27 lists the related domain 3rd-zone configuration commands. • Table 28 lists the related domain-zone configuration commands. • Table 29 lists the related domain-zone-aaa configuration commands. • Table 30 lists the related domain-zone-ap-group configuration commands. • Table 31 lists the related domain-zone-ap-group-lldp configuration commands. • Table 32 lists the related to domain-zone-ap-model configuration commands. • Table 33 lists the related domain-zone-ap-model-lan1 configuration commands. • Table 34 lists the related domain-zone-ap-registration-rule configuration commands. • Table 35 lists the related domain-zone-bonjour-policy configuration commands. • Table 37 lists the related domain-zone-device-policy configuration commands. • Table 38 lists the related domain-zone-device-policy policy rule configuration commands. • Table 39 lists the related zone-guest-access configuration commands. • Table 40 lists the related domain-zone-hotspot configuration commands. • Table 41 lists the related domain-zone-l2-acl configuration commands. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 75 Configuration Commands domain • Table 42 lists the related domain-zone-web-authentication configuration commands. • Table 43 lists the related domain-zone-wlan configuration commands. • Table 44 lists the related domain-zone-wlan-group configuration commands. • Table 45 lists the related domain-zone-wlan-scheduler configuration commands. Table 26 lists the related to domain configuration commands. Table 26. Commands related to ruckus(config-domain) Syntax and Type Parameters (if any) Description ruckus(config-domain)# 3rd-zone Creates or updates a Third Party AP zone in the current domain. Type: Privileged Adds an administrator and assign a role in the current domain. ruckus(config-domain)# description Sets the domain description. Type: Privileged ruckus(config-domain)# admin Type: Privileged ruckus(config-domain)# do Executes the do command. Type: Privileged ruckus(config-domain)# end Type: Privileged Ends the current configuration session and returns to privileged EXEC mode. ruckus(config-domain)# exit Exits from the EXEC. Type: Privileged ruckus(config-domain)# help Displays the help. Type: Privileged ruckus(config-domain-)# no admin Type: Privileged zone Disable or remove configuration settings in the current domain, ruckus(config-domain)# parent Sets the parent domain name. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 76 Configuration Commands domain Table 26. Commands related to ruckus(config-domain) Syntax and Type Parameters (if any) Description ruckus(config-domain)# zone - AP zone name Create or update an AP zone in the current domain. Type: Privileged template - Create from template clone - Clone from an existing AP zone ap-firmware Change AP firmware clusterswitch-over Enable cluster switchover ruckus(config-domain)# zone-zd Type: Privileged import Create AP zone from ZD backup file. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 77 Configuration Commands domain Table 27 lists the related domain 3rd-zone configuration commands. Table 27. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) ruckus(config-domain-3rd-zone)# acct-interval Number of Sets the accounting interval. minutes to send interim updates. Type: Privileged ruckus(config-domain-3rd-zone)# acct-server Description Sets the accounting service. Type: Privileged ruckus(config-domain-3rd-zone)# acct-service-profile Sets the accounting service profile configuration. Type: Privileged ruckus(config-domain-3rd-zone)# acct-ttg-session Enables accounting for TTG sessions. Type: Privileged ruckus(config-domain-3rd-zone)# auth-server Sets the authentication service. Type: Privileged ruckus(config-domain-3rd-zone)# auth-service-profile Sets the authentication service profile configuration. Type: Privileged ruckus(config-domain-3rd-zone)# auth-type Sets the authentication server type. Type: Privileged ruckus(config-domain-3rd-zone)# core-network Sets the core network. Type: Privileged ruckus(config-domain-3rd-zone)# description Sets the description. Sets the core network forwarding service profile. Type: Privileged ruckus(config-domain-3rd-zone)# forwarding-service-profile Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 78 Configuration Commands domain Table 27. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone)# hotspot-profile Sets the hotspot profile configuration. Type: Privileged ruckus(config-domain-3rd-zone)# ip single-ip Type: Privileged ip-range Adds access network source IP address. subnet ruckus(config-domain-3rd-zone)# move domain Moves the zone to another domain. Sets the network traffic profile. Type: Privileged ruckus(config-domain-3rd-zone)# network-traffic-profile Type: Privileged ruckus(config-domain-3rd-zone)# no acct-server Type: Privileged acct-service-profile Disables and deletes configuration options. acct-ttg-session ip radius-client vlan-tag ruckus(config-domain-3rd-zone)# radius-client default-share-secret Type: Privileged single-ip Sets the configuration for RADIUS client. ip-range subnet SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 79 Configuration Commands domain Table 27. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) ruckus(config-domain-3rd-zone)# vlan-tag Adds access network Q-in-Q s-vlan VLAN tags. c-vlan Type: Privileged Description s-vlan c-vlan vlan-mapping ruckus(config-domain-3rd-zone)# vlan-type qinq Type: Privileged strip-svlan-preservecvlan strip-qinq Sets the core network VLAN mapping type. strip-qinq-add-vlan map-svlan-preservecvlan add-svlan-preservecvlan strip-all preserve-all strip-all-add-vlan ruckus(config-domain-3rd-zone)# do Executes the do command. Type: Privileged ruckus(config-domain-3rd-zone)# end Type: Privileged ruckus(config-domain-3rd-zone)# exit Ends the current configuration session and returns to privileged EXEC mode. Exits from the EXEC. Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 80 Configuration Commands domain Table 27. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) ruckus(config-domain-3rd-zone)# help Description Displays the help. Type: Privileged Table 28 lists the related domain-zone configuration commands. Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# aaa Creates or updates the AAA server configuration. ruckus(config-domain-zone)# adjthreshold 2.4g ${value} Type: Privileged Value is minimum = 1 and maximum = 100 Sets the adjacent radio threshold of the client load balancing. ruckus(config-domain-zone)# apfirmware Type: Privileged 5g ${value} Sets the AP firmware. Type: Privileged ruckus(config-domain-zone)# ap-group Type: Privileged ruckus(config-domain-zone)# ap-logon Type: Privileged ruckus(config-domain-zone)# ap-model Creates or updates the AP group configuration. Sets the login ID for the AP administrator. Type: Privileged Sets the AP model configuration. ruckus(config-domain-zone)# appassword Sets the password for the AP administrator. Type: Privileged ruckus(config-domain-zone)# apreboot-timeout default-gateway Type: Privileged control-gateway [ ] Sets the AP reboot timeout. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 81 Configuration Commands domain Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# apregistration-rule Creates or updates the AP registration rule configuration. 2.4g Sets the background scanning. Type: Privileged ruckus(config-domain-zone)# background-scan 5g Type: Privileged ruckus(config-domain-zone)# bandbalancing 2.4g 2.4g Type: Privileged : Percentage of clients on 2.4G band Sets the band balance. 2.4G band ruckus(config-domain-zone)# bonjourgateway Enables the bonjour gateway. Type: Privileged ruckus(config-domain-zone)# bonjourpolicy Creates or updates the bonjour policy. ruckus(config-domain-zone)# channel 2.4g Sets the channel. Type: Privileged 5g indoor Type: Privileged 5g outdoor ruckus(config-domain-zone)# channelization 2.4g [ 20 | 40 ] Sets the channelization. 5g [ 40 | 20 ] Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 82 Configuration Commands domain Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# clientadmission-control 2.4g Enables the client admission control. Type: Privileged 2.4g minClientCount 5g 2.4g maxRadioLoad 2.4g minClientThroughput 5g minClientCount 5g maxRadioLoad 5g minClientThroughput ruckus(config-domain-zone)# countrycode Sets the country code. Sets the description, Sets the devise policy. Sets the guest access. Type: Privileged ruckus(config-domain-zone)# description Type: Privileged ruckus(config-domain-zone)# devicepolicy Type: Privileged ruckus(config-domain-zone)# guestaccess Type: Privileged ruckus(config-domain-zone)# headroom 2.4g Type: Privileged 5g: 5 GHz radio ruckus(config-domain-zone)# hotspot Type: Privileged Sets the headroom (# of clients) of client load balancing. Creates or updates the WISPr hotspot configuration. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 83 Configuration Commands domain Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) ruckus(config-domain-zone)# indoorchannel Description Enables the indoor channels. Type: Privileged ruckus(config-domain-zone)# l2-acl Type: Privileged ruckus(config-domain-zone)# lbs Sets the layer 2 access control list. Enables the location based service. Type: Privileged ruckus(config-domain-zone)# lbsservice Sets the location based service. Type: Privileged ruckus(config-domain-zone)# loadbalancing 2.4g Sets the client load balancing. 5g Type: Privileged ruckus(config-domain-zone)# mesh Enables mesh networking. Type: Privileged ruckus(config-domain-zone)# meshname Sets the mesh name (ESSID). Sets the mesh passphrase. [ dynamic | static ] Sets the mesh uplink auto selection to either dynamic or static link metrics. domain Moves the zone to another domain. Type: Privileged ruckus(config-domain-zone)# meshpassphrase Type: Privileged ruckus(config-domain-zone)# meshuplink-selection Type: Privileged ruckus(config-domain-zone)# move Type: Privileged SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 84 Configuration Commands domain Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# no aaa Type: Privileged ap-group Disables and deletes commands. ap-registration-rule background-scan <2.4g> <5g> band-balancing bonjour-gateway bonjour-policy client-admissioncontrol <2.4g> <5g> description device-policy guest-access hotspot indoor-channel l2-acl lbs load-balancing mesh roam smart-mon smart-roamdisconnect-event syslog-enabled timezone-dst web-authentication wlan wlan-group wlan-scheduler ruckus(config-domain-zone)# roam 2.4g Type: Privileged 5g Sets the smart roam. SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 85 Configuration Commands domain Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) ruckus(config-domain-zone)# rouge-ap- [ disable | enable ] detection Disables or enables rogue access points Type: Privileged Description Sets the report rouge access point. report-all [ disable | enable ] - Enables or disables all rogue devices report-only-malicious [ enable | disable ] Enables or disables only malicious rogue device types report-ssid-spoofing [ disable | enable ] Enables or disables malicious rogue devices which have SSID spoofing report-same-network [ enable | disable ] Enables or disables malicious rogue devices which have same network report-mac-spoofing [ disable | enable ] Enables or disables malicious rogue devices which have MAC IP address spoofing protect-frommalicious [ disable | enable ] - Enables or disables the network from malicious rogue access points SmartCell Gateway 200 Command Line Interface Reference Guide for RuckOS 3.0, 800-70675-001 Rev A 86 Configuration Commands domain Table 28. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# smartmon interval Sets the smart monitor interval. threshold Type: Privileged ruckus(config-domain-zone)# smartroam-disconnect-event Enables smart roam disconnect event. Type: Privileged ruckus(config-domain-zone)# syslogenabled Enables the external syslog server for APs for the specified zone. Type: Privileged ruckus(config-domain-zone)# syslogfacility Type: Privileged [ Local7 | Local1 | Sets the syslog server facility, Local6 | Keep Original | Local0 | Local4 | Local5 | Local3 | Local2 ] ruckus(config-domain-zone)# syslog-ip Type: Privileged ruckus(config-domain-zone)# syslogport Sets the IP address for the syslog server. Sets the port number for the syslog server. Type: Privileged ruckus(config-domain-zone)# syslogpriority Type: Privileged [ Alert | Info | Critical | Sets the syslog server priority. Warning | Notice | Emergency | All | Error ] ruckus(config-domain-zone)# timezone System - Follows the Sets the timezone for zone. SCG time zone setting Type: Privileged System [