Ruckus Virtual SmartZone Data Plane (vSZ D™) CLI Guide For 3.4.1 Smart Zone (MR) Command Line Interface Reference (v SZ D) Vszd 341 Ref Guide20161001

2016-10-17

User Manual: Ruckus SmartZone 3.4.1 (MR) Command Line Interface Reference Guide (vSZ-D)

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

DownloadRuckus Virtual SmartZone Data Plane (vSZ-D™) CLI Guide For 3.4.1 Smart Zone (MR) Command Line Interface Reference (v SZ-D) Vszd 341 Ref Guide20161001
Open PDF In BrowserView PDF
Virtual SmartZone Data Plane (vSZ-D) for
SmartZone Release 3.4.1
Command Line Interface Reference Guide

Part Number: 800-71353-001 Rev A
Published: 28 September 2016
www.ruckuswireless.com

Contents
Copyright Notice and Proprietary Information
About This Guide
Document Conventions.................................................................................................5
Terminology..................................................................................................................6
Related Documentation.................................................................................................8
Online Training Resources.............................................................................................8
Documentation Feedback.............................................................................................8

1 Overview of the vSZ-D Command Line Interface
Accessing the Command Line Interface........................................................................9

2 Supported CLI User and Privileged Modes
User Mode..................................................................................................................16
enable...............................................................................................................16
end....................................................................................................................16
exit....................................................................................................................17
help...................................................................................................................17
history...............................................................................................................17
logout................................................................................................................18
ping...................................................................................................................18
quit....................................................................................................................19
show.................................................................................................................19
traceroute..........................................................................................................20
Privileged Mode...........................................................................................................21
ruckus#enable...................................................................................................21
ruckus#end.......................................................................................................21
ruckus#exit........................................................................................................21
ruckus#help.......................................................................................................22
ruckus#logout...................................................................................................22
ruckus#history...................................................................................................23
ruckus#disable..................................................................................................23
ruckus#reboot...................................................................................................23
ruckus#ping......................................................................................................24
ruckus#traceroute.............................................................................................25

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

2

ruckus#show.....................................................................................................25
ruckus#config....................................................................................................26
ruckus#debug...................................................................................................47
ruckus#backup..................................................................................................50
ruckus#restore..................................................................................................51
ruckus#clone.....................................................................................................51
ruckus#upgrade................................................................................................52
ruckus#setup....................................................................................................52
ruckus#shutdown..............................................................................................52
ruckus#route.....................................................................................................53

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

3

Copyright Notice and Proprietary Information

Copyright Notice and Proprietary Information
Copyright 2016. 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, BeamFlex, ChannelFly, Dynamic PSK, FlexMaster,
Simply Better Wireless, SmartCell, SmartMesh, SmartZone, Unleashed, ZoneDirector and
ZoneFlex 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.

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

4

5

About This Guide
This Virtual SmartZone Data Plane (vSZ-D) Command Line Interface Reference Guide describes
the commands that the vSZ-D uses to enable the data plane based features on the Ruckus
Wireless platform.
This guide is written for service operators and system administrators who are responsible for
managing, configuring, and troubleshooting Wi-Fi networks. It assumes basic working knowledge
of local area networks, wireless networking, and wireless devices.
NOTE: Refer to the release notes shipped with your product to be aware of certain challenges

when upgrading to this release.
Most user guides and release notes are available in Adobe Acrobat Reader Portable Document
Format (PDF) or HTML on the Ruckus Wireless Support Web site at
https://support.ruckuswireless.com/contact-us.

Document Conventions
Table 1: Text conventions on page 5 and Table 2: Notice conventions on page 6 list the text
and notice conventions that are used throughout this guide.
Table 1: Text conventions
Convention

Description

Example

message phrase

Represents messages
displayed in response to a
command or a status

[Device Name] >

user input

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

user interface controls

Keyboard keys, software
buttons, and field names

Click Create New

Start > All Programs

Represents a series of
commands, or menus and
submenus

Select Start > All Programs

ctrl+V

Represents keyboard keys
pressed in combination

Press ctrl+V to paste the text
from the clipboard.

screen or page names

command name

Click Advanced Settings. The
Advanced Settings page
appears.
Represents CLI commands

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

5

About This Guide
Terminology

Convention

Description

Example

parameter name

Represents a parameter in a
CLI command or UI feature

variable name

Represents variable data

{ZoneDirectorID}

filepath

Represents file names or URI
strings

http://ruckuswireless.com

Table 2: Notice conventions
Notice type

Description

NOTE:

Information that describes important features
or instructions

CAUTION:

WARNING:

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

Terminology
The table lists the terms used in this guide.
Table 3: Terms used in this guide
Terminology

Description

ANQP

Access Network Query Protocol

AP

Access Point

CN

Common Name

CP

Captive Portal

CUI

Chargeable User Identity

EAP

Extensible Authentication Protocol

FQDN

Fully Qualified Domain Name

GAS

Generic Advertisement Service

HS2.0

Hotspot 2.0

IDM

Identity Management

MCC

Mobile Country Code

MNC

Mobile Network Code

MNO

Mobile Network Operator

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

6

About This Guide
Terminology

Terminology

Description

MO

Managed Object

MSO

Multiple System Operator

GTPv2-C

Network Access Identifier

NBI

Northbound Interface

OCSP

Online Certificate Status Protocol

OI

Organization Identifier

OMA-DM

Open Mobile Alliance’s Device Management

OSEN

OSU Server-only authenticated layer 2
Encryption Network

OSU

Online Sign-Up

Passpoint

Hotspot 2.0 certification

PKI

Public Key Infrastructure

PPS-MO

Per Provider Subscription Management Object

RAC

Radio Access Controller

RADIUS

Remote Access Dial In User Service

Release1 Device

Hotspot 2.0 Release1 specification compliant
device

Release 2 Device

Hotspot 2.0 Release 2 compliant device

RSN

Robust Security Network

SCG

Smart Cell Gateway

SSID

Service Set Identifier

SSL

Secure Socket Layer

T&C

Terms and Conditions

TCP

Transmission Control Protocol

TLS

Transport Layer Security

TTLS

Tunneled TLS

UDI

User Define Interface

UE

User Equipment

UE-IP

User Equipment - IP Address

UE-MAC

User Equipment - MAC Address

UI

User Interface

URI

Uniform Resource Identifier

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

7

About This Guide
Related Documentation

Terminology

Description

USIM

Universal Subscriber Identity Module

UTP

User Traffic Profile

UUID

Universal Unique Identifier

VSA

Vendor Specific Attributes

WAN

Wide Area Network

WFA

Wi-Fi Alliance

WLAN

Wireless Local Area Network

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

Online Training Resources
To access a variety of online Ruckus Wireless training modules, including free introductory
courses to wireless networking essentials, site surveys, and Ruckus Wireless products, visit the
Ruckus Wireless Training Portal at:
https://training.ruckuswireless.com.

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)

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

8

9

Overview of the vSZ-D Command Line
Interface

1

In this chapter:
•

Accessing the Command Line Interface

The Virtual SmartZone DataPlane (vSZ-D) command line interface (CLI) is a software tool that enables
you to configure and manage vSZ-D.
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
vSZ-D has a built-in command line interface (CLI) that you can use to configure vSZ-D settings
and manage access points. This section describes the requirements and the procedure for
accessing the vSZ-D CLI.
What You Will Need
To access the vSZ-D CLI, you will need the following:
1. A computer that you want to designate as administrative computer
2. A network connection to the vSZ-D (if you want to use an SSH connection)
3. An SSH (secure shell) client
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 vSZ-D 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 Console Connection

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

9

Overview of the vSZ-D 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 vSZ-D, 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 1: Selecting SSH as a connection type on page 10.
2. In Connection type, select SSH.

Figure 1: Selecting SSH as a connection type
3. Enter the IP address of the Management interface of vSZ-D in the Host Name (or IP address)
field.
4. Click Open. The PuTTY console appears and displays the login prompt.
Using the Console Connection
With the vSphere Web Client, you can access a virtual machine's desktop by launching a console
to the virtual machine. From the console, you can perform activities within the virtual machine
such as configure operating system settings, run applications, and monitor performance. The
prerequisites are as follows:

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

10

Overview of the vSZ-D Command Line Interface
Accessing the Command Line Interface

• Ensure that the Client Integration Plug-in is installed in your Web browser.
• Verify that the virtual machine has a guest operating system and that VMware Tools are
installed.
• Verify that the virtual machine is powered on.
The procedure is as follows:
1. Select a virtual machine.
• In the virtual machines and templates inventory tree, select a group of virtual machines
and select a virtual machine from the list on the right.
• Search for a virtual machine and select it from the search results list.
2. In the Guest OS Details pane on the Summary tab, click Launch console.The virtual machine
console opens in a new tab of the Web browser.
3. Click anywhere inside the console window to enable your mouse, keyboard, and other input
devices to work in the console.
4. (Optional) Press Ctrl+Alt to release the cursor from the console window and work outside
the console window.
5. (Optional) Click Full Screen to display the console in full screen mode.
6. (Optional) Press Ctrl+Alt+Enter to exit full screen mode.
7. (Optional) Click Send Ctrl-Alt-Delete to send a Ctrl+Alt+Delete to the guest operating system.
Log On to CLI
The process to log on to the CLI is as follows:
• Log on to the vSZ-D 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 vSZ-D installation

procedure.
• The Ruckus Wireless vSZ-D CLI welcome message appears with the CLI prompt as seen in
Figure 2: Welcome to vSZ-D on page 12 .

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

11

Overview of the vSZ-D Command Line Interface
Accessing the Command Line Interface

Figure 2: Welcome to vSZ-D
• You are now logged into the vSZ-D 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 ?.
See Figure 3: Using Show Commands on page 12.
NOTE: To change the CLI prompt to a privileged mode, see step 5.

Figure 3: 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 4: Using the Ping command on page 13.

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

12

Overview of the vSZ-D Command Line Interface
Accessing the Command Line Interface

Figure 4: 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 5: Changing to privileged mode on
page 13. The prompt changes from ruckus> to ruckus# (with a pound sign). Refer to the
enable command for details.

Figure 5: Changing to privileged mode

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

13

Supported CLI User and Privileged Modes

Supported CLI User and Privileged Modes

2

In this chapter:
•
•

User Mode
Privileged Mode

The supported commands are listed in a tree view as follows.
* Initial or User mode *

* Enable or Privileged mode *

–>enable

–>enable

–>end

–>end

–>exit

–>exit

–>help

–>help

–>logout

–>logout

–>quit

–>history

–>history

–>disable

–>show

–>reboot

–>ping

–>ping

–>traceroute

–>traceroute
–>setup
–>show
–>shutdown
–>config
•
•
•
•
•
•
•
•

–>end
–>help
–>history
–>logout
–>ip name-server
–>ip data-nat
–>set-factory
–>admin
•
•
•
•
•
•

–>help
–>logout
–>history
–>end
–>name
–>passwd

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

14

Supported CLI User and Privileged Modes

* Initial or User mode *

* Enable or Privileged mode *
• –>timeout
• –>show
• –>interface management
•
•
•
•
•
•
•
•

–>help
–>logout
–>history
–>end
–>no
–>ext-nat
–>ip
–>vlan

• –>interface data
•
•
•
•
•
•
•
•

–>help
–>logout
–>history
–>end
–>no
–>ext-nat
–>ip
–>vlan

• –>controller
•
•
•
•
•

–>help
–>logout
–>history
–>ip
–>end

• –>dpm
•
•
•
•
•

–>help
–>logout
–>history
–>end
–>hb-intvl

–>debug
•
•
•
•
•

–>help
–>diag
–>end
–>history
–>logout

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

15

Supported CLI User and Privileged Modes
User Mode

* Initial or User mode *

* Enable or Privileged mode *
• –>remote-syslogd
• –>save-log
–>backup
–>restore
–>clone
–>upgrade
–>route

User Mode
enable
Turns on privileged commands.
ruckus>enable
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
User
Example
ruckus>enable

end
Saves the changes and returns to the first tier.
ruckus>end
Syntax Description
This command has no syntax.
Default
This command has no default settings.

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

16

Supported CLI User and Privileged Modes
User Mode

Command Mode
User
Example
ruckus>end

exit
Exits from the EXEC mode.
ruckus>exit
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
User
Example
ruckus>exit

help
Displays the help messages.
ruckus>help
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
User
Example
ruckus>help

history
Displays a list of previously run commands.
ruckus>history

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

17

Supported CLI User and Privileged Modes
User Mode

Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
User
Example
ruckus>history

logout
Exits from the vDP CLI application.
ruckus>logout
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
User
Example
ruckus>logout

ping
Sends ICMP echo packets to an IP address or domain name.
ruckus# or ruckus>ping[- LRUbdfnqrvVaA]
[-c count][-i interval][-w deadline][-p pattern]
[- s packetsize][-t ttl][-I interface or address]
[- M mtu discovery hint][- S sndbuf][ -T timestamp option ]
[ -Q tos ] [hop1 ...] destination
Syntax Description
This command has the following syntax:
• count
• interval
• deadline

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

18

Supported CLI User and Privileged Modes
User Mode

•
•
•
•
•
•
•
•

pattern
packetsize
ttl
interface or address
mtu discovery hint
sndbuf
timestamp option
destination

Default
This command has no default settings.
Command Mode
User
Example
ruckus(config)#ping

quit
Ends the CLI sessions.
ruckus>quit
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
User
Example
ruckus>quit

show
Displays system information.
ruckus>show
Syntax Description
This command has no syntax.

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

19

Supported CLI User and Privileged Modes
User Mode

Default
This command has no default settings.
Command Mode
User
Example
ruckus>showversion
Shows the system version number and serial number.

traceroute
Prints the route that the packets take to the network host.
ruckus# or ruckus>traceroute[ -46dFITnreAUV ][ -f first_ttl ][ -g
gate,... ] [ -i device ] [ -m max_ttl ] [ -N squeries ] [ -p port ]
[ -t tos ] [ -l flow_label ][ -w waittime ] [ -q nqueries ][ -s
src_addr ] [ -z sendwait ] host [ packetlen ]
Syntax Description
This command has the following syntax:
•
•
•
•
•
•
•
•
•
•
•
•
•

first_ttl
gate
device
max_ttl
squeries
port
tos
flow_label
waittime
nqueries
src_address
sendwait
packetlen

Default
This command has no default settings.
Command Mode
User
Example
ruckus#traceroute

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

20

Supported CLI User and Privileged Modes
Privileged Mode

Privileged Mode
ruckus#enable
Modifies the enable password.
ruckus#enable
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#enable
Old password:
New password:
Retype:

ruckus#end
Saves the changes and returns to the first tier.
ruckus#end
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#end

ruckus#exit
Exits from the EXEC mode.
ruckus#exit

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

21

Supported CLI User and Privileged Modes
Privileged Mode

Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#exit

ruckus#help
Displays the help messages.
ruckus#help
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#help

ruckus#logout
Exits from the vDP CLI application.
ruckus#logout
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

22

Supported CLI User and Privileged Modes
Privileged Mode

Example
ruckus#logout

ruckus#history
Displays a list of previously run commands.
ruckus#history
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#history

ruckus#disable
Disables Privileged commands.
ruckus#disable
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#disable

ruckus#reboot
Reboots the VDP.
ruckus#reboot
Syntax Description
This command has no syntax.

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

23

Supported CLI User and Privileged Modes
Privileged Mode

Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#reboot

ruckus#ping
Sends ICMP echo packets to an IP address or domain name.
ruckus# ping[- LRUbdfnqrvVaA]
[-c count][-i interval][-w deadline][-p pattern]
[- s packetsize][-t ttl][-I interface or address]
[- M mtu discovery hint][- S sndbuf][ -T timestamp option ]
[ -Q tos ] [hop1 ...] destination
Syntax Description
This command has the following syntax:
•
•
•
•
•
•
•
•
•
•
•

count
interval
deadline
pattern
packetsize
ttl
interface or address
mtu discovery hint
sndbuf
timestamp option
destination

Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus(config)#ping

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

24

Supported CLI User and Privileged Modes
Privileged Mode

ruckus#traceroute
Prints the route that the packets take to the network host.
ruckus# traceroute[ -46dFITnreAUV ][ -f first_ttl ][ -g gate,... ]
[ -i device ] [ -m max_ttl ] [ -N squeries ] [ -p port ] [ -t tos ]
[ -l flow_label ][ -w waittime ] [ -q nqueries ][ -s src_addr ] [ -z
sendwait ] host [ packetlen ]
Syntax Description
This command has the following syntax:
•
•
•
•
•
•
•
•
•
•
•
•
•

first_ttl
gate
device
max_ttl
squeries
port
tos
flow_label
waittime
nqueries
src_address
sendwait
packetlen

Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#traceroute

ruckus#show
Shows system information.
ruckus#show
Syntax Description
This command has the following syntax:
• version : shows system version number and serial number
• interface: shows configured and current network settings for management and data interfaces.

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

25

Supported CLI User and Privileged Modes
Privileged Mode

• interface management-config: Shows configured network settings for the management
interface.
• interface data-config: Shows configured network settings for the data interface.
• interface current-management: Shows the current network settings for the management
interface.
• interface current-data: Shows the current network settings for the data interface.
• dpm: Shows DPM related configuration.
• status: Shows current network settings and connection status between vSCG and VDP.
• stats: Shows the current VDP traffic statistics and basic system information.
• controller : Shows the controller related configuration.
• upgrade : Shows vSZ-D previous upgrade information.
• upgrade-history: Shows vSZ-D upgrade history.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#show version

ruckus#config
Configure options and settings in this mode.
ruckus#config
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus#config
ruckus(config)#end
Saves the changes and returns to the first tier.
ruckus(config)#end

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

26

Supported CLI User and Privileged Modes
Privileged Mode

Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus(config)#end
ruckus(config)#help
Displays the help messages.
ruckus(config)#help
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus(config)#help
ruckus(config)#history
Displays a list of previously run commands.
ruckus(config)#history
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged

Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide

27

Supported CLI User and Privileged Modes
Privileged Mode

Example
ruckus(config)#history
ruckus(config)#logout
Exits from the vSZ-D CLI application.
ruckus(config)#logout
Syntax Description
This command has no syntax.
Default
This command has no default settings.
Command Mode
Privileged
Example
ruckus(config)#logout
ruckus(config)#ip name-server
Sets the name server.
ruckus(config)#ip name-server 
Syntax Description This command has the following syntax. address: Default This command has no default settings. Command Mode Privileged Example ruckus(config)#ip name-server ruckus(config)#ip-data-nat Sets the external NAT IP address of the data interface. ruckus(config)#ip-data-nat Syntax Description This command has no syntax. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 28 Supported CLI User and Privileged Modes Privileged Mode Default This command has no default settings. Command Mode Privileged Example ruckus(config)#ip-data-nat ruckus(config)#set-factory Sets factory to default settings. ruckus(config)#set-factory Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enableruckus#configruckus(config)#set-factory ruckus(config)#admin Enter the admin mode to configure admin settings. ruckus(config)#admin Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 29 Supported CLI User and Privileged Modes Privileged Mode ruckus(config)#admin ruckus(config-admin)#.. ruckus(config-admin)#end Saves the changes and returns to the first tier. ruckus(config-admin)#end Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-admin)#end ruckus(config-admin)#help Displays the help messages. ruckus(config-admin)#help Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-admin)#help ruckus(config-admin)#history Displays a list of previously run commands. ruckus(config-admin)#history Syntax Description This command has no syntax. Default This command has no default settings. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 30 Supported CLI User and Privileged Modes Privileged Mode Command Mode Privileged Example ruckus(config-admin)#history ruckus(config-admin)#logout Exits from the vSZ-D CLI application. ruckus(config-admin)#logout Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-admin)#logout ruckus(config-admin)#name Sets the host name. ruckus(config-admin)#name Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#admin ruckus(config-admin)#name Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 31 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-admin)#passwd Sets the local account super password. ruckus(config-admin)#passwd Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#admin ruckus(config-admin)#passwd ruckus(config-admin)#timeout Sets the CLI idle timeout value. ruckus(config-admin)#timeout Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#admin ruckus(config-admin)#timeout ruckus(config-admin)#show Displays the administrative settings. ruckus(config-admin)#show Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 32 Supported CLI User and Privileged Modes Privileged Mode Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#admin ruckus(config-admin)#show ruckus(config)#interface management Configure management interface settings through config interface mode. ruckus(config)#interface management Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface management ruckus(config-interface)# ruckus(config-interface)#end Saves the changes and returns to the first tier. ruckus(config-interface)#end Syntax Description This command has no syntax. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 33 Supported CLI User and Privileged Modes Privileged Mode Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface management ruckus(config-interface)#end ruckus(config-interface)#help Displays the help messages. ruckus(config-interface)#help Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface management ruckus(config-interface)#help ruckus(config-interface)#history Displays a list of previously run commands. ruckus(config-interface)#history Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface management Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 34 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-interface)#history ruckus(config-interface)#logout Displays a list of previously run commands. ruckus(config-interface)#logout Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface management ruckus(config-interface)#logout ruckus(config-interface)#ext-nat data-nat-addr Sets the external NAT IP address of the data interface. ruckus(config-interface)#ext-nat data-nat-addr Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface management ruckus(config-interface)#ext-nat data-nat-addr
ruckus(config-interface)#ip Sets the interface settings. ip addr sets the interface static IP address. ip mode sets the interface IP mode. ip gateway sets the interface gateway. ruckus(config-interface)#ip addr Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 35 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-interface)#ip mode or ruckus(config-interface)#ip gateway Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface data | management ruckus(config-interface)#ip addr ruckus(config-interface)#ip mode ruckus(config-interface)#ip gateway ruckus(config-interface)#vlan Sets interface VLAN. ruckus(config-interface)#vlan <0-4095> Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface {data | management} ruckus(config-interface)#vlan <0-4095> Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 36 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-interface)#no vlan Disables the VLAN interface. ruckus(config-interface)#no vlan <0-4095> Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface {data | management} ruckus(config-interface)# no vlan <0-4095> ruckus(config)#interface data Configures data interface settings. ruckus(config)#interface data Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface data ruckus(config-interface)# ruckus(config-interface)#end Saves the changes and returns to the first tier. ruckus(config-interface)#end Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 37 Supported CLI User and Privileged Modes Privileged Mode Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface data ruckus(config-interface)#end ruckus(config-interface)#help Displays the help messages. ruckus(config-interface)#help Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface data ruckus(config-interface)#help ruckus(config-interface)#history Displays a list of previously run commands. ruckus(config-interface)#history Syntax Description This command has no syntax. Default This command has no default settings. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 38 Supported CLI User and Privileged Modes Privileged Mode Command Mode Privileged Example ruckus(config)#interface data ruckus(config-interface)#history ruckus(config-interface)#logout Exits from the vSZ-D CLI application. ruckus(config-interface)#logout Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#interface data ruckus(config-interface)#logout ruckus(config-interface)#ext-nat data-nat-addr Sets the external NAT IP address of the data interface. ruckus(config-interface)#ext-nat data-nat-addr Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface data | management Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 39 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-interface)#ext-nat data-nat-addr
ruckus(config-interface)#ip Sets the interface settings. ip addr sets the interface static IP address. ip mode sets the interface IP mode. ip gateway sets the interface gateway. ruckus(config-interface)#ip addr ruckus(config-interface)#ip mode or ruckus(config-interface)#ip gateway Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface data | management ruckus(config-interface)#ip addr ruckus(config-interface)#ip mode ruckus(config-interface)#ip gateway ruckus(config-interface)#no data-nat-addr Removes external NAT of the data interface. ruckus(config-interface)#no data-nat-addr Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 40 Supported CLI User and Privileged Modes Privileged Mode Example ruckus>enable ruckus#config ruckus(config)#interface data ruckus(config-interface)#no data-nat-addr ruckus(config-interface)#no vlan Disables the VLAN interface. ruckus(config-interface)#no vlan <0-4095> Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#interface {data | management} ruckus(config-interface)# no vlan <0-4095> ruckus(config-interface)#vlan Sets interface VLAN. ruckus(config-interface)#vlan <0-4095> Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 41 Supported CLI User and Privileged Modes Privileged Mode ruckus#config ruckus(config)#interface {data | management} ruckus(config-interface)#vlan <0-4095> ruckus(config)#controller Configures the virtual DataPlane settings. ruckus(config)#controller Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#controller ruckus(config-controller)# ruckus(config-controller)#end Saves the changes and returns to the first tier. ruckus(config-controller)#end Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#controller ruckus(config-controller)#end Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 42 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-controller)#help Displays the help messages. ruckus(config-controller)#help Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#controller ruckus(config-controller)#help ruckus(config-controller)#history Displays a list of previously run commands. ruckus(config-controller)#history Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config)#controller ruckus(config-controller)#history ruckus(config-controller)#logout Exits from the vSZ-D CLI application. ruckus(config-controller)#logout Syntax Description This command has no syntax. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 43 Supported CLI User and Privileged Modes Privileged Mode Default This command has no default settings. Command Mode Privileged Example ruckus(config)#controller ruckus(config-controller)#logout ruckus(config-controller)#ip Sets the vSZ IP address. ruckus(config-controller)#ip Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#controller ruckus(config-controller)#ip ruckus(config)#dpm Configues DPM settings. ruckus(config)#dpm Syntax Description This command has no syntax. Default This command has no default settings. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 44 Supported CLI User and Privileged Modes Privileged Mode Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#dpm ruckus(config-dpm)# ruckus(config-dpm)#end Saves the changes and returns to the first tier. ruckus(config-dpm)#end Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-dpm)#end ruckus(config-dpm)#help Displays the help messages. ruckus(config-dpm)#help Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-dpm)#help Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 45 Supported CLI User and Privileged Modes Privileged Mode ruckus(config-dpm)#history Displays a list of previously run commands. ruckus(config-dpm)#history Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-dpm)#history ruckus(config-dpm)#logout Exits from the vSZ-D CLI application. ruckus(config-dpm)#logout Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(config-dpm)#logout ruckus(config-dpm)#hb-intvl Sets the DPM heartbeat interval. The heartbeat interval is between 10 and 255 seconds. ruckus(config-dpm)#hb-intvl Syntax Description This command has no syntax. Default This command has no default settings. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 46 Supported CLI User and Privileged Modes Privileged Mode Command Mode Privileged Example ruckus>enable ruckus#config ruckus(config)#dpm ruckus(config-dpm)#hb-intvl 50 ruckus#debug Manages system debug options. ruckus#debug Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus#debug ruckus(debug)# ruckus(debug)#end Saves the changes and returns to the first tier. ruckus(debug)#end Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 47 Supported CLI User and Privileged Modes Privileged Mode Example ruckus(debug)#end ruckus(debug)#help Displays the help messages. ruckus(debug)#help Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(debug)#help ruckus(debug)#history Displays a list of previously run commands. ruckus(debug)#history Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus(debug)#history ruckus(debug)#logout Exits from the vSZ-D CLI application. ruckus(debug)#logout Syntax Description This command has no syntax. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 48 Supported CLI User and Privileged Modes Privileged Mode Default This command has no default settings. Command Mode Privileged Example ruckus(debug)#logout ruckus(debug)#diag Diagnostic with internal CLI. Supports internal commands: tunnelmgr_cli, tbldump, dpminfo, and dp_comm. ruckus(debug)#diag Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#debug ruckus(debug)#diag ruckus(debug)#remote-syslogd Enables or disables the redirection of syslog to the remote syslog server. ruckus(debug)#remote-syslogd enable ruckus(debug)#remote-syslogd disable Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 49 Supported CLI User and Privileged Modes Privileged Mode Example ruckus#debug ruckus(debug)#remote-syslogd enable ruckus(debug)#remote-syslogd disable ruckus(debug)#save-log Saves the log to remote vSZ-D/ftp/sftp. ruckus(debug)#save-log scg ruckus(debug)#save-log [username] [password] Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus#debug ruckus(debug)#save-log scg ruckus(debug)#save-log [username] [password] ruckus#backup Backs up vDP configurations. ruckus#backup [username is needed if you used FTP] [password is needed if you used FTP] Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 50 Supported CLI User and Privileged Modes Privileged Mode Example ruckus>enable ruckus#backup ruckus#restore Restore vSZ-D configuration. ruckus#restore [username is needed if you used FTP] [password is needed if you used FTP] Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#restore ruckus#clone Clones the vSZ-D configuration. ruckus#clone [username is needed if you used FTP] [password is needed if you used FTP] Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#clone Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 51 Supported CLI User and Privileged Modes Privileged Mode ruckus#upgrade Upgrades the vDP firmware. ruckus#upgrade [username is needed if you used FTP] [password is needed if you used FTP] Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#upgrade ruckus#setup Setup wizard. To configure the interface/network settings and local password. ruckus#setup Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus#setup ruckus#shutdown Shuts down the vSZ-D. ruckus#shutdown[ now | (minutes) ] Syntax Description This command has the following syntax. Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 52 Supported CLI User and Privileged Modes Privileged Mode now : Shutdown the system immediately. X : shutdown the system after X minutes. Default This command has no default settings. Command Mode Privileged Example ruckus#shutdown ruckus#route Sets the static route. ruckus#route show ruckus#route {add | del} ROUTE ruckus#route dump Syntax Description This command has no syntax. Default This command has no default settings. Command Mode Privileged Example ruckus>enable ruckus#route show ruckus#route {add | del} ROUTE ruckus#route dump where: ROUTE := [] Virtual SmartZone Data Plane (vSZ-D) for SmartZone Release 3.4.1 Command Line Interface Reference Guide 53 Index A N admin 29 name 31 no data-nat-addr 40 no vlan 37, 41 B backup 50 P C passwd 32 ping 18, 24 privileged Mode 14 clone 51 config 26 console Connection 9 controller 42 copyright information 4 Q quit 19 D R debug 47 diag 49 disable 23 dpm 44 reboot 23 remote-syslogd 49 restore 51 route 53 E S enable 16, 21 enable Mode 14 end 16, 21, 26, 30, 33, 37, 42, 45, 47 exit 17, 21 ext-nat data-nat-addr 35, 39 save-log 50 set-factory 29 setup 52 show 19, 25, 32 shutdown 52 sSH Client 9 sSH Connection 9 H hb-intvl 46 help 17, 22, 27, 30, 34, 38, 43, 45, 48 history 17, 23, 27, 30, 34, 38, 43, 46, 48 I T timeout 32 traceroute 20, 25 trademarks 4 initial Mode 14 interface data 37 interface management 33 ip 35, 40, 44 ip name-server 28 ip-data-nat 28 U L virtual SmartZone DataPlane 9 vlan 36, 41 vSZ-D 9 legal 4 log on to vSZ-D CLI 9 logout 18, 22, 28, 31, 35, 39, 43, 46, 48 upgrade 52 user Mode 14 V

Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.4
Linearized                      : Yes
Author                          : Ruckus Wireless, Inc.
Create Date                     : 2016:09:28 10:05:52Z
Modify Date                     : 2016:09:28 15:40:06+05:30
Subject                         : Virtual SmartZone Data Plane (vSZ-D™) CLI Guide for SmartZone 3.4.1
XMP Toolkit                     : Adobe XMP Core 5.4-c005 78.147326, 2012/08/23-13:03:03
Format                          : application/pdf
Title                           : Virtual SmartZone Data Plane (vSZ-D™) CLI Guide for SmartZone 3.4.1
Creator                         : Ruckus Wireless, Inc.
Description                     : Virtual SmartZone Data Plane (vSZ-D™) CLI Guide for SmartZone 3.4.1
Producer                        : XEP 4.22 build 2013
Trapped                         : False
Creator Tool                    : DITA Open Toolkit
Metadata Date                   : 2016:09:28 15:40:06+05:30
Document ID                     : uuid:6cad4a6e-65fd-4e99-a91f-946eb33affeb
Instance ID                     : uuid:395fa2a5-10ff-4bab-bf64-df814f1b9d4f
Page Mode                       : UseOutlines
Page Count                      : 54
EXIF Metadata provided by EXIF.tools

Navigation menu