Ruckus Wireless™

ZoneFlex™ Access Point

Command Line Interface

Reference Guide

Current as of software version 9.1

Includes commands for ZoneFlex access points and wireless bridges

Part Number 800-70264-001

Published April 2011

www.ruckuswireless.com
 Contents

About This Guide

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Documentation Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

1 Understanding the ZoneFlex Access Point Command Line

Interface
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Accessing the Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Step 1: Configure the Admin PC for Direct Connection to the Access Point . . . . 5
Step 2: Connecting the Admin PC to the ZoneFlex Access Point . . . . . . . . . . . . . 6
Step 3: Start and Configure the Telnet/SSH Client . . . . . . . . . . . . . . . . . . . . . . . . . 6
Step 4: Log Into the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Using the Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Viewing Command Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

2 Debugging Commands
Debug Group Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

3 Quality of Service Commands

QoS Group Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

4 System Commands
System Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

5 Radio Commands
Radio Group Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

6 Miscellaneous Commands
Misc Group Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

i
 ACL Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Traffic Shaping Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
VLAN Group Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

Index

ii
 About This Guide

About This Guide

This Ruckus Wireless ZoneFlex Access Point Command Line Interface Reference
Guide contains the syntax and commands for configuring and managing ZoneFlex
Access Points from a command line interface.
This guide is written for service operators and system administrators who are respon-
sible for managing, configuring, and troubleshooting Ruckus Wireless devices.
Consequently, it assumes a basic working knowledge of local area networks, wireless
networking, and wireless devices.

NOTE: If a release note is shipped with your Ruckus Wireless product and the
information there differs from the information in this guide, follow the instructions in
the release note.

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:
http://support.ruckuswireless.com/

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

Table 1. Text Conventions

Convention Description Example

monospace Represents information as it [Device name]>

appears on screen

monospace bold Represents information that [Device name]> set

you enter ipaddr 10.0.0.12

default font bold Keyboard keys, software On the Start menu, click All
buttons, and field names Programs.

italics Screen or page names Click Advanced Settings.

The Advanced Settings page
appears.

1
About This Guide

Table 2. Notice Conventions

Icon Notice Type Description

Information Information that describes

important features or
instructions

Caution Information that alerts you to

potential loss of data or
potential damage to an
application, system, or device

Warning Information that alerts you to

potential personal injury

Documentation Comments
Ruckus Wireless is interested in improving its documentation and welcomes your
comments and 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)
For example:
■ Ruckus Wireless ZoneFlex Access Point Command Line Interface Reference Guide
■ Part number: 800-70264-001
■ Page 88
Please note that we can only respond to comments and questions about Ruckus
Wireless product documentation at this email address. Questions related to technical
support or sales should be directed in the first instance to your network supplier.

2
About This Guide

3
 1
Understanding the ZoneFlex
Access Point Command Line
Interface

In This Chapter
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Accessing the Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Using the Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Viewing Command Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Preface
This guide contains Command-Line Interface (CLI) commands to configure and
maintain Ruckus Wireless access points in standalone mode.

CAUTION: If you are using ZoneDirector or FlexMaster to manage your access points,
any configuration changes made through the access point CLI may conflict with
ZoneDirector or FlexMaster settings.

This guide covers the following topics:

Chapter Title Description

Chapter 1 Introduction Describes how to access the CLI,
the command organization and
how to use the help command.
Chapter 2 ACL Commands Provides an alphabetical list of
Access Control List commands.
Chapter 3 Debugging Commands Provides an alphabetical list of
Debug commands.
Chapter 4 QoS Commands Provides an alphabetical list of
Quality of Service commands.

4
 Understanding the ZoneFlex Access Point Command Line Interface
Accessing the Command Line Interface

Chapter 5 System Commands Provides an alphabetical list of

System commands.
Chapter 5 Radio Commands Provides an alphabetical list of
Radio commands.
Chapter 6 Misc Commands Provides an alphabetical list of
miscellaneous and minor CLI
commands. These commands can
be found in the miscgroup,
aclgroup, shaper and vlangroup
command groups.

Accessing the Command Line Interface

This section describes the requirements and the procedures for accessing the Zone-
Flex Access Point CLI.

Requirements
To access the ZoneFlex Access Point CLI, you will need the following:
■ A computer that you want to designate as administrative computer (“admin PC”)
■ An Ethernet cable
■ A Telnet or SSH (secure shell) client program

Step 1: Configure the Admin PC for Direct

Connection to the Access Point

NOTE: Before continuing, make sure that both the administrative computer and the
ZoneFlex Access Point are both powered on.

1. On your Windows XP, Vista or Windows 7 PC, open the Network Connections
control panel:
• On Windows XP, go to Start > Settings > Control Panel > Network
Connections.
• On Windws 7, go to Open Network and Sharing Center > Change Adapter
Settings.
2. Right-click the icon for Local Area Connection, and select Properties.
3. In the Local Area Connection Properties window:
• On Windows XP, select Internet Protocol (TCP/IP), and then click Properties.
• On Windows 7, click Internet Protocol Version 4 (TCP/IPv4), then click
Properties.

5
Understanding the ZoneFlex Access Point Command Line Interface
Accessing the Command Line Interface

4. Write down all of the currently active network settings. You will need this informa-
tion later when you restore your computer to its current network configuration.
5. Select Use the following IP address, and then configure the IP address settings
with the values below:
• IP Address: 192.168.0.22 (or any address in the 192.168.0.x range, with the
exception of 192.168.0.1, which is in use by the AP).
• Subnet Mask: 255.255.255.0.
• Default Gateway: 192.168.0.1
6. 7. Click OK to exit the Local Area Connection Properties window.

Step 2: Connecting the Admin PC to the ZoneFlex

Access Point
Connecting to the ZoneFlex Access Point
1. Connect one end of the Ethernet cable to any LAN port on the ZoneFlex Access
Point.
2. Connect the other end to a LAN port on the administrative computer.

Step 3: Start and Configure the Telnet/SSH Client

Before starting this procedure, make sure that your Telnet/SSH client is already
installed on the administrative computer.

NOTE: The following procedure uses PuTTY, a free and open source Telnet/SSH
client, for accessing the ZoneFlex Access Point CLI. If you are using a different Telnet/
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.

To start and configure the Telnet/SSH client

1. Start PuTTY. The PuTTY Configuration dialog box appears, showing the Session
screen.
2. In Connection type, click SSH.
3. In Host Name (or IP address), enter 192.168.0.1.

6
 Understanding the ZoneFlex Access Point Command Line Interface
Accessing the Command Line Interface

Figure 1. Click SSH as the connection type

4. Click Open. The PuTTY console appears and displays the login prompt.
You have completed using the Telnet/SSH client to login to the ZoneFlex Access Point.

Step 4: Log Into the CLI

5. At the login as prompt, press <Enter> once.
6. At the Please login prompt, enter super, and press <Enter>.
7. For password, enter sp-admin, and press <Enter>. The Ruckus Wireless Zone-
Flex Access Point CLI welcome message and the rkscli prompt appears.

7
Understanding the ZoneFlex Access Point Command Line Interface
Accessing the Command Line Interface

Figure 2. The PuTTY console displaying the login prompt

You are now logged into the ZoneFlex Access Point CLI. To view a list of commands
that are available at the root level, enter help or ?.

8
 Understanding the ZoneFlex Access Point Command Line Interface
Using the Help Command

Using the Help Command

The Ruckus Wireless Access Point CLI commands are divided into several command
groups. To see a list of these groups, type the help command at the rkscli: prompt.
The ? character is synonymous with help.

Example rkscli: help

Help for each command group can be shown with:
help aclgroup
help debuggroup
help helpgroup
help miscgroup
help qosgroup
help radiogroup
help shaper
help systemgroup
help vlangroup

'help <cmd>' will show help for a command or partial command

'help <foo>' will search help text as a last resort.
OK
rkscli:

Viewing Command Groups

To display commands within a specific command group, use the help <group>
command.

Example rkscli: help aclgroup

===================
ACL Commands Group:
===================
acl : get acl <wlan name> mac -- Show the MAC access-control
info of the wlan interface
acl : set acl <wlan name> mac options
-> disable, open-access policy allowing all MAC
-> allow, a white list of allowed/authorized MACs
-> deny, a black list of blocked MACs
-> add/delete <xx:xx:xx:xx:xx:xx>
-- Modify the MAC access-control info of the wlan
interface
OK
rkscli:

9
Debugging Commands
Debug Group Commands

2
Debugging Commands

In This Chapter
Debug Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Debug Group Commands

Debug commands include ping, rpmkey, support, sysinfo and traceroute. To view the
list of debug commands, type help debuggroup.

Example rkscli: help debuggroup

=========================
Debugging Commands Group:
=========================
ping : ping host -- Conduct a ping test
rpmkey : get rpmkey <key> -- Display value of a RPM key
rpmkey : set rpmkey key [value] -- Modify value of a RPM key
: Omit the value to delete or set to empty string
: (you will be prompted to choose)
restore allrpmkeys : restore allrpmkeys filename -- Restore all
defined keys with values from a file
save allrpmkeys : save allrpmkeys filename -- Save all defined keys
& their values in a file
show allrpmkeys : show allrpmkeys -- Show all defined keys & their
values
support : support <show | auto | [filename]> -- Generate support
information
sysinfo : sysinfo -- Get CPU / Memory information
traceroute : traceroute host -- Conduct a traceroute test
OK

10
 Debugging Commands
Debug Group Commands

ping
Use the ping command to attempt to ping another station.

Syntax ping {host}

Example rkscli: ping 192.168.0.22

PING 192.168.0.22 (192.168.0.22): 56 data bytes
64 bytes from 192.168.0.22: icmp_seq=0 ttl=128 time=15.9 ms
64 bytes from 192.168.0.22: icmp_seq=1 ttl=128 time=0.6 ms
64 bytes from 192.168.0.22: icmp_seq=2 ttl=128 time=0.6 ms
64 bytes from 192.168.0.22: icmp_seq=3 ttl=128 time=0.6 ms
64 bytes from 192.168.0.22: icmp_seq=4 ttl=128 time=0.5 ms

--- 192.168.0.22 ping statistics ---

5 packets transmitted, 5 packets received, 0% packet loss
round-trip min/avg/max = 0.5/3.6/15.9 ms
OK
rkscli:

rpmkey
Show or change RPM key values.

Syntax get rpmkey <key>

set rpmkey key [value]
restore allrpmkeys [filename]
save allrpmkeys [filename]

Description
get rpmkey [key] Display the value of an RPM key
set rpmkey key [value] Modify the value of an RPM key
restore allrpmkeys Restore allrpmkeys -- Restore all defined keys with values
[filename] from a file
save allrpmkeys Save all defined keys and their values to a file
[filename]
show allrpmkeys Show all defined keys and their values

Example rkscli: get rpmkey wlans/wlan9/wlan-wds

wlans/wlan9/wlan-wds = 1
OK

11
Debugging Commands
Debug Group Commands

support
Generate or show support log information.

Syntax support <show|auto|[filename]>

Example rkscli: support auto

Support Info will be gathered every 1800 seconds
OK
rkscli:

sysinfo
Get CPU and memory utilization information.

Syntax sysinfo

Example rkscli: sysinfo

CPU : 6.00%
Memory : 38136 KB (free), 61920 KB (total)
OK
rkscli:

traceroute
Conduct a traceroute test.

Syntax traceroute host

Example rkscli: traceroute 192.168.0.22

traceroute to 192.168.0.22 (192.168.0.22), 30 hops max, 40 byte
packets
1 * * *
2 * * *
3 * * *
4 * * *
rkscli:

12
 Quality of Service Commands
QoS Group Commands

3
Quality of Service Commands

In This Chapter
QoS Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

QoS Group Commands

This chapter describes commands that you can use to view and configure the Quality
of Service (QoS) settings of the device.

get qos
Use get qos to display the state and attributes of Ruckus SmartQoS processing on
a global or per-interface basis.

Syntax get qos

get qos <if-name>

Example 1 rkscli: get qos

Tx Failure Threshold: 50 Dead Station Count: 0

IGMP/MLD Query Interval: 125

IGMP/MLD aging mechanism: Enabled
IGMP General Query V2/V3: Disabled/Enabled
MLD General Query V1/V2: Disabled/Enabled

TOS Classification: Voice=0xE0,0xC0,0xB8, Video=0xA0,0x80,

Data=0x0, Background=0x0
TOS marking: VoIP=0x0, Video=0xA0, Data=0x0,
Background=0x0

13
Quality of Service Commands
QoS Group Commands

Dot1p Classification: Voice=none, Video=none, Data=none,

Background=none
Dot1p marking: VoIP=0, Video=0, Data=0, Background=0

Tunnel TOS Marking: 0xA0

Heuristic Classifier: VoIP Video Data Background

Octet Count During Classify: 600 50000 0 0
Octet Count Between Classify: 10000 500000 0 0
Min/Max Avg Packet Length: 70/400 1000/1518 0/0 0/0
Min/Max Avg Inter Packet Gap: 15/275 0/65 0/0 0/0
OK
rkscli:

Example 2 rkscli: get qos wlan0

Ruckus Wireless SmartMedia QOS info for wlan0 interface

QOS Configuration options:

Classification: Enabled
UDP Heuristic Classification: Enabled
TOS Classification: Enabled
Dot1p Classification: Enabled
VID Voice Classification:
VID Video Classification:
VID BE Classification:
VID BK Classification:
Dot1p Classification VIDs:
Dot1p Marking VIDs:
Directed Multicast: Enabled
IGMP Snooping Mode: Enabled
MLD Snooping Mode: Disabled

General Mcast->U Cloned Filters TOS-Mark

Stats 0 0 0/0/0 0

L2 Mcast Packets Unicast Unk-Drop Known-Mcast

UDP Data 2463 0 2463 1896

Heuristics Voice Video

UDP Packets 0 0

14
 Quality of Service Commands
QoS Group Commands

IGMP/MLD Clone1/2/3
Errors 0/0/0

No Filters are currently defined on wlan0 interface

OK
rkscli:

set qos
Use set qos to configure QoS settings for a specified interface. Refer to Table 1 for
a list of QoS arguments.

Table 1. Setting QoS parameters

Command Description
qos aging Sets the state of the IGMP/MLD aging mechanism

qos classification Sets the QoS classification for the specified interface to
enabled or disabled

qos directed multicast Sets the state of egress packet processing for the specified
interface

qos dot1p Enables Dot1p-based processing on the specified interface

Sets Dot1p values for each type of traffic

qos heuristics Sets parameters for Heuristic-based classification

qos heuristics udp Enables UDP Heuristics-based classification on the specified

interface

qos igmp Sets the state of IGMP Snooping for the specified interface

qos igmp_query Sets IGMP General Query version for IGMP General Query
Mechanism

qos ip Sets L3 IP Filters on the specified interface.

qos known_multicast Sets values for DOT1P-based classification

qos mac Sets L2 MAC Filters on the specified interface

qos mld Sets the state of MLD Snooping for the specified interface

qos mld_query Sets MLD General Query version for MLD General Query
Mechanism

qos port Sets L4 Port Filters on the specified interface

qos QueryInterval Sets the periodical interval for issuing IGMP/MLD General
Query messages

qos tos Sets values for TOS-based classification

qos txFailThreshold Sets the periodical interval for issuing IGMP/MLD General
Query messages

15
Quality of Service Commands
QoS Group Commands

qos aging
Use set qos aging to set the state of the IGMP/MLD aging mechanism.

Syntax set qos aging [enable|disable]

Example rkscli: set qos wlan0 classification enable

QOS processing is Enabled on interface wlan0
OK

qos classification
Use set qos classification to enable QoS processing on a specified interface.

Syntax set qos <if-name> classification [enable|disable]

Example rkscli: set qos wlan0 classification enable

QOS processing is Enabled on interface wlan0
OK

qos directed multicast

Use set qos directed multicast to configure the state of egress packet
processing for a specified interface.

Syntax set qos <ifname> directed multicast [enable|disable]

Example rkscli: set qos wlan0 directed multicast enable

Directed Multicast ingress packet processing is Enabled on interface
wlan0
OK

qos dot1p
Use set qos dot1p to configure values for dot1p-based classification (classify) or
to set dot1p values for each type of traffic (mark).

Options classify
mark

16
 Quality of Service Commands
QoS Group Commands

Syntax ■ set qos <network name|ifname> dot1p classify [enable|disable]

■ set qos <network name|ifname> dot1p [classify|mark]
[<vid>|<vid1-vid2>|all] [enable|disable]

Example rkscli: set qos wlan0 dot1p classify enable

Dot1p-based classification is Enabled on interface wlan0
OK

qos heuristics
Use set qos heuristics to configure heuristics-based classification.

Options classify <octet-count>

noclassify <octet-count>
ipg/pktlen <minimum> <maximum>
udp

Syntax set qos heuristics [voice|video] delay <octet-count>

set qos heuristics [voice|video] delay <octet-count> [ipg||pktlen]
<min> <max>
set qos heuristics [voice|video] [ipg|pktlen] <minimum>
<maximum>
set qos <network name|ifname> heuristics udp [enable|disable]

Example rkscli: set qos heuristics enable

Heuristic-based Classification is Enabled
OK
rkscli: set qos heuristics video ipg 3 6
Heuristic average IPG for Video is 3/6 ms
OK

qos heuristics udp

Use set qos heuristics udp to enable UDP Heuristics-based classification on
the specified interface.

Syntax set qos <ifname> heuristics udp [enable|disable]

Example rkscli: set qos wlan0 heuristics udp enable

UDP Heuristic-based classification is Enabled on interface wlan0

17
Quality of Service Commands
QoS Group Commands

OK

qos igmp
Use set qos igmp to configure the state of IGMP Snooping for a specified interface.

Syntax set qos {<net-name>||<if-name>} igmp [enable|disable]

Example rkscli: set qos wlan0 igmp enable

IGMP Snooping is Enabled on interface wlan0
OK

qos igmp_query
Use set qos igmp_query to set IGMP General Query version for IGMP General
Query Mechanism

Syntax set qos igmp_query [v2|v3] [enable|disable]

Example rkscli: set qos igmp_query v2 enable

IGMP Query version 2 is Enabled
OK

qos ip
Use set qos ip to set L3 IP Filters on the specified interface.

Syntax set qos <network name|ifname> ip [add|delete] [ucast|bcast]

[dest|src] <xxx.xxx.xxx.xxx>/<fff.fff.fff.fff>
[drop|[tos|priority] [voice|video]] [<comment-text>]

Example rkscli: set qos wlan0 ip add ucast dest 192.168.11.111 drop voice
Unicast IP(UDP/TCP) Filter is added on interface wlan0
OK

qos known_multicast
Use set qos known_multicast to enable the forwarding of well-known multicast
traffic, such as UPnP, for a specified interface. Use unknown_mcast to enable the
dropping of unknown multicast traffic for a specified interface.

Syntax set qos <net-name>|<if-name> known_multicast [enable|disable]

18
 Quality of Service Commands
QoS Group Commands

set qos <net-name>|<if-name> unknown_mcast [enable|disable]

Example rkscli: set qos wlan0 known_multicast enable

Well-known Multicast Forwarding is Enabled on interface wlan0
OK

qos mac
Use set qos mac to set L2 MAC Filters on the specified interface.

Syntax set qos <network name|ifname> mac [add|delete]

[ucast|bcast|nonip|all] [dest|src] <xx:xx:xx:xx:xx:xx>
[drop|[tos|priority] [voice|video]] [<comment-text>]

Example rkscli: set qos wlan0 mac add ucast dest 01:ab:02:bc:03:cd drop voice
Unicast IP(UDP/TCP) Filter is added on interface wlan0
OK

qos mld
Use set qos mld to set the state of MLD Snooping for the specified interface.

Syntax set qos <network name|ifname> mld [v1|v2] [enable|disable]

Example rkscli: set qos wlan0 mld enable

MLD Snooping is Enabled on interface wlan0
OK

qos mld_query
Use set qos mld_query to set the MLD General Query version for the MLD General
Query Mechanism.

Syntax set qos mld_query [v1|v2] [enable|disable]

Example rkscli: set qos mld_query v1 enable

MLD Query Version 1 is Enabled
OK

qos port
Use set qos port to set L4 Port Filters on the specified interface.

19
Quality of Service Commands
QoS Group Commands

Syntax set qos <network name|ifname> port [add|delete] [ucast|bcast]

[tcp|udp] [dest|src] <xxxx|xxxx-yyyy> [drop|[tos|priority]
[voice|video]] [<comment-text>]

Example rkscli: set qos wlan0 port add ucast tcp dest 25 drop
Unicast IP(UDP/TCP) Filter is added on interface wlan0
OK

qos QueryInterval
Use set qos QueryInterval to set the periodical interval for issuing IGMP/MLD
General Query messages. Setting <new interval> to zero disables the periodic
IGMP/MLD General Query mechanism.

Syntax set qos QueryInterval <new interval>

Example rkscli: set qos QueryInterval 10

Query Interval is 10 seconds
OK

qos tos
Use set qos tos to configure values for TOS-based classification.

Options classify
mark

Syntax set qos tos classify [voice|video] [<comma-separated-tos-

values>|none]
set qos tos mark [voice|video] <tos-value>
■ set qos <net-name>|<if-name> tos classify [enable|disable]
■ set qos <net-name>|<if-name> tos mark [enable|disable]
■ set qos tos mark [voice|video] <TOS value>

Example rkscli: set qos tos mark voice 2

TOS marking value for Voice is 0x2
OK

20
 Quality of Service Commands
QoS Group Commands

qos txFailThreshold
Use set qos txFailThreshold to configure the number of consecutive TX failures
before STA is considered dead.

Syntax set qos txFailThreshold <new-threshold>

Example rkscli: set qos txFailThreshold 50

Tx Failure Threshold is 50
OK

21
Quality of Service Commands
QoS Group Commands

22
 System Commands
System Group Commands

4
System Commands

In This Chapter
System Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

System Group Commands

This chapter describes commands that you can use to configure the device’s system
and network settings, including password, IP addressing and network connection
settings, among others. System commands also allow you to retrieve the device’s
system information and to reset it to factory defaults.

aerosct
Use aerosct to turn On/Off AeroScout support and configure settings. Only appli-
cable to 11g radio.

Syntax get aerosct -- Display AeroScout support settings

set aerosct [enable|disable] -- Configure AeroScout support
settings

ap-mode
Use get ap-mode to display AP operation mode.

Example rkscli: get ap-mode

AP is in ZoneDirector-Managed mode
OK

boarddata
Use get boarddata to display hardware version and system board information.

23
System Commands
System Group Commands

Syntax get boarddata

Example rkscli: get boarddata

name: zf7363
magic: 35333131
cksum: 166f
rev: 5.4
Serial#: 160904000153
Customer ID: 4bss
Model: zf7363
V54 Board Type: GD11
V54 Board Class: AP71
Random#: 3230 3932 3334 3738 3231 3334 0000 0000
symimgs: yes
ethport: 3
V54 MAC Address Pool: yes, size 16, base 00:24:82:3F:14:60
major: 8
minor: 1
pciId: 0000
wlan0: yes 00:24:82:3F:14:68
wlan1: yes 00:24:82:3F:14:6C
eth0: yes 00:24:82:3F:14:63
eth1: yes 00:24:82:3F:14:64
eth2: - 00:24:82:3F:14:65
eth3: - 00:24:82:3F:14:66
eth4: - 00:24:82:3F:14:67
eth5: - 00:13:92:FF:FF:FF
uart0: yes
sysled: yes, gpio 0
sysled2: yes, gpio 0
sysled3: yes, gpio 0
sysled4: yes, gpio 0
Fixed Ctry Code: no
Antenna Info: yes, value 0x00002726
Local Bus: enabled
factory: yes, gpio 8
serclk: external
cpufreq: configured 4294967295 Hz
sysfreq: configured 4294967295 Hz
memcap: disabled
watchdg: enabled
OK

24
 System Commands
System Group Commands

device-gps
Use device-gps to set or get GPS coordinates for the device.

Syntax get device-gps

set device-gps <latitude>,<longitude>

device-location
Use device-location to set or get a location for the device.

Syntax get device-location

set device-location <string>

Description Enter a location for the device, using a single string of alphanumeric characters.

Example rkscli: set device-location somewhere

OK
rkscli: get device-location
Device location : ‘somewhere’
OK
rkscli:

device-name
Use device-name to set or get a name for the device.

Syntax get device-name

set device-name <string>

Description Enter a unique name to identify the specific device.

Example rkscli: get device-name

device name: ‘RuckusAP’
OK
rkscli: set device-name Hotspot-AP1
OK
rkscli: get device-name
device name: ‘Hotspot-AP1’
OK
rkscli:

25
System Commands
System Group Commands

dhcpc
Use dhcpc to get or set the Vendor Class identifier (option 60) for DHCP requests.

Syntax get dhcpc -- Returns the value set for DHCP option 60 for the device
set dhcpc option60 <identifier> -- Enter a new option 60 vendor class
identifier

Example rkscli: get dhcpc

DHCP Option 60 is Ruckus CPE
OK

dhcps
Use dhcps to display or configure DHCP server status.

Syntax get dhcps

set dhcps [disable|enable][iprange] <start_ip> <end_ip>

director
Use get director to show ZoneDirector information. Use set director to set
ZoneDirector options. Reboot is required for changes to take effect.

Syntax get director

set director [options]

Options ■ ip del -- Delete ZoneDirector IP address from this AP

■ ip <primary-ip> <secondary ip> -- Set ZoneDirector primary/secondary
director IP
■ zdcode [del] -- Delete ZoneDirector code from this AP
■ zdcode [n] -- Set ZoneDirector option 43 subcode (valid entries are 3-243)

Example rkscli: get director

------ ZoneDirector Info ------
Primary Controller : 192.168.0.1
Secondary Controller : 192.168.0.2
DHCP Opt43 Code : 243
AP is in Stand-alone mode.
OK
rkscli:

26
 System Commands
System Group Commands

Example rkscli: set director ip 192.168.0.1 192.168.0.2

** Please reboot for this change to take effect
OK
rkscli: set director zdcode 243
** Please reboot for this change to take effect
OK

dns
Use dns to set or get Domain Names Service (DNS) information.

Syntax set dns <ip-addr1> [<ip-addr2>]

get dns

Description ■ set dns <ip-addr1> [<ip-addr2>] -- Configures static DNS IP address

entries. If the primary IP is unreachable, the AP will fail over to the second IP.
■ get dns -- Displays DNS entries.

Example rkscli: set dns 10.1.1.1 10.1.1.2

OK
rkscli: get dns
DNS servers currently being used
DNS 1 ipaddress: 10.1.1.1
DNS 2 ipaddress: 10.1.1.2
OK

eth
Use get eth to display the Ethernet physical link status.
An interface eth0 (usually associated with LAN) may be tied to more than one physical
Ethernet port. In this situation, this command does not elaborate on such details and
will show “Up” status as long as one physical port is up.

Syntax get eth [<ifname>|<port num>] -- Display Physical Ethernet Link State of the
interface name or the port number
set eth [<ifname>|<port num>] [enable|disable] -- Configure Ethernet
State of the interface name or the port number

Example rkscli: get eth

27
System Commands
System Group Commands

Port Interface Logical Link Physical Link Label

----------------------------------------------------------
2 eth2 Up Up 100Mbps full 10/100/1000 PoE
1 eth1 Down Down 10/100
0 eth0 Down Down 10/100
OK

NOTE:: As a comparison, see “wlanlist” on page 71.

eth-mon
Use eth-mon to get or set the Ethernet monitor period.

Syntax get eth-mon

set eth-mon <period>

factory
Use set factory to return all configuration settings to their factory defaults.

Syntax set factory

Example rkscli: set factory

Factory defaults will take effect after reboot
OK
rkscli: reboot
Rebooting... please wait.

fw
Use fw to configure or display firmware update parameters. By default, the initial
firmware check occurs five minutes after reboot. If booting up from a backup image,
this initial check is performed immediately.
The firmware server is checked on a 12-hour (720 minutes) interval for new updates.
This check is reduced to 30 minutes if previous attempt to download firmware was
unsuccessful.
If firmware is automatically upgraded, the AP only reboots if the Internet network
activity falls below 1 or 2Mbps.

Syntax fw auto [enable|disable]

fw check [main|bkup]

28
 System Commands
System Group Commands

fw show [main|bkup]
fw update [main|bkup] [<host>]
fw force-update [custom] [<host>]
fw set <parameter> <value>

Description ■ fw auto [enable|disable]--Enables or disables automatic firmware

upgrades. The default is enable. The AP checks the control file periodically for
the IP image server information. If the image on the server is different than the
one currently loaded on the AP, the new firmware will be downloaded and installed
automatically (without user intervention). The auto feature automatically reboots
the AP after a successful download.
■ fw check [main | bkup]--Verifies the validity of the image currently in flash
memory. If main fails 5 consecutive reboots (possible file corruption), the backup
(bkup) image will be loaded.
■ fw set <parameter> <value>--Sets firmware parameters, where <param-
eter> <value> can be any of the following. All time intervals are in units of
minutes:
■ control <file-name>--The control file name for the image. Use this command
to change the default file name of the image.
■ proto [tftp|ftp|http]--Protocol type to use for firmware downloads. The
default is ftp.
■ port <port>, ** 0 for auto
■ host <ip-addr>--The IP address of the host serving the image. Use this
command to change the default server IP address.
■ user <myname>--Changes the user name for FTP.
■ password <mypass>--Changes the password for FTP.
■ firstcheck <min>|interval <min>|badfile_retry <min>--The
defaults for the <min> argument are 5, 720, and 30 respectively. On initial bootup,
the AP finds an image once then performs a firstcheck 5 minutes later. If a
normal valid file is detected, the AP checks again every 720 minute interval. If
the image is not valid, the AP performs a badfile_retry every 30 minutes.
■ reboot <hour> [am|pm]--Set the time of day to reboot. Reboot 0 sets to ANY.
■ fw show [main|bkup]--Displays header information for the main or backup
image.
■ fw update [main|bkup] [<host-ip>]--Forces an immediate firmware
update attempt. If the image is the same, no update will occur. This command
enables you to manually upgrade the firmware while auto enable runs in the
background. The auto feature automatically reboots the AP after a successful
download whereas fw update does not. A manual reboot is required.

29
System Commands
System Group Commands

Example 1 By default, the AP uses Ruckus’ fwupdate1.ruckuswireless.com as the default image

server.
rkscli: fw show
---------------------------------------
Auto F/W upgrade enabled, running on MAIN, reboot_cnt=0
Next check in -1 seconds
FW Check intervals (first,normal,badfile) = 5, 720, 30
FW control file = fwcntrl_vf2825.rcks
Control File Server = 204.2.106.105
Protocol = ftp User = "vf2825" Passwd = "password400"
Boot Flags: M. ..
-----------------------------------------
OK

Example 2 rkscli: fw show main

<Control Info>
ipaddr: 0.0.0.0
file: zf7363/9.1.1.0.33/rcks_fw.bl7.main
size: 5607424
MD5 : 2316EB8920AF12236AD740D712B80437
type: 0
local_file
<Image1 FW header>
Magic: RCKS
next_image: d0000
invalid: 0
hdr_len: 160
compression: l7
load_address: 0x80080000
entry_point: 0x802C1000
timestamp: Thu Apr 7 02:50:41 2011
binl7_len: 5607264
hdr_version: 3
hdr_cksum: 0xF9B1
version: 9.1.1.0.33 ( 9.1.1.0.33 )
MD5: 2316EB8920AF12236AD740D712B80437
product: zf7942 (0)
architecture: 1
chipset: 0
board_type: 9
board_class: 3
customer:

30
 System Commands
System Group Commands

OK

Example 3 rkscli: fw check main

Main FW check ...
MD5 = AAB25C1989C14D0F5A9EF014FE749CE4
OK
rkscli: fw check bkup
Bkup FW check ...
MD5 = 24257B053A3D46B25D4EE16D5C5335AF
OK

Example 4 rkscli: fw set control fwcntrl_vf2825.rcks

OK
rkscli: fw set host 11.1.1.1
OK
rkscli: fw show
Auto F/W upgrade enabled, running on MAIN, reboot_cnt=0
Next check in -1 seconds
FW Check intervals (first,normal,badfile) = 5, 2, 30
FW control file = fwcntrl_vf2825.rcks
Control File Server = 11.1.1.1
...

Example 5 rkscli: fw update main 192.168.0.10

_erase_flash: offset=0x0 count=49
Erase Total 49 Units
Performing Flash Erase of length 65536 at offset 0x300000 done
.................................................................
.................................................................
.................................................................
.................................................................
.................................................................
................................................................N
ew
Firmware rcks_fw.main written to Flash
**fw 192.168.0.10: Completed
OK

home_login, home_password
Use these home commands to set the current home user’s login ID and password for
the AP’s web UI only.

31
System Commands
System Group Commands

In contrast, the administrator’s login information is set using “login” on page 34 and
“password” on page 37.

Syntax set home_login <name>

set home_password <password>

Example rkscli: set home_login frank

OK
rkscli: set home_password frank-pass
Password set
OK

http
Use this command to get/set the HTTP web access service. If you disable this service,
the web user interface will be inaccessible via HTTP.

Syntax get http

set http [enable|disable]
The default is http disable.

Example rkscli: get http

HTTP access is disabled
OK
rkscli: set http enable
OK

https
Use this command to get/set the HTTPS Web access service. If you disable this service,
the web user interface will be inaccessible via HTTPS.

Syntax get https

set https [enable|disable]
The default is https enable.

Example rkscli: get https

HTTPS access is disabled
OK
rkscli: set https enable
OK

32
 System Commands
System Group Commands

internal_heater
Use this command to enable/disable the internal heater. If no internal heater is
included in the device, this option will have no impact. Default is disabled.

Syntax get internal_heater

set internal_heater [enable|disable]

Example rkscli: get internal_heater

Internal Heater status: Disabled
OK
rkscli: set internal_hater enable
Internal Heater status: Enabled
OK
rkscli:

ipaddr
Use ipaddr to get or set default IP gateway information used for LAN, WAN, video,
and management communication. Different traffic types can be segregated
depending on a service provider’s preferences.
Only a gateway address for a WAN network is used by the system.

Syntax set ipaddr [lan|wan|video|mgmt] <ipaddr> <netmask> <gw-ipaddr>

get ipaddr [lan|wan|video|mgmt]

NOTE:: Depending on the type of profile loaded on the AP, these interface types
(lan|wan|video|mgmt) might not be available on your system.

Example 1 rkscli: get ipaddr lan

lan ip address configuration type: static, rc = 0
lan ip address: 192.168.1.1, netmask 255.255.255.0, gateway
192.168.0.1
rkscli: get ipaddr wan
wan ip address configuration type: dynamic, rc = 0
wan ip address: 192.168.0.1, netmask 255.255.255.0, gateway
192.168.0.1

Example 2 rkscli: get ipaddr video

video ip address configuration type: dynamic, rc = 0

33
System Commands
System Group Commands

video ip address: 192.168.0.1, netmask 255.255.255.0, gateway

192.168.2.1

rkscli: get ipaddr mgmt

mgmt ip address configuration type: static, rc = 0
mgmt ip address: 192.168.7.2, netmask 255.255.255.0, gateway
192.168.2.1

login
Use login to set or get the current administrative login name for the AP.

Syntax set login <name>

get login
The default administrator login name is super.

Example rkscli: get login

Login Name: super
OK
rkscli: set login joe
OK

mgmt-vlan
Use mgmt-vlan to set or get management VLAN information.

Syntax get mgmt-vlan -- Display managemeng VLAN info

set mgmt-vlan [options] -- set management VLAN info

Options [disable]
<vlan id>
ip <ipaddr> <netmask> <gateway>

model-display
Use model-display to set or get the AP model name as displayed in the Web UI.
Enclose text in quotation marks to allow multiple words to be displayed.

Syntax get model-display

set model-display <UI string>

Example rkscli: get model-display

34
 System Commands
System Group Commands

model-display : Ruckus 7363 Multimedia Hotzone Wireless AP

OK
rkscli: set model-display "Ruckus 7363 Multimedia Hotzone Wireless
AP"
OK

nat
Use nat to get or set NAT configuration settings.

Syntax get nat

set nat [wan|video|mgmt] [enable|disable]

netstats
Use get netstats to display network statistics information. Depending on the
profile, some of the interfaces listed below may not exist on your AP. Use set
netstats clear to clear the network statistics (all or a specific interface).

Syntax get netstats [<interface name>|all|speed]

set netstats [<interface name>|all] clear

Example rkscli: get netstats wifi1

<--- Receive Statistics --->

Interface bytes packets errors drop FIFO Frame
Mcast ZIP
wifi1 537389438 448352 0 0 0 51270 0 0

<--- Transmit Statistics --->

Interface bytes packets errors drop FIFO Collide
Carrier ZIP
wifi1 67206892 343116 10 0 0 0 0 0

Backlog Device
Pkts Q'd Dropped TimeSqueeze
0027a1b2 00000000 0000002f
OK

ntp
Use ntp to get or set Network Time Protocol information.

35
System Commands
System Group Commands

Syntax get ntp -- Display network time service info

set ntp [server|update] -- Modify the network time service info
• server name/IP: set default NTP server
• update: synchronize time now

nwstate
Use get nwstate to display network status for specified network types.
Network status reflects network connectivity. For example, if an interface is waiting
for DHCP network address assignment, then the network status will be considered
down.

Syntax get nwstate [wan|lan|video|mgmt]

Example rkscli: get nwstate lan

Network 'lan' is up
OK
rkscli: get nwstate wan
Network 'wan' is down
OK
rkscli: get nwstate video
Network 'video' does not exist!
OK
rkscli: get nwstate mgmt
Network 'mgmt' does not exist!
OK

NOTE:: Depending on the type of profile loaded on the AP, some interface types
(lan|wan|video|mgmt) might not be available on your system.

oem
Use get oem to display OEM information.

Example rkscli: get oem

OEM company name : Ruckus Wireless
OEM company short name : Ruckus
OK

36
 System Commands
System Group Commands

orientation
Orientation sensors are available on select ZoneFlex products only.
■ get orientation -- Show the orientation sensor info
■ set orientation t, [30..86400] seconds -- Set the orientation sensor
info

password
Use set password to configure a new administrative login password for the AP.
There is no explicit password recovery procedure. If you are locked out of the AP, press
and hold the reset button on the back of the unit for 5 seconds to reset factory defaults.

Syntax set password <new-pass>

■ The default administrator password is sp-admin.

Example rkscli: set password

Current password:
New password:
Confirm:
Password set
OK

poe_out
Enable or disable the PoE Out port. Command available on select ZoneFlex products
only.

Syntax set poe_out [enable|disable] -- Enable/Disable PoE OUT port

get poe_out -- Display PoE OUT port status

portfwd
Use portfwd to display or configure port forwarding rules.

Syntax get portfwd

set portfwd <rulename> [options]

Options <startport> <endport>

[tcp|udp|both]
<dest ip> <dest port>

37
System Commands
System Group Commands

[enable|disable|delete]

reboot
Use reboot to restart the AP.

Syntax reboot

Example rkscli: reboot

Rebooting... please wait.

remote-mgmt
Use remote-mgmt to get or set remote management configuration options. See snmp
and tr069 for more information on remote management options.

Syntax get remote-mgmt

set remote-mgmt [off|auto|tr069|snmp]

Example rkscli: get remote-mgmt

Remote Management: AUTO
TR069: enabled
SNMP: enabled
OK

route
Use get route to display the static or default route, or set route to define the
static or default route through the network. <target> can be a host IP or a subnet IP.

Syntax get route [wan|lan|video|mgmt|default]

set route [wan|lan|video|mgmt]
add <target> <netmask> <gateway>
del <target> <netmask> <gateway>

snmp
Use snmp to set or get Simple Network Management Protocol (SNMP) version,
community strings and SNMP trap server options.
SNMPv2c and SNMPv3 are supported as of software version 9.0.

Syntax get snmp [username|community]

38
 System Commands
System Group Commands

set snmp [options]

set snmpv3 [options]

Options version <value> -- SNMP version (v2c, v3, both)

system contact <value> -- SNMP V2c system contact
system location <value> -- SNMP V2c system location
community ro <name> -- read-only community name
community rw <name> -- read-write community name
trap [enable|disable] -- SNMP V2c trap enable flag
trap-svr <ipaddr> -- SNMP V2c trap server ipaddr
manager <ipaddr> -- SNMP V2c trap server ipaddr, equal to 'trap-svr'
support-kt [enable|disable] -- SNMP V2c support for custom KT

SNMPv3 Options ro username <name> -- SNMP v3 ro username

ro auth <type> -- SNMP v3 auth type (MD5/SHA)
ro auth-key <key> -- SNMP v3 auth key
ro privacy <type> -- SNMP v3 privacy type (DES/AES/NONE)
ro privacy-key <key> -- SNMP v3 privacy key
rw username <name> -- SNMP v3 ro username
rw auth <type> -- SNMP v3 auth type (MD5/SHA)
rw auth-key <key> -- SNMP v3 auth key
rw privacy <type> -- SNMP v3 privacy type (DES/AES)
rw privacy-key <key> -- SNMP v3 privacy key
trap [enable|disable] -- SNMP V3 trap enable flag
trap username <name> -- SNMP v3 trap username
trap auth <type> -- SNMP v3 trap auth type (MD5/SHA)
trap auth-key <key> -- SNMP v3 trap auth key
trap privacy <type> -- SNMP v3 trap privacy type (DES/AES/NONE)
trap privacy-key <key> -- SNMP v3 trap privacy key
trap-svr <ipaddr> -- SNMP V3 trap server ipaddr

Example rkscli: set snmp community ro newcommname

OK
rkscli: get snmp community
SNMP ro community=newcommname

39
System Commands
System Group Commands

SNMP rw community=private
OK

snmp-acl
Use snmp-acl to set or get SNMP Access Control List information.

Syntax get snmp-acl -- Display SNMP ACL info

set snmp-acl [enable|disable] [add|del] <ipaddr>|clear

Example rkscli: set snmp-acl enable

OK
rkscli: set snmp-acl add 192.168.0.22
OK
rkscli: get snmp-acl
Allow only these IP to access SNMP
SNMP ACL list
1: 192.168.0.22
OK
rkscli:

ssh
Use set ssh to enable or disable the Secure Shell (SSH) protocol. Use get ssh to
display SSH information. Default is enabled.

Syntax set ssh [enable|disable]

get ssh

Example rkscli: get ssh

get ssh: disabled
OK
rkscli: set ssh enabled
OK

syslog
Use syslog to set or get syslog settings.

Syntax get syslog [info|log|status]

set syslog [enable|disable]
set syslog ipv4 <ipaddr>

40
 System Commands
System Group Commands

set syslog port <service-port>

set syslog level [local|network] level (0..7)
-----------------------------------------------
** 0(emergency), 1(alert), 2(critical) 3(error)
** 4(warning), 5(notice), 6(info), 7(debug)

Example rkscli: get syslog status

Syslog is enabled
Syslog Info:
Server IP : <not specified>
Server Port : 514
Network Log Level : 3
Local Log Level : 7
Busybox syslog daemon is running [147]
OK
rkscli: set syslog ipv4 10.1.1.1
arg3 10.1.1.1
OK
rkscli: get syslog info
Syslog Info:
Server IP : 10.1.1.1
Server Port : 514
Message Ident: <not specified>
OK

telnet
Use set telnet to enable or disable Telnet access. Use get telnet to display
Telnet status information. Default is disabled. See ssh for SSH access commands.

Syntax set telnet [enable|disable]

get telnet

Example rkscli: set telnet enable

OK
rkscli: get telnet
Telnet Service is enabled
OK

41
System Commands
System Group Commands

thermo
Use thermo to get or set temperature sensor information. set thermo sets the
interval at which temperature readings are acquired; get thermo returns a summary
of recent temperature readings. Thermo sensors are available on select outdoor
ZoneFlex products only.

Syntax get thermo -- Show the temperature sensor info

set thermo -- set thermo t, [30..7200] seconds -- Set the temperature
sensor info

Example rkscli: get thermo

Frequency: once every 30 seconds

Just In ... : 34 (Celcius) 93 (Fahrenheit) Sat Feb 21 11:27:50 2009
Lifetime Max: 50 (Celcius) 122 (Fahrenheit) Sun May 12 07:51:00 2009
Lifetime Min: 0 (Celcius) 32 (Fahrenheit) Sun Jan 1 00:00:00 2000

Recent Temperature Readings:

0 : 34 (Celcius) 93 (Fahrenheit) Sun Feb 21 11:25:00 2009
1 : 34 (Celcius) 93 (Fahrenheit) Sun Feb 21 11:25:00 2009
2 : 34 (Celcius) 93 (Fahrenheit) Sun Feb 21 11:25:00 2009
3 : 34 (Celcius) 93 (Fahrenheit) Sun Feb 21 11:25:00 2009
4 : 34 (Celcius) 93 (Fahrenheit) Sun Feb 21 11:25:00 2009
OK

timeout
Use timeout to set or get the current CLI session’s timeout value, where <value>
is in seconds. A value of “0” disables timeout. However, you must first exit your current
session then log back in to use the new no-timeout session.

Syntax set timeout <value>

get timeout

Example rkscli: get timeout

get timeout: 900 sec
OK
rkscli: set timeout 0
set timeout: 0 sec: OK
OK

42
 System Commands
System Group Commands

tr069
Use the tr069 command to get or set FlexMaster (TR069 protocol)-related parame-
ters. See remote-mgmt for information on enabling or disabling TR069 management.

Syntax get tr069

set tr069 [options]

Options url -- <ACS url> ** format: http://... or https//...

interval <secs> -- inform period
user <username> -- for CPE authentication to ACS
password <password> -- for CPE authentication to ACS
digest-user <username> -- for ACS authentication to CPE
digest-password <password> -- for ACS authentication to CPE

uptime
Use get uptime to display how long the Ruckus Wireless device has been running.

Syntax get uptime

Example rkscli: get uptime

Uptime: 2 days 21 hrs 48 mins 15 secs
OK

version
Use get version to display the software version running on the AP.

Syntax get version

Example rkscli: get version

Ruckus 7363 Multimedia Hotzone Wireless AP
Version: 9.1.1.0.33
OK

43
System Commands
System Group Commands

44
 Radio Commands
Radio Group Commands

5
Radio Commands

In This Chapter
Radio Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Radio Group Commands

This chapter describes commands that you can use to configure the device’s radio
settings. Radio settings include basic wireless settings, wireless security, AP/bridge
mode, and country code, among others.

802.11-h
The 802.11h standard amendment provides Dynamic Frequency Selection (DFS) and
Transmit Power Control (TPC) to address interference issues in the 5GHz frequency
band.

Syntax get 802.11-h <wifi name>

set 802.11-h <wifi name> [enable|disable]

aiming
[Wireless bridge command only] Use the aiming command to get or set configura-
tion options for aiming wireless bridge links.

Syntax get aiming -- Display aiming configuration

set aiming [enable|disable] [duration <secs>] [min-rssi <rssi>]
[tg-count <pkt cnt>] [tg-delay <IPG>] -- Modify aiming configuration

Example rkscli: get aiming

Aiming: Enabled
Minimum RSSI: 5

45
Radio Commands
Radio Group Commands

Aiming Time: 600 seconds

Traffic-Gen IPG: 1 ms
Traffic-Gen Rate: 200 Pkt/sec
OK

air-fair
Set or get airtime fairness configuration.

Syntax get air-fair <wifi name> -- Display Air-Time Fairness Configuration

set air-fair <wifi name> [enable|disable] -- Modify Air-Time Fairness
Configuration

ap-bridge
Use the ap-bridge command to configure the device’s wireless LAN bridge mode.
Disabling this feature will prevent two wireless clients on the same wireless network
from communicating with each other.

Syntax set ap-bridge <wlan name> [enable|disable]

get ap-bridge <wlan name>

Example rkscli: get ap-bridge wlan0

wlan0 AP-Bridge Mode: Disabled
OK
rkscli: set ap-bridge wlan0 enable
OK

autoconfig
Use the autoconfig command to set or get auto configuration state. When the
Ruckus Wireless device first boots up, it needs to set a unique SSID and auto generate
keys as influenced by this command.

Syntax set autoconfig <wlan name> options [enable|disable]

set autoconfig <wlan name> options nasid-sel m[0..1]
set autoconfig <wlan name> options ssid-sel [0..2]
set autoconfig <wlan name> options ssid-prefix <string>
set autoconfig <wlan name> options [ weplen (5,13) ]
set autoconfig <wlan name> options [ wpalen (8..63) ]
set autoconfig options [ fw-control-sel n (0..1) ]
set autoconfig options [ fw-control-prefix xyz ]

46
 Radio Commands
Radio Group Commands

set autoconfig options [ super-pswd-sel n (0..1) ]

get autoconfig

Options ■ wlan name

■ enable|disable
■ nasid-sel m (0..1) – NAS-ID select for 802.1X authentication. A NAS-ID is
sent to a RADIUS server. Use these options to turn the feature on or off.
■ ssid-sel n(0..2) – The SSID select. Use these options to turn the feature on
or off.
■ ssid-prefix xyz – The prefix is V54 by default. The SSID defaults to V54-
<last 3 octets of device’s MAC address>. Use this command to change
the prefix.
■ [ weplen (5,13) ] -- WEP key length.
■ [ wpalen (8..63) ] -- WPA passphrase length.
■ fw-control-sel n (0..1) -- Firmware control select.
■ fw-control-prefix xyz -- Firmware control prefix.
■ super-pswd-sel n (0..1) -- Super admin password select.
■ get autoconfig -- Displays the auto configuration state.

Example rkscli: set autoconfig wlan0 nasid-sel 1

OK
rkscli: get autoconfig
~~ Auto-Configuration ~~
Name Status NASID-Sel SSID-Sel SSID-Prefix
-----------------------------------------------------------
wlan0 : Enabled 0 1 V54
wlan1 : Disabled
OK

autoprov
Use autoprov to set or get auto provisioning state. This command enables automatic
AP and adapter provisioning.
For wireless bridge devices, autoprov mode can be used to provision the unit as
the root or non-root bridge.

Syntax set autoprov [enable|disable]

get autoprov

(For wireless bridge)

47
Radio Commands
Radio Group Commands

set autoprov [mode [root|non-root] ]

Description ■ set autoprov – Configures the auto provisioning state. The options are enable
or disable.
■ get autoprov – Displays the auto provisioning state.

Example 1 rkscli: get autoprov

Disabled
Auto-Provisiong task is stopped!...
OK
rkscli: set autoprov enable
Setting AutoProv state to Enabled
OK

Example 2: Bridge is rkscli: get autoprov

factory reset and Auto-Provisioning
provisioning as root/ Status: Enable
non-root not yet Mode: Not Decided
decided
OK
set autoprov mode root
Auto-provisioning must be disabled if you want to set device mode
manually
Disable Auto-Provision? [yes|no], or Press “Enter” to Accept :
yes
** Please reboot for this change to take effect!!!
OK
rkscli: reboot

band-steering
[Dual-band APs only.] For dual-band Ruckus devices, the band-steering command
is used to enable or disable steering clients to the 5GHz band when possible. If the
RSSI threshold is set to 1, all 5GHz capable clients will be redirected to the 5GHz radio.

Syntax get band-steering <wlan name> -- Get band steering RSSI threshold
set band-steering <wlan name> mesh-ap [enable|disable] rssi --
Enable band steering, modify RSSI threshold

Example rkscli: get band-steering

Band Steering:
Under Mesh AP : Off
OK

48
 Radio Commands
Radio Group Commands

rkscli: set band-steering mesh-ap enable 20

OK
rkscli: get band-steering wlan0
Band Steering:
Under Mesh AP : On
RSSI Threshold: 20
OK

beacon-interval
Use beacon-interval to set or get the beacon interval.

Syntax set beacon-interval <wlan name> <interval>

get beacon-interval <wlan name>

Description ■ set beacon-interval <wlan name> [100..1000] – Configures the

beacon interval, where <interval> is any integer between 100 and 1000.
■ get beacon-interval <wlan name> – Displays the beacon interval.
■ Aliases: beacon-intval

Example rkscli: get beacon-interval wlan1

Beacon Interval: 100
OK
rkscli: set beacon-interval wlan1 200
OK

blacklist
Use blacklist to get or set the channel blacklist information.

Syntax get blacklist <wifi name>

set blacklist <wifi name> options

Options [enable|disable]
[clear]
[chan_num [1(temporary)|0(clear)|-1(permanent)]]
[[rx_phyerr|util_busy|nf0hi|nf0lo] val]

Description wifi name: wifi0 = 2.4GHz radio; wifi1 = 5GHz radio

clear: clears the blacklist
chan_num: channel number to add to or remove from blacklist

49
Radio Commands
Radio Group Commands

1: temporary
-1: permanent (channel will remain blacklisted after reboot)
0: remove channel from blacklist
rx_phyerr: receive phy error threshold
util_busy: utilization threshold
nf0hi: noise floor high
nf0lo: noise floor low

Example rkscli: set blacklist wifi0 enable

OK
rkscli: set blacklist wifi0 3 1
Ok.
OK
rkscli: get blacklist wifi0
wifi0 Channel Blacklist is enabled.
wifi0 Blacklisted Channel: 3 Timeout: temporary
wifi0 Threshold override:
OK

bssminrate
Use bssminrate to get or set the BSS min rate.

Syntax get bssminrate <wlan name>

set bssminrate <wlan name> [0..65535]

Example rkscli: set bssminrate wlan0 2000

OK
rkscli: get bssminrate wlan0
wlan0 BSS Min Rate: 2000 kbps
OK

channel
Use channel to set or get the transmit channel on the device. The default is auto.
On boot up, the device finds an available channel and continues to use it unless
interference is detected.

Syntax set channel <wifi name> [channel <number>|auto]

get channel <wifi name>

50
 Radio Commands
Radio Group Commands

Description ■ set channel <wifi name> [channel <number>|auto] -- Configures the transmit
channel for the radio. You may set the channel to any <number> allowed for the
current country code setting.
■ get channel <wifi name> -- Displays the transmit channel being used by the radio.

Example rkscli: get channel wifi0

wifi0 Channel: 11 (2462 Mhz) (Smart Auto Select)
OK
rkscli: set channel wifi0 6
OK
rkscli: get channel wifi0
wifi0 Channel: 6 (2437 Mhz) (Manual Channel Select)
OK

chano
[Wireless bridge only.] Use chano to get or set channel optimization parameters.

Syntax get chano

set chano [enable|disable] [duration <secs>]

class2mqprio
Use class2mqprio to set or get the MQ Class Priority Mapping. Setting one type
of traffic to a higher priority level (lower number) gives a higher priority to that traffic
class. Four traffic classes are defined in order, and the order can not be changed.
However, each class can be given a high or a low priority within its rank. Each traffic
class has two possible priority levels. For Voice, the options are 0 and 1 (0 is high
priority, 1 is low priority). For Video, the options are 2 and 3, etc.
The four traffic classes, in order of highest to lowest priority, are:
■ p1: Voice
■ p2: Video
■ p3: Data
■ p4: Background

Syntax get class2mqprio <wlan name> -- Display MQ Class to Priority Mapping. Priority
is 0-7, 0 is the highest.
set class2mqprio <wlan name> p1 p2 p3 p4 -- Set a binary priority level
for each of the four traffic classes (p1-p4).

Example rkscli: get class2mqprio wlan1

51
Radio Commands
Radio Group Commands

Class Voice : 0
Class Video : 2
Class Data : 4
Class Background : 6
OK
rkscli: set class2mqprio wlan1 1 2 4 6
OK
rkscli: get class2mqprio wlan1
Class Voice : 1
Class Video : 2
Class Data : 4
Class Background : 6
OK
rkscli:

countrycode
Use countrycode to set or get the country code in which the device is operating.

Syntax set countrycode <code>

get countrycode

Description ■ set countrycode <code> -- Configures the country code. Replace <code> with an
ISO country code such as one of the following: CA, US, HK, IL, UK, JP.
■ get countrycode -- Displays the country code.

Example rkscli: get countrycode

Country code not configured
rkscli: set countrycode us
OK
rkscli: get countrycode
Country is US
OK
rkscli: reboot
Rebooting... please wait.

NOTE:: After you execute the countrycode command, you need to reboot the
device for the updated settings to take effect.

52
 Radio Commands
Radio Group Commands

countryie
The information in the Country Information Element provides an indication of the
regulatory domain and the requirements of that domain.

Syntax get countryie <wifi name> -- Get Country Information Element status
set countryie <wifi name> [enable|disable] -- Enable/disable Country
Information Element support

cwmin-adapt
Use cwmin-adapt to enable/disable dynamic adaptation of contention window
minimum (cwmin) for service prioritization.

Syntax get cwmin-adapt <wifi name> -- Get CWMIN ADAPT mode

set cwmin-adapt <wifi name> [enable|disable] -- Set CWMIN ADAPT
mode

cwmode
Set 802.11n channel width to 20MHz, 20/40MHz or 40MHz.

Syntax get cwmode -- Get 11n channel width mode

set cwmode [0,2] -- Set 802.11n channel width mode (0=20Mhz, 2=40MHz)

dbstats

Syntax get dbstats <wlan name> -- Get the # of packets that are transferred from Bcast
to Ucast

detected
(Internal debug command, for dual band Ruckus devices only.)

Syntax get detected -- Show detected stations by band-steering feature

set detected -- Clear detected stations by band-steering feature

53
Radio Commands
Radio Group Commands

dfsmidbandblock
Dynamic Frequency Selection rules require 11n wireless traffic to avoid frequencies in
use by radar systems. Use dfsmidbandblock to enable or disable dynamic
frequency selection.

Syntax get dfsmidbandblock <wifi name>

set dfsmidbandblock <wifi name> [enable|disable|

Description ■ Get DFS mid-band (UNI-11 2) block status

■ Enable or disable blocking of the DFS mid-band (UNI-11 2) channels

directed-thr
Use directed-thr to set an upper limit on Directed Broadcast processing.

Syntax get directed-thr <wlan name>

set directed-thr <wlan name> <new threshold>

Description set directed-thr <wlan name> <integer 1-128; 0=disabled>

Example set directed-thr wlan1 0

OK
rkscli: get direced-thr wlan1
Directed Bcast is Disabled
OK
rkscli:

dtim-period
Use dtim-period to set or get the Delivery Traffic Information Map (DTIM) period.
A station checks for buffered data every DTIM period beacon.

Syntax set dtim-period <wlan name> <1..255>

get dtim-period <wlan name>

Description ■ set dtim-period <wlan name> <period>--Configures the DTIM for a named
WLAN.
■ get dtim-period <wlan name>--Displays the DTIM for a named WLAN.

Example rkscli: get dtim-period wlan0

54
 Radio Commands
Radio Group Commands

wlan0 DTIM Period: 1

OK
rkscli: set dtim-period wlan0 20
OK

dvlan
Use dvlan to enable or disable dynamic VLAN on a WLAN.

Syntax get dvlan <wlan name>

set dvlan <wlan name> [enable|disable]

encryption
Use encryption to set or get the encryption method used by a named WLAN.

Syntax set encryption <wlan name>

get encryption <wlan name>

Description ■ set encryption <wlan name> -- Configures encryption information for a

named WLAN. The output of set encryption will vary depending on the kind
of profile the device is running.
■ get encryption <wlan name> -- Displays encryption information for a named
WLAN.

Example 1 rkscli: get encryption wlan0

SSID : V54-020210
Net Security : WPA
Protocol Version : WPA
Authentication : Open
Cipher Algorithm : TKIP
WPA PassPhrase : C3B8DC71FDECA
wlan0
OK

Example 2 rkscli: set encryption wlan0

Wireless Encryption Type: [0] quit, [1] OPEN, [2] WEP, or [3] WPA
Wireless Encryption Type: 3
WPA Protocol Version: [0] quit, [1] WPA, [2] WPA2, or [3] AUTO
WPA Protocol Version: 3

55
Radio Commands
Radio Group Commands

WPA Authentication Type: [0] quit, [1] OPEN (PSK), [2] EAP (.1X),
or [3] AUTO
WPA Authentication Type: 3
WPA Cipher Type: [0] quit, [1] TKIP, [2] AES-CCMP, or [3] AUTO
WPA Cipher Type: 3
WPA PassPhrase: "helloworld"
Enter A New PassPhrase [8-63 letters], or Press "Enter" to Accept :
NAS-ID (network access server ID): "wlan0"
Enter A New NAS-ID [1-63 letters], or Press "Enter" to Accept :
-----------------------------
Primary Authentication Server
-----------------------------
IP : 172.21.100.22
Port : 1812
Secret : admin
-----------------------------
Select server to change (or 4 to skip): [0] quit, [1] Primary, [2]
Backup1, or [3] Backup2
Select : 4
-----------------------------
Primary Accounting Server
-----------------------------
IP : 172.21.100.22
Port : 1813
Secret : admin
-----------------------------
Select server to change (or 4 to skip): [0] quit, [1] Primary, [2]
Backup1, or [3] Backup2
Select : 4
WPA no error
-- WPA HostAPd ReStart --
hostapd termination count is 1
<6>br1: port 2(wlan0) entering disabled state
<6>br2: port 2(wlan1) entering disabled state
Configuration file: /var/run/hostapd.conf.wlan0
Using interface wlan0 with hwaddr 00:13:92:be:f1:d6 and ssid 'V54-
BEF1D6'
<6>br1: port 2(wlan0) entering learning state
Flushing old station entries
Deauthenticate all stations
Configuration file: /var/run/hostapd.conf.wlan1
Using interface wlan1 with hwaddr 00:13:92:be:f1:d7 and ssid 'gd6-
lan'

56
 Radio Commands
Radio Group Commands

<6>br2: port 2(wlan1) entering learning state

Flushing old station entries
Deauthenticate all stations
Applying new encryption settings...
OK
rkscli:
<6>br1: port 2(wlan0) entering forwarding state
<6>br1: topology change detected, propagating
<6>br2: port 2(wlan1) entering forwarding state
<6>br2: topology change detected, propagating

NOTE: An encryption change results in the device restarting to accommodate the

new settings. When the changes are finalized, the device goes into “forwarding state”.

event
Use event to display WLAN monitoring events or set event configuration options.

Syntax ■ get event <wlan name> -- Display Event-Configuration State

■ set event <wlan name> options -- Modify Event-Configuration State

Options assoc [threshold] [period]

auth [period]
crc [threshold] [period]
obss [threshold] [period]
rssi [threshold] [period]
vid-drop [threshold] [period]
vo-drop [threshold] [period]

Example rkscli: get event wlan0

wlan0 monitor settings:
Threshold Interval
(per Radio Chip)
CRC 5000 10
(wlan0 specific)
Association 3 10
Authentication 0 10
Other BSS 1000 10
RSSI 20 10
Video Pkt Drop 10 10
Voice Pkt Drop 10 10

57
Radio Commands
Radio Group Commands

OK

extant
Use extant to display or modify external antenna configuration.

Syntax get extant <wifi name>

set extant <wifi name> [enable|disable|both]

extantgain
Use extantgain to set or get the external antenna gain.

Syntax get extantgain <wifi name>

set extantgain <wifi name> <0 - 90dBi>

Example rkscli: set extantgain wifi0 5

OK
rkscli: get extantgain wifi0
External Antenna Gain: 5 dBi
OK

fixed-rate
Use fixed-rate to set or get the fixed transmission rate for a named WLAN. The
device supports various wireless data rates.

Syntax set fixed-rate <wlan>

[1mb|2mb|5.5mb|11mb|12mb|18mb|24mb|36mb|48mb|54mb|auto]
get fixed-rate <wlan>

Description ■ set fixed-rate <wlan>--Configures the fixed transmission rate of a named

WLAN. The rate can be any of the options listed above. Regardless of how far or
close the client is to the device (signal strength), this fixed-rate will remain
constant. In contrast, the auto option (default) will auto adjust the rate accord-
ingly.
■ get fixed-rate <wlan name>--Displays the fixed transmission rate of a
named WLAN.

Example rkscli: get fixed-rate wlan0

wlan0 rate is fixed mode, Rate 11Mb
OK

58
 Radio Commands
Radio Group Commands

rkscli: set fixed-rate wlan0 auto

OK

frag-thr

Syntax get frag-thr <wlan name> - get fragmentation threshold.

invisible

Syntax get invisible <wlan name> -- get invisible status for a wlan
set invisible <wlan name> [enable|disable] -- Set invisible
capability for wlan interface

key
Use get key to return the encryption method, key length and static encryption keys
for the WLAN. For TKIP encryption, the cipher operation requires four keys: a transmit
key, receive key, MIC (message integrity check) transmit key and a MIC receive key.

Syntax get key <wlan name>

Example 1 rkscli: get key wlan4

WPA network
Default TX Key: 1
Key 0: NONE
Key: TKIP, cache-entry: 5 length:16 XMIT RECV
f751-2343-fed2-ae66-2342-851b-2e35-b235
TX MIC: 98ce-ba73-1a35-45a
RX MIC: 455e-c4be-176b-abbf
Key 2: NONE
Key 3: NONE
OK

Example 2 rkscli: get key wlan1

WPA network
Default TX Key: 1
Key 0: NONE
Key 1: CCMP, cache-entry: 4 length:16 XMIT RECV
8906-2c07-591f-fe56-8ac8-7989-9330-ce99
Key 2: CCMP, cache-entry: 36 length:16 XMIT RECV

59
Radio Commands
Radio Group Commands

128d-aa82-7a1d-2699-1601-8e98-5f8b-533a

Example 3 rkscli: get key wlan3

WEP network
Default TX Key: 1
Key 0: NONE
Key 1: WEP, cache-entry: 1 length:5 XMIT RECV
4935-755f-42
Key 2: NONE
Key 3: NONE
OK

leave
Use the leave command to disassociate all clients of a WLAN.

Syntax set leave <wlan name> -- Disassociate all WLAN clients

legacytxchainmask

Syntax ■ get legacytxchainmask <wifi name> -- Get 11n Legacy Transmit chainmask
■ Set legacytxchainmask <wifi name> [1|5|7] -- Set 11n Legacy Transmit
chainmask (1, 5, 7)

Example rkscli: set legacytxchainmask wlan1 5

OK
rkscli: get legacytxchainmask wlan1
Legacy Transmit Chainmask: 5
OK
rkscli:

link-count
[Wireless bridge command only]. Use link-count to display the number of times
the link has been up and down since reboot.

Syntax get link-count <wlan name> -- Display link up/down count

Example rkscli: get link-count wlan1

MAC Addr #UP #DOWN
------------------------------------------

60
 Radio Commands
Radio Group Commands

xx:xx:xx:xx:xx:xx 1 0
OK

mesh
[ZoneDirector-controlled APs only] See ZoneDirector CLI Reference Guide.

meshcfg
[ZoneDirector-controlled APs only] See ZoneDirector CLI Reference Guide.

max-aid
Use max-aid to limit the number of IDs that can associate to a specific WLAN.

Syntax get max-aid <wlan name>

set max-aid <wlan name> [value]

Description ■ get max-aid <wlan name> -- Get the maximum number of allowed associated
IDs for the WLAN
■ set max-aid <wlan name> [value] -- Set the maximum number of
associated IDs allowed for the WLAN

minrate
Use minrate to set the minimum transfer rate for management and control packets.
Generally this rate is handled by the rate control algorithm and should not be
changed.

Syntax get minrate <wlan name>

set minrate <wlan name> [0..7]

Description ■ get minrate -- Get the minimum management packet rate for the WLAN
■ set minrate -- Set the minimum management packet rate for the WLAN
Values are relative indexes that vary depending on wireless protocol. See Table 2 for
minrate index values by protocol.

Table 2. Minrate index values

Index 11g or 11ng 11a or 11na

0 1Mbps 6Mbps
1 2 9

61
Radio Commands
Radio Group Commands

Table 2. Minrate index values

2 5.5 12
3 11 18
4 6 24
5 9 36
6 12 48
7 18 54

mode
Use get mode to display the Phy Mode of a wireless interface.
On 11bg APs, the default mode is auto. Ruckus 11bg APs support the association of
11b clients, 11g clients, or a mixture. Use set mode to configure the interface for 11b
only, 11g only or both. Default is auto.
The set mode command is not valid for 11n products. For 11n products, wifi0 is the
11gn (2.4GHz) radio. If the 11n AP is a dual-band AP, the wifi1 interface is the 11an
(5GHz) radio. These settings are not configurable.

Syntax set mode <wifi name> [auto|11g|11b]

get mode <wifi name>

Description ■ set mode <wlan name> [auto|11g | 11b]-- Configures the Phy Mode of
a named WLAN.
■ get mode <wlan name> -- Displays the Phy Mode of a named WLAN.

Example rkscli: get mode wlan0

wlan0 Mode: auto
OK
rkscli: set mode wlan0 11g
OK

mq
Get or set current Media Queue options.

Syntax ■ get mq <wifi name> -- Displays current Media Queue options

■ set mq <wifi name> options
-> credit c1 c2, 0~60, credit for 802.11 G/B client
-> pscredit p, 0~600, max power-save credit

62
 Radio Commands
Radio Group Commands

-> qtime t1 t2 t3 t4, voice/video/data/background pkt queue time

-> maxpkts p1 p2 p3 p4, voice/video/data/background pkts
-- Set the Media Queue hold time / credit / queuing options
■ get mq holdingtime/credit/pscredit/psinqmode – Displays current
mediaqueue max holding times or max/power save credit
■ set mq holdingtime t1 t2 t3 t4/credit G B/pscredit c/psinqmode
[head|tail]
t1 -> voice class max holding time
t2 -> video class max holding time
t3 -> data class max holding time
t4 -> background class max holding time --
Sets the maximum mediaqueue holding times or max/power save credit of all wlan
interfaces

mqstats
Use mqstats to clear or get the media queue statistics. Different queue types are
given different packet transmission priorities. For example, multicast video packets
are placed in a high priority video queue. Every client that associates with the device
is given a set of correctly prioritized queues.

Syntax set mqstats <wlan name> clear [all|def|<mac-addr>]

get mqstats <wlan name> [all|def|<mac-addr>]

Description ■ set mqstats <wlan name> clear [all|def|<mac-addr>]--Clears the media queue
statistics.
■ get mqstats <wlan name> [all|def|<mac-addr>]--Displays the media queue statis-
tics.

Example rkscli: get mqstats wlan0 all

-----------------------------------------------------------------
----------------
STA: None
Qued ovrflw enq deq reenq deact XRetries
(deflt): 0 0 1120 9572 8452 0 896
rkscli: set mqstats wlan0 clear all
OK
rkscli: get mqstats wlan0 all

63
Radio Commands
Radio Group Commands

-----------------------------------------------------------------
----------------
STA: None
Qued ovrflw enq deq reenq deact XRetries
(deflt): 0 0 0 0 0 0 0

nf

Syntax get nf -- Get refreshed 11n Noisefloor

Example rkscli: get nf

### Noisefloor for Radio 0 ###
NF Ch0 -128[-128], ext -120[120]
NF Ch1 95[95], ext 96[96]
NF Ch2 -32[-32], ext 111[111]
OK
rkscli:

nfmin
get nfmin -- Get 11n Min Noisefloor Limit Value
set nfmin <value> -- Set 11n Min Noisefloor Limit Value (negative number, dBm)

nfoverride
get nfoverride -- Get 11n Noisefloor Override Value
set nfoverride <value> -- Set 11n Noisefloor Override Value (0=disable, >0 = |NF|
[e.g., 85 sets NF=-85 dBm])

passphrase
Use get passphrase to display the WPA passphrase. There is no set passphrase
because that operation is done using the command “encryption” on page 55.

Syntax get passphrase <wlan name>

Example rkscli: get passphrase wlan0

wlan0 WPA PassPhrase (13): C3B8DC71FDECA
OK

64
 Radio Commands
Radio Group Commands

phyrpt-mode
■ get phyrpt-mode < wifi name> -- Get phyrpt-mode
■ set phyrpt-mode <wifi name> [0=disabled, 1=interrupt,
2=counter] -- Set Phy error report mode

preferredap
Use preferredap to get or set preferred AP for a WLAN.
■ get preferredap <wlan name> – Get Preferred AP
■ set preferredap <wlan name> <xx:xx:xx:xx:xx:xx> – Set Preferred AP

preferredapmode
■ get preferredapmode <wlan name> -- Get Preferred AP Mode
■ set preferredapmode <wlan name> [preferred|locked] -- Set
Preferred AP Mode

prot-mode
Use prot-mode to set or get the protection mode for 11b/11g. For mixed-mode
scenarios, g clients notify b clients when transmissions are about to occur. Default is
none.

Syntax set prot-mode <wlan name> [none|cts-only|rts-cts]

get prot-mode <wlan name>

Description ■ set prot-mode <wlan name> [none|cts-only | rts-cts]– Configures

the protection mode for 11b/11g.
■ get prot-mode <wlan name> – Displays the protection mode for 11b/11g.

Example rkscli: get prot-mode wlan0

wlan0 Protection Mode: none
OK
rkscli: set prot-mode wlan0 cts-only
OK

rescan
Get or set rescan settings.

Syntax get rescan <wifi name>

set rescan <wifi name> options

65
Radio Commands
Radio Group Commands

Options exp [2..1024] -- time exponent factor

max [1..65536] -- minutes, max rescan interval
min [0..65536] -- minutes, min rescan interval

rts-thr
Use rts-thr to set or get the Request To Send (RTS) threshold. Default is disabled.

Syntax ■ set rts-thr <wlan name> [disable|<threshold>]

■ get rts-thr <wlan name>

Description ■ set rts-thr <wlan name> [disable|<threshold>]– Configures the RTS

threshold, where <threshold> is the threshold value in bytes between 1 and
2346.
■ get rts-thr <wlan name> – Displays the RTS threshold.

Example rkscli: get rts-thr wlan0

wlan0 RTS Threshold: disabled
OK
rkscli: set rts-thr wlan0 50
OK

rxchainmask

Description ■ get rxchainmask <wifi name> -- Get 11n Receive chainmask

■ set rxchainmask <wifi name> [1|3|5|7] -- Set 11n Receive chainmask
(1, 3, 5, 7)

scanap
Use scanap to return the latest background scan results for any detected WLANs.
Use set scanap to perform an immediate background scan.

Syntax get scanap : get scanap <wlan name>

set scanap : set scanap <wlan name>

schedstats
Display Scheduler statistics.

66
 Radio Commands
Radio Group Commands

Syntax get schedstats <wlan name> <TBD..>

ssid
Use ssid to set or get the Service Set IDentifier (SSID).

Syntax set ssid <wlan name> <ssid>

get ssid <wlan name>

Description ■ set ssid <wlan name> <ssid>--Configures the SSID, where <ssid> is the
ID. To distinguish the device from other APs, the SSID is defaulted to “V54-<last
3 octets of mac>”.
■ get ssid <wlan name>--Displays the SSID.

Example rkscli: get ssid home

home SSID: V54-HOME001
OK
rkscli: set ssid home apples
-- Open / WEP (/var/run/hostapd.conf.wlan1)
OK
rkscli: get ssid home
home SSID: apples
OK

NOTE:: Ruckus Wireless recommends that you do not change the wlan0’s SSID due
to autoprov. The pair must match.

ssid-suppress
Use ssid-suppress to allow or deny the Service Set IDentifier (SSID) in control
frames.

Syntax set ssid-suppress <wlan name> [enable|disable]

get ssid-suppress <wlan name>

Description ■ set ssid-suppress <wlan name> [enable|disable]--Allows or denies

the SSID in control frames, where <wlan name> is a named WLAN interface.
When enabled, the beacons are transmitted but not advertised (suppress). The
wlan0 is enabled by default whereas home is disabled.
■ get ssid-suppress <wlan name>--Displays the SSID in the control frames.

67
Radio Commands
Radio Group Commands

Example rkscli: get ssid-suppress home

home SSID Suppression: Disabled
OK
rkscli: set ssid-suppress home enable
OK

state
Use state to set or get the radio state of a WLAN interface.

Syntax set state <wlan name> [up|down]

get state <wlan name>

Description ■ set state <wlan name> {up|down}--Configures the state of a WLAN

interface. Note a down set state remains down on the next reboot.
■ get state <wlan name>--Displays the state of a WLAN interface.

Example rkscli: get state wlan0

wlan0 State: up
OK
rkscli: set state wlan0 down
OK
rkscli: set state wlan0 up
--> wlan0 crypto OK...
-- WPA HostAPd ReStart --
hostapd termination count is 1
Configuration file: /var/run/hostapd.conf.wlan0
Using interface wlan0 with hwaddr 00:13:92:02:02:10 and ssid
'abc123'
Flushing old station entries
Deauthenticate all stations
OK

station
Use station to clear or get station information.

Syntax set station <wlan name> stats clear [all|<mac-addr>]

get station <wlan name> [list|info|stats] [all|<mac-addr>]

68
 Radio Commands
Radio Group Commands

Description ■ set station <wlan name> stats clear [all|<mac-addr>]--Clears

station statistics, which is useful for debugging purposes. Use <mac-addr> to
clear a specific station.
■ get station [list|info|stats] [all|<mac-addr>]--Displays a list of
stations that are currently associated to the AP.

Example rkscli: get station home info all

MAC Addr AID Rate RSSI Idle ERP State Flags
------------------------------------------------------
00:0c:41:cf:e9:f4 1 54M 55 120 0 25 0

OK
rkscli: get station home stats all
00:0c:41:cf:e9:f4:
rx_data_frm 32 rx_mgt_frm 18 rx_bytes 4192
tx_data_frm 502 tx_mgmt_frm 19 tx_bytes 4241
tx_assoc 1 tx_auth 1
good_tx_frms 511 good_rx_frms 51 tx_retries 157
tx_rate 54000 tx_kbps 33400 rx_crc_errs 1
tx_per 6 tx_rssi 49
OK
rkscli: get station home list all
ADDR AID CHAN RATE RSSI IDLE TXSEQ RXSEQ CAPS ACAPS
ERP STATE MODE
00:0c:41:cf:e9:f4 1 1 54M 49 120 572 3792 ESs
0 25 Normal
OK
rkscli: get station home stats 00:0c:41:cf:e9:f4
00:0c:41:cf:e9:f4:
rx_data_frm 32 rx_mgt_frm 23 rx_bytes 4192
tx_data_frm 645 tx_mgmt_frm 24 tx_bytes 4412
tx_assoc 1 tx_auth 1
good_tx_frms 658 good_rx_frms 56 tx_retries 204
tx_rate 54000 tx_kbps 33602 rx_crc_errs 1
tx_per 6 tx_rssi 49
OK
rkscli: set station home stats clear all
rkscli: get station home stats 00:0c:41:cf:e9:f4
00:0c:41:cf:e9:f4:

tx_data_frm 9
good_tx_frms 9

69
Radio Commands
Radio Group Commands

tx_rate 54000 tx_kbps 33842

tx_per 5 tx_rssi 49

txchainmask

Syntax ■ get txchainmask <wifi name> -- Get 11n Transmit chainmask

■ set txchainmask <wifi name> [1, 3, 5, 7] -- Set 11n Transmit chainmask
(1, 3, 5, 7)

txpower
Use txpower to set or get the AP’s transmit power strength.

Syntax set txpower <wlan name> [max|half|quarter|eigth|min]

get txpower <wlan name>
The default is max. Consider a lesser value if the AP’s signal is too strong and
interfering with neighboring APs.

Description ■ set txpower <wlan name> [max|half|quarter|eigth|min]--Configures the transmit

power.
■ get txpower <wlan name>--Displays the transmit power.

Example rkscli: get txpower wlan0

wlan0 transmit power set to max
OK
rkscli: set txpower wlan0 min
OK

uplink
Use get uplink to display the wireless uplink status.

Syntax get uplink <wlan name>

voice-detect
Use voice-detect to turn On/Off voice call detection mode.

Syntax get voice-detect <wlan name>

set voice-detect <wlan name> [enable|disable]

70
 Radio Commands
Radio Group Commands

Description ■ get voice-detect <wlan name> -- Get Voice Call Detection mode
■ set voice-detect <wlan name> [enable|disable] -- Set Voice Call
Detection mode

wds-mode
Use wds-mode to set or get Wireless Distribution Service (WDS) mode. This feature
enables you to have multiple outbound clients behind a wireless bridge adaptor.
Default is enabled.

Syntax set wds-mode <wlan name> [enable|disable]

get wds-mode <wlan name>

Description ■ set wds-mode <wlan name> [enable|disable]--Configures WDS mode.

■ get wds-mode <wlan name>--Displays WDS mode information.

Example rkscli: get wds-mode wlan0

wlan0 WDS Mode: Disabled
OK
rkscli: set wds-mode wlan0 enable
OK

wep
Use get wep to display the WEP usage/allocation.

Syntax get wep <wifi name>

wlanlist
Use get wlanlist to display a list of all WLAN interfaces. If the AP is a dual radio
AP, the RadioID column indicates which radio (2.4GHz or 5GHz) is serving the WLAN.

Syntax get wlanlist

Example rkscli: get wlanlist

name status type wlanID radioID bssid
-----------------------------------------------------------
wlan0 up AP wlan0 0 00:24:82:3f:14:69
wlan8 up AP wlan8 1 00:24:82:3f:14:6d
OK

71
Radio Commands
Radio Group Commands

wlantext
Use wlantext to change the description of the wirelesss network, as displayed in
the WebUI. For example, “Video Network”, “Data Network”, “HotZone 1”, and so on.

Syntax set wlantext <wlan name> <your-text-here>

get wlantext <wlan name>

Description ■ set wlantext <wlan name> <your-text-here> -- Configures the text

description.
■ get wlantext <wlan name> -- Displays the text description.

Example rkscli: get wlantext wlan0

wlan0: 'Video WLAN'
OK
rkscli: set wlantext wlan0 This is a test
OK
rkscli: get wlantext wlan0
wlan0: 'This is a test'
OK

wmm
Use wmm to set or get the WMM protocol information for EDCA QoS control. WMM
is the 802.11e method for managing video and voice queues. WMM prioritizes traffic
according to four Access Categories (AC) - voice, video, best effort, and background.
Default is enabled. See “cwmin-adapt” on page 53 for more information.

Syntax set wmm <wlan name> [enable|disable]

get wmm <wlan name>
set wmm-params <wlan name> [ap|bss] [vo|vi|be|bk] <cwmin> <cwmax>
<aifs>

Description ■ set wmm <wlan name> [enable|disable]--Sets the WWM protocol for
EDCA QoS control.
■ get wmm <wlan name>--Displays WMM protocol information.

Example rkscli: get wmm wlan0

wlan0 WMM: Disabled
OK
rkscli: set wmm wlan0 enable
OK

72
 Radio Commands
Radio Group Commands

zaxis

Syntax get zaxis <wifi name> -- Get Z Axis antenna status for the g/n or a/n radio
set zaxis <wifi name> [enable|disable] -- Enable Z Axis antenna for the
g/n or a/n radio

73
Radio Commands
Radio Group Commands

74
 Miscellaneous Commands
Misc Group Commands

6
Miscellaneous Commands

In This Chapter
Misc Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
ACL Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Traffic Shaping Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
VLAN Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

This chapter describes miscellaneous and minor CLI commands. These commands
can be found in the miscgroup, aclgroup, shaper and vlangroup command groups.

Misc Group Commands

ftp
Use ftp to get or put files using the FTP protocol.

Syntax ftp get <hostname-or-ip> <localfilename> <remotefilename>

ftp put <hostname-or-ip> <localfilename> <remotefilename>

Example rkscli: ftp get 10.1.1.1 test test1

tftp
Use tftp to get or put files using the TFTP protocol.

Syntax tftp get <hostname-or-ip> <localfilename> <remotefilename>

tftp put <hostname-or-ip> <localfilename> <remotefilename>

Example rkscli: tftp get 10.1.1.1 test test1

75
Miscellaneous Commands
ACL Group Commands

ACL Group Commands

This chapter describes the commands that you can use to configure the Access
Control List (ACL) settings on the Access Point.

get acl
Show the MAC access control info of the wlan interface.

Syntax get acl [wlan]

Description Get ACL information for the specified WLAN

Example rkscli: get acl wlan0

'wlan0' MAC ACL: black list of access-denied MACs
============================================================
1: 11:11:11:11:11:11
2: 11:12:11:11:11:11
OK
rkscli: get acl wlan1
'wlan1' MAC ACL: white list, access to authorized MACs only
============================================================
1: 00:00:00:00:00:00
OK
rkscli:

set acl
Set ACL MAC options.

Syntax set acl [wlan] <options>

Options disable: open-access policy allowing all MAC addresses

allow: white list of all authorized/allowed MACs
deny: black list of blocked MACs
add/delete: add or delete MAC addresses from list

Example rkscli: set acl wlan3 disable

OK
rkscli: get acl wlan3
'wlan3' MAC ACL: open-access

76
 Miscellaneous Commands
Traffic Shaping Commands

OK

Traffic Shaping Commands

shaper

Syntax get shaper [wlan]

set shaper [wlan] [preset [uplink]]
set shaper [wlan] disable
shaper notes
shaper debug

Description
shaper Shows available preset shaping configurations
shaper notes Shows shaper usage notes
shaper debug Dumps shaper debug state
shaper [preset] Shows details for specified preset
get shaper [wlan] Gets shaper configuration for the specified WLAN
set shaper [wlan] Configures a WLAN to use a specific preset
[preset [uplink]]
set shaper [wlan] Disables shaping on specified WLAN
disable

Example rkscli: get shaper wlan0

Traffic Shaping Config for 'wlan0'
Downlink Preset: "500kbps"
EGRESS to WLAN: ( 500 kbps shared per station)
Class Rate Ceiling Buffer
3 (VO): 100 kbps, 128 kbps, 10 pkts
2 (VI): 100 kbps, 400 kbps, 25 pkts
1 (BE): 200 kbps, 500 kbps, 25 pkts
0 (BK): 100 kbps, 500 kbps, 10 pkts

Uplink Preset: "100kbps"

INGRESS from WLAN: ( 100 kbps shared per station)
Class Rate Ceiling Buffer
3 (VO): 25 kbps, 100 kbps, 5 pkts
2 (VI): 25 kbps, 100 kbps, 5 pkts
1 (BE): 25 kbps, 100 kbps, 5 pkts
0 (BK): 25 kbps, 100 kbps, 5 pkts

77
Miscellaneous Commands
VLAN Group Commands

OK

VLAN Group Commands

vlan
Use vlan to get VLAN information on one or more VLANs, WLANs or ports.

Syntax get vlan all

get vlan vid [vlan id]
get vlan port [port #]
get vlan wlan [wlan #]

Description
get vlan all Shows VLAN configuration for all networks
get vlan vid Displays VLAN information for the specified VLAN ID (valid
VLAN ID range is from 1 to 4094)
get vlan Show VLANs the port is attached to
get vlan Shows the VLANs to which the wireless network is attached

Example rkscli: get vlan all

---------------------------------------
Network 0: (Management) VID 1
Services: DHCP Client
Eth Port (no tag): 1,2,4
Wireless (no tag):
- wlan0 (Wireless 1)
- wlan1 (Wireless 2)
- wlan2 (Wireless 3)
- wlan3 (Wireless 4)
- wlan4 (Wireless 5)
- wlan5 (Wireless 6)
- wlan6 (Wireless 7)
- wlan7 (Wireless 8)
---------------------------------------
Network 4: (Vlan A) VID 100
Services:
Eth Port (no tag): 3
Eth Port (tagged): 4
---------------------------------------
Network 5: (Vlan B) VID 10

78
 Miscellaneous Commands
VLAN Group Commands

Services:
Eth Port (no tag): 0
Eth Port (tagged): 4
---------------------------------------

OK

79
Index

Symbols detected, 53
device, 25
?, 9
device-gps, 25
device-location, 25
Numerics device-name, 25
802.11-h, 45 dfs, 54
dfsmidbandblock, 54
A dhcpc, 26
dhcps, 26
aerosct, 23
directed multicast, 16
aiming, 45
directed-thr, 54
air-fair, 46
director, 26
ap-bridge, 46
dns, 27
ap-mode, 23
dtim-period, 54
autoconfig, 46
dvlan, 55
autoprov, 47

B E
encryption, 55
band-steering, 48
eth, 27
beacon-intval, 49
eth-mon, 28
blacklist, 49
event, 57
boarddata, 23
extant, 58
bssid, 50
extantgain, 58
bssminrate, 50

C F
factory, 28
chainmask, 66, 70
fixed-rate, 58
channel, 50
frag-thr, 59
chano, 51
ftp, 75
class2mqprio, 51
fw, 28
countrycode, 52
countryie, 53
cwmin-adapt, 53 G
cwmode, 53 get qos, 13

D H
dbstats, 53 help, 9
debuggroup, 10 heuristics, 17

80
home_login, 31 orientation, 37
home_password, 31
http, 32 P
https, 32
passphrase, 64
password, 37
I phyrpt-mode, 65
internal_heater, 33 ping, 11
invisible, 59 poe_out, 37
ipaddr, 33 portfwd, 37–38
pppoe, 38
K preferredap, 65
preferredapmode, 65
key, 59
prot-mode, 65

L Q
leave, 60
qos aging, 16
legacytxchainmask, 60
qos classification, 16
link-count, 60
qos directed multicast, 16
login, 34
qos dot1p, 16, 21
qos heuristics, 17
M qos heuristics udp, 17
max-aid, 61 qos igmp, 18
mesh, 61 qos igmp_query, 18
meshcfg, 61 qos ip, 18
mgmt-vlan, 34 qos known_multicast, 18
minrate, 61 qos mac, 19
mode, 62 qos mld, 19
model-display, 34 qos mld_query, 19
mq, 62 qos port, 19
mqstats, 63 qos QueryInterval, 20
qos tos, 20
qos txFailThreshold, 21
N
nat, 35
netstats, 35 R
nf, 64 reboot, 38
nfmin, 64 remote-mgmt, 38
nfoverride, 64 rescan, 65
ntp, 35 route, 38
nuttcp, 36 rpmkey, 11
nwstate, 36 rts-thr, 66
rxchainmask, 66
O
oem, 36 S
opmode, 37 scanap, 66

81
schedstats, 66
shaper, 77
snmp, 38
snmp-acl, 40
ssh, 40
ssid, 67
ssid-suppress, 67
sta-mgmt, 68
state, 68
station, 68
support, 12
sysinfo, 12
syslog, 40

T
telnet, 41
tftp, 75
thermo, 42
timeout, 42
tr069, 43
traceroute, 12
txchainmask, 70
txFailThreshold, 21
txpower, 70

U
uplink, 70
uptime, 43

V
version, 43
vlan, 78
voice-detect, 70

W
wds-mode, 71
wep, 71
wlanlist, 71
wlantext, 72
wmm, 72

Z
zaxis, 73

82
83