+ All Categories
Home > Documents > Virtual SmartZone Data Plane (vSZ-D™) Command Line … · About This Guide This Virtual SmartZone...

Virtual SmartZone Data Plane (vSZ-D™) Command Line … · About This Guide This Virtual SmartZone...

Date post: 02-Feb-2021
Category:
Upload: others
View: 4 times
Download: 0 times
Share this document with a friend
69
Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide Part Number: 800-71243-001 Published: 11 April 2017 www.ruckuswireless.com
Transcript
  • Virtual SmartZone Data Plane (vSZ-D) forSmartZone 3.5

    Command Line Interface Reference Guide

    Part Number: 800-71243-001Published: 11 April 2017

    www.ruckuswireless.com

  • Contents

    Copyright Notice and Proprietary Information

    About This GuideDocument Conventions.................................................................................................6

    Terminology..................................................................................................................7

    Related Documentation.................................................................................................9

    Online Training Resources.............................................................................................9

    Documentation Feedback.............................................................................................9

    1 Overview of the vSZ-D Command Line InterfaceAccessing the Command Line Interface......................................................................10

    2 Supported User and Privileged Modes

    3 User Modeenable.........................................................................................................................18

    end.............................................................................................................................18

    exit..............................................................................................................................19

    help.............................................................................................................................19

    history.........................................................................................................................20

    logout..........................................................................................................................20

    ping and ping6............................................................................................................21

    show...........................................................................................................................21

    traceroute and traceroute6..........................................................................................22

    4 Privilege Moderuckus#backup...........................................................................................................24

    ruckus#clone...............................................................................................................25

    ruckus#config..............................................................................................................25

    ruckus(config)#admin........................................................................................26

    ruckus(config)#controller....................................................................................27

    ruckus(config)#dhcp..........................................................................................27

    ruckus(config)#dhcpd_conf ..............................................................................33

    ruckus(config)#dpm...........................................................................................36

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide2

  • ruckus(config)#end............................................................................................37

    ruckus(config)#help...........................................................................................37

    ruckus(config)#history........................................................................................37

    ruckus(config)#interface management...............................................................38

    ruckus(config)#interface data.............................................................................39

    ruckus(config)#interface access-core-separate..................................................40

    ruckus(config)#ip name-server...........................................................................41

    ruckus(config)#ip-data-nat.................................................................................41

    ruckus(config)#logout........................................................................................42

    ruckus(config)#nat.............................................................................................42

    ruckus(config)#no..............................................................................................47

    ruckus(config)#protobuf ....................................................................................47

    ruckus#debug.............................................................................................................54

    ruckus(debug)#end............................................................................................55

    ruckus(debug)#exit............................................................................................55

    ruckus(debug)#help...........................................................................................55

    ruckus(debug)#history.......................................................................................56

    ruckus(debug)#logout........................................................................................56

    ruckus(debug)#diag...........................................................................................57

    ruckus(debug)#remote-syslogd.........................................................................57

    ruckus(debug)#save-log....................................................................................58

    ruckus(debug)#show.........................................................................................58

    ruckus#disable............................................................................................................59

    ruckus#enable.............................................................................................................59

    ruckus#exit..................................................................................................................60

    ruckus#help................................................................................................................60

    ruckus#history.............................................................................................................60

    ruckus#logout.............................................................................................................61

    ruckus#ping ...............................................................................................................61

    ruckus#ping6..............................................................................................................62

    ruckus#quit.................................................................................................................63

    ruckus#reboot.............................................................................................................63

    ruckus#reset...............................................................................................................64

    ruckus#restore............................................................................................................64

    ruckus#route...............................................................................................................65

    ruckus#set-factory......................................................................................................65

    ruckus#show...............................................................................................................66

    ruckus#shutdown........................................................................................................67

    ruckus#traceroute.......................................................................................................67

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide3

  • ruckus#traceroute6.....................................................................................................68

    ruckus#upgrade..........................................................................................................69

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide4

  • Copyright Notice and Proprietary InformationCopyright 2017. Ruckus Wireless, Inc. All rights reserved.

    No part of this documentation may be used, reproduced, transmitted, or translated, in any formor by any means, electronic, mechanical, manual, optical, or otherwise, without prior writtenpermission of Ruckus Wireless, Inc. (“Ruckus”), or as expressly provided by under license fromRuckus.

    Destination Control Statement

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

    Disclaimer

    THIS DOCUMENTATION AND ALL INFORMATION CONTAINED HEREIN (“MATERIAL”) ISPROVIDED FOR GENERAL INFORMATION PURPOSES ONLY. RUCKUS AND ITS LICENSORSMAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THEMATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE,OR THAT THE MATERIAL IS ERROR-FREE, ACCURATE OR RELIABLE. RUCKUS RESERVESTHE 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, SPECIALOR CONSEQUENTIAL DAMAGES, OR DAMAGES FOR LOSS OF PROFITS, REVENUE, DATAOR USE, INCURRED BY YOU OR ANY THIRD PARTY, WHETHER IN AN ACTION IN CONTRACTOR TORT, ARISING FROM YOUR ACCESS TO, OR USE OF, THE MATERIAL.

    TrademarksRuckus Wireless, Ruckus, the bark logo, BeamFlex, ChannelFly, Dynamic PSK, FlexMaster,Simply Better Wireless, SmartCell, SmartMesh, SmartZone, Unleashed, ZoneDirector andZoneFlex are trademarks of Ruckus Wireless, Inc. in the United States and other countries. Allother product or company names may be trademarks of their respective owners.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide5

    5

  • About This GuideThis Virtual SmartZone Data Plane (vSZ-D) Command Line Interface Reference Guide describesthe commands that the vSZ-D uses to enable the data plane based features on the RuckusWireless platform.

    This guide is written for service operators and system administrators who are responsible formanaging, configuring, and troubleshooting Wi-Fi networks. It assumes basic working knowledgeof local area networks, wireless networking, and wireless devices.

    NOTE: Refer to the release notes shipped with your product to be aware of certain challengeswhen upgrading to this release.

    Most user guides and release notes are available in Adobe Acrobat Reader Portable DocumentFormat (PDF) or HTML on the Ruckus Wireless Support Web site athttps://support.ruckuswireless.com/contact-us.

    Document ConventionsTable 1: Text conventions on page 6 and Table 2: Notice conventions on page 7 list the textand notice conventions that are used throughout this guide.

    Table 1: Text conventions

    ExampleDescriptionConvention

    [Device Name] >Represents messagesdisplayed in response to acommand or a status

    message phrase

    [Device Name] > setipaddr 10.0.0.12

    Represents information that youenter

    user input

    Click Create NewKeyboard keys, softwarebuttons, and field names

    user interface controls

    Select Start > All ProgramsRepresents a series ofcommands, or menus andsubmenus

    Start > All Programs

    Press ctrl+V to paste the textfrom the clipboard.

    Represents keyboard keyspressed in combination

    ctrl+V

    Click Advanced Settings. TheAdvanced Settings pageappears.

    screen or page names

    Represents CLI commandscommand name

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide6

    About This GuideDocument Conventions

    https://support.ruckuswireless.com/contact-us

  • ExampleDescriptionConvention

    Represents a parameter in aCLI command or UI feature

    parameter name

    {ZoneDirectorID}Represents variable datavariable name

    http://ruckuswireless.comRepresents file names or URIstrings

    filepath

    Table 2: Notice conventions

    DescriptionNotice type

    Information that describes important featuresor instructions

    NOTE:

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

    CAUTION:

    Information that alerts you to potential personalinjury

    WARNING:

    TerminologyThe table lists the terms used in this guide.

    Table 3: Terms used in this guide

    DescriptionTerminology

    Access Network Query ProtocolANQP

    Access PointAP

    Common NameCN

    Captive PortalCP

    Chargeable User IdentityCUI

    Extensible Authentication ProtocolEAP

    Fully Qualified Domain NameFQDN

    Generic Advertisement ServiceGAS

    Hotspot 2.0HS2.0

    Identity ManagementIDM

    Mobile Country CodeMCC

    Mobile Network CodeMNC

    Mobile Network OperatorMNO

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide7

    About This GuideTerminology

  • DescriptionTerminology

    Managed ObjectMO

    Multiple System OperatorMSO

    Network Access IdentifierGTPv2-C

    Northbound InterfaceNBI

    Online Certificate Status ProtocolOCSP

    Organization IdentifierOI

    Open Mobile Alliance’s Device ManagementOMA-DM

    OSU Server-only authenticated layer 2Encryption Network

    OSEN

    Online Sign-UpOSU

    Hotspot 2.0 certificationPasspoint

    Public Key InfrastructurePKI

    Per Provider Subscription Management ObjectPPS-MO

    Radio Access ControllerRAC

    Remote Access Dial In User ServiceRADIUS

    Hotspot 2.0 Release1 specification compliantdevice

    Release1 Device

    Hotspot 2.0 Release 2 compliant deviceRelease 2 Device

    Robust Security NetworkRSN

    Smart Cell GatewaySCG

    Service Set IdentifierSSID

    Secure Socket LayerSSL

    Terms and ConditionsT&C

    Transmission Control ProtocolTCP

    Transport Layer SecurityTLS

    Tunneled TLSTTLS

    User Define InterfaceUDI

    User EquipmentUE

    User Equipment - IP AddressUE-IP

    User Equipment - MAC AddressUE-MAC

    User InterfaceUI

    Uniform Resource IdentifierURI

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide8

    About This GuideTerminology

  • DescriptionTerminology

    Universal Subscriber Identity ModuleUSIM

    User Traffic ProfileUTP

    Universal Unique IdentifierUUID

    Vendor Specific AttributesVSA

    Wide Area NetworkWAN

    Wi-Fi AllianceWFA

    Wireless Local Area NetworkWLAN

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

    Online Training ResourcesTo access a variety of online Ruckus Wireless training modules, including free introductorycourses to wireless networking essentials, site surveys, and Ruckus Wireless products, visit theRuckus Wireless Training Portal at:

    https://training.ruckuswireless.com.

    Documentation FeedbackRuckus Wireless is interested in improving its documentation and welcomes your commentsand suggestions.

    You can email your comments to Ruckus Wireless at: [email protected]

    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 3.5 Command Line Interface Reference Guide9

    About This GuideRelated Documentation

    https://training.ruckuswireless.commailto:[email protected]

  • 1Overview of the vSZ-D Command LineInterface

    In this chapter:

    • Accessing the Command Line Interface

    The Virtual SmartZone DataPlane (vSZ-D) command line interface (CLI) is a software tool that enablesyou to configure and manage vSZ-D.

    Using the command line interface, you can issue commands from an operating system prompt, suchas the Microsoft Windows command prompt or a Linux operating system terminal. Each commandperforms a specific action for configuring device settings or returning information about the status ofa specific device feature.

    Accessing the Command Line InterfacevSZ-D has a built-in command line interface (CLI) that you can use to configure vSZ-D settingsand manage access points. This section describes the requirements and the procedure foraccessing 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 computer2. 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 theadministrative computer.

    NOTE: The following procedure describes how to use PuTTY, a free and open source telnet/SSHclient, to access the vSZ-D CLI. If you are using a different SSH client, the procedure may beslightly different (although the connection settings should be the same). For more informationon 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 3.5 Command Line Interface Reference Guide10

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

  • Using SSH Connection

    If you have connected the administrative computer to the same subnet or broadcast domain asthe Management (Web) interface of vSZ-D, follow these steps to start and configure the SSHclient.

    1. Start PuTTY. The PuTTY configuration dialog box appears, showing the Session screen asseen in Figure 1: Selecting SSH as a connection type on page 11.

    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 consoleto the virtual machine. From the console, you can perform activities within the virtual machinesuch as configure operating system settings, run applications, and monitor performance. Theprerequisites are as follows:

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide11

    Overview of the vSZ-D Command Line InterfaceAccessing 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 machinesand 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 machineconsole opens in a new tab of the Web browser.

    3. Click anywhere inside the console window to enable your mouse, keyboard, and other inputdevices to work in the console.

    4. (Optional) Press Ctrl+Alt to release the cursor from the console window and work outsidethe 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 oflogin name and password as given.

    NOTE: You cannot use 'admin' as a password, which is used during the vSZ-D installationprocedure.

    • The Ruckus Wireless vSZ-D CLI welcome message appears with the CLI prompt as seen inFigure 2: Welcome to vSZ-D on page 13 .

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide12

    Overview of the vSZ-D Command Line InterfaceAccessing 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 CLIprompt. 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 13.

    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 previouslyexecuted and ping a device as seen in Figure 4: Using the Ping command on page 14.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide13

    Overview of the vSZ-D Command Line InterfaceAccessing 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 enableand the password at the root prompt as seen in Figure 5: Changing to privileged mode onpage 14. The prompt changes from ruckus> to ruckus# (with a pound sign). Refer to theenable command for details.

    Figure 5: Changing to privileged mode

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide14

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

  • 2Supported User and Privileged ModesThe supported commands are listed in the below tables.

    Table 4: Initial or User Mode

    DescriptionInitial or User mode (Using ?)

    Enter the password to change the mode to Enable.enable

    Exits from the EXECexit

    Displays the help messagehelp

    Shows a list of previously run commandshistory

    Exits from the EXEClogout

    Sends the packets to an IP address or domain basedon the IP protocol.

    ping and ping6

    Ends the CLI sessions.quit

    Shows the:show

    • vSZ-D system details and version• NAT session system options and settings• DHCP binding

    Prints the route packets taken to reach the networkhost based on the IP protocol.

    traceroute and traceroute 6

    Table 5: Privilege Mode

    DescriptionCommandMode

    Backups the vSZ-D configuration.backupEnable

    Backups the vSZ-D configuration and unique ID.clone

    Changes the mode to configuration to executeconfiguration commands.

    config

    Manages the system debug options.debug

    Disables the privileged commands.disable

    Modifies the enable passwordenable

    Exits from the EXECexit

    Displays the help messagehelp

    Shows a list of previously run commandshistory

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide15

    15

  • DescriptionCommandMode

    Exits from the EXEClogout

    Sends the ICMP echo packets to the specified IP addressbased on the IP address protocol.

    ping and ping6

    Ends the CLI sessions.quit

    Reboots the vSZ-D.reboot

    Resets the DHCP binding.reset

    Restores the vSZ-D configuration.restore

    Sets the route configuration.route

    Reverts to factory settings.set-factory

    Shows the:show

    • vSZ-D system details and version• NAT session system options and settings• DHCP binding

    Shuts the vSZ-D.shutdown

    Prints the route packets taken to reach the network hosttraceroute andtraceroute6

    Upgrade to a new release of vSZ-D.upgrade

    Configure the administrative settings.adminConfiguration

    Configure the vSZ settings.controller

    Configure dhcpd.conf settings.dhcp

    Configure dhcpd_conf add/delete/modified settings.dhcpd_conf

    Configure DPM settings.dpm

    Save changes and exit from the configuration mode.end

    Exit from the configuration mode without saving thechanges.

    exit

    Displays the help messagehelp

    Shows a list of previously run commandshistory

    Configure the interface settings.interface

    Configure the IP settings.ip

    Exit from the EXEClogout

    Configure NAT server settings.nat

    Disables the configurationno

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide16

    Supported User and Privileged Modes

  • DescriptionCommandMode

    Configure protobuf /nat/dhcps/vpn settings.protobuf

    Save the changes and exit from the configuration modeendDebug

    Exit from the configuration mode without saving thechanges.

    exit

    Displays the help messagehelp

    Shows a list of previously run commandshistory

    Enable or disable KDUMP on vSZ-Dkdump

    Exit from the EXEClogout

    Enables or disables remote packet capture on vSZ-Dremote-packet-capture

    Redirect the syslog of the vSZ-D to a remote syslogdremote-syslogd

    Save the log to remotesave-log

    Shows the disabled status of remote packet capture anddata plane packet capture.

    show

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide17

    Supported User and Privileged Modes

  • 3User ModeIn this chapter:

    • enable• end• exit• help• history• logout• ping and ping6• show• traceroute and traceroute6

    You generally begin in user EXEC mode, which is one of two access levels of the EXEC mode. Forsecurity purposes, only a limited subset of EXEC commands are available in user EXEC mode. Thislevel of access is reserved for tasks that do not change the configuration of the router, such asdetermining the router status.

    enableTurns on privileged commands.ruckus>enable

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus>enable

    endSaves the changes and returns to the first tier.ruckus>end

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide18

    User Modeenable

  • Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus>end

    exitExits from the EXEC mode.ruckus>exit

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus>exit

    helpDisplays the help messages.ruckus>help

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide19

    User Modeexit

  • Command Mode

    User

    Exampleruckus>help

    historyDisplays a list of previously run commands.ruckus>history

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus>history

    logoutExits from the vDP CLI application.ruckus>logout

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus>logout

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide20

    User Modehistory

  • ping and ping6Sends ICMP echo packets to an IP address based on the IP version 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• pattern• packetsize• ttl• interface or address• mtu discovery hint• sndbuf• timestamp option• destination

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus(config)#ping

    showDisplays system information.ruckus>show

    Syntax Description

    This command has no syntax.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide21

    User Modeping and ping6

  • Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus>showversion

    Shows the system version number and serial number.

    traceroute and traceroute6Prints the route that the packets take to the network host.ruckus# or ruckus>traceroute[ -46dFITnreAUV ][ -f first_ttl ][ -ggate,... ] [ -i device ] [ -m max_ttl ] [ -N squeries ] [ -p port ][ -t tos ] [ -l flow_label ][ -w waittime ] [ -q nqueries ][ -ssrc_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

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide22

    User Modetraceroute and traceroute6

  • Exampleruckus#traceroute

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide23

    User Modetraceroute and traceroute6

  • 4Privilege ModeIn this chapter:

    • ruckus#backup• ruckus#clone• ruckus#config• ruckus#debug• ruckus#disable• ruckus#enable• ruckus#exit• ruckus#help• ruckus#history• ruckus#logout• ruckus#ping• ruckus#ping6• ruckus#quit• ruckus#reboot• ruckus#reset• ruckus#restore• ruckus#route• ruckus#set-factory• ruckus#show• ruckus#shutdown• ruckus#traceroute• ruckus#traceroute6• ruckus#upgrade

    To have access to all commands, you must enter privileged EXEC mode, which is the second levelof access for the EXEC mode. You must enter a password to enter privileged EXEC mode.

    ruckus#backupBacks up vDP configurations.ruckus#backup [username is needed if you used FTP] [password is needed if you usedFTP]

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide24

    Privilege Moderuckus#backup

  • Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#backup

    ruckus#cloneClones the vSZ-D configuration.ruckus#clone [username is needed if you used FTP] [password is needed if you usedFTP]

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#clone

    ruckus#configConfigure 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

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide25

    Privilege Moderuckus#clone

  • Exampleruckus#config

    ruckus(config)#adminEnter 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

    Exampleruckus>enable

    ruckus#config

    ruckus(config)#admin

    ruckus(config-admin)#..

    Related Commands

    DescriptionCommand

    Saves changes, and exits the config-admincontext.

    end

    Exits the config-admin context without savingchanges

    exit

    Displays the help messagehelp

    Shows a list of previously run commandshistory

    Exits from the EXEClogout

    Sets the hostname.name

    Sets the local account admin password.passwd

    Displays the settingsshow

    Sets the CLI idle timeout value in minutes.timeout

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide26

    Privilege Moderuckus#config

  • ruckus(config)#controllerConfigures the virtual DataPlane settings.ruckus(config)#controller

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#config

    ruckus(config)#controller

    ruckus(config-controller)#

    Related Commands

    DescriptionCommand

    Saves changes, and exits the config-controllercontext.

    end

    Exits the config-contoller context without savingchanges

    exit

    Displays the help messagehelp

    Shows a list of previously run commandshistory

    Sets the vSZ IP addressip

    Exits from the EXEClogout

    ruckus(config)#dhcpUse the dhcp command to create or set the Dynamic Host Configuration (DHCP) serverconfiguration setting. Use the dhcpd.conf for configuring the settings.ruckus(config)#dhcp

    Default

    This command has no default settings.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide27

    Privilege Moderuckus#config

  • Command Mode

    config

    Parameter Settings

    Table 6: DHCP Parameter Details

    DescriptionTypeParameter

    Sets the default lease timervalue in days, hours, minutesor infinite.

    Globaldefault-lease-time

    Specifies the option for clientdomain name. This is set a

    Global and Pooloption domain-name

    global type by default if it notspecified inside a pool.

    Specifies the list of DNSservers (up to 8) for the client

    Global and Pooloption dns-server

    Sends the DHCP events toSyslog.

    Globaldhcp-log-syslog

    Adds or modifies a DHCP poolentry.

    Global and Pooldhcp-pool

    Specifies the network addressand prefix for the pool.

    Poolnetwork

    Specifies the list of addressesto be excluded from the pool.

    Poolexclude-address

    Addresses are commaseparated and must be withinthe pool subnet defined in thenetwork.

    Specifies the IP address rangeto be excluded from the pool.

    Poolexclude-address-range

    Addresses must be within thepool subnet defined in thenetwork.

    Specifies the default router forthe pool.

    Pooldefault-router

    Sets the lease timer value forthe pool in days, hours,minutes or infinite.

    Poollease-time

    This define the VLAN ID in UEL2 frame for identifying the

    Poolvlan-range

    pool. This is for vSZ-D to

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide28

    Privilege Moderuckus#config

  • DescriptionTypeParameter

    identify which DHCP pool touse. Multiple instance of thisparameter can be specified inone pool.

    The vlan-ranges must beunique across pools and therecannot be any overlap acrossDHCP pools.

    Simiar to the above parameterbut allows to specify a single

    Poolvlan

    VLAN rather that a range.Multiple instance of thisparameter can be specified inone pool.

    The vlan values must be uniqueacross pools. There cannot beany overlap across pools.

    This define a singleC-VLAN/S-VLAN tuple which

    Poolqinq-vlan

    is used as the selection keyinto the array of configuredDHCP pools. This value mustbe unique across the DHCPpools in a particular vSZ-Dinstance.

    This parameter definesC-VLAN and S-VLAN ranges

    Poolqinq-vlan-range

    used as the selection key intothe array of configured DHCPpools. The values must notoverlap with other DHCP poolsin a particular vSZ-D instance.

    Clears DHCP bindings for aclient or a pool or the entiresystem.

    reset dhcp bindings

    Resets the stasticsreset dhcp stat

    Display binding information fora pool or a specific MACaddress.

    show dhcp binding

    Display statisticsshow dhcp stat

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide29

    Privilege Moderuckus#config

  • Examples

    ruckus#config

    ruckus(config)#dhcp

    ruckus(config-dhcp)#dhcp-log-syslog Sends the DHCP events to the syslog server.

    ruckus(config-dhcp)#no dhcp-log-syslog Stops sending DHCP events to the syslogserver.

    ruckus(config-dhcp)#end

    Do you want to apply changes (y/n)?y

    Configuration Applied Successfully

    vSZ-D-01#configure

    vSZ-D-01(configure)#dhcp

    vSZ-D-01(configure-dhcp)#default-lease-time 0 10 30 // 0 days 10h30min

    vSZ-D-01(configure-dhcp)#option domain-name “ruckuswireless.com” //Sets the default domain name for subscribers to be used if notspecified in the pool

    vSZ-D-01(configure-dhcp)#option dsn-server 172.16.200.3, 172.16.200.5/Sets the default DNS servers for the subscribers to be used id notspecified in the pool

    vSZ-D-01(configure-dhcp)#end

    Do you want to apply changes (y/n)?y

    Configuration Applied Successfully

    vSZ-D-01#

    Creating a New DHCP PoolTo create a new DHCP pool, ensure to be in the configuration mode.

    vSZ-D-01#configurevSZ-D-01(configure)# ? // Shows all configure option

    vSZ-D-01(configure)#dhcp ? // Shows all dhcp config option along withexisting dhcp pool already configured

    For example:

    vSZ-D-01(configure)#dhcp ?

    pool_name_1 // Name of existing dhcp pool

    pool_name_2 // Name of existing dhcp pool

    // Enter name of new pool to add// In this exmaple dhcppool_name_3

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide30

    Privilege Moderuckus#config

  • vSZ-D-01(configure-dhcp)# ? // Shows all the DHCP configurableparameters

    network

    default-router

    option domain-name

    option dns-server

    lease-time

    vlan

    vlan-range

    qinq-vlan

    qinq-vlan-range < s-vlan S-VLAN-start “-“ S-VLAN Stop “space” c-vlanC-VLAN-Start “-“ S-VLAN-Stop>

    Example of new DHCP Pool

    vSZ-D-01#configure

    vSZ-D-01(configure)#dhcp demo-dhcp-pool

    vSZ-D-01(configure-dhcp)#network 192.168.1.0\24

    vSZ-D-01(configure-dhcp )#default-router 192.168.1.1

    vSZ-D-01(configure-dhcp)#lease-time 1 0 0

    vSZ-D-01(configure-dhcp)#option dns-server 4.2.2.2, 8.8.8.8

    vSZ-D-01(configure-dhcp)#option domain-name “test.com”

    vSZ-D-01(configure-dhcp)#vlan-range 1000-1100

    vSZ-D-01(configure-dhcp)#end

    Do you want to apply changes (y/n)?y

    Configuration Applied Successfully

    vSZ-D-01#

    NOTE: CLI enusres IP address and subnet validation, where all the IP addresses in the rangeare in the same subnet. Its ensures that: (1) All necessary parameters are provisioned. (2) Noport range overlap with other pools. (3) No private VLAN overlap with other pools. (4) PrivateVLAN must be the same as global value and other pools.Single public subnet is supported.

    Clearing and Reset Commands

    To clear DHCP bindings for an IP address in a pool or the entire vSZ-D

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide31

    Privilege Moderuckus#config

  • vSZ-D-01#reset dhcp bindings ||

    To reset DHCP count on a per pool basis

    vSZ-D-01#reset dhcp stat |

    Show Commands

    To view the running configuration

    vSZ-D-01#show running-config dhcp

    default-lease-time 1day 12h 30min

    default-domain-name “ruckuswireless.com”

    default-dns-server 172.16.200.3, 172.16.200.5

    dhcp-log-syslog

    No Pool Name Created by Created on1 demo-dhcp-pool admin 2017-01-12 20:04:02 GMT

    To view the DHCP Pool

    vSZ-D-01#show running-config dhcp demo-dhcp-pool

    pool "demo-dhcp=pool"

    network 192.168.1.0\24

    default-router 192.168.1.1

    lease-time 1day 0h 0min

    option dns-server 4.2.2.2, 8.8.8.8

    option domain-name “test.com”

    vlan-range 1000-1100

    To monitor DHCP information related to configuration as well as active DHCP bindings on aper pool basis and per subscriber basis.

    vSZ-D-01#show dhcp binding || UE MAC address>

    This command shows the list of DHCP bindings for a specific pool and includes the followinginformation. This to troubleshoot issues when a Client does not get the IP address or is unableto send or receive packets. You can identify at which stage DHCP exchange has been completed.

    • Client MAC• Client IP // Shows it as not assigned if it is in progress or has failed• Remaining lease time• Number of Discover packets for this session• Number of Offer packets for this session• Number of Request packet for this session

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide32

    Privilege Moderuckus#config

  • • Number of Acknowledged packets for this session• Number of Release packets for this session

    To view DHCP statistics .

    vSZ-D-01#show dhcp stat

    This command shows the statistics for global DHCP or per pool if specified and include thefollowing fields.

    • Number of Discover packets for this session• Number of Offer packets for this session• Number of Request packet for this session• Number of Acknowledged packets for this session• Number of Release packets for this session• Number of Inform (if supported) packets for this session

    ruckus(config)#dhcpd_confConfigure dhcpd_conf to add or modfiy or delete DHCPD settings.vSZ-D(config)# dhcpd_conf vSZ-D(config-dhcpd)# add default-lease-time 600

    Default

    This command has no default settings.

    Command Mode

    config

    Creating a New dhcpd.confTo create a new dhcpd.conf, ensure to be in the configuration mode.

    vSZ-D# config

    vSZ-D(config)# dhcpd_conf

    vSZ-D(config-dhcpd)# add default-lease-time 600

    vSZ-D(config-dhcpd)# add option domain-name profile_vlan_A

    vSZ-D(config-dhcpd)# add option domain-name-servers 172.16.200.5

    vSZ-D(config-dhcpd)# show

    Configuration for Option43 in Global dhcpd.conf

    vSZ-D(config-dhcpd)# option43

    vSZ-D(config-dhcpd-vendor)# add option_space VendorInfo

    vSZ-D(config-dhcpd-vendor)# add option VendorInfo.FM code 1 = text

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide33

    Privilege Moderuckus#config

  • vSZ-D(config-dhcpd-vendor)# add option VendorInfo.ZD code 3 = text

    vSZ-D(config-dhcpd-vendor)# add option VendorInfo.WSG code 6 = text

    vSZ-D(config-dhcpd-vendor)# add option VendorInfo.WSGD code 7 = text

    vSZ-D(config-dhcpd-vendor)# add option VendorInfo.IP code 8 =ip-address

    vSZ-D(config-dhcpd-vendor)# add option VendorInfo.NUM code 9 =unsigned integer 16

    vSZ-D(config-dhcpd-vendor)# show

    vSZ-D(config-dhcpd-vendor)# exit //type "end" to save the changes

    Configuration of Subnet in Global dhcpd.conf

    vSZ-D(config-dhcpd)# subnet 192.0.0.0 netmask 255.0.0.0

    vSZ-D(config-dhcpd-subnet)# add range 192.0.100.100 192.254.160.200

    vSZ-D(config-dhcpd-subnet)# add option broadcast-address 10.92.255.255

    vSZ-D(config-dhcpd-subnet)# add option domain-name-servers172.16.200.5

    vSZ-D(config-dhcpd-subnet)# add option routers 10.92.0.1

    vSZ-D(config-dhcpd-subnet)# add default-lease-time 300

    vSZ-D(config-dhcpd-subnet)# add option domain-name profile_vlan_A

    vSZ-D(config-dhcpd-subnet)# add option host-name host_vlan_A

    vSZ-D(config-dhcpd-subnet)# show

    Configuration of Option43 in Subnet

    vSZ-D(config-dhcpd-subnet)# option43

    vSZ-D(config-dhcpd-subnet-vendor)# add Vendor-option-space VendorInfo

    vSZ-D(config-dhcpd-subnet-vendor)# add option VendorInfo.WSGhttps://10.65.0.41/wsg/ap

    vSZ-D(config-dhcpd-subnet-vendor)# add option VendorInfo.ZD 10.65.0.41

    vSZ-D(config-dhcpd-subnet-vendor)# add option VendorInfo.IP12.13.14.15

    vSZ-D(config-dhcpd-subnet-vendor)# add option VendorInfo.NUM 12345

    vSZ-D(config-dhcpd-subnet-vendor)# show

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide34

    Privilege Moderuckus#config

  • Modifying Netmask in Subnet

    vSZ-D(config-dhcpd-subnet)# add netmask 255.255.0.0

    vSZ-D(config-dhcpd-subnet)# add range 192.104.1.100 192.104.80.200

    vSZ-D(config-dhcpd-subnet)# add option broadcast-address 10.94.255.255

    vSZ-D(config-dhcpd-subnet)# add option domain-name-servers172.16.200.5

    vSZ-D(config-dhcpd-subnet)# add option routers 10.94.0.1

    vSZ-D(config-dhcpd-subnet)# add default-lease-time 300

    vSZ-D(config-dhcpd-subnet)# add option domain-name profile_vlan_B

    vSZ-D(config-dhcpd-subnet)# add range-vlan 100 200

    vSZ-D(config-dhcpd-subnet)# show

    Delete Parameters in dhcpd.conf

    To delete dhcpd.conf

    vSZ-D(config)# dhcpd_conf

    vSZ-D(config-dhcpd)# del default-lease-time

    vSZ-D(config-dhcpd)# del option domain-name

    vSZ-D(config-dhcpd)# del option domain-name-servers

    To delete Option43 configuration in subnet

    vSZ-D(config-dhcpd)# subnet 192.0.0.0

    vSZ-D(config-dhcpd-subnet)# option43

    vSZ-D(config-dhcpd-subnet-vendor)# del option VendorInfo.NUM

    vSZ-D(config-dhcpd-subnet-vendor)# show

    To delete all Option43 configuration in subnet

    vSZ-D(config-dhcpd-subnet-vendor)# del Vendor-option-space VendorInfo

    To delete the option Vendor Informataion IP address in dhcpd_conf and Subnet layer

    vSZ-D(config-dhcpd-vendor)# del option VendorInfo.IP

    vSZ-D(config-dhcpd-vendor)# show

    To delete all Vendor Information in dhcpd_conf and subnet layer

    vSZ-D(config-dhcpd-vendor)# del option_space VendorInfo

    vSZ-D(config-dhcpd-vendor)# show

    To delete all 192.0.0.0 subnet in dhcpd.conf

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide35

    Privilege Moderuckus#config

  • vSZ-D(config-dhcpd)# subnet 192.0.0.0

    vSZ-D(config-dhcpd-subnet)# del all // Cleans all subnet ip"192.0.0.0" configuration// Type "end" to save.

    vSZ-D(config-dhcpd)# show

    vSZ-D(config-dhcpd-vendor)# show

    To delete subnet parameters in dhcpd.conf dhcpd.conf

    vSZ-D(config-dhcpd)# subnet 192.104.0.100

    vSZ-D(config-dhcpd-subnet)# del range

    vSZ-D(config-dhcpd-subnet)# del option broadcast-address

    vSZ-D(config-dhcpd-subnet)# del option domain-name-servers

    vSZ-D(config-dhcpd-subnet)# del option routers

    vSZ-D(config-dhcpd-subnet)# del default-lease-time

    vSZ-D(config-dhcpd-subnet)# del option domain-name

    vSZ-D(config-dhcpd-subnet)# del range-vlan

    vSZ-D(config-dhcpd-subnet)# show

    ruckus(config)#dpmConfigues DPM settings.ruckus(config)#dpm

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#config

    ruckus(config)#dpm

    ruckus(config-dpm)#

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide36

    Privilege Moderuckus#config

  • Related Commandsend Saves the changes, and exits the config-dpm exit Exits the config-dpm context. hb-intvlSets the DPM heartbeat interval help Display the help message history Shows the list of previouslyrun commands logout Exits from the EXEC

    ruckus(config)#endSaves the changes and returns to the first tier.ruckus(config)#end

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus(config)#end

    ruckus(config)#helpDisplays the help messages.ruckus(config)#help

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus(config)#help

    ruckus(config)#historyDisplays a list of previously run commands.ruckus(config)#history

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide37

    Privilege Moderuckus#config

  • Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus(config)#history

    Command history:

    0. en

    1. config

    2. dpm pd

    3. exit

    4. history

    ruckus(config)#interface managementConfigure 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

    Exampleruckus>enable

    ruckus#config

    ruckus(config)#interface management

    ruckus(config-interface)#

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide38

    Privilege Moderuckus#config

  • Related Commands

    DescriptionCommand

    Saves changes, and exits theconfig-management context.

    end

    Exits the config-management context withoutsaving changes.

    exit

    Displays the help message.help

    Shows a list of previously run commands.history

    Sets the IPv4 or IPv6 address for the interface.ip

    Exits from the EXEC.logout

    Removes VLAN identfier of the interface.no

    Shows the current interface setup or all theJSON files.

    show

    Sets the VLAN identifier for interface.vlan

    ruckus(config)#interface dataConfigures data interface settings.ruckus(config)#interface data

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#config

    ruckus(config)#interface data

    ruckus(config-interface)#

    Related Commands

    DescriptionCommand

    Saves changes and exits the config-interfaceend

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide39

    Privilege Moderuckus#config

  • DescriptionCommand

    Exits the config-interface context without savingchanges.

    exit

    Displays the help message.help

    Shows a list of previously run commands.history

    Sets the IPv4 or IPv6 address for the interface.ip

    Exits from the EXEC.logout

    Removes VLAN identfier of the interface.no

    Shows the current interface setup or all theJSON files.

    show

    Sets the VLAN identifier for interface.vlan

    ruckus(config)#interface access-core-separateSets the access core separate core interface.ruckus(config)#interface access-core-separate

    ruckus(config-core-separate)#

    Syntax DescriptionThis command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    config

    Exampleruckus>enable

    ruckus#config

    ruckus(config)#interface access-core-separate

    ruckus(config-core-separate)#

    Related Commands

    DescriptionCommand

    Disables access core separate.disable

    Saves changes and exits the config-interfaceend

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide40

    Privilege Moderuckus#config

  • DescriptionCommand

    Exits the config-interface context without savingchanges.

    exit

    Displays the help message.help

    Shows a list of previously run commands.history

    Sets the IPv4 or IPv6 address for the interface.ip

    Exits from the EXEC.logout

    Removes VLAN identfier of the interface.no

    Shows the current interface setup or all theJSON files.

    show

    Sets the VLAN identifier for interface.vlan

    ruckus(config)#ip name-serverSets 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-natSets the external NAT IP address of the data interface.ruckus(config)#ip-data-nat

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide41

    Privilege Moderuckus#config

  • Command Mode

    Privileged

    Example

    ruckus(config)#ip-data-nat

    ruckus(config)#logoutExits 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

    Exampleruckus(config)#logout

    ruckus(config)#natUse the nat command to configure NAT server settings.ruckus(config)# natvSZ-D-01(configure-nat)#

    Default

    This command has no default settings.

    Command Mode

    config

    Parameter Settings

    Table 7: DHCP Parameter Details

    DescriptionTypeParameter

    Defines the public subnet startaddress and prefix along with

    Globalnat-public-subnet-id

    VLAN identifier used for NATpacet northbound.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide42

    Privilege Moderuckus#config

  • DescriptionTypeParameter

    Sends the NAT events toSyslog.

    Globalnat-log-syslog

    Specifies the GW for sendingNAT packets.

    Global and Poolnat-default-route

    Specifies the range of public IPaddress used for matchingNAT packets in this pool.

    Poolpublic-addr-range

    Similiar to the above parameterbut this is for a single IPaddress.

    Poolpublic-addr

    Specifies the port range usedas the source port when

    Poolnat-port-range

    matching NAT packets in thispool. Multiple instance of thisparameter can be specified inone pool. The “port range +public IP” must be uniqueacross pools.

    This define the VLAN ID in UEL2 frame used to identify the

    Poolpublic-prefix

    pool. Multiple instance of thisparameter can be specified inone pool. The vlan-rangesmust be unique across poolsand there cannot be anyoverlap across pools.

    Similiar to the above parameterbut this is for a single IPaddress.

    Poolprivate-vlan

    This define a singleC-VLAN/S-VLAN tuple used as

    Poolprivate-qinq-vlan

    the selection key into the arrayof configured NAT pools. Thisvalue must be unique acrossthe NAT pools in a particulatvSZ-D instance.

    This parameter definesC-VLAN and S-VLAN ranges

    Poolprivate-qinq-vlan-range

    to be used as the selection keyinto the array of configuredNAT pools. The values mustnot overlap with other NAT

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide43

    Privilege Moderuckus#config

  • DescriptionTypeParameter

    pools in a particular vSZ-Dinstance.

    Creating a New NAT PoolTo create a new NAT server pool, ensure to be in the configuration mode.

    vSZ-D-01#configurev

    SZ-D-01(configure)# ? // Shows all configure option

    vSZ-D-01(configure)#nat ? // Shows all nat configuration option alongwith existing nat pool configuration.

    For example:

    vSZ-D-01(configure)#nat ?

    pool_name_1 // Name of existing nat pool

    pool_name_2 // Name of existing nat pool

    // Enter name of new pool to add// In this exmaple natpool_name_3

    vSZ-D-01(configure-nat)# ? // Shows all the nat configurableparameters

    public-addr-range

    public-addr

    nat-port-range

    private-vlan

    private-vlan-range

    private-qinq-vlan

    private-qinq-vlan-range < s-vlan S-VLAN-start “-“ S-VLAN Stop “space”c-vlan C-VLAN-Start “-“ S-VLAN-Stop>

    Example of new NAT Pool

    vSZ-D-01#configure

    vSZ-D-01(configure)#nat demo-pool

    vSZ-D-01(configure-nat)public-addr-range 12.217.161.215 12.217.161.220

    vSZ-D-01(configure-nat)#port-range all

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide44

    Privilege Moderuckus#config

  • vSZ-D-01(configure-nat)#private-vlan 2017

    vSZ-D-01(configure-nat)#end

    Do you want to apply changes (y/n)?y

    Configuration Applied Successfully

    vSZ-D-01#

    NOTE: CLI enusres IP address and subnet validation, where all the IP addresses in the rangeare in the same subnet. Its ensures that: (1) All necessary parameters are provisioned. (2) Noport range overlap with other pools. (3) No private VLAN overlap with other pools. (4) PrivateVLAN must be the same as global value and other pools.Single public subnet is supported.

    Modifying NAT Pool Configuration

    To modify NAT pool range.

    vSZ-D-01#configure

    vSZ-D-01(configure)#nat demo-pool

    vSZ-D-01(configure-nat)port-range 10000-20000

    vSZ-D-01(configure-nat)#end //Change is applied when “end” keywordis entered and confirmed.

    Do you want to apply changes (y/n)?y

    Configuration Applied Successfully

    vSZ-D-01#

    To confirm that the NAT pool range is modified use the show command.

    vSZ-D-01#show running-config nat demo-poolpool “demo-pool”public-addr-range 12.217.161.215 12.217.161.220nat-port-range 10000-20000private-vlan 2017

    Syslog and NAT Server Configuration

    It is a requirement that all NAT transactions be logged to an external Syslog server. The followingparameters are configurable on the vSZ-D instance.

    • Syslog server IP address (Primary server)• Syslog server port (default port number is 514)• Syslog protocol is the UDP• Facility for NAT logs (Local0-Local7)• Facility for DHCP logs (Local0-Local7)• Syslog priority is set to Info

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide45

    Privilege Moderuckus#config

  • vSZ-D-01#configure

    vSZ-D-01(configure)#syslog

    vSZ-D-01(configure-syslog)#server-ip 10.150.0.159

    vSZ-D-01(configure-syslog)#server-port 514

    vSZ-D-01(configure-syslog)#facility nat local0

    vSZ-D-01(configure-syslog)#facility nat local7

    Show Commands

    To view therunning configuration. This command will show the NAT pool configuration for aparticular pool name or for all the configured NAT pools on this vSZ-D instance.

    vSZ-D-01#show running-config nat

    Sample output#show running-config nat allGlobal Configuration:---------------------nat-public-subnet-id 10.92.0.0/24 vlan 500nat-default-route gw 10.92.0.1nat-log-syslogPool Configuration:No Pool Name Created by Created on1 pool_name_abc admin 2017-01-12 20:04:02 GMT2 pool_name_efg admin 2017-01-10 12:34:28 GMT

    vSZ-D-01# show running-config nat // To view theconfiguration of a specified pool.

    vSZ-D-01#show running-config nat // Using QinQ tagof a specified pool.

    To view NAT configured filters.

    vSZ-D-01#show nat-filters

    Sample output:nat filter private-ip 10.150.0.109nat filter private-port 1200nat filter public-ip 12.217.161.214nat filter public-port 16000nat filter ue-mac 00:01:02:03:04:05

    Deleting NAT Pool Configuration

    To delete a specific NAT pool. .

    vSZ-D-01(configure)#no demo-pool

    vSZ-D-01(configure-nat)#end

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide46

    Privilege Moderuckus#config

  • Do you want to continue to delete (or input ‘no’ to cancel)? [yes/no]yes

    Successful operation

    vSZ-D-01(configure)#

    To delete each NAT configured filter, prefix a no before the filter name.

    vSZ-D-01(configure-nat)#no filter private-ip

    vSZ-D-01(configure-nat)#end

    Do you want to apply changes (y/n)?y

    Configuration Applied Successfully

    vSZ-D-01(configure)#

    ruckus(config)#noUse the no command to disable the specified configuration.ruckus(config)# no < ip-data-nat>

    Syntax Description

    This command has the following syntax:

    ip-data-nat: Removes the external NAT server settings from the Data Interface.

    Default

    This command has no default settings.

    Command Mode

    config

    Example

    ruckus(config)# no ip-data-nat

    ruckus(config)#protobufUse the protobuf command to create protocol compiler.vSZ-D57(config)# protobuf

    vSZ-D57(config-protobuf)#

    Default

    This command has no default settings.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide47

    Privilege Moderuckus#config

  • Command Mode

    config

    Commands for DHCP Server

    NOTE: Ensure to be in the configuration mode.

    To view DHCP service configuration on Google protocol.

    vSZ-D57(config-protobuf)# dhcps cfg show

    To enable DHCPS service. By default the default setting is Disable.

    vSZ-D57(config-protobuf)# dhcps service enable

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# dhcps cfg showenable : enablecore_68_to_67_enable : disable

    To enable or disable DHCPS core_68_to_67. By default the default setting is Disable.

    vSZ-D57(config-protobuf)# dhcps core_68_to_67 enable

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# dhcps cfg showenable : disablecore_68_to_67_enable : enable

    Commands for NAT Server

    NOTE: Ensure to be in the configuration mode.

    To view NAT server summary. .

    vSZ-D57(config-protobuf)# nat sum

    >> NAT MAP-HASH tbl: gbl(rawIP='Disabled'wlan='Disabled' vpn='Disabled'); cli_cfg_count=0Map_hash=0/0(used); actv=0;assign_rate=0NAT Port_array=0(used);(0, 0, 0, 0, 0, 0, 0, 0 available)low_threshold_hit: (0, 0, 0, 0, 0, 0, 0, 0)port_recover_events=0 nat_port_LL=0,hash_full_errA=0 errB=0entry_actv_time=0 (sec); cmd_actv_enforce=0; (act as show

    filter)

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide48

    Privilege Moderuckus#config

  • out_of_port_err=0, map_hash_add_err=0map_hash_buckets_used=0, nat_hash_entry_tmo=0sb_saw_nb_tcp_flags_err=0At Private: RxPkts=0; rate=0 (kbps)At Public: RxPkts=0; rate=0 (kbps)

    ------ NAT Port array table:>> NAT port array tbl: 0/0(used),Map-hash=0(used);actv=0(per-port-used: 0, 0, 0, 0, 0, 0, 0, 0)>>NAT public IPs: 0(0 cfg), MAC(local):00:0C:29:F2:CB:5F

    To add NAT server IP address.

    vSZ-D57(config-protobuf)# nat public_ip add 172.17.50.23/24 vlan 100port_low 10000 port_hi 65000

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# nat cfg showgbl_enable : disablegbl_wlan_enable : disablenat_public[0] {pub_ip : 172.17.50.23/24pub_vlan : 100pub_port_low : 10000pub_port_hi : 65000}

    To enable NAT server global.By default the default setting is Disable.

    vSZ-D57(config-protobuf)# nat global enable

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# nat cfg showgbl_enable : disablegbl_wlan_enable : disable

    To enable NAT server global WLAN. By default the default setting is Disable.

    vSZ-D57(config-protobuf)# nat global wlan enable

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# nat cfg showgbl_enable : disablegbl_wlan_enable : disable

    To enable NAT server default route. This adds the global default route gateway IP address tothe Google protocol buffer file.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide49

    Privilege Moderuckus#config

  • vSZ-D57(config-protobuf)# nat global default_route add gw 172.17.65.1

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# nat cfg showgbl_enable : disablegbl_wlan_enable : disabledefault_rte_gw : 172.17.65.1

    To view NAT server configuration on Google protocol buffer.

    vSZ-D57(config-protobuf)# nat cfg show

    vSZ-D57(config-protobuf)# nat cfg showgbl_enable : disablegbl_wlan_enable : disable

    To delete NAT public IP address. It deletes the NAT public IP address, preflen and VLANidentifier from the Google protocol buffer for the data core to read the configuration.

    vSZ-D57(config-protobuf)# nat public_ip del 172.17.50.23/24 vlan 100

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    To delete NAT global default gateway IP address. It deletes this from the Google protocolbuffer.

    vSZ-D57(config-protobuf)# nat global default_route delete

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    Commands for VPN Server

    NOTE: Ensure to be in the configuration mode.

    To view VPN server summary.

    vSZ-D57(config-protobuf)# vpn summary

    VPNGRE-Free-Pool: 1022 entries, max=1024;cli_cfg_count=10vpngret_hash_entry_cnt=11, number_sites=1Gbl CALEA: site=172.17.65.31 vlan=0 vpntid=15001 l2gre=127.0.0.2UE_subnet_filter='disabled'Ingress: pkts=0 (drops=0), bytes=0Egress: pkts=14268, bytes=1398264, drops=43Actv VPNGRE: ACC NB=0, SB=0 (past 4-sec)Actv VPNGRE: CORE NB=0, SB=0 (past 4-sec)Rx unconfigured VPNGRE (pkts=0, bytes=0)Total VPNGRE: (in-hash-tbl=1)

    To view VPN site summary.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide50

    Privilege Moderuckus#config

  • vSZ-D57(config-protobuf)# vpn site summary

    UE_subnet_filter='disabled'site 0: 172.17.65.31, vlan=0, UDP=0 (site is CALEA/DC)CALEA_server=127.0.0.2Total: Servers=0, UE_subnets=0, UE_vlans=0crypto: 'enabled', psk_bits=128, iv_len=16psk: 0011223344556677 0011223344556677iv: 0011223344556677 0011223344556677Total VPN sites: 1

    To view VPN all site information.

    vSZ-D57(config-protobuf)# vpn site all

    UE_subnet_filter='disabled'site 0: 172.17.65.31, vlan=0, UDP=0 (site is CALEA/DC)CALEA_server=127.0.0.2Total: Servers=0, UE_subnets=0, UE_vlans=0crypto: 'enabled', psk_bits=128, iv_len=16psk: 0011223344556677 0011223344556677iv: 0011223344556677 0011223344556677Total VPN sites: 1

    To send the entire information of the VPN server .

    vSZ-D57(config-protobuf)# vpn all

    VPNGRE-Free-Pool: 1022 entries, max=1024; cli_cfg_count=10vpngret_hash_entry_cnt=11, number_sites=1Gbl CALEA: site=172.17.65.31 vlan=0 vpntid=15001 l2gre=127.0.0.2UE_subnet_filter='disabled'Ingress: pkts=0 (drops=0), bytes=0Egress: pkts=14310, bytes=1402380, drops=43Actv VPNGRE: ACC NB=0, SB=0 (past 4-sec)Actv VPNGRE: CORE NB=0, SB=0 (past 4-sec)Rx unconfigured VPNGRE (pkts=0, bytes=0)Total VPNGRE: shown=1 (in-hash-tbl=1)

    To get the tunnel identifier from the VPN server.

    vSZ-D57(config-protobuf)# vpn tid 15001

    RGRE_tun_id=15001; array_id=1; peer_ip=172.17.65.31 state=UP,upTime=2611UDP=0; crypto=1/chg_cnt=1, in_use=1MTU: sent=0 err=0 reply=0 mtu=0(rcv_rep_val), done=0;rcv_req_cnt=0; mtu=0(rcv_req_val)kalive: sent=1(sec ago);rcv=0 (err=0)eqc_id: nb=0, sb=0; del=0; frag_cnt=0Ingress pkts=0 (drops=0), bytes=0, idle=-1(sec)Egress pkts=333, bytes=32634;drops=0, idle=1(sec)Actv4S NB(flows=0 inprog=0); SB(flows=0 inprog=0)

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide51

    Privilege Moderuckus#config

  • EncapLen=50 crypto=1 greudp=0 opprt=0(state=1)data 1CAFF7F5 E846000C 29F2CB56 08004500data 00540000 4000402F 8B46C0A8 015CAC11data 411FB000 65580000 0000E400 00000000data 00000000 00000000 00000000 00000000data 00000000 00000000 00000000 0000

    To get the total number of VPN servers.

    vSZ-D57(config-protobuf)# vpn count 10

    VPNGRE-Free-Pool: 1022 entries, max=1024; cli_cfg_count=10vpngret_hash_entry_cnt=11, number_sites=1Gbl CALEA: site=172.17.65.31 vlan=0 vpntid=15001 l2gre=127.0.0.2UE_subnet_filter='disabled'Ingress: pkts=0 (drops=0), bytes=0Egress: pkts=14419, bytes=1413062, drops=43Actv VPNGRE: ACC NB=0, SB=0 (past 4-sec)Actv VPNGRE: CORE NB=0, SB=0 (past 4-sec)Rx unconfigured VPNGRE (pkts=0, bytes=0)

    To enable VPN user equipment IP address filter. By default the default setting is Disable. .

    vSZ-D57(config-protobuf)# vpn ue_ip_filter enable

    vSZ-D57(config-protobuf)# end // Type " end " to save or the setupwill not execute.

    vSZ-D57(config-protobuf)# vpn cfg showue_subnet_filter : 1number_sites : 1vpngre_site[0]{site ip : 172.17.65.31}

    To add VPN site IP address and server IP address. This command allows you to build two(2) vDP build tunnels. You have to set this command on both vDPs.

    In vDP A: // connect to BvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.2.1

    crypto enable keys psk 1280011223344556677 0011223344556677 keys iv 16

    0011223344556677 0011223344556677

    // connect to CvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.3.1

    site_DC yes calea_server 2.1.1.1crypto enable keys psk 128 0011223344556677

    0011223344556677keys iv 16 0011223344556677 0011223344556677

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide52

    Privilege Moderuckus#config

  • In vDP B: // connect to AvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.1.1

    server_ip 1.1.1.2 crypto enable keyspsk 128 0011223344556677 0011223344556677 keys iv 16

    0011223344556677 0011223344556677

    // connect to CvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.3.1

    site_DC yes calea_server 2.1.1.1crypto enable keys psk 128 0011223344556677

    0011223344556677keys iv 16 0011223344556677 0011223344556677

    In vDP B:// add ue_ip to vDP AvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.1.1

    ue_ip 1.1.2.20

    In vDP C: // connect to AvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.1.1

    server_ip 1.1.1.2 crypto enable keyspsk 128 0011223344556677 0011223344556677 keys iv 16

    0011223344556677 0011223344556677

    // connect to BvSZ-D57(config-protobuf)#vpn site add site_ip 1.1.1.2

    crypto enable keys psk128 0011223344556677 0011223344556677 keys i 16

    0011223344556677 0011223344556677

    vSZ-D57(config-protobuf)# end // Type " end " to save.

    To delete VPN site IP address and server IP address.

    vSZ-D57(config-protobuf)#vpn site del site_ip 1.1.1.1 // Deletes allinformation for IP address 1.1.1.1

    vSZ-D57(config-protobuf)#vpn site del site_ip 1.1.1.1 ue_ip 1.1.1.20// // Deletes user equipment IP address 1.1.1.20 in the site IPaddress 1.1.1.1. All other information is retained.

    Commands for Calea Server

    NOTE: Ensure to be in the configuration mode.

    To add one or multiple MAC addresses to Calea configuration file.

    vSZ-D57(config-protobuf)# calea add mac 11:11:11:11:11:1

    vSZ-D57(config-protobuf)# calea add mac 11:11:11:11:11:1112:12:33:23:12:12 23:23:23:23:23:23 45:45:45:45:45:45:45

    vSZ-D57(config-protobuf)# end // Type " end " to save.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide53

    Privilege Moderuckus#config

  • To save the current changes and to fetch the Calea configuration file.

    vSZ-D57(config-protobuf)# saveNotifyDC dhcps

    vSZ-D57(config-protobuf)# end // Type " end " to save.

    To view Calea configuration. .

    vSZ-D57(config-protobuf)# calea cfg show

    vSZ-D57(config-protobuf)# calea cfg shownum_mac_cnt = 1n_calea_mac = 1{calea_mac[0]{calea_mac_48 = 11:11:11:11:11:11}

    }

    To delete one or multiple MAC addressess from the Calea configuration file. .

    vSZ-D57(config-protobuf)# calea del mac 11:11:11:11:11:11

    vSZ-D57(config-protobuf)# calea del mac 11:11:11:11:11:1112:12:33:23:12:12 23:23:23:23:23:23 45:45:45:45:45:45:45

    To delete all MAC addressess from the Calea configuration file.

    vSZ-D57(config-protobuf)# calea del mac all

    ruckus#debugManages system debug options.ruckus#debug

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#debug

    ruckus(debug)#

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide54

    Privilege Moderuckus#debug

  • ruckus(debug)#endSaves 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

    Exampleruckus(debug)#end

    ruckus(debug)#exitExits the debug context.ruckus(debug)#exit

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#debug

    ruckus(debug)#exit

    ruckus(debug)#helpDisplays the help messages.ruckus(debug)#help

    Syntax Description

    This command has no syntax.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide55

    Privilege Moderuckus#debug

  • Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus(debug)#help

    ruckus(debug)#historyDisplays 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

    Exampleruckus(debug)#history

    ruckus(debug)#logoutExits from the vSZ-D CLI application.ruckus(debug)#logout

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus(debug)#logout

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide56

    Privilege Moderuckus#debug

  • ruckus(debug)#diagDiagnostic 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

    Exampleruckus>enable

    ruckus#debug

    ruckus(debug)#diag

    ruckus(debug)#remote-syslogdEnables 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

    Exampleruckus#debug

    ruckus(debug)#remote-syslogd enable

    ruckus(debug)#remote-syslogd disable

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide57

    Privilege Moderuckus#debug

  • ruckus(debug)#save-logSaves 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

    Exampleruckus#debug

    ruckus(debug)#save-log scg

    ruckus(debug)#save-log [username] [password]

    ruckus(debug)#showShows the disabled status of remote packet capture and data plane packet capture.ruckus(debug)#show

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#debug

    ruckus(debug)#show

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide58

    Privilege Moderuckus#debug

  • ruckus#disableDisables Privileged commands.ruckus#disable

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#disable

    ruckus#enableModifies the enable password.ruckus#enable

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#enable

    Old password:

    New password:

    Retype:

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide59

    Privilege Moderuckus#disable

  • ruckus#exitExits from the EXEC mode.ruckus#exit

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#exit

    ruckus#helpDisplays the help messages.ruckus#help

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#help

    ruckus#historyDisplays a list of previously run commands.ruckus#history

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide60

    Privilege Moderuckus#exit

  • Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#history

    ruckus#logoutExits from the vDP CLI application.ruckus#logout

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#logout

    ruckus#pingSends 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:

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide61

    Privilege Moderuckus#logout

  • • 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

    Exampleruckus(config)#ping

    ruckus#ping6Sends ICMP echo packets to an IPv6 address or domain name.

    ruckus# ping6[- LRUbdfnqrvVaA][-c count][-i interval][-w deadline][-p pattern][- s packetsize][-t ttl][-I interface or address][- M mtu discovery hint][- S sndbuf][-F flow label][-Q traffic class] [hop1 ...] destination

    Syntax Description

    This command has the following syntax:

    • count• interval• deadline• pattern• packetsize• ttl• interface or address• mtu discovery hint• sndbuf

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide62

    Privilege Moderuckus#ping6

  • • flow label• traffic class• destination

    Default

    This command has no default settings.

    Command Mode

    config

    Exampleruckus(config)# ping 6

    ruckus#quitEnd the CLI sessions.ruckus#quit

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    User

    Exampleruckus#quit

    ruckus#rebootReboots the VDP.ruckus#reboot

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide63

    Privilege Moderuckus#quit

  • Command Mode

    Privileged

    Exampleruckus#reboot

    ruckus#resetResets the DHCP server binding.ruckus# reset dhcp binding

    Default

    This command has no default settings.

    Command Mode

    config

    Example

    ruckus(config)# reset dhcp binding 172.19.19.55

    ruckus#restoreRestore vSZ-D configuration.ruckus#restore [username is needed if you used FTP] [password is needed if youused FTP]

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#restore

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide64

    Privilege Moderuckus#reset

  • ruckus#routeSets 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

    Exampleruckus>enable

    ruckus#route show

    ruckus#route {add | del} ROUTE

    ruckus#route dump

    where: ROUTE := []

    ruckus#set-factoryResets the vSZ-D configuration to the factory settings.ruckus(config)#set-factory

    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 3.5 Command Line Interface Reference Guide65

    Privilege Moderuckus#route

  • Exampleruckus# set-factory

    ruckus#showShows the system information.ruckus#show

    Syntax Description

    This command has the following syntax:

    • ue-nat-session Displays the system options and settings.• version : Shows the system version number and serial number.• interface: Shows configured and current network settings for management and data interfaces.

    • management-config: Shows the management interface configuration.• data-config: Shows the data interface configuration.• data-core-sep-config: Shows the data core separate interface configuration.• current-management: Shows the management interface runtime.• current-data: Shows the data interface runtime.• current-data-core-separate: Shows the data core separate interface runtime.

    • ip: Shows the IP information of the system

    • name-server: Shows the DNS server information.• data-nat: Shows the NAT server information.

    • dpm: Shows DPM related configuration.• status: Shows current network settings and connection status between the controller and

    vSZ-D.• stats: Shows the current vDP traffic statistics and basic system information.• upgrade: Shows the previous upgrade information of vSZ-D• upgrade-history: Shows the vSZ-D upgrade history• controller : Shows the controller related configuration.• running-config: Displays the DHCP/NAT configuration• dhcp : Shows DHCP binding

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide66

    Privilege Moderuckus#show

  • Example

    ruckus# show versionModel : vSZ-DvSZ-D Serial Number : 978xxxxxxxxxxxxvSZ-D Version : 3.5.0.0.808

    ruckus# show running-confignat Display NAT configurationdhcp Display DHCP configuration

    ruckus#shutdownShuts down the vSZ-D.ruckus#shutdown[ now | (minutes) ]

    Syntax Description

    This command has the following syntax.

    now : Shutdown the system immediately.

    X : shutdown the system after X minutes.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#shutdown

    ruckus#traceroutePrints 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 ] [ -zsendwait ] host [ packetlen ]

    Syntax Description

    This command has the following syntax:

    • first_ttl• gate

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide67

    Privilege Moderuckus#shutdown

  • • device• max_ttl• squeries• port• tos• flow_label• waittime• nqueries• src_address• sendwait• packetlen

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus#traceroute

    ruckus#traceroute6Prints the route that the packets take to the network host.ruckus# traceroute6[ -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 ] [ -zsendwait ] host [ packetlen ]

    Syntax Description

    This command has the following syntax:

    • first_ttl• gate• device• max_ttl• squeries• port• tos• flow_label• waittime• nqueries

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide68

    Privilege Moderuckus#traceroute6

  • • src_address• sendwait• packetlen

    Default

    This command has no default settings.

    Command Mode

    config

    Example

    ruckus# traceroute6 indus-ap

    ruckus#upgradeUpgrades the vDP firmware.ruckus#upgrade [username is needed if you used FTP] [password is neededif you used FTP]

    Syntax Description

    This command has no syntax.

    Default

    This command has no default settings.

    Command Mode

    Privileged

    Exampleruckus>enable

    ruckus#upgrade

    Virtual SmartZone Data Plane (vSZ-D) for SmartZone 3.5 Command Line Interface Reference Guide69

    Privilege Moderuckus#upgrade

    ContentsCopyright Notice and Proprietary InformationAbout This GuideDocument ConventionsTerminologyRelated DocumentationOnline Training ResourcesDocumentation Feedback

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

    Supported User and Privileged ModesUser Modeenableendexithelphistorylogoutping and ping6showtraceroute and traceroute6

    Privilege Moderuckus#backupruckus#cloneruckus#configruckus(config)#adminruckus(config)#controllerruckus(config)#dhcpruckus(config)#dhcpd_confruckus(config)#dpmruckus(config)#endruckus(config)#helpruckus(config)#historyruckus(config)#interface managementruckus(config)#interface dataruckus(config)#interface access-core-separateruckus(config)#ip name-serverruckus(config)#ip-data-natruckus(config)#logoutruckus(config)#natruckus(config)#noruckus(config)#protobuf

    ruckus#debugruckus(debug)#endruckus(debug)#exitruckus(debug)#helpruckus(debug)#historyruckus(debug)#logoutruckus(debug)#diagruckus(debug)#remote-syslogdruckus(debug)#save-logruckus(debug)#show

    ruckus#disableruckus#enableruckus#exitruckus#helpruckus#histor


Recommended