Page 1 Ruckus Wireless ™ SmartCell Gateway 200 Virtual ™ SmartZone High-Scale and SmartZone ™ ™ Command Line Interface Reference Guide for SmartZone 3.5.1 Part Number 800-71515-001 Rev A Published June 2017 www.ruckuswireless.com...
Page 2: Limitation Of Liability
Ruckus Wireless, Ruckus, the bark logo, ZoneFlex, FlexMaster, ZoneDirector, SmartMesh, Channelfly, Smartcell, Dynamic PSK, and Simply Better Wireless are trademarks of Ruckus Wireless, Inc. in the United States and other countries. All other product or company names may be trademarks of their respective owners.
Page 3: Table Of Contents
Content s Contents About This Guide Document Conventions ..........14 Related Documentation .
Page 4 Content s calea..............72 cert-store .
Page 5 Content s hostname ............211 hotspot-profile .
Page 6 Content s no ap-zone-aggregate ..........275 no auth-profile .
Page 7 Content s no radius-service ........... . . 297 no report.
Page 8 Content s snmp-v2-community........... 338 snmp-v3-user .
Page 9 Content s show sha1-state ............460 show strict-wfa-compliance-state .
Page 10 Content s show dhcp-server-stats ..........496 show diameter-gx-stats .
Page 11 Content s backup config ............546 backup network .
Page 12 Content s service start ............573 set-factory .
Page 13: About This Guide
Most user guides and release notes are available in Adobe Acrobat Reader Portable Document Format (PDF) or HTML on the Ruckus Wireless Support Web site at https://support.ruckuswireless.com/contact-us.
Page 14: Document Conventions
For a complete list of documents that accompany this release, refer to the Release Notes. Online Training Resources To access a variety of online Ruckus Wireless training modules, including free introductory courses to wireless networking essentials, site surveys, and Ruckus Wireless products, visit the Ruckus Wireless Training Portal at: https://training.ruckuswireless.com...
Page 15: Documentation Feedback
About This Guide Documentation Feedback Documentation Feedback Ruckus Wireless is interested in improving its documentation and welcomes your comments and suggestions. You can email your comments to Ruckus Wireless at: docs@ruckuswireless.com When contacting us, please include the following information: • Document title •...
Page 16: Introduction To The Controller Command Line Interface
Introduction to the Controller Command Line Interface Introduction to the Controller Command Line Interface In this chapter: • Overview of the Controller Command Line Interface • Accessing the Command Line Interface SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 17: Overview Of The Controller Command Line Interface
Interface The Controller command line interface (CLI) is a software tool that enables you to configure and manage SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300. Using the command line interface, you can issue commands from an operating system prompt, such as the Microsoft Windows command prompt or a Linux operating system terminal.
Page 18 Introduction to the Controller Command Line Interface Accessing the Command Line Interface Figure 1. SCG200 Location of console port Figure 2. SZ300 Location of console port SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 19: Start And Configure The Ssh Client
Introduction to the Controller Command Line Interface Accessing the Command Line Interface Start and Configure the SSH Client Before starting this procedure, make sure that the SSH client is already installed on the administrative computer. NOTE: The following procedure describes how to use PuTTY, a free and open source telnet/SSH client, to access the controller CLI.
Page 20 Introduction to the Controller Command Line Interface Accessing the Command Line Interface Figure 3. Selecting SSH as a connection type 3 Enter the IP address of the Management (Web) interface of the controller in the Host Name (or IP address) field as seen in Figure 4 Click Open.
Page 21: Using Serial Connection
Introduction to the Controller Command Line Interface Accessing the Command Line Interface Using Serial Connection If you have connected the administrative computer to the console port on the controller using an RS-232 serial to RJ45 cable, follow these steps to start and configure the SSH client.
Page 22 Introduction to the Controller Command Line Interface Accessing the Command Line Interface Figure 5. PuTTy’s default serial connection setting 4 Configure the serial connection settings as follows. See Figure • Serial line to connect to: Type the COM port name to which you connected the RS-232 cable.
Page 23 Introduction to the Controller Command Line Interface Accessing the Command Line Interface Figure 6. PuTTY’s serial connection settings for connecting to controller 5 Click Open. The PuTTY console appears and displays the login prompt as seen Figure SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 24: Log On To Cli
NOTE: You cannot use 'admin' as a password, which is used during the controller installation procedure. • The Ruckus Wireless controller CLI welcome message appears with the CLI prompt as seen in Figure SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 25 Introduction to the Controller Command Line Interface Accessing the Command Line Interface Figure 8. Logging into CLI • You are now logged into the controller CLI as a user with limited privileges by looking at the CLI prompt. If you are in limited mode, the prompt appears as ruckus>...
Page 26 Introduction to the Controller Command Line Interface Accessing the Command Line Interface Figure 9. Using Show Commands • As a user with limited privileges, you can view a history of commands that were previously executed and ping a device as seen in Figure Figure 10.
Page 27 Introduction to the Controller Command Line Interface Accessing the Command Line Interface • If you want to run more commands, you need to switch to privileged mode by entering enable and the password at the root prompt as seen in Figure 11.
Page 28: Configuration Commands (A - D)
Configuration Commands (a - d) config Configuration Commands (a - d) This chapter describes the commands that you can use to configure, enable, and disable various controller components. The following table lists the commands. NOTE: For easy access and reading, the configuration chapter has been split into three chapters based on the alphabetical order of commands.
Page 29: 3Rd-Zone
Configuration Commands (a - d) 3rd-zone 3rd-zone To create or update the third party AP zone configuration, use the following command. ruckus(config)# 3rd-zone <name> Syntax Description This command uses the following syntax: name: AP zone name Default This command has no default settings. Command Mode Config Example...
Page 30 Configuration Commands (a - d) 3rd-zone Table 4. Commands related to ruckus(config-3rd-zone). Syntax and Type Parameters (if any) Description ruckus(config-3rd-zone)# acct-ttg- <name> Sets the accounting for TTG session. session Type: Privileged ruckus(config-3rd-zone)# auth- Sets the authentication service. server Type: Privileged ruckus(config-3rd-zone)# auth- <name>...
Page 31 Configuration Commands (a - d) 3rd-zone Table 4. Commands related to ruckus(config-3rd-zone). Syntax and Type Parameters (if any) Description ruckus(config-3rd-zone)# exit Exits from the EXEC. Type: Privileged ruckus(config-3rd-zone)# <name> Sets the core network forwarding forwarding-service-profile profile. Type: Privileged ruckus(config-3rd-zone)# help Displays the help.
Page 32 Configuration Commands (a - d) 3rd-zone Table 4. Commands related to ruckus(config-3rd-zone). Syntax and Type Parameters (if any) Description ruckus(config-3rd-zone)# radius- default-share-secret Sets the RADIUS client options. client <password> Type: Privileged single-ip <ip> <password> ip-range <ip> <ip> <password> subnet <ip> <mask> <password>...
Page 33 Configuration Commands (a - d) 3rd-zone Table 5 lists the related 3rd-zone-wlan configuration commands. Table 5. Commands related to ruckus(config-3rd-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-3rd-zone-wlan)# [ <start-vlan> | <vlan> ] Adds the access VLAN range. access-vlan <end-vlan> Type: Privileged <start-vlan>: VLAN range start value...
Page 34 Configuration Commands (a - d) 3rd-zone Table 5. Commands related to ruckus(config-3rd-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-3rd-zone-wlan)# do Executes the Executes the do command. Type: Privileged ruckus(config-3rd-zone-wlan)# Ends the current configuration session and return to privileged EXEC mode. Type: Privileged ruckus(config-3rd-zone-wlan)# Exits from the EXEC.
Page 35: Acct-Profile
Configuration Commands (a - d) acct-profile acct-profile To create or update the accounting service profile configuration, use the following command: ruckus(config)# acct-profile <name> Syntax Description This command uses the following syntax: name: Accounting service profile name Default This command has no default settings. Command Mode Config Example...
Page 36 Configuration Commands (a - d) acct-profile Table 6. Commands related to ruckus(config-acct-profile). Syntax and Type Parameters (if any) Description ruckus(config-acct-profile)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode. ruckus(config-acct-profile)# exit Exits from the EXEC. Type: Privileged ruckus(config-acct-profile)# help Displays the help.
Page 37: Ad-Service
Configuration Commands (a - d) ad-service Table 7. Commands related to ruckus(config-acct-profile-realm) Syntax and Type Parameters (if any) Description ruckus(config-acct-profile-realm)# Displays the help. help Type: Privileged ruckus(config-acct-profile-realm)# <name> Sets the realm name. name Type: Privileged ad-service To create or update the active directory service configuration, use the following command: ruckus(config)# ad-service <name>...
Page 38 Configuration Commands (a - d) ad-service Related Commands Table 8 lists the related ad-service configuration commands. Table 8. Commands related to ruckus(config-ad-service) Syntax and Type Parameters (if any) Description ruckus(config-ad-service)# admin- <domain-name> Sets the administrator domain domain-name name. This field is applicable on executing the group attribute Type: Privileged command.
Page 39 Configuration Commands (a - d) ad-service Table 8. Commands related to ruckus(config-ad-service) Syntax and Type Parameters (if any) Description ruckus(config-ad-service)# help Displays the help. Type: Privileged ruckus(config-ad-service)# ip- <ip> - Sets the primary Sets the primary service IP address. address server IP address Type: Privileged ruckus(config-ad-service)# name...
Page 40: Admin
Configuration Commands (a - d) admin admin To create or update the administrator’s profile (including the email address, login ID and password), use the following command: ruckus(config)# admin <name> Once you enter the config-admin context, you can configure the rest of the administrator’s profile (see example below).
Page 41 Configuration Commands (a - d) admin Related Commands Table 9 lists the related admin configuration commands. Table 9. Commands related to ruckus(config-admin) Syntax and Type Parameters (if any) Description ruckus(config-admin)# do Executes the do command. Type: Privileged ruckus(config-admin)# email <email> Set the user’s email details.
Page 42: Admin-Radius
Configuration Commands (a - d) admin-radius admin-radius To configure the RADIUS server for administrators use the following command: ruckus(config)# admin-radius Syntax Description This command uses the following syntax: name: RADIUS server name Default This command has no default settings. Command Mode Config Example ruckus(config)# admin-radius aaa-auth...
Page 43 Configuration Commands (a - d) admin-radius Related Commands Table 10 lists the related config-admin-radius configuration commands. Table 10. Commands related to ruckus(config-admin-radius) Syntax and Type Parameters (if any) Description ruckus(config-admin-radius)# ip <ip> - Sets the IP Enables RADIUS backup. backup address of secondary RADIUS server Type: Privileged...
Page 44 Configuration Commands (a - d) admin-radius Table 10. Commands related to ruckus(config-admin-radius) Syntax and Type Parameters (if any) Description ruckus(config-admin-radius)# ip <ip> Sets the IP addresses of the primary RADIUS server. Type: Privileged ruckus(config-admin-radius)# <name> Sets the RADIUS server name. name Type: Privileged ruckus(config-admin-radius)# no...
Page 45: Adv-Forwarding-Profile
Configuration Commands (a - d) adv-forwarding-profile adv-forwarding-profile To enter the advanced (mixed mode) profile configuration, use the following command: ruckus(config)# adv-forwarding-profile <name> Syntax Description This command uses the following syntax: name: Profile name Default This command has no default settings. Command Mode Config Example...
Page 46 Configuration Commands (a - d) adv-forwarding-profile Table 11. Commands related to ruckus(config-adv-forwarding-profile) Syntax and Type Parameters (if any) Description ruckus(config-adv-forwarding- Executes the do command. profile)# do Type: Privileged ruckus(config-adv-forwarding- Ends the current configuration profile)# end session and returns to privileged EXEC mode.
Page 47 Configuration Commands (a - d) adv-forwarding-profile Table 12 lists the related adv-forwarding-profile-apn configuration commands. Table 12. Commands related to ruckus(config-adv-forwarding-profile-apn) Syntax and Type Parameters (if any) Description ruckus(config-adv-forwarding- Executes the do command. profile-apn)# do Type: Privileged ruckus(config-adv-forwarding- Ends the current configuration profile-apn)# end session and returns to privileged EXEC mode.
Page 48 Configuration Commands (a - d) To update the AP configuration, use the following commands: ruckus(config)# ap <mac> ruckus(config)# ap <apMac> pre-prov ruckus(config)# ap pre-prov <import <ftp-url>> <export <ftp-url>> ruckus(config)# ap swap <import <ftp-url>> <export <ftp-url>> Syntax Description This command uses the following syntax: <mac>...
Page 49 Configuration Commands (a - d) Example ruckus(config)# ap mac ruckus(config)# ap A1:87:45:34:56:FE ruckus(config)# ap pre-prov <export <ftp-url>> ruckus(config)# ap pre-prov import ftp:// ruckus:ruckus1!@172.19.7.100/backup/AP_ad8745345 ruckus(config)# ap swap <import <ftp-url>> ruckus(config)# ap swap export ftp:// ruckus:ruckus1!@172.19.7.100 Related Commands • Table 13 lists the related ap-profile configuration commands. •...
Page 50 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# bonjour- Enables the bonjour gateway. gateway Type: Privileged ruckus(config-ap)# bonjour-policy Enables the bonjour policy. Type: Privileged ruckus(config-ap)# channel- <seconds>: The interval Sets the channel evaluation interval.
Page 51 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# client- 2.4g Enables the client admission admission-control control. Type: Privileged 2.4g minClientCount <minClientCount> Min Client Count (Default: 2.4g maxRadioLoad <maxRadioLoad> Max Radio Load (Default: 75%) 2.4g minClientThroughput...
Page 52 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# end Ends the current configuration session and return to privileged Type: Privileged EXEC mode. ruckus(config-ap)# exit Exits from the EXEC. Type: Privileged ruckus(config-ap)# gps <latitude>...
Page 53 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# ip6 • address Sets the AP IPv6 network settings. <ip><gateway>: Type: Privileged • address: Set IPv6 address • <ip>: Static IPv6 address •...
Page 54 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# no admin Disables the configuration. Type: Privileged bonjour-gateway channel-evaluation- interval channel-select-mode client-admission-control description ........continued hotspot20 ip <address> <name- server secondary> ip6 <address> <name- server secondary>...
Page 55 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# no venue-profile Disables the configuration. Type: Privileged ruckus(config-ap)# override-ap- <vlanTag>: VLAN tag (1- Overrides AP Management VLAN mgmt-vlan 4094) enter ‘keep’ to retain the APs setting.
Page 56 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# radio 2.4g channel <channel> Sets the radio channels. Type: Privileged 5g channel <channel> 2.4g channelization <channelization> 5g channelization <channelization> 2.4g tx-power <tx- power>...
Page 57 Configuration Commands (a - d) Table 13. Commands related to ruckus(config-ap) Syntax and Type Parameters (if any) Description ruckus(config-ap)# syslog enable <ip> <port> - Sets the syslog server. Enable the syslog server Type: Privileged enable <ip> <port> [ Local2 | Keep Original | Local1 | Local5 | Local6 | Local0 | Local7 | Local3 | Local4 ] [ Error |...
Page 58 Configuration Commands (a - d) Table 14 lists the related ap-model configuration commands. Table 14. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-ap-model)# do Executes the do command. Type: Privileged ruckus(config-ap-model)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode.
Page 59 Configuration Commands (a - d) Table 14. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-ap-model)# led- Sets the LED mode. mode Type: Privileged ruckus(config-ap-model)# lldp Enables link layer discovery protocol. Type: Privileged ruckus(config-ap-model)# lldp-ad- <seconds> Sets the LLDP advertise interval. interval Type: Privileged ruckus(config-ap-model)# lldp-...
Page 60 Configuration Commands (a - d) Table 14. Commands related to ruckus(config-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-ap-model)# poe- Enables the PoE out port. out-port Type: Privileged ruckus(config-ap-model)# radio- ${value} Switches the radio band. band Type: Privileged ruckus(config-ap-model)# usb Enables the USB port.
Page 61 Configuration Commands (a - d) Table 15. Commands related to ruckus(config-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-ap-model-lan1)# Displays the help. help Type: Privileged ruckus(config-ap-model-lan1)# Sets the MAC bypass. mac-bypass Type: Privileged ruckus(config-ap-model-lan1)# <members> Sets the AP model configurations. members Type: Privileged ruckus(config-ap-model-lan1)# no...
Page 62: Ap-Auto-Tagging
Configuration Commands (a - d) ap-auto-tagging Table 16 lists the related to ap-pre-prov configuration commands. Table 16. Commands related to ruckus(config-ap-pre-prov) Syntax and Type Parameters (if any) Description ruckus(config-ap-pre-prov)# ip6 Sets IPV6 network settings. Type: Privileged ruckus(config-ap-pre-prov)# ip6 <ip>: IP address Sets the IPV6 address and address gateway.
Page 63 Configuration Commands (a - d) ap-auto-tagging Example ruckus(config)# ap-auto-tagging enable ruckus(config)# ap-auto-tagging rule daily-threshold 90 g Related Commands Table 17 lists the related to ap-auto-tagging configuration commands. Table 17. Commands related to ruckus(config-ap-auto-tagging) Syntax and Type Parameters (if any) Description ruckus(config-ap-auto-tagging)# Executes the do command.
Page 64: Ap-Cert-Check
Configuration Commands (a - d) ap-cert-check ap-cert-check To enable the access point certificate check, use the following command: ruckus(config)# ap-cert-check Syntax Description This command has no arguments or keywords. Default This command has the default settings of enable. Command Mode Config Example ruckus(config)# ap-cert-check...
Page 65: Ap-Control-Mgmt-Tos
Configuration Commands (a - d) ap-control-mgmt-tos ap-control-mgmt-tos To enable the access control and management traffic type of service and values, use the following command: ruckus(config)# ap-control-mgmt-tos <value> Syntax Description This command has no arguments or keywords. Default This command uses the following syntax: value: TOS value Command Mode Config...
Page 66: Ap-Zone-Aggregate
Configuration Commands (a - d) ap-zone-aggregate ap-zone-aggregate To enable the AP Zone data aggregation task, use the following command: ruckus(config)# ap-zone-aggregate Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# ap-zone-aggregate auth-profile...
Page 67 Configuration Commands (a - d) auth-profile Table 18 lists the related auth-profile configuration commands. Table 18. Commands related to ruckus(config-auth-profile) Syntax and Type Parameters (if any) Description ruckus(config-auth-profile)# aaa- <seconds> Sets the interim accounting interval for hosted AAA server. interim-acct-interval Type: Privileged ruckus(config-auth-profile)# aaa- <seconds>...
Page 68 Configuration Commands (a - d) auth-profile Table 18. Commands related to ruckus(config-auth-profile) Syntax and Type Parameters (if any) Description ruckus(config-auth-profile)# no aaa-support Disables the commands. Type: Privileged gpp-support realm <realm> ruckus(config-auth-profile)# realm <realm> Sets the realm. Type: Privileged ruckus(config-auth-profile)# sgsn- <mcc>...
Page 69: Bridge-Profile
Configuration Commands (a - d) bridge-profile Table 19. Commands related to ruckus(config-auth-profile-realm) Syntax and Type Parameters (if any) Description ruckus(config-auth-profile-realm)# Exits from the EXEC. exit Type: Privileged ruckus(config-auth-profile-realm)# Displays the help. help Type: Privileged bridge-profile To create or update the bridge profile configuration, use the following command: ruckus(config)# bridge-profile <name>...
Page 70 Configuration Commands (a - d) bridge-profile Table 20 lists the related bridge-profile configuration commands. Table 20. Commands related to ruckus(config-bridge-profile) configuration Syntax and Type Parameters (if any) Description ruckus(config-bridge-profile)# <text> Sets the description description Type: Privileged ruckus(config-bridge-profile)# Enables the DHCP Option 82. dhcp-option-82 Type: Privileged ruckus(config-bridge-profile)#...
Page 71 Configuration Commands (a - d) bridge-profile Table 20. Commands related to ruckus(config-bridge-profile) configuration Syntax and Type Parameters (if any) Description ruckus(config-bridge-profile)# no dhcp-option82 Disables DHCP Option 82, DHCP Relay or deletes DHCP Server 2 Type: Privileged dhcp-relay dhcp-server2 relay-both ruckus(config-bridge-profile)# Enables sending DHCP requests to both the servers relay-both...
Page 72: Calea
Configuration Commands (a - d) calea Table 21. Commands related to ruckus(config-bridge-profile-dhcp-option82) Syntax and Type Parameters (if any) Description ruckus(config-bridge-profile- Enables subopt-150 dhcp-option82)# subtopt150 Type: Privileged ruckus(config-bridge-profile- essid Enables subopt-151 dhcp-option82)# subtopt151 area-name <name> Type: Privileged ruckus(config-bridge-profile- [ ap-essid | ue-essid | ue- Enables subopt-2 dhcp-option82)# subtopt2 mac | ap-mac ]...
Page 73: Cert-Store
Configuration Commands (a - d) cert-store cert-store To create or update certificate configurations, use the following command: ruckus(config)# cert-store ap-cert <name> ruckus(config)# cert-store cert <name> ruckus(config)# cert-store csr <name> ruckus(config)# cert-store hotspot-cert <name> ruckus(config)# cert-store web-cert <name> Syntax Description This command uses the following syntax: ap-cert <name>: Create / updates the AP port certificate cert <name>: Create / updates the certificate configuration csr <name>: Create / updates CSR (Certificate Signing Request) configuration...
Page 74 Configuration Commands (a - d) cert-store Related Commands Table 23 lists the related cert-store configuration commands. Table 23. Commands related to ruckus(config-cert-store) configuration Syntax and Type Parameters (if any) Description ruckus(config-cert-store)# cert <ftp-url> Uploads the certificate file. Type: Privileged <ftp-url> append ruckus(config-cert-store)# city <city>...
Page 75 Configuration Commands (a - d) cert-store Table 23. Commands related to ruckus(config-cert-store) configuration Syntax and Type Parameters (if any) Description ruckus(config-cert-store)# no inter-cert Removes the certificates. Type: Privileged root-cert ruckus(config-cert-store)# <org> Sets the organization. organization Type: Privileged ruckus(config-cert-store)# <passphrase> Sets the key passphrase. passphrase Type: Privileged ruckus(config-cert-store)# private-...
Page 76: Cgf-Service
Configuration Commands (a - d) cgf-service cgf-service To setup the CGF service configuration, use the following command: ruckus(config)# cgf-service <name> Syntax Description This command uses the following syntax: name: CGF service name Default This command has no default settings. Command Mode Config Example ruckus(config)# cgf-service charge-ser...
Page 77 Configuration Commands (a - d) cgf-service Table 24. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# cdr- <retry-times> Sets the CDR retries. retry Type: Privileged ruckus(config-cgf-service)# cdr- Enables in sending the APN network identifier to the CDR. send-apn-network-id Type: Privileged ruckus(config-cgf-service)# cdr-...
Page 78 Configuration Commands (a - d) cgf-service Table 24. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# cdr- Enables in sending the PDF address to the CDR. send-pdp-addr Type: Privileged ruckus(config-cgf-service)# cdr- Enables in sending the PDF type to the CDR.
Page 79 Configuration Commands (a - d) cgf-service Table 24. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# do Executes the do command. Type: Privileged ruckus(config-cgf-service)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode.
Page 80 Configuration Commands (a - d) cgf-service Table 24. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# lbo- <node-id> Enables the node ID. The length range is between 1 and 20. node-id Type: Privileged ruckus(config-cgf-service)# lbo- Enables in sending the local record sequence number.
Page 81 Configuration Commands (a - d) cgf-service Table 24. Commands related to ruckus(config-cgf-service) profile Syntax and Type Parameters (if any) Description ruckus(config-cgf-service)# no cdr-send-sgsn-addr Disables various options. Type: Privileged cdr-sgsn-plmn-id cdr-traffic-vol cdr-ttg lbo-send-local-record-sn lbo-send-node-id server <ip> ruckus(config-cgf-service)# <integer> Sets the record limit. record-limit Type: Privileged ruckus(config-cgf-service)# server...
Page 82 Configuration Commands (a - d) cgf-service Table 25. Commands related to ruckus(config-cgf-service-ftp-server) Syntax and Type Parameters (if any) Description ruckus(config-cgf-service-ftp- <password> Sets the username for the FTP server. server)# password Type: Privileged ruckus(config-cgf-service-ftp- <port> Sets the FTP server port. server)# port Type: Privileged ruckus(config-cgf-service-ftp- <remote-dir>...
Page 83: Changepassword
Configuration Commands (a - d) changepassword Table 26. Commands related to ruckus(config-cgf-service-server) Syntax and Type Parameters (if any) Description ruckus(config-cgf-service-server)# <port> Sets the server port. port Type: Privileged changepassword To change the administrative password, use the following command: ruckus(config)# change <old password>...
Page 84: Clock
Configuration Commands (a - d) clock clock To update the system clock or the timezone configuration, use the following command: ruckus(config)# clock timezone <timezone> Syntax Description This command uses the following syntax: timezone: Sets the system clock timezone <timezone>: Timezone name of the domain Default This command has no default settings.
Page 85: Cluster-Name
Configuration Commands (a - d) cluster-name ruckus(config)# cluster-ip-list 172.19.18.96:172.19.13.56 172.19.15.67:172.19.10.07 cluster-name To change the cluster name, use the following command: ruckus(config)# cluster-name <cluster-name> Syntax Description This command uses the following syntax: cluster-name: Change the cluster name. Default This command has no default settings. Command Mode Config Example...
Page 86 Configuration Commands (a - d) cluster-redundancy Related Commands • Table 27 lists the related cluster-redundancy configuration commands. • Table 28 lists the related cluster-redundancy-cluster configuration commands. Table 27 lists the related cluster redundancy configuration commands. Table 27. Commands related to ruckus(config-cluster-redundancy) Syntax and Type Parameters (if any) Description...
Page 87 Configuration Commands (a - d) cluster-redundancy Table 28 lists the related cluster-redundancy-cluster configuration commands. Table 28. Commands related to ruckus(config-cluster-redundancy-cluster) Syntax and Type Parameters (if any) Description ruckus(config-cluster-redundancy- Executes the do command. cluster)# do Type: Privileged ruckus(config-cluster-redundancy- <dual-list> Sets the dual address list. List cluster)# dual-list format: IPv4 address/IPv6 address,IPv4 address,IPv6...
Page 88: Data-Plane
Configuration Commands (a - d) data-plane data-plane To update the data plane configuration, use the following command: ruckus(config)# data-plane <name> <<name> <forward-stp> ruckus(config)# data-plane <vSZ-D> <data-external-port> <keep-config> <approve> <remote-vdp-cli> Syntax Description This command uses the following syntax: <name>: Name of the data plane forward-stp: Disables the STP package bridge data-external-port: Updates the data external port configuration keep-config: Retains the original data plane configuration...
Page 89 Configuration Commands (a - d) data-plane Table 29. Commands related to ruckus(config-data-plane) Syntax and Type Parameters (if any) Description ruckus(config-data-plane)# help Displays the help. Type: Privileged ruckus(config-data-plane)# ip address- Sets the IP Updates the IP configuration. address of the data Type: Privileged plane ip address dhcp - Sets...
Page 90: Diameter-Remote-Service
Configuration Commands (a - d) diameter-remote-service Table 29. Commands related to ruckus(config-data-plane) Syntax and Type Parameters (if any) Description ruckus(config-data-plane)# no ip - Deletes IP static Disables / deletes options. routes Type: Privileged natip - Deletes NAT IP vlan - Deletes VLAN of primary interface ruckus(config-data-plane)# vlan <vlan-id>...
Page 91 Configuration Commands (a - d) diameter-remote-service Related Commands Table 30 lists the related diameter-remote-service configuration commands. Table 30. Commands related to ruckus (config-diameter-remote-service) Syntax and Type Parameters (if any) Description config-diameter-remote- ruckus( Sets the diameter remote service service )# description description.
Page 92 Configuration Commands (a - d) diameter-remote-service Table 30. Commands related to ruckus (config-diameter-remote-service) Syntax and Type Parameters (if any) Description config-diameter-remote- ruckus( [2 | 1 | 4 | 3]: Updates or adds service type. service )# service-type 2:PCRF Type: Privileged 1:OCS 4:STA 3:DRA...
Page 93: Diameter-System-Wide
Configuration Commands (a - d) diameter-system-wide diameter-system-wide To set the Diameter system wide e configuration, use the following command. ruckus(config)# diameter-system-wide Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# diameter-system-wide ruckus(config-diameter-system-wide)#...
Page 94 Configuration Commands (a - d) diameter-system-wide Table 32. Commands related to ruckus (config-diameter-system-wide) Syntax and Type Parameters (if any) Description ruckus(config-diameter-system- <name> Updates the local realm name. wide)# local-realm-name Type: Privileged ruckus(config-diameter-system- Updates the peer expiry time and wide)# peer-timeout timeval in seconds.
Page 95: Dns-Server-Service
Configuration Commands (a - d) dns-server-service dns-server-service To create or update DNS server services, use the following command. ruckus(config)# dns-server-service <name> Syntax Description This command has the following keywords: <name>: DNS server service name Default This command has no default settings. Command Mode Config Example...
Page 96 Configuration Commands (a - d) Table 33. Commands related to ruckus(config-dns-server-service) Syntax and Type Parameters (if any) Description ruckus(config-dns-server-service)# Displays the help. help Type: Privileged ruckus(config-dns-server-service)# <device type> Deletes the device policy rules. no policy-rule Type: Privileged ruckus(-dns-server-service)# Sets the device policy. policy-rule Type: Privileged To setup the do command, use the following command.
Page 97: Domain
Configuration Commands (a - d) domain domain To create or update the domain configuration, use the following command: ruckus(config)# domain <name> Syntax Description This command uses the following syntax: name: Name of the domain Default This command has no default settings. Command Mode Config Example...
Page 98 Configuration Commands (a - d) domain • Table 49 lists the related domain-zone-client-isolation-whitelist configuration commands. • Table 50 lists the related domain-zone-device-policy configuration commands. • Table 51 lists the related domain-zone-device-policy rule configuration commands. • Table 52 lists the related domain-zone-diffserv configuration commands. •...
Page 99 Configuration Commands (a - d) domain Table 34 lists the related domain configuration commands. Table 34. Commands related to ruckus(config-domain) Syntax and Type Parameters (if any) Description ruckus(config-domain)# 3rd-zone <name> Creates or updates a Third Party AP zone in the current domain. Type: Privileged ruckus(config-domain)# admin <username>...
Page 100 Configuration Commands (a - d) domain Table 34. Commands related to ruckus(config-domain) Syntax and Type Parameters (if any) Description ruckus(config-domain)# zone <name> - AP zone name Create or update an AP zone in the current domain. Type: Privileged <name> template <name>...
Page 101 Configuration Commands (a - d) domain Table 35 lists the related domain-3rd-zone configuration commands. Table 35. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone)# [ qinq-l2 | l2ogre | qinq-l3 ] Sets the access network. access-network Type: Privileged ruckus(config-domain-3rd-zone)# <minutes>...
Page 102 Configuration Commands (a - d) domain Table 35. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone)# Sets the default WLAN. The default WLAN is used when WLAN default-wlan configuration is not found for Type: Privileged incoming access VLAN or SSID. One default WLAN is allowed in each 3rd party AP zone.
Page 103 Configuration Commands (a - d) domain Table 35. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone)# <name> Sets the network traffic profile. network-traffic-profile Type: Privileged ruckus(config-domain-3rd-zone)# acct-server Disables and deletes configuration options. acct-service-profile Type: Privileged acct-ttg-session bypass-cna default-wlan radius-client...
Page 104 Configuration Commands (a - d) domain Table 35. Commands related to ruckus(config-domain-3rd-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone)# qinq Sets the core network VLAN mapping type. vlan-type strip-qinq Type: Privileged strip-svlan-preserve-cvlan strip-qinq-add-vlan <vlan- id> ruckus(config-domain-3rd-zone)# <ssid> Sets the WLAN. wlan Type: Privileged Table 36...
Page 105 Configuration Commands (a - d) domain Table 36. Commands related to ruckus(config-domain-3rd-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone- <name> Sets the authentication service profile. wlan)# auth-service-profile Type: Privileged ruckus(config-domain-3rd-zone- Sets the authentication service type. wlan)# auth-type Type: Privileged ruckus(config-domain-3rd-zone- Enables bypass CNA.
Page 106 Configuration Commands (a - d) domain Table 36. Commands related to ruckus(config-domain-3rd-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-3rd-zone- access-vlan Disables or deletes the configurations that have been set. wlan)# no acct-server Type: Privileged acct-service-profile acct-ttg-session bypass-cna ruckus(config-domain-3rd-zone- preserve-all Enables dynamic VLAN.
Page 107 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# ap- <lvlanTag>: VLAN Tag (1- Sets the AP management VLAN. mgmt-vlan 4094); enter ‘keep’to keep APs setting. Type: Privileged ruckus(config-domain-zone)# ap- <name>...
Page 108 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# <name>: Bonjour fencing Enables bonjour fencing policy. bonjour-fencing policy name to apply Type: Privileged ruckus(config-domain-zone)# <name>: Bonjour fencing Creates or updates the bonjour fencing policy.
Page 109 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# 2.4g Enables the client admission control. client-admission-control Type: Privileged 2.4g minClientCount <minClientCount> 2.4g maxRadioLoad <maxRadioLoad> 2.4g minClientThroughput <minClientThroughput>5 g minClientCount <minClientCount>...
Page 110 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# do Executes the do command. Type: Privileged ruckus(config-domain-zone)# dos- <dosBarringPeriod>: DoS Enables DoS (Denial-of-service) protection protection period protection. Type: Privileged <dosBarringThreshold>: DoS protection threshold <dosBarringCheckPeriod...
Page 111 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# <name> Creates or updates the WISPr hotspot configuration. hotspot Type: Privileged ruckus(config-domain-zone)# <name> Creates or updates the venue profile for hotspot release 2 hotspot20-venue-profile configuration.
Page 112 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# Enables mesh networking. mesh Type: Privileged ruckus(config-domain-zone)# <name> Sets the mesh name (ESSID). mesh-name Type: Privileged ruckus(config-domain-zone)# <mesh-passphrase> Sets the mesh passphrase. mesh-passphrase Type: Privileged ruckus(config-domain-zone)#...
Page 113 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# no band-balancing Disables and deletes commands. Type: Privileged block-client bonjour-fencing bonjour-fencing-policy bonjour-gateway bonjour-policy channel-select-mode client-admission-control <2.4g> <5g> client-isolation-whitelist description device-policy dfs-channel diffserv dos-protection...
Page 114 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# no mesh Disables and deletes commands. Type: Privileged roam smart-mon smart-roam-disconnect- event syslog-enabled timezone-dst usb-software venue-code venue-profile vlan-pooling web-authentication wechat wlan <name>...
Page 115 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# [ disable | enable ] - Sets the report rogue access point. rogue-ap-detection Disables or enables rogue access points Type: Privileged report-all [ disable | enable ] - Enables or disables all rogue devices...
Page 116 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# interval <value> Sets the smart monitor interval. smart-mon threshold <value> Type: Privileged ruckus(config-domain-zone)# Enables smart roam disconnect event. smart-roam-disconnect-event Type: Privileged ruckus(config-domain-zone)# Enables the external syslog server for APs for the specified zone.
Page 117 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# System - Follows the Sets the timezone for zone. timezone controller time zone setting Type: Privileged System [ <time zone> ] Select the time zone from system database User-defined [ <time zone...
Page 118 Configuration Commands (a - d) domain Table 37. Commands related to ruckus(config-domain-zone) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone)# <name> Sets the venue profile. venue-profile Type: Privileged ruckus(config-domain-zone)# Enables the overlapping of VLAN pooling. vlan-overlapping Type: Privileged ruckus(config-domain-zone)# 2.4g ${value} Sets the weak bypass threshold of the client load balancing.
Page 119 Configuration Commands (a - d) domain Table 38 lists the related domain-zone-aaa configuration commands. Table 38. Commands related ruckus(config-domain-zone-aaa) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-aaa)# Enables the admin domain name. admin-domain Type: Privileged ruckus(config-domain-zone-aaa)# <admin-domain> Creates or updates the admin domain.
Page 120 Configuration Commands (a - d) domain Table 38. Commands related ruckus(config-domain-zone-aaa) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-aaa)# Enables the global catalog support. global-catalog Type: Privileged ruckus(config-domain-zone-aaa)# Displays the help. help Type: Privileged ruckus(config-domain-zone-aaa)# <ip> Set IP addresses of primary RADIUS server.
Page 121 Configuration Commands (a - d) domain Table 38. Commands related ruckus(config-domain-zone-aaa) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-aaa)# <username> Tests the RADIUS server based on the user credentials and protocol test <password> [PAP | settings. CHAP] Type: Privileged ruckus(config-domain-zone-aaa)# Tests the accounting server.
Page 122 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- 2.4g [<channels | all>]: Set channel range. group)# channel-range 2.4GHz radio Type: Privileged 5g indoor [<channels | all>]: 5GHz radio 5g outdoor [<channels | all>]: 5GHz radio ruckus(config-domain-zone-ap-...
Page 123 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- 2.4g minClientThroughput Enables the client admission group)# client-admission-control <minClientThroughput>: control. Type: Privileged Min Client Throughput (Default: 0.0Mbps) 5g minClientCount <minClientCount> Min Client Count (Default: 5g maxRadioLoad <maxRadioLoad>...
Page 124 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- <ap-model> 5g [ disable | Sets the external antenna for group)# external-antenna enable ] specific AP model. Type: Privileged <ap-model> 5g gain <gain>...
Page 125 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- <ap-model> Sets the LED mode for specific AP group)# led-mode model. Type: Privileged ruckus(config-domain-zone-ap- <ap-model> [ enable | Sets the LLDP for a specific AP group)# lldp disable ] model.
Page 126 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- ani-ofdm-level Disables / deletes the group)# no configuration settings. channel 2.4g Type: Privileged channel 5g indoor channel 5g outdoor channel-evaluation- interval channel-select-mode channel-range...
Page 127 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- override-ap-mgmt-vlan Disables / deletes the group)# no configuration settings. override-channel-select- Type: Privileged mode override-client- admission-control override-lbs override-zone-location override-zone-location- additional-info poe-operating-mode poe-out port-setting radio-band...
Page 128 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- Overrides the location based group)# override-lbs service to zone settings. Type: Privileged ruckus(config-domain-zone-ap- Overrides the zone location group)# override-zone-location setting. Type: Privileged ruckus(config-domain-zone-ap- Overrides the zone location...
Page 129 Configuration Commands (a - d) domain Table 39. Commands related to ruckus(config-domain-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- <ap-model>:AP model Sets AP USB software package group)# usb-software name for a specific AP model Type: Privileged ruckus(config-domain-zone-ap- <name>: Venue profile Sets the venue profile.
Page 130 Configuration Commands (a - d) domain Table 41 lists the related domain-zone-ap-group-lldp configuration commands. Table 41. Commands related to ruckus(config-domain-zone-ap-group lldp) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- <seconds> Sets the LLDP advertise interval in group-lldp)# lldp-ad-interval seconds from the range 1 to 300. Type: Privileged ruckus(config-domain-zone-ap- <seconds>...
Page 131 Configuration Commands (a - d) domain Table 42. Commands related to ruckus(config-domain-zone-ap-group-port-setting) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- Ends the current configuration group-port-setting)# end session and returns to the privileged EXEC mode. Type: Privileged ruckus(config-domain-zone-ap- Exits from the EXEC. group-port-setting)# exit Type: Privileged ruckus(config-domain-zone-ap-...
Page 132 Configuration Commands (a - d) domain Table 43 lists the related domain-zone-ap-model configuration commands. Table 43. Commands related to ruckus(config-domain-zone-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- Executes the do command. model)# do Type: Privileged ruckus(config-domain-zone-ap- Ends the current configuration model)# end session and returns to privileged EXEC mode.
Page 133 Configuration Commands (a - d) domain Table 43. Commands related to ruckus(config-domain-zone-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- Enables the status of led. model)# led Type: Privileged ruckus(config-domain-zone-ap- Sets the led mode description model)# led-mode Type: Privileged ruckus(config-domain-zone-ap- Enables the Link Layer Discovery model)# lldp Protocol (LLDP).
Page 134 Configuration Commands (a - d) domain Table 43. Commands related to ruckus(config-domain-zone-ap-model) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- ext-ant Disables or deletes the settings model)# no that have been configured. internal-heater Type: Privileged lan1 lan2 lan3 lan4 lan5 lldp lldp-mgmt poe-operating-mode...
Page 135 Configuration Commands (a - d) domain Table 44 lists the related domain-zone-ap-model-lan1 configuration commands. Table 44. Commands related to ruckus(config-domain-zone-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- <8021x-type> Sets the 802.1x. model-lan1)# 8021x Type: Privileged ruckus(config-domain-zone-ap- <acct-service> Sets the accounting service model-lan1)# acct-service configurations.
Page 136 Configuration Commands (a - d) domain Table 44. Commands related to ruckus(config-domain-zone-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- <profile>: Ethernet Port Sets the Ethernet Port profile. model-lan1)# profile profile Type: Privileged ruckus(config-domain-zone-ap- Sets the supplicant. model-lan1)# supplicant custom <username> Type: Privileged <password>...
Page 137 Configuration Commands (a - d) domain Table 45. Commands related to ruckus(config-domain-zone-ap-registration-rule) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-ap- Displays the help. registration-rule)# help Type: Privileged ruckus(config-domain-zone-ap- <ip> <ip> Sets the IP address range from and registration-rule)# ip-range to IP address. Type: Privileged ruckus(config-domain-zone-ap- <tag>...
Page 138 Configuration Commands (a - d) domain Table 47 lists the related domain-zone-bonjour-fencing-policy configuration commands. Table 47. Commands related to ruckus(config-domain-zone-bonjour-fencing-policy) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <text> Sets the description. bonjour-fencing-policy)# description Type: Privileged ruckus(config-domain-zone- description Sets to delete sub commands. bonjour-fencing-policy)# no rule <rule index>...
Page 139 Configuration Commands (a - d) domain Table 49 lists the related domain-zone- client-isolation-whitelist configuration commands. Table 49. Commands related to ruckus(config-domain- client-isolation-whitelist ) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-client- Enables the auto whitelist. Each isolation-whitelist)# auto entry must have an IP address in order to enable auto whitelist.
Page 140 Configuration Commands (a - d) domain Table 50. Commands related to ruckus(config-domain-zone-device-policy) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Ends the current configuration device-policy)# end session and returns to privileged EXEC mode. Type: Privileged ruckus(config-domain-zone- Displays the help. device-policy)# help Type: Privileged ruckus(config-domain-zone- <device type>...
Page 141 Configuration Commands (a - d) domain Table 51. Commands related to ruckus (config-domain-zone-device-policy-policy rule) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- [ <Device Type> ] Sets the device type. device-policy-policy-rule)# type Type: Privileged ruckus(config-domain-zone- [ <Rate Limiting> ] Sets the uplink rate limiting. device-policy-policy-rule)# uplink Rate limiting (mbps) Type: Privileged...
Page 142 Configuration Commands (a - d) domain Table 52. Commands related to ruckus(config-domain-zone-diffserv) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- description Disables various options. diffserv)# no downlink-diffserv Type: Privileged preserved-diffserv uplink-diffserv ruckus(config-domain-zone- <value> Adds the preserved diffserv diffserv)# preserved-diffserv number. Type: Privileged ruckus(config-domain-zone- <value>...
Page 143 Configuration Commands (a - d) domain Table 53. Commands related to ruckus(config-domain-ethernet-port-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Exits from the EXEC. ethernet-port-profile )# exit Type: Privileged ruckus(config-domain-zone- Ends the current configuration ethernet-port-profile )# end session and returns to the privileged EXEC mode.
Page 144 Configuration Commands (a - d) domain Table 53. Commands related to ruckus(config-domain-ethernet-port-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Enables tunnel. ethernet-port-profile )# tunnel Type: Privileged ruckus(config-domain-zone- Sets the port type. ethernet-port-profile )# type Type: Privileged ruckus(config-domain-zone- <vlan-members> Sets the VLAN members. ethernet-port-profile )# vlan- members Type: Privileged...
Page 145 Configuration Commands (a - d) domain Table 54. Commands related to ruckus (config-zone-guest-access) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Exits from the EXEC. guest-access)# exit Type: Privileged ruckus(config-domain-zone- <minutes> Sets the grace period. guest-access)# grace-period Type: Privileged ruckus(config-domain-zone- Displays the help.
Page 146 Configuration Commands (a - d) domain Table 54. Commands related to ruckus (config-zone-guest-access) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Sets the terms and conditions for guest-access)# terms-and- the web portal. conditions Type: Privileged ruckus(config-domain-zone- Sets the title for the web portal. guest-access)# title Type: Privileged Table 55...
Page 147 Configuration Commands (a - d) domain Table 55. Commands related to ruckus(config-domain-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Sets the portal language. hotspot)# language Type: Privileged ruckus(config-domain-zone- <location-id> Sets the location ID. hotspot)# location-id Type: Privileged ruckus(config-domain-zone- <name> Sets the location name.
Page 148 Configuration Commands (a - d) domain Table 55. Commands related to ruckus(config-domain-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Shows the terms and conditions. hotspot)# show-terms-conditions Type: Privileged ruckus(config-domain-zone- none Sets the smart client support. hotspot)# smart-client-support enable Type: Privileged only <instructions>...
Page 149 Configuration Commands (a - d) domain Table 56. Commands related to ruckus(config-domain-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Ends the current configuration hotspot20-venue-profile)# end session and returns to the privileged EXEC mode. Type: Privileged ruckus(config-domain-zone- Exits from the EXEC. hotspot20-venue-profile)# exit Type: Privileged ruckus(config-domain-zone-...
Page 150 Configuration Commands (a - d) domain Table 56. Commands related to ruckus(config-domain-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- business [ unspecified | Sets the venue category. hotspot20-venue-profile) police-station | attorney- office | professional-office Type: Privileged | research-and- development-facility |doctor-or-dentist-office | fire-station | post-office | bank ]...
Page 151 Configuration Commands (a - d) domain Table 56. Commands related to ruckus(config-domain-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- residential [ unspecified | Sets the venue category. hotspot20-venue-profile) private-residence | hotel- or-motel | dormitory | Type: Privileged boarding-house ] storage unspecified utility-and-miscellaneous unspecified...
Page 152 Configuration Commands (a - d) domain Table 56. Commands related to ruckus(config-domain-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- [ link-up | link-test | link- Sets the link status. hotspot20-venue-profile)# wan- down ] link-status Type: Privileged ruckus(config-domain-zone- <duration> Sets the load measurement duration.
Page 153 Configuration Commands (a - d) domain Table 57. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config--domain-zone- <url> Sets the ASRA DNS redirection. hotspot20-wlan-profile)# asra- dns-redirect Type: Privileged ruckus(config--domain-zone- Sets the ASRA HTTP redirection. hotspot20-wlan-profile)# asra- http-redirect Type: Privileged ruckus(config--domain-zone- <ssid>...
Page 154 Configuration Commands (a - d) domain Table 57. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config--domain-zone- [ pptp | http | voip-6 | Sets the connection capabilities. hotspot20-wlan-profile)# connect- ipsec-vpn | ikev2 | ftp | tls pptp: Protocol Number:6 capabilities | voip-17 | icmp | ssh | esp...
Page 155 Configuration Commands (a - d) domain Table 57. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config--domain-zone- [ pptp | http | voip-6 | ssh: Protocol Number:6 Port:22 Protocol Name: SSH hotspot20-wlan-profile)# connect- ipsec-vpn | ikev2 | ftp | tls capabilities | voip-17 | icmp | ssh | esp ] [ open | unknown |...
Page 156 Configuration Commands (a - d) domain Table 57. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <identityProvider> default Sets the identity providers. hotspot20-wlan-profile)# identity- providers Type: Privileged ruckus(config-domain-zone- enable Enables the specified WLAN with hotspot20-wlan-profile)# internet- Internet connectivity.
Page 157 Configuration Commands (a - d) domain Table 57. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <name> Sets the operator name. hotspot20-wlan-profile)# operator Type: Privileged Table 58 lists the related domain-zone-hotspot20-wlan-profile-cust-connect-capa- bilities configuration commands. Table 58. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile-cust- connect-capabilities) Syntax and Type Parameters (if any)
Page 158 Configuration Commands (a - d) domain Table 58. Commands related to ruckus(config-domain-zone-hotspot20-wlan-profile-cust- connect-capabilities) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- [ closed | unknown | open] Sets the status. hotspot20-wlan-profile-cust- connect-capabilities) status Type: Privileged Table 59 lists the related domain-zone-l2-acl configuration commands. Table 59.
Page 159 Configuration Commands (a - d) domain Table 60 lists the related domain-zone-web-authentication configuration commands. Table 60. Commands related to ruckus (config-domain-zone-web-authentication) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-web- <text> Sets the description. authentication)# description Type: Privileged ruckus(config-domain-zone-web- <minutes> Sets the grace period. authentication)# grace-period Type: Privileged ruckus(config-domain-zone-web-...
Page 160 Configuration Commands (a - d) domain Table 61. Commands related to ruckus(config-domain-zone--wechat) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <text> Sets the DNAT destination. wechat)# dnat-destination Type: Privileged ruckus(config-domain-zone- <source> <dest> Sets the source and destination wechat)# dnat-port-mapping port for DNAT mapping. Type: Privileged ruckus(config-domain-zone- Executes the do command.
Page 161 Configuration Commands (a - d) domain Table 62 lists the related domain-zone-wlan configuration commands. Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Enables AAA VLAN override. wlan)# aaa-vlan-override Type: Privileged ruckus(config-domain-zone- Enables tunnel WLAN traffic to the controller.
Page 162 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Sets the authentication type. wlan)# auth-type Type: Privileged ruckus(config-domain-zone- [ 5.5mbps | 24mbps | Sets the BSS minimum rate. wlan)# bss-minrate 12mbps | 1mbps | 2mbps Type: Privileged ruckus(config-domain-zone-...
Page 163 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Disables downstream group- address frame forwarding. wlan)# dgaf Type: Privileged ruckus(config-domain-zone- Enables DHCP option 82. wlan)# dhcp-option-82 Type: Privileged ruckus(config-domain-zone- [ ruckus-gre | soft-gre ] Enables DHCP option 82 format options.
Page 164 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Sets the DPSK expiration effective type. wlan)# dpsk-effective-type Type: Privileged ruckus(config-domain-zone- Sets the DPSK expiration. wlan)# dpsk-expiration Type: Privileged ruckus(config-domain-zone- <number>: key length Sets the DPSK length.
Page 165 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Sets the encryption algorithm. wlan)# enc-algorithm Type: Privileged ruckus(config-domain-zone- Sets the encryption method. wlan)# enc-method Type: Privileged ruckus(config-domain-zone- Sets the MFP. wlan)# enc-mfp Type: Privileged ruckus(config-domain-zone-...
Page 166 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- timeout <seconds> Sets the timeout for DHCP in seconds. wlan)# force-dhcp timeout: Sets the Type: Privileged disconnect client timeout interval <seconds>: Sets the disconnect client timeout in intervals of 5 - 15...
Page 167 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <name> Sets the hotspot 2.0 configuration. wlan)# hotspot2 Type: Privileged ruckus(config-domain-zone- Enables the hotspot 2.0 device registration from the guest portal. wlan)# hotspot20-osu-support Type: Privileged ruckus(config-domain-zone-...
Page 168 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- aaa-vlan-override Disables or deletes the configuration settings. wlan)# no access-network Type: Privileged acct-delay-time acct-service acct-service-use-proxy acct-ttg-session auth-service-use-proxy bss-minrate bypass-cna calea client-fingerprinting client-tx-rx-statistics device-policy...
Page 169 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- ofdm-only (Orthogonal Disables or deletes the configuration settings. wlan)# no Frequency Division Multiplexing) Type: Privileged okc-support onboarding-auth-service onboarding-auth-service- use-proxy pmk-caching proxy-arp qinq-vlan qos-map-enable...
Page 170 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <service-name> local Sets the onboarding authentication service. wlan)# onboarding-auth-service <realm> Type: Privileged <service-name> remote <realm> <service-name> local <realm> never <service-name> local <realm>...
Page 171 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <name> Sets the onboarding portal. wlan)# onboarding-portal Type: Privileged ruckus(config-domain-zone- Sets the operator realm. wlan)# operator-realm Type: Privileged ruckus(config-domain-zone- Enables the PMK caching support. wlan)# pmk-caching-support Type: Privileged ruckus(config-domain-zone-...
Page 172 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- [ sz-mgmt-ip | disabled | Sets the RADIUS NAS IP type. wlan)# radius-nas-ip-type user | sz-control-ip ] Type: Privileged ruckus(config-domain-zone- <times>...
Page 173 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- Enables support for 802.11d. wlan)# support-802-11d Type: Privileged ruckus(config-domain-zone- Enables support for 802.11k neighbor reports. wlan)# support-802-11k Type: Privileged ruckus(config-domain-zone- Enables 802.11r fast BSS transition.
Page 174 Configuration Commands (a - d) domain Table 62. Commands related to ruckus(config-domain-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone- <name> WeChat services wlan)# wechat Type: Privileged ruckus(config-domain-zone- Sets the wireless client Isolation. wlan)# wireless-client-isolation Type: Privileged ruckus(config-domain-zone- [ <Whitelist Name> ] Sets the wireless client Isolation whitelist.
Page 175 Configuration Commands (a - d) domain Table 63. Commands related to ruckus(config-domain-zone-wlan-qos-map) Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-wlan- Sets the exception values for DSCP. qos-map)# excp-dscp-values Type: Privileged ruckus(config-domain-zone-wlan- enable Disables the commands. qos-map)# no excp-dscp-values Type: Privileged Table 64 lists the related domain-zone-wlan-group configuration commands.
Page 176 Configuration Commands (a - d) domain Table 64. Commands related to ruckus(config-domain-zone-wlan-group). Syntax and Type Parameters (if any) Description ruckus(config-domain-zone-wlan- <name> vlan <vlanTag> Sets a WLAN in this group or overrides VLAN setting. group)# wlan nasid <nasid> Type: Privileged <name> nasid <nasid> vlan <vlanTag>...
Page 177: Dp-Group
Configuration Commands (a - d) dp-group dp-group To enable and set the data plane grouping, use the following command. ruckus(config)# dp-mac-group <dp1-mac>, <dp2-mac> Syntax Description This command uses the following syntax: <dp-mac-group>: Data plane groups defined as DP MAC addresses in a group. For example, 3 data plane groups are configured as <dp1-mac>,<dp2-mac>...
Page 178: Configuration Commands (E - R)
Configuration Commands (e - r) Configuration Commands (e - r) This chapter describes the commands that you can use to configure, enable, and disable various controller components. The following table lists the commands. NOTE: For easy access and reading, the configuration chapter has been split into 3 chapters based on the alphabetical order of commands.
Page 179 Configuration Commands (e - r) Table 66. Configuration commands no ap-control- no ap-zone- no auth-profile no bridge- no calea-mac mgmt-tos aggregate profile no calea- no cert-store no cls-sess no control- no data-plane server-ip msisdn plane no diameter- no dns- no domain no dp-group no eap-aka remote-service server-service...
Page 180: Eap-Aka
Configuration Commands (e - r) eap-aka eap-aka To setup the EAP-AKA configuration, use the following command. ruckus(config)# eap-aka <enable> Syntax Description This command uses the following syntax: enable: Enable EAP-AKA Default This command has no default settings. Command Mode Config Example ruckus(config)# eap-aka enable Related Commands...
Page 181 Configuration Commands (e - r) eap-aka Table 67. Commands related to ruckus(config-eap-aka) Syntax and Type Parameters (if any) Description ruckus(config-eap-aka)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode. ruckus(config-eap-aka)# exit Exits from the EXEC. Type: Privileged ruckus(config-eap-aka)# help Displays the help.
Page 182: Eap-Sim
Configuration Commands (e - r) eap-sim eap-sim To setup the EAP-SIM configuration, use the following command. ruckus(config)# eap-sim <enable> Syntax Description This command uses the following syntax: enable: Enable EAP-SIM Default This command has no default settings. Command Mode Config Example ruckus(config)# eap-sim enable Related Commands...
Page 183 Configuration Commands (e - r) eap-sim Table 68. Commands related to ruckus(config-eap-sim) Syntax and Type Parameters (if any) Description ruckus(config-eap-sim)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode. ruckus(config-eap-sim)# exit Exits from the EXEC. Type: Privileged ruckus(config-eap-sim)# help Displays the help.
Page 184: Encrypt-Mac-Ip
Configuration Commands (e - r) encrypt-mac-ip encrypt-mac-ip To enable encryption of MAC and IP address, use the following command. ruckus(config)# encrypt-mac-ip Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# encrypt-mac-ip Successful operation...
Page 185: End
Configuration Commands (e - r) To end the current session and returns to privileged EXEC mode, use the following command. ruckus(config)# end Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# end...
Page 186: Eth-Port-Validate-One-Trunk
Configuration Commands (e - r) eth-port-validate-one-trunk eth-port-validate-one-trunk To update the validator for an AP with at least one trunk port, use the following command. ruckus(config)# eth-port-validate-one-trunk Syntax Description This command has the following keywords: disable: Disable the validator for the AP with at least one trunk port enable: Enable the validator for the AP with at least one trunk port Default This command has no default settings.
Page 187: Event Db-Persistence
Configuration Commands (e - r) event db-persistence Related Commands Table 69 lists the related event configuration commands. Table 69. Commands related to ruckus(config-event) Syntax and Type Parameters (if any) Description ruckus(config-event)# db- Enables the data blade persistence for the event. persistence Type: Privileged ruckus(config-event# do...
Page 188 Configuration Commands (e - r) event db-persistence Command Mode Config Example ruckus(config)# event db-persistence Event Code Category Type Description Severity SNMP Email DB Persistence --------- ----------- --------------- ----------------------- 1 103 AP Communication AP status changed to Managed This event occurs when AP is appro Informational Enabled Enabled Enabled by the SCG.
Page 189: Event Email
Configuration Commands (e - r) event email event email To enable event triggers for selected email notification, use the following command. ruckus(config)# event email <eventCode> Syntax Description This command has no arguments or keywords. Command Mode Config Example ruckus(config)# event email 305, 214, 113 event snmp-trap To enable the events to trigger the SNMP trap, use the following command.
Page 190: Event-Email
Configuration Commands (e - r) event-email event-email To setup the event to email services, use the following command. ruckus(config)# event-email <eventCode> Syntax Description This command has no arguments or keywords. Command Mode Config Example ruckus(config)# event-email ruckus(config-event-email)# Related Commands Table 70 lists the related event-email configuration commands.
Page 191: Event-Threshold
Configuration Commands (e - r) event-threshold event-threshold To update the event threshold configuration, use the following command. ruckus(config)# event-threshold <threshold> Syntax Description This command has no arguments or keywords. Command Mode Config Example ruckus(config)# event-threshold thres ruckus(config-event-threshold)# Related Commands Table 71 lists the related event-threshold configuration commands.
Page 192: Exit
Configuration Commands (e - r) exit exit To exit from the EXEC, use the following command. ruckus(config)# exit Syntax Description This command has no arguments or keywords. Command Mode Config Example ruckus(config)# exit ftp-server To update the FTP server for uploading reports configuration, use the following command.
Page 193 Configuration Commands (e - r) ftp-server ruckus(config-ftp-server)# exit ruckus(config)# Related Commands Table 72 lists the related ftp-server commands. Table 72. Commands related to ruckus(config-ftp-server) Syntax and Type Parameters (if any) Description ruckus(config-ftp-server)# do Executes the do command. Type: Privileged ruckus(config-ftp-server)# enable Enable for uploading reports to the FTP server.
Page 194: Ftp-Test
Configuration Commands (e - r) ftp-test Table 72. Commands related to ruckus(config-ftp-server) Syntax and Type Parameters (if any) Description ruckus(config-ftp-server)# test Test the FTP settings. Type: Privileged ruckus(config-ftp-server)# <username> Sets the user name. username Type: Privileged ftp-test To test the FTP server connection, use the following command. ruckus(config)# ftp-test <name>...
Page 195: Flexivpn
Configuration Commands (e - r) flexiVpn flexiVpn To create or update flexi vpn roaming profile configuration, use the following command. ruckus(config)# flexiVpn NOTE: This command is applicable to vSZ-H. Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode config Example...
Page 196: Gateway-Advance
Configuration Commands (e - r) gateway-advance Table 73. Commands related to ruckus(config-flexiVpn)#) Syntax and Type Parameters (if any) Description ruckus(config-flexiVpn)# no <enable > Disables the flexi vpn settings. Type: Privileged gateway-advance To set the gateway server advance options, use the following command. ruckus(config)# gateway-advance Syntax Description This command has no arguments or keywords...
Page 197 Configuration Commands (e - r) gateway-advance Table 74. Commands related to ruckus(config-gateway-advance) Syntax and Type Parameters (if any) Description ruckus(config-gateway-advance)# Ends the current configuration session and return to privileged EXEC mode. Type: Privileged ruckus(config-gateway-advance)# Exits from the EXEC. exit Type: Privileged ruckus(config-gateway-advance)# <number>...
Page 198: Ggsn-Service
Configuration Commands (e - r) ggsn-service Table 74. Commands related to ruckus(config-gateway-advance) Syntax and Type Parameters (if any) Description ruckus(config-gateway-advance)# Include TAI in GTPV2 messages tai-in-gtpv2-msg Type: Privileged ggsn-service To create or update the APN resolution to GGSN / PGW configuration, use the following command.
Page 199 Configuration Commands (e - r) ggsn-service request-timer <seconds> request-timer: Sets the echo request timer in seconds <seconds>: Echo request timeout response-timer <seconds> response-timer: Sets the echo response timer in seconds <seconds>: Echo response timeout retry <number> retry: Sets the number of retries <number>: Number of retries Default This command has no default settings.
Page 200: Help
Configuration Commands (e - r) help Related Commands Table 75 lists the related ggsn-service-apn configuration commands. Table 75. Commands related to ruckus(config-ggsn-service-apn) Syntax and Type Parameters (if any) Description ruckus(config-ggsn-service-apn)# <ip> Sets the GGSN IP address. Type: Privileged ruckus(config-ggsn-service-apn)# Executes the do command. Type: Privileged ruckus(config-ggsn-service-apn)# Ends the current configuration...
Page 201: Hlr-Mnc-Ndc
Configuration Commands (e - r) hlr-mnc-ndc hlr-mnc-ndc To setup the HLR service MNC to NDC mapping configuration, use the following command. ruckus(config)# hlr-mnc-ndc Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# hlr-mnc-ndc 345 346 679...
Page 202: Hlr-Service
Configuration Commands (e - r) hlr-service Table 76. Commands related to ruckus(config-hlr-mnc-ndc) Syntax and Type Parameters (if any) Description ruckus(config-hlr-mnc-ndc)# ndc <ndc> Sets the network destination code. Type: Privileged hlr-service To setup the HLR service MNC to NDC mapping configuration, use the following command.
Page 203 Configuration Commands (e - r) hlr-service Table 77 lists the related hlr-service configuration commands. Table 77. Commands related to ruckus(config-hlr-service) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service)# auth- Enables authorization caching. caching Type: Privileged ruckus(config-hlr-service)# auth- [version3 | version2 ] Sets the authorization MAP version.
Page 204 Configuration Commands (e - r) hlr-service Table 77. Commands related to ruckus(config-hlr-service) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service)# dest- [ 3 | 4 | 1 | 5 | 2 ] where Sets the destination address indicator. nature-addr-indicator Type: Privileged 3: Reserved for National 4: National Significant Number...
Page 205 Configuration Commands (e - r) hlr-service Table 77. Commands related to ruckus(config-hlr-service) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-hlr-service)# <friendly-name> Sets the HLR service friendly friendly-name name. Type: Privileged ruckus(config-hlr-service)# gt- <point-code>...
Page 206 Configuration Commands (e - r) hlr-service Table 77. Commands related to ruckus(config-hlr-service) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service)# sctp <ip> Sets the SCTP association to core network configuration. Type: Privileged ruckus(config-hlr-service)# sgsn- <sgsn-isdn-address> Sets the SGSN ISDN address. isdn-addr Type: Privileged ruckus(config-hlr-service)# source-...
Page 207 Configuration Commands (e - r) hlr-service Table 78 lists the related hlr-service-sccp-gtt configuration commands. Table 78. Commands related to ruckus(config-hlr-service-sccp-gtt) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service-sccp- [ 2 | 1 ] Sets the address indicator. gtt)# addr-indicator 2: Route on SSN Type: Privileged 1: Route on GT ruckus(config-hlr-service-sccp-...
Page 208 Configuration Commands (e - r) hlr-service Table 78. Commands related to ruckus(config-hlr-service-sccp-gtt) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service-sccp- [ 3 | 2 | 1 | 5 | 4 ] Sets the destination nature of address indicator to: gtt)# nature-addr-indicator 3: Reserved for national use Type: Privileged 2: Subscriber number...
Page 209 Configuration Commands (e - r) hlr-service Table 79 lists the related hlr-service- sctp configuration commands. Table 79. Commands related to ruckus(config-hlr-service-sctp) Syntax and Type Parameters (if any) Description ruckus(config-hlr-service-sctp)# <point-code> Sets the point codes. adj-point-code <point-code-1> <point- Type: Privileged code-2> <point-code-3> ruckus(config-hlr-service-sctp)# <port>...
Page 210: Hlr-System-Wide
Configuration Commands (e - r) hlr-system-wide hlr-system-wide To setup the HLR system wide configuration, use the following command. ruckus(config)# hlr-system-wide Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# hlr-system-wide Related Commands Table 80...
Page 211: Hostname
Configuration Commands (e - r) hostname hostname To change the hostname, use the following command. ruckus(config)# hostname <hostname> Syntax Description This command uses the following syntax: hostname: Changed hostname Default This command has no default settings. Command Mode Config Example ruckus(config)# hostname This command will restart some services.
Page 212 Configuration Commands (e - r) hotspot-profile Related Commands Table 81 lists the related hotspot-profile configuration commands. Table 81. Commands related to ruckus(config-hotspot-profile) Syntax and Type Parameters (if any) Description ruckus(config-hotspot-profile)# <text> Sets the description. description Type: Privileged ruckus(config-hotspot-profile# do Executes the do command. Type: Privileged ruckus(config-hotspot-profile)# Ends the current configuration...
Page 213 Configuration Commands (e - r) hotspot-profile Table 81. Commands related to ruckus(config-hotspot-profile) Syntax and Type Parameters (if any) Description ruckus(config-hotspot-profile)# internal Sets the logon model. logon-url Type: Privileged external <logon-url> <logon-url>: Redirects unauthenticated user to the URL for authentication ruckus(config-hotspot-profile)# Sets the MAC address format.
Page 214 Configuration Commands (e - r) hotspot-profile Table 81. Commands related to ruckus(config-hotspot-profile) Syntax and Type Parameters (if any) Description ruckus(config-hotspot-profile)# none Sets the smart client support. smart-client-support enable Type: Privileged only <instructions> only Only smart client allowed with instructions for enabling users to log on using the Smart Client application...
Page 215: Identity-Provider
Configuration Commands (e - r) identity-provider identity-provider To create or update identity provider configuration, use the following command. ruckus(config)# identity-provider <name> Syntax Description This command uses the following syntax: name: Name of the identity provider Default This command has no default settings. Command Mode Config Example...
Page 216 Configuration Commands (e - r) identity-provider Table 82 lists the related identity-provider configuration commands. Table 82. Commands related to ruckus(config-identity-provider) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider)# Enables accounting. acct-enable Type: Privileged ruckus(config-identity-provider)# Sets the accounting profile. acct-profile Type: Privileged ruckus(config-identity-provider)# Sets the authentication profile.
Page 217 Configuration Commands (e - r) identity-provider Table 82. Commands related to ruckus(config-identity-provider) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider)# <name> Sets the identity provider name. name Type: Privileged ruckus(config-identity-provider)# acct-enable Disables the commands. home-ois Type: Privileged osu-enable plmns realm ruckus(config-identity-provider)# Enables the online signup and osu-enable...
Page 218 Configuration Commands (e - r) identity-provider Table 83. Commands related to ruckus(config-identity-provider-acct-profile) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- Ends the current configuration acct-profile)# end session and returns to privileged EXEC mode. Type: Privileged ruckus(config-identity-provider- Exits from the EXEC. acct-profile)# exit Type: Privileged ruckus(config-identity-provider-...
Page 219 Configuration Commands (e - r) identity-provider Table 84. Commands related to ruckus(config-identity-provider-acct-profile-realm) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- Exits from the EXEC. acct-profile-realm)# exit Type: Privileged ruckus(config-identity-provider- Displays the help. acct-profile-realm)# help Type: Privileged ruckus(config-identity-provider- <name> Sets the realm name. acct-profile-realm)# name Type: Privileged ruckus(config-identity-provider-...
Page 220 Configuration Commands (e - r) identity-provider Table 85 lists the related identity-provider-auth-profile configuration commands. Table 85. Commands related to ruckus(config-identity-provider-auth-profile) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- <seconds> Sets the accounting interim interval for the hosted AAA server. auth-profile)# aaa-interim-acct- interval Type: Privileged ruckus(config-identity-provider-...
Page 221 Configuration Commands (e - r) identity-provider Table 85. Commands related to ruckus(config-identity-provider-auth-profile) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- Ends the current configuration auth- profile)# end session and returns to privileged EXEC mode. Type: Privileged ruckus(config-identity-provider- Exits from the EXEC. auth-profile)# exit Type: Privileged ruckus(config-identity-provider-...
Page 222 Configuration Commands (e - r) identity-provider Table 86 lists the related identity-provider-auth-profile-realm configuration commands. Table 86. Commands related to ruckus(config-identity-provider-auth-profile-realm) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- Sets the authorization method. auth-profile-realm)# auth-method Type: Privileged ruckus(config-identity-provider- RAD_AUTH: Sets the Sets the authentication service.
Page 223 Configuration Commands (e - r) identity-provider Table 87 lists the related identity-provider-osu-enable configuration commands. Table 87. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- <ftp-url> Sets the common language icon. osu-enable)# common-icon Type: Privileged ruckus(config-identity-provider- Executes the do command. osu-enable)# do Type: Privileged ruckus(config-identity-provider-...
Page 224 Configuration Commands (e - r) identity-provider Table 87. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- <service-name> local Sets the OSU authentication osu-enable)# osu-auth-services <realm> services. Type: Privileged <service-name>: Authentication services name local: Local database <realm>: Realm server <service-name>...
Page 225 Configuration Commands (e - r) identity-provider Table 87. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- <service-name> local Sets the OSU authentication osu-enable)# osu-auth-services <realm> month services. <expiration-value> - Type: Privileged Local credential expiration - between 1 and 240 ruckus(config-identity-provider- ${cert}...
Page 226 Configuration Commands (e - r) identity-provider Table 87. Commands related to ruckus(config-identity-provider-osu-enable) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- home-only Sets the provisioning update. osu-enable)# provisioning-update- home-roaming Type: Privileged ruckus(config-identity-provider- <language> <name> Sets the subscription description osu-enable)# service-descr <icon-ftp-url> Type: Privileged <language>...
Page 227 Configuration Commands (e - r) identity-provider Table 88. Commands related to ruckus(config-identity-provider-realms) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- Exits from the EXEC. realms)# exit Type: Privileged ruckus(config-identity-provider- Displays the help. realms)# help Type: Privileged ruckus(config-identity-provider- <name> Sets the realm name. realms)# name Type: Privileged ruckus(config-identity-provider-...
Page 228 Configuration Commands (e - r) identity-provider Table 89. Commands related to ruckus(config-identity-provider-realms-eaps) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- Displays the help. realms-eaps)# help Type: Privileged ruckus(config-identity-provider- [ eap-aka-23 | eap-tls | Sets the EAP method. realms-eaps)# method eap-mschap-v2 | na | eap-aka-50 | md5 | eap- Type: Privileged ttls | reserved | eap-sim |...
Page 229 Configuration Commands (e - r) identity-provider Table 90 lists the related identity-provider-realms-eaps-auth configuration commands. Table 90. Commands related to ruckus(config-identity-provider-realms-eaps-auth) Syntax and Type Parameters (if any) Description ruckus(config-identity-provider- tunneled | credential | Sets the authentication parameter realms-eaps-auth)# info non-eap-inner | expand- type.
Page 230: Interface
Configuration Commands (e - r) interface interface To setup the interface configuration, use the following command. ruckus(config)# interface <cluster> ruckus(config)# interface <control> ruckus(config)# interface <management> ruckus(config)# interface <user-defined <name>> Syntax Description This command has no arguments or keywords. Default cluster <name> cluster: Sets the cluster interface <name>: Name of the cluster control...
Page 231 Configuration Commands (e - r) interface Related Commands • Table 91 lists the related interface configuration commands. • Table 92 lists the related interface-user-defined configuration commands. • Table 93 lists the related interface-management configuration commands Table 91 lists the related interface configuration commands. Table 91.
Page 232 Configuration Commands (e - r) interface Table 91. Commands related to ruckus(config-interface) Syntax and Type Parameters (if any) Description config-interface )# ip ruckus( address dhcp Sets the IP address. Type: Privileged address: Sets IP address of interface dhcp: IP address negotiated by DHCP ipv6-address auto ipv6-address: Sets the...
Page 233 Configuration Commands (e - r) interface Table 92 lists the related interface-user-defined configuration commands. Table 92. Commands related to ruckus(config-interface-user-defined) Syntax and Type Parameters (if any) Description config-interface )# do ruckus( Executes the do command. Type: Privileged ruckus( config-interface )# end Ends the current configuration session and returns to privileged Type: Privileged...
Page 234 Configuration Commands (e - r) interface Table 93 lists the related interface-management configuration commands. Table 93. Commands related to ruckus(config-interface-user-defined) Syntax and Type Parameters (if any) Description config-if )# data-plane ruckus( <name> Updates the dataplane configuration. Type: Privileged ruckus( config-if )# do Executes the do command.
Page 235: Ip Control-Nat
Configuration Commands (e - r) ip control-nat ip control-nat To set the control NAT IP configuration, use the following command. ruckus(config)# ip control-nat Syntax Description This command uses the following syntax: <ip>: The Control NAT IP Default This command has no default settings. Command Mode Config Example...
Page 236: Ip Default-Gateway-Ipv6
Configuration Commands (e - r) ip default-gateway-ipv6 ip default-gateway-ipv6 To setup the default gateway configuration for IPv6, use the following command. ruckus(config)# ip default-gateway-ipv6 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example...
Page 237: Ip Name-Server
Configuration Commands (e - r) ip name-server Example ruckus(config)# ip internal-subnet prefix This command will reboot internal interface, data planes and SMF service. Do you want to continue? ip name-server To setup the name server configuration, use the following command. ruckus(config)# ip name-server <ip>...
Page 238: Ip Route
Configuration Commands (e - r) ip route Example ruckus(config)# ip name-server-ipv6 172.19.13.56 Successful operation ip route To setup the static rule configuration, use the following command. ruckus(config)# ip route <ip> <mask> <ip> <interface> <metric> Syntax Description This command uses the following syntax: <ip>...
Page 239: Ip Separate-Access-Core
Configuration Commands (e - r) ip separate-access-core <interface>: Interface <metric>: Distance metric for this route Default This command has no default settings. Command Mode Config Example ruckus(config)# ip route ipv6 193.12.30.10 193.12.30.20 ip separate-access-core To enable access and core gateway, use the following command. ruckus(config)# ip separate-access-core <enable>...
Page 240: Ip-Support
Configuration Commands (e - r) ip-support ip-support To update IP version support, use the following command. ruckus(config)# ip-support <ipv4-ipv6> <ipv4-only> Syntax Description This command uses the following syntax: ipv4-ipv6: To support both IPv4 and IPv6 versions ipv4-only: To support IPv4 version only Default This command has no default settings.
Page 241 Configuration Commands (e - r) ipsec-profile Related Commands Table 94 lists the related ipsec-profile configuration commands Table 94. Commands related to ruckus(config-ipsec-profile). Syntax and Type Parameters (if any) Description ruckus(config-ipsec-profile)# auth- Sets the authentication type type Type: Privileged ruckus(config-ipsec-profile)# cara- Sets Certificate Management Protocol CA/RA address.
Page 242 Configuration Commands (e - r) ipsec-profile Syntax and Type Parameters (if any) Description ruckus(config-ipsec-profile)# end End the current configuration session and return to privileged Type: Privileged EXEC mode ruckus(config-ipsec-profile)# esp- [ 3des | aes256 | aes192 | Add ESP proposal proposal aes128 | none ] [ md5 | sha512 | sha384 | sha1 |...
Page 243 Configuration Commands (e - r) ipsec-profile Syntax and Type Parameters (if any) Description ruckus(config-ipsec-profile)# esp- Sets the ESP Rekey time. rekeytime Type: Privileged ruckus(config-ipsec-profile)# esp- Set ESP Proposal Type type Type: Privileged ruckus(config-ipsec-profile)# exit Exits from the EXEC mode. Type: Privileged ruckus(config-ipsec-profile)# Sets the Fail Over Check Interval failover-check-interval...
Page 244 Configuration Commands (e - r) ipsec-profile Syntax and Type Parameters (if any) Description ruckus(config-ipsec-profile)# ike- [ 3des | aes256 | aes192 | Adds IKE proposal proposal aes128 ] [ sha1 | md5 | aesxcbc | sha512 | Type: Privileged sha384 | sha256 ] [ prfsha1 | prfmd5 |prfsha256 | prfaescmac | prfaesxcbc | prfsha384 |...
Page 245 Configuration Commands (e - r) ipsec-profile Syntax and Type Parameters (if any) Description • use-integrity-alg: Use integrity ALG • modp1024: MODP1024 • modp8192: MODP8192 • modp6144: MODP6144 • modp768: MODP768 ruckus(config-ipsec-profile)# ike- Sets the IKE Rekey time. rekeytime Type: Privileged ruckus(config-ipsec-profile)# ike- Sets the IKE Proposal type.
Page 246 Configuration Commands (e - r) ipsec-profile Syntax and Type Parameters (if any) Description ruckus(config-ipsec-profile)# no cara-server Disables and deletes commands. Type: Privileged cara-server-path cara-subject-name dpd-delay esp-proposal esp-rekeytime ike-proposal ike-rekeytime ip-compression keep-alive-interval nat-traversal replay-window retry-limit security-gateway ruckus(config-ipsec-profile)# <packet>: Replay window Sets the Replay window. replay-window packets (1 - 32) Type: Privileged...
Page 247: L2Ogre-Profile
Configuration Commands (e - r) l2ogre-profile l2ogre-profile To create or update the L2oGRE profile configuration, use the following command. ruckus(config)# l2ogre-profile <name> Syntax Description This command uses the following syntax: name: L2oGRE profile name Default This command has no default settings. Command Mode Config Example...
Page 248 Configuration Commands (e - r) l2ogre-profile Table 95. Commands related to ruckus(config-l2ogre-profile). Syntax and Type Parameters (if any) Description ruckus(config-l2ogre-profile)# do Executes the do command. Type: Privileged ruckus(config-l2ogre-profile)# end Ends the current configuration session and return to privileged Type: Privileged EXEC mode.
Page 249 Configuration Commands (e - r) l2ogre-profile Table 95. Commands related to ruckus(config-l2ogre-profile). Syntax and Type Parameters (if any) Description ruckus(config-l2ogre-profile)# auto - Auto MTU size Sets the tunnel MTU options. tunnel-mtu <bytes> - Manual MTU Type: Privileged size Table 96 lists the related l2ogre-profile -dhcp-option82 configuration commands.
Page 250: Lbs-Service
Configuration Commands (e - r) lbs-service Table 96. Commands related to ruckus(config- l2ogre-profile -dhcp-option82) configuration Syntax and Type Parameters (if any) Description ruckus(config-l2ogre-profile-dhcp- essid Enables subopt-151 option82)# subtopt151 area-name <name> Type: Privileged ruckus(config-l2ogre-profile-dhcp- [ ap-essid | ue-essid | ue- Enables subopt-2 option82)# subtopt2 mac | ap-mac ] Type: Privileged...
Page 251 Configuration Commands (e - r) lbs-service Related Commands Table 97 lists the related lbs-service configuration command. Table 97. Commands related to ruckus(config-lbs-service). Syntax and Type Parameters (if any) Description ruckus(config-lbs-service)# do Sets the do command. Type: Privileged ruckus(config-lbs-service)# end Ends the current configuration session and returns to the Type: Privileged privileged EXEC mode.
Page 252: Ldap-Service
Configuration Commands (e - r) ldap-service ldap-service To create and update the LDAP service configuration, use the following command. ruckus(config)# ldap-service <name> Syntax Description This command uses the following syntax: name: LDAP service name Default This command has no default settings. Command Mode Config Example...
Page 253 Configuration Commands (e - r) ldap-service Table 98. Commands related to ruckus(config-ldap-service) Syntax and Type Parameters (if any) Description ruckus(config-ldap-service)# base- <domain-name> LDAP Sets the LDAP base domain name. domain-name base domain name. For example: Type: Privileged dc=ldap,dc=com ruckus(config-ldap-service)# <text> Sets the description.
Page 254: License Cloud
Configuration Commands (e - r) license cloud Table 98. Commands related to ruckus(config-ldap-service) Syntax and Type Parameters (if any) Description ruckus(config-ldap-service)# port <port> Sets the port number for LDAP server. Type: Privileged ruckus(config-ldap-service)# <filter> Sets the search filter for LDAP server.
Page 255: License Export
Configuration Commands (e - r) license export license export To export licenses, use the following command. ruckus(config)# license export <ftp-url><name> Syntax Description This command uses the following syntax: ftp-url: License file. FTP URL format is, ftp://<username>:<password>@<ip>/ <file-path> name: Set Control Plane Default This command has no default settings.
Page 256: License Local
Configuration Commands (e - r) license local license local To enable the local license server, use the following command. ruckus(config)# license local <local-server><port> Syntax Description This command uses the following syntax: <local-server>: Set Local License Server IP or Domain name <port>: Set Local License Server port number Default This command has no default settings.
Page 257: Lineman
Configuration Commands (e - r) lineman lineman To setup the workflow URL or to upload the workflow file, use the following command. ruckus(config)# lineman workflow-file <ftp-url> ruckus(config)# lineman workflow-url <ftp-url> Syntax Description This command uses the following syntax: <ftp-url>: Define the FTP URL format Default This command has no default settings.
Page 258 Configuration Commands (e - r) localdb-service Related Commands Table 99 lists the related localdb-service configuration command Table 99. Commands related to ruckus(config-localdb-service). Syntax and Type Parameters (if any) Description ruckus(config-localdb-service)# <text> Sets the description. description Type: Privileged ruckus(config-localdb-service)# do Sets the do command Type: Privileged ruckus(config-localdb-service)# Ends the current configuration...
Page 259: Logging Console
Configuration Commands (e - r) logging console logging console To enable service logging on the console, use the following command. ruckus(config)# logging console cli [ error | info ] cli debug <name> Syntax Description This command uses the following syntax: cli: Enable CLI logging on the console error: Enable CLI logging on the console and change logging level to ERROR info: Enable CLI logging on the console and change logging level to INFO...
Page 260: Lwapp2Scg
Configuration Commands (e - r) lwapp2scg lwapp2scg To update the LWAPP to SCG configurations, use the following command. ruckus(config)# lwapp2scg Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# lwapp2scg Related Commands Table 100...
Page 261 Configuration Commands (e - r) lwapp2scg Table 100. Commands related to ruckus(config-lwapp2scg). Syntax and Type Parameters (if any) Description ruckus(config-lwapp2scg)# end Ends the current configuration session and returns to the Type: Privileged privileged EXEC mode. ruckus(config-lwapp2scg)# exit Exits from the EXEC. Type: Privileged ruckus(config-lwapp2scg)# help Displays the help message.
Page 262 Configuration Commands (e - r) lwapp2scg Table 100. Commands related to ruckus(config-lwapp2scg). Syntax and Type Parameters (if any) Description ruckus(config-lwapp2scg)# policy accept Accept by ACL AP Sets the ACL policy. Use the accept option to uprade list Type: Privileged individual APs as required by MAC accept-all Accept all address or serial number.
Page 263: Mgmt-Acl
Configuration Commands (e - r) mgmt-acl mgmt-acl To create or update the management interface access control list configuration, use the following command. ruckus(config)# mgmt-acl Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example...
Page 264 Configuration Commands (e - r) mgmt-acl Table 101. Commands related to ruckus( config-mgmt-acl) ). Syntax and Type Parameters (if any) Description ruckus(config-mgmt-acl)# no enable Disables various options. Type: Privileged rule ruckus(config-mgmt-acl)# rule <name>: ACL rule name Creates or updates the management interface ACL rule Type: Privileged configuration.
Page 265: Mvno
Configuration Commands (e - r) mvno Table 102. Commands related to ruckus( config-mgmt-acl-rule ). Syntax and Type Parameters (if any) Description ruckus(config-mgmt-acl-rule)# range <ip> <ip>: Sets IP Sets the restriction restriction range restriction with start and end IP addresses Type: Privileged single <ip>: Sets single IP restriction and IP address subnet <ip>...
Page 266 Configuration Commands (e - r) mvno Table 103 lists the related mvno configuration commands. Table 103. Commands related to ruckus(config-mvno) Syntax and Type Parameters (if any) Description ruckus(config-mvno)# admin <name> Adds an administrator account. Type: Privileged ruckus(config-mvno)# admin- <name> Set the RADIUS server for administrators.
Page 267 Configuration Commands (e - r) mvno Table 103. Commands related to ruckus(config-mvno) Syntax and Type Parameters (if any) Description ruckus(config-mvno)# no admin-radius Disables and deletes configuration commands. Type: Privileged capabilities <capabilities-depth-1> <capabilities-depth-2> <capabilities-depth-3> <capabilities-depth-4> <capabilities-depth-5> <capabilities-depth-6> wlan zone ruckus(config-mvno)# wlan <name>...
Page 268 Configuration Commands (e - r) mvno Table 104. Commands related to ruckus(config-mvno-admin) Syntax and Type Parameters (if any) Description ruckus(config-mvno-admin)# <name> Sets the account name. name Type: Privileged ruckus(config-mvno-admin)# <password> Sets the password for user password Type: Privileged ruckus(config-mvno-admin)# <phone> Sets the phone number of the user phone Type: Privileged...
Page 269 Configuration Commands (e - r) mvno Table 105. Commands related to ruckus(config-mvno-admin-radius) Syntax and Type Parameters (if any) Description ruckus(config-mvno-admin- Exits from the EXEC. radius# exit Type: Privileged ruckus(config-mvno-admin- Displays the help. radius)# help Type: Privileged ruckus(config-mvno-admin- <ip> Sets the IP addresses of primary RADIUS server radius)# ip Type: Privileged...
Page 270: No 3Rd-Zone
Configuration Commands (e - r) no 3rd-zone no 3rd-zone To delete the 3rd Party AP zone configurations, use the following command. ruckus(config)# no 3rd-zone <name> Syntax Description This command uses the following syntax: name: 3rd Party AP zone name Default This command has no default settings.
Page 271: No Ad-Service
Configuration Commands (e - r) no ad-service no ad-service To delete the all active service directories, use the following command. ruckus(config)# no ad-service <name> Syntax Description This command uses the following syntax: name: Name of the active service directory to be deleted Default This command has no default settings.
Page 272: No Admin-Radius
Configuration Commands (e - r) no admin-radius no admin-radius To delete RADIUS servers configurations for administrators, use the following command. ruckus(config)# no admin-radius <name> Syntax Description This command uses the following syntax: name: AAA server name Default This command has no default settings. Command Mode Config Example...
Page 273: No Ap Auto-Tagging
Configuration Commands (e - r) no ap no ap To delete the lock or unlock the access point, use the following command. ruckus(config)# no ap <mac> lock Syntax Description This command uses the following syntax: mac: AP MAC address lock: Unlock AP Default This command has no default settings.
Page 274: No Ap-Cert-Check
Configuration Commands (e - r) no ap-cert-check no ap-cert-check To disable the access point certificate check, use the following command. ruckus(config)# no ap-cert-check Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# no ap-cert-check...
Page 275: No Ap-Zone-Aggregate
Configuration Commands (e - r) no ap-zone-aggregate no ap-zone-aggregate To disable the AP Zone aggregation task, use the following command. ruckus(config)# no ap-zone-aggregate Syntax Description This command has no arguments or key words. Default This command has no default settings. Command Mode Config Example...
Page 276: No Bridge-Profile
Configuration Commands (e - r) no bridge-profile no bridge-profile To delete the bridge profile configuration, use the following command. ruckus(config)# no bridge-profile <name> Syntax Description This command uses the following syntax: name: Name of the bridge profile to be deleted. Default This command has no default settings.
Page 277: No Calea-Server-Ip
Configuration Commands (e - r) no calea-server-ip no calea-server-ip To delete all Calea MAC server IP address configuration, use the following command. ruckus(config)# no calea-server-ip Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example...
Page 278: No Cert-Store
Configuration Commands (e - r) no cert-store no cert-store To delete all OSU (Online SignUp) portal profile configuration, use the following command. ruckus(config)# no cert-store <name> ruckus(config)# no csr <name> Syntax Description This command uses the following syntax: cert <name> - Deletes certificate csr <name>...
Page 279: No Cls-Sess Msisdn
Configuration Commands (e - r) no cls-sess msisdn no cls-sess msisdn To delete the session served by current node for the received MSISDN, use the following command: ruckus(config)# no cls-sess msisdn <ms-isdn> Syntax Description msisdn <msisdn>: MSISDN and MSISDN value. The length of MSISDN should be between 10 to15 digits.
Page 280: No Data-Plane
Configuration Commands (e - r) no data-plane no data-plane To disable the STP package bridge of the local dataplane configuration, use the following command. ruckus(config)# no data-plane <name> forward-stp Syntax Description This command uses the following syntax: name: Dataplane name forward-stp: Disables the STP package bridge Default This command has no default settings.
Page 281: No Dns-Server-Service
Configuration Commands (e - r) no dns-server-service no dns-server-service To disable the DNS server service, use the following command. ruckus(config)# no dns-server-service <name> Syntax Description This command uses the following syntax: name: DNS server service name Default This command has no default settings. Command Mode Config Example...
Page 282 Configuration Commands (e - r) no domain zone: Deletes AP zones of a specific domain <name>: AP zone name wlan: Deletes WLANs of a specific AP zone <name>: WLAN name <name> zone <name> aaa <name> <name>: Domain name zone: Deletes AP zones of a specific domain <name>: AP zone name aaa: Deletes AAA servers of a specific AP zone <name>: AAA server name...
Page 283: No Dp-Group
Configuration Commands (e - r) no dp-group <name> zone <name> wlan-group <name> <name>: Domain name zone: Deletes AP zones of a specific domain <name>: AP zone name wlan-group: Delete WLAN groups of a specific AP zone <name>: WLAN group name <name>...
Page 284: No Eap-Aka
Configuration Commands (e - r) no eap-aka Default This command has no default settings. Command Mode Config Example ruckus(config)# no dp-group no eap-aka To disable the EAP_AKA configuration, use the following command. ruckus(config)# no eap-aka <enable> Syntax Description This command uses the following syntax: enable: Disables the EAP-AKA Default This command has no default settings.
Page 285: No Encrypt-Mac-Ip
Configuration Commands (e - r) no encrypt-mac-ip Command Mode Config Example ruckus(config)# no eap-sim enable no encrypt-mac-ip To disable the encryption of MAC and IP address, use the following command. ruckus(config)# no encrypt-mac-ip Syntax Description This command has no arguments or keywords. Default This command has no default settings.
Page 286: No Event
Configuration Commands (e - r) no event Example ruckus(config)# no encrypt-zone-name Do you want to continue to disable (or input 'no' to cancel)? [yes/ no event To disable the trigger to SNMP trap/email configuration, use the following command. ruckus(config)# no event <snmp-trap> <email> <db-persistence> Syntax Description This command uses the following syntax: snmp-trap: Disables the trigger to SNMP trap...
Page 287: No Ggsn-Service
Configuration Commands (e - r) no ggsn-service Example ruckus(config)# no ftp-server ftp1 no ggsn-service To delete GGSN APN resolutions or DNS servers, use the following command. ruckus(config)# no ggsn-service <apn <name>> <dns-server <ip>> Syntax Description This command uses the following syntax: apn <domain-name>...
Page 288: No Hlr-Service
Configuration Commands (e - r) no hlr-service Default This command has no default settings. Command Mode Config Example ruckus(config)# no hlr-mnc-ndc 345 346 679 no hlr-service To delete HLR service configuration, use the following command. ruckus(config)# no hlr-service <name> Syntax Description This command uses the following syntax: hlr-name: HLR service name Default...
Page 289: No Identity-Provider
Configuration Commands (e - r) no identity-provider Command Mode Config Example ruckus(config)# no hotspot-profile hpsp12 no identity-provider To delete all identity provider profile, use the following command. ruckus(config)# no identity-provider <identity-provider ${name}?> | <name> Syntax Description This command uses the following syntax: $name? name: Name of identity provider Default...
Page 290 Configuration Commands (e - r) no ip Command Mode Config Example ruckus(config)# no interface user-defined UD1 no ip To remove all IP address static routes, use the following command. ruckus(config)# no ip <route> <route <dest-network> <network-mask> <next- hop-ip> [ cluster | management | control ]> <name-server secondary> Syntax Description This command uses the following syntax: route: Deletes static routes...
Page 291: No Ipsec-Profile
Configuration Commands (e - r) no ipsec-profile Command Mode Config Example ruckus(config)# no ip route ip 193.12.30.10 255.255.255 10.9.0.254 management no ipsec-profile To delete all IPsec profiles, use the following command. ruckus(config)# no ipsec-profile Syntax Description This command has no arguments or keywords. Default This command has no default settings.
Page 292: No Lbs-Service
Configuration Commands (e - r) no lbs-service Example ruckus(config)# no l2ogre l2g13 no lbs-service To delete the location based service venue name. use the following command. ruckus(config)# no lbs-service <name> Syntax Description This command uses the following syntax: name: LBS venue name Default This command has no default settings.
Page 293: No Lineman
Configuration Commands (e - r) no lineman no lineman To delete the workflow URL, use the following command. ruckus(config)# no lineman <workflowURL> Syntax Description This command uses the following syntax: <workflowURL>: Deletes the workflow URL Default This command has no default settings. Command Mode Config Example...
Page 294: No Network-Traffic-Profile
Configuration Commands (e - r) no mvno no mvno To delete MVNO configurations, use the following command. ruckus(config)# no mvno <name> Syntax Description This command uses the following syntax: name: MVNO name Default This command has no default settings. Command Mode Config Example ruckus(config)# no mvno mv1...
Page 295: No Oauth-Service
Configuration Commands (e - r) no oauth-service no oauth-service To disable the all OAuth servers, use the following command. ruckus(config)# no oauth-service <name> Syntax Description This command uses the following syntax: <name>: OAuth server name Default This command has no default settings. Command Mode Config Example...
Page 296: No Osu-Portal-Profile
Configuration Commands (e - r) no osu-portal-profile no osu-portal-profile To disable all OSU portal profile settings, use the following command. ruckus(config)# no osu-portal <osu-portal-profile ${name}?| <name> Syntax Description This command uses the following syntax: osu-portal ${name}? <name>: OSU profile name Default This command has no default settings.
Page 297: No Radius-Service
Configuration Commands (e - r) no radius-service no radius-service To delete a RADIUS service configuration, use the following command. ruckus(config)# no radius-service <name> Syntax Description This command uses the following syntax: name: Name of the RADIUS service to be deleted. Default This command has no default settings.
Page 298: No Rks-Gre
Configuration Commands (e - r) no rks-gre no rks-gre To delete reports, use the following command. ruckus(config)# no rks-gre <name> Syntax Description This command uses the following syntax: name: Ruckus GRE tunnel profile name Default This command has no default settings. Command Mode Config Example...
Page 299: No Sci-Profile
Configuration Commands (e - r) no sci-profile no sci-profile To delete the SCI profile, use the following command. ruckus(config)# no sci-profile <name> Syntax Description This command uses the following syntax: name: Name of the SCI profile to be deleted enter: Deletes all the SCI profile Default This command has no default settings.
Page 300: No Snmp-V2-Community
Configuration Commands (e - r) no snmp-v2-community no snmp-v2-community To delete SNMPv2 community, use the following command. ruckus(config)# no snmp-v2-community <community> Syntax Description This command uses the following syntax: community: Community name Default This command has no default settings. Command Mode Config Example ruckus(config)# no snmp-v2-community cm2...
Page 301: No Soft-Gre
Configuration Commands (e - r) no soft-gre no soft-gre To delete the oft GRE tunnel profile, use the following command. ruckus(config)# no soft-gre <name> Syntax Description This command uses the following syntax: name: Soft GRE tunnel profile name Default This command has no default settings. Command Mode Config Example...
Page 302: No Ttg-Pdg-Profile
Configuration Commands (e - r) no ttg-pdg-profile no ttg-pdg-profile To delete TTG+PDG profile configurations, use the following command. ruckus(config)# no ttg-pdg-profile <name> Syntax Description This command uses the following syntax: name: TTG PDG profile name Default This command has no default settings. Command Mode Config Example...
Page 303: No User-Group
Configuration Commands (e - r) no user-group no user-group To delete the user group, use the following command. ruckus(config)# no user-group <name> Syntax Description This command uses the following syntax: name: User group name Default This command has no default settings. Command Mode Config Example...
Page 304: No User-Traffic-Profile
Configuration Commands (e - r) no user-traffic-profile no user-traffic-profile To delete all users traffic profiles, use the following command. ruckus(config)# no user-traffic-profile <name> Syntax Description This command uses the following syntax: name: Name of the user traffic profile Default This command has no default settings. Command Mode Config Example...
Page 305 Configuration Commands (e - r) no zone no zone To delete all AP zones, expect staging zone use the following command. ruckus(config)# no zone Syntax Description This command uses the following syntax: <name> ap <ap-mac> <name>: AP zone name ap: Deletes an AP of a specific AP zone <ap-mac>: AP MAC address <name>...
Page 306 Configuration Commands (e - r) no zone <name>: AP Group name <name> wlan-group <name> <name>: AP zone name wlan-group: Delete WLAN Groups of a specific AP Zone <name>: WLAN Group name <name> wlan-scheduler <name> <name>: AP zone name wlan-scheduler: Deletes WLAN scheduler profiles of a specific AP zone <name>: WLAN scheduler name <name>...
Page 307: No Zone-Affinity
Configuration Commands (e - r) no zone-affinity no zone-affinity To delete vSZ-D zone affinity profiles, use the following command. ruckus(config)# no zone-affinity<name> Syntax Description This command uses the following syntax: name: Profile name of the vSZ-D zone affinity Default This command has no default settings. Command Mode Config Example...
Page 308: Node-Affinity-Config
Configuration Commands (e - r) node-affinity-config node-affinity-config To update the node affinity configuration, use the following command. ruckus(config)# node-affinity-config Syntax Description This command has no arguments or keywords. Default This command has the default settings of enable. Command Mode Config Example node-affinity-config ruckus(config)#...
Page 309 Configuration Commands (e - r) node-affinity-config Table 106. Commands related to ruckus(config-node-affinity-config) Syntax and Type Parameters (if any) Description ruckus (config-node-affinity- Displays the help. config)# help Type: Privileged ruckus(config-node-affinity- <enable> Disables node affinity config)# no <profile> Type: Privileged ruckus(config-node-affinity- <name> Creates or updates the node config)# profile affinity profile.
Page 310: Northbound-Authtype
Configuration Commands (e - r) northbound-authtype Table 107. Commands related to ruckus(config-node-affinity-config-profile) Syntax and Type Parameters (if any) Description ruckus (config-node-affinity- Displays the help. config-profile)# help Type: Privileged ruckus(config-node-affinity-config- <name> Sets the node affinity profile profile)# name name. Type: Privileged northbound-authtype Sets the RADIUS authentication type to northbound portal interface, use the following command.
Page 311: Northbound-Portal
Configuration Commands (e - r) northbound-portal northbound-portal Sets the northbound portal configuration, use the following command. ruckus(config)# northbound-portal <password> Syntax Description This command uses the following syntax: password: Password for the northbound portal interface Default This command has no default settings. Command Mode Config Example...
Page 312: Oauth-Service
Configuration Commands (e - r) oauth-service oauth-service To create or update OAuth service configuration, use the following command. ruckus(config)# oauth-service <name> Syntax Description This command uses the following syntax: name: OAuth service name Default This command has no default settings. Command Mode Config Example...
Page 313 Configuration Commands (e - r) oauth-service Table 108. Commands related ruckus(config-oauth-service) Syntax and Type Parameters (if any) Description ruckus(config-oauth-service)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode. ruckus(config-oauth-service)# exit Exits from the EXEC. Type: Privileged ruckus(config-oauth-service)# <user-role>...
Page 314: Operator-Profile
Configuration Commands (e - r) operator-profile operator-profile To create or update WiFi operator profile configuration, use the following command. ruckus(config)# operator-profile <name> Syntax Description This command uses the following syntax: name: Operator profile name Default This command has no default settings. Command Mode Config Example...
Page 315: Osu-Portal-Profile
Configuration Commands (e - r) osu-portal-profile Table 109. Commands related ruckus(config-operator-profile) Syntax and Type Parameters (if any) Description ruckus(config-operator-profile)# <language> <names> Sets the friendly name as seen by the end user. friendly-names Type: Privileged ruckus(config-operator-profile)# Displays the help. help Type: Privileged ruckus(config-operator-profile)# <name>...
Page 316 Configuration Commands (e - r) osu-portal-profile Example ruckus(config)# osu-portal-profile orangeosu ruckus(config-osu-portal-profile)# Related Commands Table 110 lists the related osu-portal-profile configuration commands. Table 110. Commands related ruckus(config-osu-portal-profile) Syntax and Type Parameters (if any) Description ruckus(config-osu-portal-profile)# <text> Sets the description. description Type: Privileged ruckus(config-osu-portal-profile)# Executes the do command.
Page 317: Outbound-Firewall
Configuration Commands (e - r) outbound-firewall Table 110. Commands related ruckus(config-osu-portal-profile) Syntax and Type Parameters (if any) Description ruckus(config-osu-portal-profile)# show-terms-condition Disables the command. Type: Privileged ruckus(config-osu-portal-profile)# Shows the terms and conditions. show-terms-conditions Type: Privileged ruckus(config-osu-portal-profile)# <terms> Sets the terms and conditions. terms-conditions Type: Privileged ruckus(config-osu-portal-profile)#...
Page 318 Configuration Commands (e - r) outbound-firewall Related Commands Table 111 lists the related outbound-firewall configuration commands. Table 111. Commands related to ruckus (config-outbound-firewall). Syntax and Type Parameters (if any) Description outbound-firewall )# ruckus(config- Allow the outbound traffic. enable Type: Privileged ruckus(config- outbound-firewall )# <profileName>...
Page 319 Configuration Commands (e - r) outbound-firewall Table 111. Commands related to ruckus (config-outbound-firewall). Syntax and Type Parameters (if any) Description outbound-firewall )# ruckus(config- • <profileName> out [ Allow IPtables profile. ip-rule udp | sctp | tcp ] [ sport | dport ] <port> [ src | Type: Privileged dst ] <ipaddress>...
Page 320: Q-In-Q-Ethertype
Configuration Commands (e - r) q-in-q-ethertype q-in-q-ethertype To change Q-in-Q ether type, use the following command. ruckus(config)# q-in-q-ethertype <8100> | <9100> | <9200> | <88a8> Syntax Description This command uses the following syntax: [8100 | 9100 | 9200 | 88a8] 8100: 0x8100 9100: 0x9100 9200: 0x9200...
Page 321: Radius-Service
Configuration Commands (e - r) radius-service radius-service Sets the RADIUS service configurations, use the following command. ruckus(config)# radius-service <name> Syntax Description This command uses the following syntax: name: Name of the RADIUS server Default This command has no default settings. Command Mode Config Example...
Page 322 Configuration Commands (e - r) radius-service Table 112. Commands related to ruckus(config-radius-service). Syntax and Type Parameters (if any) Description ruckus(config-radius-service)# Ends the current configuration session and return to privileged EXEC mode. Type: Privileged ruckus(config-radius-service)# Exits from the EXEC. exit Type: Privileged ruckus(config-radius-service)# <friendly-name>...
Page 323 Configuration Commands (e - r) radius-service Table 112. Commands related to ruckus(config-radius-service). Syntax and Type Parameters (if any) Description ruckus(config-radius-service)# auto-fallback-disable Disables various options. backup Type: Privileged group-attrs no-response-fail out-of-band ruckus(config-radius-service)# Enables the no response fail. no-response-fail Type: Privileged ruckus(config-radius-service)# RFC5580 out of bank location delivery.
Page 324: Rebalance-Aps
Configuration Commands (e - r) rebalance-aps Table 112. Commands related to ruckus(config-radius-service). Syntax and Type Parameters (if any) Description ruckus(config-radius-service)# <username> <password> Tests the RADIUS server based on the user credentials and protocol test [PAP | CHAP] settings. Type: Privileged ruckus(config-radius-service)# [ <10-90 %>...
Page 325: Report
Configuration Commands (e - r) report report Sets the report configurations, use the following command. ruckus(config)# report <title> Syntax Description This command uses the following syntax: title: Name of the report Default This command has no default settings. Command Mode Config Example ruckus(config)# report rep01...
Page 326 Configuration Commands (e - r) report Related Commands Table 113 lists the related report configuration command. Table 113. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) Description ruckus(config-report)# csv- Sets the output of the report in CSV format. format Type: Privileged ruckus(config-report)#...
Page 327 Configuration Commands (e - r) report Table 113. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) Description ruckus(config-report)# no csv-format Disables and deletes commands. Type: Privileged email enable-export pdf-format resource-filter schedule ruckus(config-report)# pdf- Sets the outputs of the report in a PDF format.
Page 328 Configuration Commands (e - r) report Table 113. Commands related to ruckus(config-report) Syntax and Type Parameters (if any) Description ruckus(config-report)# time-filter monthly months <months> Sets the time filter. Type: Privileged daily days <days> hourly days <days> hourly hours <hours> 15min hours <hours> 5mintime-period hours time-period hours <hours>...
Page 329: Rks-Gre
Configuration Commands (e - r) rks-gre rks-gre To create or update the Ruckus GRE configuration, use the following command. ruckus(config)# rks-gre <name> Syntax Description This command uses the following syntax: <name>: Ruckus GRE name Default This command has no default settings. Command Mode Config Example...
Page 330 Configuration Commands (e - r) rks-gre Table 114. Commands related to ruckus(config-rke-gre) Syntax and Type Parameters (if any) Description ruckus(config-rks-gre)# gateway- auto: Enables auto Sets the WAN interface MTU. discover Type: Privileged <manually-size> Manual size between 850 and 1500 ruckus(config-rks-gre)# no description Disables and deletes commands.
Page 331 Configuration Commands (s - z) Configuration Commands (s - z) This chapter describes the commands that you can use to configure, enable, and disable various controller components. The following table lists the commands. NOTE: For easy access and reading, the configuration chapter has been split into 3 chapters based on the alphabetical order of commands.
Page 332: Sci-Profile
Configuration Commands (s - z) sci-profile sci-profile To enable SCI profile settings, use the following command. ruckus(config)# sci-profile Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus(config)# sci-profile ruckus(config-sci-profile)# Related Commands Table 116...
Page 333: Sci-Setting
Configuration Commands (s - z) sci-setting Table 116. Commands related to ruckus(config-sci-profile) Syntax and Type Parameters (if any) Description ruckus(config-sci-profile)# Sets the user. user Type: Privileged ruckus(config-sci-profile)# Enables the SCI server. enable Type: Privileged ruckus(config-sci-profile)# no Disables the SCI server. enable Type: Privileged ruckus(config-sci-profile)#...
Page 334: Sms-Server
Configuration Commands (s - z) sms-server Table 117. Commands related to ruckus(config-sci-setting) Syntax and Type Parameters (if any) Description ruckus(config-sci-setting)# do Enables the do command Type: Privileged ruckus(config-sci-setting)# enable Enables the SCI server. Type: Privileged ruckus(config-sci-setting)# end Ends the current configuration session and return to the privileged Type: Privileged EXEC mode.
Page 335: Smtp-Server
Configuration Commands (s - z) smtp-server Command Mode Config Example ruckus(config)# sms-server ruckus(config-sms-server)# Related Commands Table 118 lists the related sms-server configuration commands. Table 118. Commands related to ruckus(config-sms-server) Syntax and Type Parameters (if any) Description ruckus(config-sms-server)# <sid> Sets the account SID, which is a 34 character string that uniquely account-sid identifies this account.
Page 336 Configuration Commands (s - z) smtp-server personalname: Personal name. Default This command has no default settings. Command Mode Config Example ruckus(config)# smtp-server ruckus(config-smtp-server)# Related Commands Table 119 lists the related smtp-server configuration commands. Table 119. Commands related to (config-smtp-server) Syntax and Type Parameters (if any) Description ruckus(config-smtp-server)# do...
Page 337 Configuration Commands (s - z) smtp-server Table 119. Commands related to (config-smtp-server) Syntax and Type Parameters (if any) Description ruckus(config-smtp-server)# no enable: Disables SMTP Disables TLS or STARTTLS encryption commands. Server Type: Privileged password: Removes password personalname: Deletes personal name start-tls: Disables STARTTLS encryption tls: Disables TLS encryption...
Page 338: Snmp-Notification
Configuration Commands (s - z) snmp-notification Table 119. Commands related to (config-smtp-server) Syntax and Type Parameters (if any) Description ruckus(config-smtp-server)# <username> Sets the logon name. username Type: Privileged snmp-notification To enable SNMP notifications, use the following command. ruckus(config)# snmp-notification Syntax Description This command has no arguments or keywords.
Page 339 Configuration Commands (s - z) snmp-v2-community Example ruckus(config)# snmp-v2-community comm3 ruckus(config-snmp-v2-community)# Related Commands Table 120 lists the related snmp-v2-community configuration commands. Table 120. Commands related to ruckus(config-snmp-v2-community) Syntax and Type Parameters (if any) Description ruckus(config-snmp-v2- Executes the do command. community)# do Type: Privileged ruckus(config-snmp-v2- Ends the current configuration...
Page 340: Snmp-V3-User
Configuration Commands (s - z) snmp-v3-user Table 120. Commands related to ruckus(config-snmp-v2-community) Syntax and Type Parameters (if any) Description ruckus(config-snmp-v2- <inform> <trap> Set the notification type by setting a trap or through information. community)# notification-type Type: Privileged ruckus(config-snmp-v2- Enables read privileges community)# read Type: Privileged ruckus(config-snmp-v2-...
Page 341 Configuration Commands (s - z) snmp-v3-user Related Commands Table 121 lists the related snmp-v3-user configuration commands. Table 121. Commands related to ruckus(config-snmp-v3-user) Syntax and Type Parameters (if any) Description ruckus(config-snmp-v3-user)# none Sets SNMPv3 user authentication. auth sha <auth-password> Type: Privileged md5 <auth-password>...
Page 342: Soft-Gre
Configuration Commands (s - z) soft-gre Table 121. Commands related to ruckus(config-snmp-v3-user) Syntax and Type Parameters (if any) Description ruckus(config-snmp-v3-user)# <inform> <trap> Set the notification type by setting a trap or through information. notification-type Type: Privileged ruckus(config-snmp-v3-user)# Enables read privileges read Type: Privileged ruckus(config-snmp-v3-user)#...
Page 343 Configuration Commands (s - z) soft-gre Related Commands Table 122 lists the related soft-gre configuration commands. Table 122. Commands related to ruckus(config-soft-gre) Syntax and Type Parameters (if any) Description ruckus(config-soft-gre)# <text> Set the description description Type: Privileged ruckus(config-soft-gre)# device- [ ipv4 | ipv6 ] Sets the gateway IP mode to IPv4 or IPv6 version.
Page 344: Stats-Upload
Configuration Commands (s - z) stats-upload Table 122. Commands related to ruckus(config-soft-gre) Syntax and Type Parameters (if any) Description ruckus(config-soft-gre)# icmp- <retryTimes> Sets the ICMP keep alive retry. retry Type: Privileged ruckus(config-soft-gre)# name <name> Sets the SoftGRE name. Type: Privileged ruckus(config-soft-gre)# no force-disassociate-client Disables various options...
Page 345: Subpackages
Configuration Commands (s - z) subpackages Related Commands Table 123 lists the related stats-upload configuration commands. Table 123. Commands related to ruckus(config-stats-upload) Syntax and Type Parameters (if any) Description ruckus(config-stats-upload)# do Executes the do command. Type: Privileged ruckus(config-stats-upload)# <text> Enables to upload the statistical data to the FTP server.
Page 346 Configuration Commands (s - z) subpackages Example ruckus(config)# subpackages sub1 ruckus(config-subpackages)# Related Commands Table 124 lists the related subpackages configuration commands. Table 124. Commands related to ruckus (config-subpackages) Syntax and Type Parameters (if any) Description ruckus(config-subpackages)# <description> Sets the description. description Type: Privileged ruckus(config-subpackages)# do...
Page 347: Support-Admin
Configuration Commands (s - z) support-admin support-admin To support administrator configuration, use the following command. ruckus(config)# support-admin Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Config Example ruckus(config)# support-admin ruckus(config-support-admin)# Related Commands Table 125 lists the relate support-admin configuration commands.
Page 348: Syslog-Server
Configuration Commands (s - z) syslog-server Table 125. Commands related to ruckus(config-support-admin Syntax and Type Parameters (if any) Description ruckus(config-support-admin)# Displays the help. help Type: Privileged ruckus(config-support-admin)# no enable Disables the support administrator. Type: Privileged syslog-server To update the syslog server configurations, use the following command. ruckus(config)# syslog-server Syntax Description This command has no arguments or keywords.
Page 349 Configuration Commands (s - z) syslog-server Table 126. Commands related to ruckus(config-syslog-server) Syntax and Type Parameters (if any) Description ruckus(config-syslog-server)# do Executes the do command. Type: Privileged ruckus(config-syslog-server)# Enables sending events to the remote syslog server. enable Type: Privileged ruckus(config-syslog-server)# end Ends the current configuration session and returns to privileged Type: Privileged...
Page 350 Configuration Commands (s - z) syslog-server Table 126. Commands related to ruckus(config-syslog-server) Syntax and Type Parameters (if any) Description ruckus(config-syslog-server)# Pings the secondary syslog server. pingsecondary Type: Privileged ruckus(config-syslog-server)# port <port> Sets the syslog server port. Type: Privileged ruckus(config-syslog-server)# [ Minor | Critical | Debug | Sets the priority for events.
Page 351: Ttg-Pdg-Profile
Configuration Commands (s - z) ttg-pdg-profile ttg-pdg-profile To create and update the TTG+PDG profile configurations, use the following command. ruckus(config)# ttg-pdg-profile <name> Syntax Description This command uses the following syntax: name: TTG PDG profile name Default This command has no default settings. Command Mode Config Example...
Page 352 Configuration Commands (s - z) ttg-pdg-profile Table 127. Commands related to (config-ttg-pdg-profile) Syntax and Type Parameters (if any) Description ruckus(config-ttg-pdg-profile)# [ dns | string ] Sets the APN format to GGSN. apn-format-ggsn Type: Privileged ruckus(config-ttg-pdg-profile)# Enables APN-OI for DNS resolution. apn-oi Type: Privileged ruckus(config-ttg-pdg-profile)#...
Page 353 Configuration Commands (s - z) ttg-pdg-profile Table 127. Commands related to (config-ttg-pdg-profile) Syntax and Type Parameters (if any) Description ruckus(config-ttg-pdg-profile)# Exits from the EXEC. exit Type: Privileged ruckus(config-ttg-pdg-profile)# Displays the help. help Type: Privileged ruckus(config-ttg-pdg-profile)# Deletes forwarding policies for APN or default APNs for realm. apn-oi Type: Privileged dhcp-options82...
Page 354 Configuration Commands (s - z) ttg-pdg-profile Table 128. Commands related to (config-ttg-pdg-profile-apn) Syntax and Type Parameters (if any) Description ruckus(config-ttg-pdg-profile- Exits from the EXEC. apn)# exit Type: Privileged ruckus(config-ttg-pdg-profile- Displays the help. apn)# help Type: Privileged ruckus(config-ttg-pdg-profile- [ pdg | gtpv2 | gtpv1 ]] Sets the route type.
Page 355 Configuration Commands (s - z) ttg-pdg-profile Table 129. Commands related to ruckus(config- config-ttg-pdg-profile -dhcp-option82) configuration Syntax and Type Parameters (if any) Description ruckus(config-ttg-pdg-profile- [ ap-info | ap-essid | ap-mac Enables subopt-1 dhcp-option82)# subtopt1 Type: Privileged ruckus(config-ttg-pdg-profile- Enables subopt-150 dhcp-option82)# subtopt150 Type: Privileged ruckus(config-ttg-pdg-profile- essid...
Page 356: User-Agent-Blacklist
Configuration Commands (s - z) user-agent-blacklist user-agent-blacklist To create and update the user agent blacklisted configuration, use the following command. ruckus(config)# user-agent-blacklist <name> Syntax Description This command uses the following syntax: name: Name of the user agent blacklisted Default This command has no default settings. Command Mode Config Example...
Page 357 Configuration Commands (s - z) user-agent-blacklist Table 130. Commands related to ruckus(config-user-agent-blacklist) Syntax and Type Parameters (if any) Description ruckus(config-user-agent- Exits from the EXEC. blacklist)# exit Type: Privileged ruckus(config-user-agent- Displays the help. blacklist)# help Type: Privileged ruckus(config-user-agent- <name> Sets the user agent name who is blacklist)# name blacklisted.
Page 358: User-Group
Configuration Commands (s - z) user-group user-group To create and update the user group configuration, use the following command. ruckus(config)# user-group <name> Syntax Description This command uses the following syntax: name: Name of the user group Default This command has no default settings. Command Mode Config Example...
Page 359 Configuration Commands (s - z) user-group Table 131. Commands related to ruckus(config-user-group) Syntax and Type Parameters (if any) Description ruckus(config-user-group)# help Displays the help. Type: Privileged ruckus(config-user-group)# name <name> Sets the user group name Type: Privileged ruckus(config-user-group)# no <domain> Disables the override on the specified settings.
Page 360: User-Role
Configuration Commands (s - z) user-role user-role To create and update the user role configuration, use the following command. ruckus(config)# user-role <name> Syntax Description This command uses the following syntax: name: Name of the user role Default This command has no default settings. Command Mode Config Example...
Page 361 Configuration Commands (s - z) user-role Table 132. Commands related to ruckus(config-user-role) Syntax and Type Parameters (if any) Description ruckus(config-user-role)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode. ruckus(config-user-role)# exit Exits from the EXEC. Type: Privileged ruckus(config-user-role)# help Displays the help.
Page 362: User-Traffic-Profile
Configuration Commands (s - z) user-traffic-profile user-traffic-profile To create and update the user traffic profile configuration, use the following command. ruckus(config)# user-traffic-profile <name> Syntax Description This command uses the following syntax: name: Name of the user traffic profile Default This command has no default settings. Command Mode Config Example...
Page 363 Configuration Commands (s - z) user-traffic-profile Table 133. Commands related to (config-user-traffic-profile) Syntax and Type Parameters (if any) Description ruckus(config-user-traffic-profile)# Sets the do command. Type: Privileged ruckus(config-user-traffic-profile)# Sets the downlink rate limit in downlink mbps. Type: Privileged ruckus(config-user-traffic-profile)# Ends the current configuration session and returns to privileged EXEC mode.
Page 364 Configuration Commands (s - z) user-traffic-profile Table 134 lists the related user-traffic-profile-acl configuration commands. Table 134. Commands related to ruckus(config-user-traffic-profile-acl) Syntax and Type Parameters (if any) Description ruckus(config-user-traffic-profile- <allow>: Allows the traffic Sets the handling action. acl)# action <block>: Blocks the traffic Type: Privileged ruckus(config-user-traffic-profile- <description>...
Page 365 Configuration Commands (s - z) user-traffic-profile Table 134. Commands related to ruckus(config-user-traffic-profile-acl) Syntax and Type Parameters (if any) Description ruckus(config-user-traffic-profile- Displays the help. acl))# help Type: Privileged ruckus(config-user-traffic-profile- <protocol> Value should Sets the protocol. acl))# protocol be in the range of 1 to 255 Type: Privileged ruckus(config-user-traffic-profile- network [ <Network...
Page 366: Vlan-Pooling
Configuration Commands (s - z) vlan-pooling vlan-pooling To set the VLAN pooling profile, use the following command. ruckus(config)# vlan-pooling <name> Syntax Description This command uses the following syntax: name: Name of the vlan pooling profile Default This command has no default settings. Command Mode Config Example...
Page 367: Zone
Configuration Commands (s - z) zone Table 135. Commands related to ruckus(config-vlan-pooling) Syntax and Type Parameters (if any) Description ruckus(config-vlan-pooling)# help Displays the help. Type: Privileged ruckus(config-vlan-pooling)# <name> Sets the VLAN pooling profile name name. Type: Privileged ruckus(config-vlan-pooling)# no <description> Disables the settings.
Page 368 Configuration Commands (s - z) zone cluster-switch-over: Enables the cluster switchover <name>: Cluster redundancy name <name> template-apply <name> <name>: AP zone name template-apply: Apply the zone template <name>: Zone template name <name> trigger-prefer-node <name>: AP zone name trigger-prefer-node: Apply the trigger preference for the node Default This command has no default settings.
Page 369 Configuration Commands (s - z) zone • Table 150 lists the related zone-bonjour-policy configuration commands. • Table 151 lists the related zone-bonjour-policy-rule configuration commands. • Table 152 lists the related zone-client-isolation-whitelist configuration commands. • Table 153 lists the related zone-device-policy configuration commands. •...
Page 370 Configuration Commands (s - z) zone Table 136 lists the related zone configuration commands. Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# aaa <name> Creates or updates the AAA server configuration. Type: Privileged ruckus(config-zone)# adj- 2.4g ${value} Sets the adjacent radio threshold of the client load balancing.
Page 371 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# ap- default-gateway [ <hours Sets the AP reboot timeout. reboot-timeout and minutes> ] Type: Privileged default-gateway: Sets the default gateway timeout in hours and minutes.
Page 372 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# bonjour- <name> Creates or updates the bonjour policy. policy Type: Privileged ruckus(config-zone)# channel 2.4g <channel> Sets the channel. Type: Privileged 5g indoor <channel>...
Page 373 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# channel- Selects the channel. select-mode Type: Privileged ruckus(config-zone)# • 2.4g <number> Sets MTBC value of ChannelFly. channelfly-mtbc 2.4g: 2.4 GHz radio Type: Privileged <number>: MTBC value (Range: 100~1440)
Page 374 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# country- <country-code> Sets the country code. code Type: Privileged ruckus(config-zone)# <text> Sets the description, description Type: Privileged ruckus(config-zone)# device- <name> Sets the device policy.
Page 375 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# gps- <altitude> [ floor | meters ] Sets the GPS altitude. altitude altitude value Type: Privileged floor meters ruckus(config-zone)# guest- <name>...
Page 376 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# lbs Enables the location based service. Type: Privileged ruckus(config-zone)# lbs- Sets the location based service. service Type: Privileged ruckus(config-zone)# load- 2.4g: 2.4 GHz radio Sets client load balancing balancing...
Page 377 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# no aaa <name> Disables and deletes command configuration. Type: Privileged ap-group <name> ap-registration-rule <priority> ap-snmp-options background-scan <2.4g> <5g> band-balancing block-client bonjour-fencing bonjour-fencing-policy bonjour-gateway...
Page 378 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# no location Disables and deletes command configuration. Type: Privileged location-additional-info mesh roam smart-mon smart-roam-disconnect- event syslog-enabled timezone-dst usb-software venue-code venue-profile vlan-pooling web-authentication wlan <name>...
Page 379 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# rogue-ap- enable | disable ] - Enables or Sets the report rogue access point. detection disables malicious rogue devices which have same Type: Privileged network report-all [ disable | enable ] :...
Page 380 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# smart- Enables smart roam disconnect event. roam-disconnect-event Type: Privileged ruckus(config-zone)# syslog- Enables the external syslog server for APs in this zone. enabled Type: Privileged ruckus(config-zone)# syslog-...
Page 381 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# timezone- [ <hour | hour: minute>] For Sets the user defined timezone for GMT offset. gmt-offset example, 8, -7:45 Type: Privileged ruckus(config-zone)# tunnel- <profile-name>...
Page 382 Configuration Commands (s - z) zone Table 136. Commands related to ruckus(config-zone) Syntax and Type Parameters (if any) Description ruckus(config-zone)# wlan <name> Creates or updates the WLAN configuration. Type: Privileged ruckus(config-zone)# wlan- <name> Creates or updates the WLAN group configuration. group Type: Privileged ruckus(config-zone)# wlan-...
Page 383 Configuration Commands (s - z) zone Table 137. Commands related ruckus(config-zone-aaa) Syntax and Type Parameters (if any) Description ruckus(config-zone-aaa)# backup ip <ip> Enables backup of RADIUS support and set related settings. Type: Privileged ipv6 <ipv6> port <port> shared-secret <shared- secret> ruckus(config-zone-aaa)# base- <base-domain>...
Page 384 Configuration Commands (s - z) zone Table 137. Commands related ruckus(config-zone-aaa) Syntax and Type Parameters (if any) Description ruckus(config-zone-aaa)# no backup Disables or deletes configuration settings. Type: Privileged global-catalog ruckus(config-zone-aaa)# <password> Sets the password for the primary RADIUS server. password Type: Privileged ruckus(config-zone-aaa)# port <port>...
Page 385 Configuration Commands (s - z) zone Table 138 lists the related zone-ap-group configuration commands. Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# <ap-model> - AP model Sets the AP adaptive noise ani-ofdm-level name immunity level for specific AP model.
Page 386 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# • 2.4g <number> Sets MTBC value of ChannelFly. channelfly-mtbc 2.4g: 2.4 GHz radio Type: Privileged <number>:MTBC value (Range: 100~1440) • 5g <number> 5g: 5 GHz radio <number>:MTBC value (Range: 100~1440)
Page 387 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# 2.4g minClientThroughput Enables the client admission client-admission-control <minClientThroughput>: control. Type: Privileged Min Client Throughput (Default: 0.0Mbps) 5g minClientCount <minClientCount> Min Client Count (Default: 5g maxRadioLoad <maxRadioLoad>...
Page 388 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# <ap-model> 5g [ disable | Sets the external antenna for external-antenna enable ] specific AP model. Type: Privileged <ap-model> 5g gain <gain>...
Page 389 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# <ap-model> Sets the LED mode for specific AP led-mode model. Type: Privileged ruckus(config-zone-ap-group)# <ap-model> [ enable | Sets the LLDP for a specific AP lldp disable ] model.
Page 390 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# no ani-ofdm-level Disables / deletes the configuration settings. Type: Privileged channel 2.4g channel 5g indoor channel 5g outdoor channel-evaluation- interval channel-range channel-select-mode client-admission-control...
Page 391 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# no override-ap-mgmt-vlan Disables / deletes the configuration settings. Type: Privileged override-ap-snmp- options override-channel-select- mode override-client- admission-control override-lbs override-venue-code override-zone-location override-zone-location- additional-info poe-operating-mode poe-out...
Page 392 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# 2.4g Overrides auto channel selection override-channel-select-mode mode and ChannelFly MTBC. Type: Privileged ruckus(config-zone-ap-group)# 2.4g Overrides the client admission override-client-admission-control control settings. Type: Privileged ruckus(config-zone-ap-group)# Overrides the location based...
Page 393 Configuration Commands (s - z) zone Table 138. Commands related to ruckus(config-zone-ap-group) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group)# 5g indoor [ <secondary Sets the secondary channel. secondary-channel channel> ] Type: Privileged 5g outdoor [ <secondary channel> ] ruckus(config-zone-ap-group)# <ap-model>...
Page 394 Configuration Commands (s - z) zone Table 139 lists the related zone-ap-group-ap-snmp-options configuration commands. Table 139. Commands related to ruckus (zone-ap-group-ap-snmp-options) configuration) Syntax and Type Parameters (if any) Description zone-ap-group- ruckus(config- Enables AP SNMP. ap-snmp-options )# ap-snmp Type: Privileged ruckus(config- zone-ap-group- ap-snmp Disables and deletes commands.
Page 395 Configuration Commands (s - z) zone Table 140. Commands related to ruckus(config-zone-ap-group-lldp configuration) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group- <seconds> Sets the LLDP advertise interval in lldp)# lldp-ad-interval seconds from the range 1 to 300. Type: Privileged ruckus(config-zone-ap-group- <seconds>...
Page 396 Configuration Commands (s - z) zone Table 141. Commands related to ruckus(config-zone-ap-group-port-setting) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-group- <port> Enables or disable specific port. port-setting)# lan Type: Privileged <port> uplink [ general | access | trunk ] <port> untag <vlan> <port>...
Page 397 Configuration Commands (s - z) zone Table 142. Commands related to ruckus(config-zone-ap-model) configuration commands Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-model)# Displays the help. help Type: Privileged ruckus(config-zone-ap-model)# Enables international heater. internal-heater Type: Privileged ruckus(config-zone-ap-model)# Sets the LAN configurations from 1 lan1 to 5.
Page 398 Configuration Commands (s - z) zone Table 142. Commands related to ruckus(config-zone-ap-model) configuration commands Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-model)# Enables the LLDP management IP lldp-mgmt TLV. Type: Privileged ruckus(config-zone-ap-model)# ext-ant Disables or deletes the settings that have been configured. internal-heater Type: Privileged lan1...
Page 399 Configuration Commands (s - z) zone Table 143 lists the related zone-ap-model-lan1 configuration commands. Table 143. Commands related to ruckus(config-zone-ap-model-lan1) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-model- Executes the do command. lan1)# do Type: Privileged ruckus(config-zone-ap-model- Ends the current configuration lan1)# end session and returns to privileged EXEC mode.
Page 400 Configuration Commands (s - z) zone Table 144 lists the related zone-ap-registration-rule configuration commands. Table 144. Commands related to ruckus(config-zone-ap-registration-rule) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap- <text> Sets the description. registration-rule)# description Type: Privileged ruckus(config-zone-ap- Executes the do command. registration-rule)# do Type: Privileged ruckus(config-zone-ap-...
Page 401 Configuration Commands (s - z) zone Table 145 lists the related zone-ap-snmp-options configuration commands. Table 145. Commands related to ruckus(config-zone-ap-snmp-options configuration) Syntax and Type Parameters (if any) Description ruckus(config-zone-ap-snmp- Enables AP SNMP. options)# ap-snmp Type: Privileged ruckus(config-zone-ap-snmp- snmp-v2-community Disables the settings that have options)# no <name>...
Page 402 Configuration Commands (s - z) zone Table 146. Commands related to ruckus(config-zone-ap-snmp-options-snmp-v2-community configuration) Syntax and Type Parameters (if any) Description zone-ap-snmp- ruckus(config- [ inform | trap ] Sets the notification type. options-snmp-v2-community)# notification-type Type: Privileged ruckus(config -zone-ap-snmp- Enable the read privilege. options-snmp-v2-community )# read Type: Privileged...
Page 403 Configuration Commands (s - z) zone Table 147. Commands related to ruckus(config-zone-ap-snmp-options-snmp-v3-user configuration) Syntax and Type Parameters (if any) Description -zone-ap-snmp- ruckus(config <ip> <port> Enables notification target options-snmp-v3-user)# configuration commands. notification-target Type: Privileged ruckus(config- zone-ap-snmp- <trap> Sets the notification type. options-snmp-v3-user)# notification-type Type: Privileged...
Page 404 Configuration Commands (s - z) zone Table 149. Commands related to ruckus(config-zone-bonjour-fencing-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjour- description Sets to delete sub commands. fencing-policy)# no rule <rule index> Type: Privileged ruckus(config-zone-bonjour- <index> - rule index Sets the bonjour fencing rule. fencing-policy)# rule Type: Privileged Table 150...
Page 405 Configuration Commands (s - z) zone Table 150. Commands related to ruckus(config-zone-bonjour-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjour- <priority> Sets the bonjour policy set of rules policy)# rule based on the rule priority. Type: Privileged Table 151 lists the related zone-bonjour-policy-rule configuration commands. Table 151.
Page 406 Configuration Commands (s - z) zone Table 151. Commands related to ruckus(config-zone-bonjour-policy-rule) Syntax and Type Parameters (if any) Description ruckus(config-zone-bonjour- Executes the do command. policy-rule)# do Type: Privileged ruckus(config-zone-bonjour- Ends the current configuration policy-rule)# end session and returns to privileged EXEC mode.
Page 407 Configuration Commands (s - z) zone Table 152. Commands related to ruckus(config-zone- client-isolation-whitelist ) Syntax and Type Parameters (if any) Description ruckus(config-zone-client-isolation- <text> Sets the description. whitelist)# description Type: Privileged ruckus(config-zone-client-isolation- <index> - entry index Sets the client isolation entry. whitelist)# entry Type: Privileged ruckus(config-zone-bonjour-policy-...
Page 408 Configuration Commands (s - z) zone Table 153. Commands related to ruckus(config-zone-device-policy) Syntax and Type Parameters (if any) Description ruckus(config-zone-device- [ <device type> ] Deletes the device policy rules. policy# no policy-rule Type: Privileged ruckus(config-zone-device- Sets the device policy. policy)# policy-rule Type: Privileged Table 154 lists the related zone-device-policy-policy-rule configuration commands.
Page 409 Configuration Commands (s - z) zone Table 155 lists the related zone-diffserv configuration commands. Table 155. Commands related to ruckus(config-zone-diffserv) Syntax and Type Parameters (if any) Description ruckus(config-zone-diffserv)# <text> Sets the description. description Type: Privileged ruckus(config-zone-diffserv)# do Executes the do command. Type: Privileged ruckus(config-zone-diffserv)# <value>...
Page 410 Configuration Commands (s - z) zone Table 156 lists the related config-zone-ethernet-port-profile configuration commands. Table 156. Commands related to ruckus(config-zone-ethernet-port-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-ethernet-port- Sets 802.1x. profile)# 8021x Type: Privileged ruckus(config-zone-ethernet-port- <acct-service> Accounting service. profile)# acct-service Type: Privileged ruckus(config-zone-ethernet-port- <auth-service>...
Page 411 Configuration Commands (s - z) zone Table 156. Commands related to ruckus(config-zone-ethernet-port-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-ethernet-port- • mac Set the supplicant. profile)# supplicant • custom <username> Type: Privileged <password> ruckus(config-zone-ethernet-port- Enable tunnel profile)# tunnel Type: Privileged ruckus(config-zone-ethernet-port- Set port type profile)# type...
Page 412 Configuration Commands (s - z) zone Table 157. Commands related to ruckus (config-zone-guest-access) Syntax and Type Parameters (if any) Description ruckus(config-zone-guest- Exits from the EXEC. access)# exit Type: Privileged ruckus(config-zone-guest- <minutes> Sets the grace period. access)# grace-period Type: Privileged ruckus(config-zone-guest- Displays the help.
Page 413 Configuration Commands (s - z) zone Table 157. Commands related to ruckus (config-zone-guest-access) Syntax and Type Parameters (if any) Description ruckus(config-zone-guest- Sets the web portal terms and access)# terms-and-conditions conditions. Type: Privileged ruckus(config-zone-guest- Sets the title for the web portal. access)# title Type: Privileged Table 158...
Page 414 Configuration Commands (s - z) zone Table 158. Commands related to ruckus(config-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot)# <location-id> Sets the location ID. location-id Type: Privileged ruckus(config-zone-hotspot)# <location-name> Sets the location name. location-name Type: Privileged ruckus(config-zone-hotspot)# logo <ftp-url> Sets the logo.
Page 415 Configuration Commands (s - z) zone Table 158. Commands related to ruckus(config-zone-hotspot) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot)# enable Sets the smart client support. smart-client-support none Type: Privileged only <instructions> Only smart client allowed with instructions for enabling users to log on using the smart client application ruckus(config-zone-hotspot)#...
Page 416 Configuration Commands (s - z) zone Table 159 lists the related zone-hotspot20-venue-profile configuration commands. Table 159. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- <text> Sets the description. venue-profile)# description Type: Privileged ruckus(config-zone-hotspot20- Executes the do command. venue-profile)# do Type: Privileged ruckus(config-zone-hotspot20-...
Page 417 Configuration Commands (s - z) zone Table 159. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- business [ unspecified | Sets the venue category venue-profile)# venue-category police-station | attorney- office | professional-office Type: Privileged | research-and- development-facility |doctor-or-dentist-office | fire-station | post-office |...
Page 418 Configuration Commands (s - z) zone Table 159. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- storage unspecified Sets the venue category. venue-profile) Type: Privileged utility-and-miscellaneous unspecified vehicular [ train | airplane | ferry | automobile-or-truck | bus | motor-bike | unspecified | ship-or-boat outdoor [ unspecified |...
Page 419 Configuration Commands (s - z) zone Table 159. Commands related to ruckus(config-zone-hotspot20-venue-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- Enables symmetric link. venue-profile)# wan-sym-link Type: Privileged ruckus(config-zone-hotspot20- <uplink-load> Sets the WAN uplink load. venue-profile)# wan-uplink-load Type: Privileged ruckus(config-zone-hotspot20- <speed> - Uplink speed in Sets the WAN uplink speed.
Page 420 Configuration Commands (s - z) zone Table 160. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- [ pptp | http | voip-6 | Sets the connection capabilities. wlan-profile)# connect-capabilities ipsec-vpn | ikev2 | ftp | tls pptp: Protocol Number:6 | voip-17 | icmp | ssh | esp Port:1723 Protocol Name: Used...
Page 421 Configuration Commands (s - z) zone Table 160. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- [ pptp | http | voip-6 | ssh: Protocol Number:6 Port:22 Protocol Name: SSH wlan-profile)# connect-capabilities ipsec-vpn | ikev2 | ftp | tls | voip-17 | icmp | ssh | esp Type: Privileged ] [ open | unknown |...
Page 422 Configuration Commands (s - z) zone Table 160. Commands related to ruckus(config-zone-hotspot20-wlan-profile) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- enable Enables the specified WLAN with wlan-profile)# internet-option Internet connectivity. Type: Privileged ruckus(config-zone-hotspot20- [ port-restrict-address | Sets the IPv4 address. wlan-profile)# ipv4-address single-nated-private- address | double-nated-...
Page 423 Configuration Commands (s - z) zone Table 161 lists the related hotspot20-wlan-profile-cust-connect-capabilities config- uration commands. Table 161. Commands related to ruckus(config-zone-hotspot20-wlan-profile-cust-connect- capabilities) Syntax and Type Parameters (if any) Description ruckus(config-zone-hotspot20- Executes the do command. wlan-profile-cust-connect- capabilities)# do Type: Privileged ruckus(config-zone-hotspot20- Ends the current configuration wlan-profile-cust-connect- session and returns to privileged...
Page 424 Configuration Commands (s - z) zone Table 162 lists the related zone-l2-acl configuration commands. Table 162. Commands related to ruckus(config-zone-l2-acl) Syntax and Type Parameters (if any) Description ruckus(config-zone-l2-acl)# action [ allow | block ] Sets the handling action to allow or block.
Page 425 Configuration Commands (s - z) zone Table 164 lists the related zone-weçhat configuration commands. Table 164. Commands related to ruckus (config-zone-wechat) Syntax and Type Parameters (if any) Description ruckus(config-zone-wechat)# <text>: Authentication Sets Authentication URL authentication-url Type: Privileged ruckus(config-zone-wechat)# <text>: Black list Sets black list.
Page 426 Configuration Commands (s - z) zone Table 165 lists the related zone-wlan configuration commands. Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# aaa- Enables AAA VLAN override. vlan-override Type: Privileged ruckus(config-zone-wlan)# Enables tunnel WLAN traffic to the controller.
Page 427 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# auth- Sets the authentication service. Enables accounting for TTG service-use-proxy sessions. Type: Privileged ruckus(config-zone-wlan)# auth- Sets the authentication type. type Type: Privileged ruckus(config-zone-wlan) #bss- [ 5.5mbps | 24mbps |...
Page 428 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# dhcp- Enables DHCP option 82. option-82 Type: Privileged ruckus(config-zone-wlan)# dhcp- [ subopt-1 | ruckus-gre | Enables DHCP option 82 format options.
Page 429 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# dnlink- Sets the downlink rate limiting. limit Type: Privileged ruckus(config-domain-zone- Sets the DNS server profile. wlan)# dns-server-profile Type: Privileged ruckus(config-domain-zone- Enables the DP tunnel NAT server.
Page 430 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# Enables the WLAN service type. enable-type Type: Privileged ruckus(config-zone-wlan)# enc- Sets the encryption algorithm. algorithm Type: Privileged ruckus(config-zone-wlan)# enc- Sets the encryption method. method Type: Privileged ruckus(config-zone-wlan)# enc-...
Page 431 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# force- timeout <seconds> Sets the timeout for DHCP in seconds. dhcp timeout: Sets the Type: Privileged disconnect client timeout interval <seconds>: Sets the disconnect client timeout in intervals of 5 - 15...
Page 432 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# <name> Sets the hotspot 2.0 configuration. hotspot2 Type: Privileged ruckus(config-zone-wlan)# Enables the hotspot 2.0 device registration from the guest portal. hotspot20-osu-support Type: Privileged ruckus(config-zone-wlan)#...
Page 433 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# no aaa-vlan-override Disables or deletes the configuration settings. Type: Privileged access-network acct-delay-time acct-service acct-service-use-proxy acct-ttg-session app-visibility auth-service-use-proxy bss-minrate bypass-cna calea client-fingerprinting client-tx-rx-statistics device-policy...
Page 434 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# no l2-acl Disables or deletes the configuration settings. Type: Privileged mac-auth ofdm-only (Orthogonal Frequency Division Multiplexing) okc-support onboarding-auth-service onboarding-auth-service- use-proxy pmk-caching proxy-arp qos-map-enable...
Page 435 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# <service-name> local Sets the onboarding authentication service. onboarding-auth-service <realm> Type: Privileged <service-name> remote <realm> <service-name> local <realm> never <service-name> local <realm>...
Page 436 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# <name> Sets the onboarding portal. onboarding-portal Type: Privileged ruckus(config-zone-wlan)# Sets the operator realm. operator-realm Type: Privileged ruckus(config-zone-wlan)# pmk- Enables the PMK caching support. caching-support Type: Privileged ruckus(config-zone-wlan)# priority...
Page 437 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# radius- <minutes> Sets the reconnection to the primary RADIUS NAS. nas-reconnect-primary Type: Privileged ruckus(config-zone-wlan)# radius- <seconds> Sets the RADIUS NAS request timeout.
Page 438 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# uplink- Sets the uplink rate limiting. limit Type: Privileged ruckus(config-zone-wlan)# user- Sets the user traffic profile. traffic-profile Type: Privileged ruckus(config-zone-wlan)# venue- Enables venue code.
Page 439 Configuration Commands (s - z) zone Table 165. Commands related to ruckus(config-zone-wlan) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan)# wispr- Enables WISPr TTG support. ttg-support Type: Privileged ruckus(config-zone-wlan)# zero-it- Enables zero-it activation (WLAN users are provided with wireless activation configuration installer after they log Type: Privileged in).
Page 440 Configuration Commands (s - z) zone Table 167 lists the related zone-wlan-group configuration commands. Table 167. Commands related to ruckus(config-zone-wlan-group). Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan-group)# <text> Sets the description, description Type: Privileged ruckus(config-zone-wlan-group# Executes the do command. Type: Privileged ruckus(config-zone-wlan-group)# Ends the current configuration...
Page 441: Zone-Affinity
Configuration Commands (s - z) zone-affinity Table 168 lists the related zone-wlan-scheduler configuration commands. Table 168. Commands related to ruckus (config-zone-wlan-scheduler) Syntax and Type Parameters (if any) Description ruckus(config-zone-wlan- <text> Sets the description, scheduler)# description Type: Privileged ruckus(config-zone-wlan- description Disables the commands. scheduler)# no schedule-data [ <weekday Type: Privileged...
Page 442 Configuration Commands (s - z) zone-affinity Related Commands Table 169 lists the related zone-affinity configuration command. Table 169. Commands related to ruckus(config-zone-affinity) Syntax and Type Parameters (if any) Description ruckus(config-zone-affinity)# Allows session on accounting failure. allow-sess-on-acct-fail Type: Privileged ruckus(config-zone-affinity)# auth Sets the SNMPv3 user authentication.
Page 443 Configuration Commands (s - z) zone-affinity Table 169. Commands related to ruckus(config-zone-affinity) Syntax and Type Parameters (if any) Description ruckus(config-zone-affinity)# Sets the expiration interval. expiration-interval Type: Privileged ruckus(config-zone-affinity)# fast- Enables fast re-authentication reauth support. Type: Privileged ruckus(config-zone-affinity)# gtp- Sets the GTP network service nsapi access point identifier.
Page 444 Configuration Commands (s - z) zone-affinity Table 169. Commands related to ruckus(config-zone-affinity) Syntax and Type Parameters (if any) Description ruckus(config-zone-affinity)# nat- Sets the NAT IP translation in FTP passive mode. ip-translation Type: Privileged ruckus(config-zone-affinity)# ndc Sets the NDC (network destination code). Type: Privileged ruckus(config-zone-affinity)# name Sets the SCI profile.
Page 445 Configuration Commands (s - z) zone-affinity Table 169. Commands related to ruckus(config-zone-affinity) Syntax and Type Parameters (if any) Description ruckus(config-zone-affinity)# Adds EAP-SIM secret key. secret Type: Privileged ruckus(config-zone-affinity)# Sets the shared secret for the primary RADIUS server. shared-secret Type: Privileged ruckus(config-zone-affinity)# Sets the system identifier.
Page 446: Zone-Template
Configuration Commands (s - z) zone-template zone-template To create or update the zone template configurations, use the following command. ruckus(config)# zone-template Syntax Description This command uses the following syntax: import <ftp-url> import: Import AP Zone Template from FTP server <ftp-url>: FTP URL, format: ftp://<username>:<password>@<ftp-host>/ <file-path>...
Page 447: Debug
Debug Commands debug Debug Commands This chapter describes the commands that you can use to debug the controller. The following table lists the commands. Table 170. Debug commands debug ap-cli ap-routine- data-plane diagnostic status-interval exit export log customized- config help no dp- no screen- no sha1...
Page 448: Ap-Cli
Debug Commands ap-cli ap-cli To run AP CLI debug script management, use the following command: ruckus(debug)# ap-cli Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example ruckus(debug)# ap-cli Related Commands Table 171 lists the related debug ap-cli commands.
Page 449: Ap-Routine-Status-Interval
Debug Commands ap-routine-status-interval ap-routine-status-interval To set the AP routine status interval, use the following command: ruckus(debug)# ap-routine-status-interval <slowdown> <speedup> Syntax Description This command uses the following syntax: slowdown: Sets all the APs to report status in 900 seconds interval speedup: Sets all the APs to report status in 180 seconds interval Default This command has no default settings.
Page 450: Diagnostic
Debug Commands diagnostic Related Commands Table 172 lists the related debug data-plane commands. Table 172. Commands related to ruckus(debug-data-plane) Syntax and Type Parameters (if any) Description ruckus(debug-data-plane)# do Executes the do command. Type: Privileged ruckus(debug-data-plane)# end Ends the current configuration session and returns to privileged Type: Privileged EXEC mode.
Page 451 Debug Commands diagnostic Related Commands Table 173 lists the related debug diagnostic commands. Table 173. Commands related to ruckus(debug-diagnostic) Syntax and Type Parameters (If Any) Description ruckus(debug-diagnostic)# delete <name> Deletes a diagnostic script. Specify the script name. Type: Privileged ruckus(debug-diagnostic)# do Executes the do command.
Page 452: Dp-Customized-Config
Debug Commands To run the debug do command: ruckus(debug)# do Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Debug Example ruckus(debug)# do dp-customized-config To set customized data plane configuration commands. ruckus(debug)# dp-customized-config <name>...
Page 453: Exit
Debug Commands To end the current configuration session and returns to privileged exec mode, use the following command: ruckus(debug)# end Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Debug Example ruckus(debug)# end exit To exit from the exec mode, use the following command:...
Page 454: Execute
Debug Commands execute execute To execute a debug script that has been uploaded to the controller, use the following command: ruckus(debug)# execute <script-name> Syntax Description This command uses the following syntax: script-name: Name of the debug script that you want to execute Default This command has no default settings.
Page 455: Help
Debug Commands help help To display the command line interface help, use the following command: ruckus(debug)# help Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example ruckus(debug)# help no dp-customized-config To disable customized data plane configuration commands.
Page 456: No Screen-Pagination
Debug Commands no screen-pagination no screen-pagination To disable the screen pagination, use the following command: ruckus(debug)# no screen-pagination Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example ruckus(debug)# no screen-pagination no sha1 To disable SHA1 support, use the following command: ruckus(debug)# no sha1...
Page 457: No Strict-Wfa-Compliance
Debug Commands no strict-wfa-compliance no strict-wfa-compliance To disable WFA compliance, use the following command: ruckus(debug)# no strict-wfa-compliance NOTE: Its is highly recommended that the user contacts Ruckus customer support before enabling / disabling this CLI command. NOTE: Syntax Description This command has no arguments or keywords. Default This command has no default settings.
Page 458: Reindex-Elasticsearch-All
Debug Commands reindex-elasticsearch-all reindex-elasticsearch-all To reindex all elastic search data, use the following command: ruckus(debug)# reindex-elasticsearch-all Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example ruckus(debug)# reindex-elasticsearch-all screen-pagination To enable the screen pagination, use the following command: ruckus(debug)# screen-pagination Syntax Description This command has no arguments or keywords.
Page 459: Sha1
Debug Commands sha1 sha1 To enable SHA1 support, use the following command: ruckus(debug)# sha1 Syntax Description This command has no default settings. Default This command has no default settings. Command Mode Debug Example SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 460: Show Dp-Customized-Config
Debug Commands show dp-customized-config show dp-customized-config To display customized data plane configuration commands. ruckus(debug)# show dp-customized-config Syntax Description This command has the following arguments or keywords: all: All data planes <name>: Data plane name Default This command has no default settings. Command Mode Debug Example...
Page 461: Show Strict-Wfa-Compliance-State
Debug Commands show strict-wfa-compliance-state show strict-wfa-compliance-state To view the WFA compliance state, use the following command: ruckus(debug)# show strict-wfa-compliance-state NOTE: Its is highly recommended that the user contacts Ruckus customer support before enabling / disabling this CLI command. Syntax Description This command has no arguments or keywords.
Page 462: Show Tlsv1-State
Debug Commands show tlsv1-state show tlsv1-state To view tlsv1 support state, use the following command: ruckus(debug)# show tlsv1-state Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example ruckus(debug)# show tlsv1-state strict-wfa-compliance To enable WFA compliance, use the following command: ruckus(debug)# no strict-wfa-compliance...
Page 463: Tlsv1
Debug Commands tlsv1 tlsv1 To enable tlsv1 support, use the following command: ruckus(debug)# tlsv1 Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Debug Example ruckus(debug)# tlsv1 SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 464: Rbddump
Setup Commands Setup Commands This chapter describes the commands that you can use Sets up the controller. Commands covered include: • • rbddump • setup To setup the board data of the controller, use the following command: ruckus# rbd <board> <model> <serial> <mac> <mac-count> <customer> Syntax Description This command has the following syntax: <board>: Board name...
Page 465 Setup Commands rbddump ruckus# rbddump Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# rbddump name: Gallus magic: 35333131 cksum: 6dd rev: 5.4 Serial#: 00000089 Customer ID: ruckus Model: SCG1k V54 Board Type: Undef V54 Board Class: AP71...
Page 466: Setup
Setup Commands setup sysled2: no, gpio 0 sysled3: no, gpio 0 sysled4: no, gpio 0 Fixed Ctry Code: no Antenna Info: no, value 0x00000000 Local Bus: disabled factory: yes, gpio 8 serclk: internal cpufreq: calculated 0 Hz sysfreq: calculated 0 Hz memcap: disabled watchdg: enabled setup...
Page 467 Setup Commands setup Gateway : Default Gateway : Primary DNS Server : Secondary DNS Server : ************************************ ************************************ Cluster: ************************************ IP TYPE : IP Address : Netmask : Gateway : Default Gateway : Primary DNS Server : Secondary DNS Server : ************************************ ************************************ Management(Web):...
Page 468 Setup Commands setup Gateway : 10.2.0.1 Primary DNS Server : 172.17.17.16 Secondary DNS Server : 168.95.1.1 ************************************ Are these correct? (y/n): y Execute networking configuration of Control(AP/Dataplane)! Save networking configuration of Control(AP/Dataplane)! ************************************ IP address setup for Cluster ************************************ 1. MANUAL 2.
Page 469 Setup Commands setup Primary DNS Server : 172.17.17.16 Secondary DNS Server : 168.95.1.1 ************************************ Are these correct? (y/n): y Execute networking configuration of Management(Web)! Save networking configuration of Management(Web)! ************************************ Available Gateway: ************************************ Control : 10.2.0.1 Cluster : 10.2.0.1 Management : 10.2.0.1 ************************************ Select system default gateway (Control, Cluster, Management)? Management...
Page 470 Setup Commands setup ************************************ ************************************ Cluster: ************************************ IP TYPE : dhcp IP Address : 10.2.6.229 Netmask : 255.255.0.0 Gateway : 10.2.0.1 Default Gateway : no Primary DNS Server : 172.17.17.16 Secondary DNS Server : 168.95.1.1 ************************************ ************************************ Management(Web): ************************************ IP TYPE : dhcp IP Address : 10.2.6.230 Netmask : 255.255.0.0 Gateway : 10.2.0.1...
Page 471 Setup Commands setup Enter admin password: Enter admin password again: Enter the enable password: Enter the enable password again: Reset admin's password done! stty: standard input: Invalid argument New hostname: test_cluster Change admin password done! ************************************ Check SCG installation status ************************************ Wait for cluster config operation start! Wait for cluster config operation start!
Page 472: Show Commands
Show Commands Show Commands This chapter describes the commands that you can use to view information about the various components of controller. The following table lists the various Show commands. NOTE: Use the “do show” command to use show commands in either user or privileged mode.
Page 473: Show Admin-Activity
Show Commands show admin-activity Table 174. Show commands show running- show service show ttg-client show upgrade- show upgrade- config history state show version show wired- show zone client show admin-activity To view the activities of an administrator account, use the following command: ruckus# show admin-activity Syntax Description This command uses the following syntax:...
Page 474: Show Alarm
Show Commands show alarm show alarm To see the outstanding access point alarms, use the following command: ruckus# show alarm Syntax Description This command uses the following syntax: category <alarm-category> | source [ cluster | client | ap | mvno | scg ] [ data- plane | control-plane ] <name>...
Page 475 Show Commands show alarm License System Threshold Tunnel - Access Point control-plane <name> control-plane: Control Plane <name>: Plane name data-plane <name> data-plane: Data Plane <name>: Plane name [ ap-mac | zone ] <value> ap-mac: AP MAC address zone: AP Zone name <value>: Filter Value status [ outstanding | cleared ] status: Filtered by Status...
Page 476 Show Commands show ap warn: Warning type <alarm-type> type: Filtered by Type <alarm-type>: Alarm type Default This command has no default settings. Command Mode privileged Example ruckus# show alarm category session control-plane indus7-c show ap To display details about a particular access point, use the following command: ruckus# show ap <mac>...
Page 477: Show Ap-Certificate-Status
Show Commands show ap-certificate-status show ap-certificate-status To show the status of AP certificates, use the following command: ruckus# show ap-certificate-status [ request | update ] Syntax Description This command uses the following syntax: request - Shows AP certificate request status update - Shows AP certificate update status Default This command has no default settings.
Page 478: Show Ap-Stats
Show Commands show ap-stats show ap-stats To display the AP statistics, use the following command: ruckus# show ap-stats Syntax Description This command uses the following syntax: <mac> type [data-throughput | client-count | client-association ] ap period [ 30- d | 8-h | 24-h | 7-d ] <mac>: AP MAC address type: Statistics data type data-throughput: Data throughput...
Page 479 Show Commands show ap-stats 24-h: 24 hours <mac> type [ client-count | client-association | data-throughput ] zone <name> wlan <ssid> period [ 8-h | 24-h | 7-d| 30-d ] <mac>: AP MAC address type: Statistics data type client-count: Client count client-association: Client associations data-throughput: Data throughput zone: AP Zone...
Page 480 Show Commands show ap-stats 30-d: 30 days 8-h: 8 hours 24-h: 24 hours 7-d: 7 days <mac> type client-os <mac>: AP MAC address type: Statistics data type client-os: Client OS types <mac> type client-os zone <name> wlan <ssid> <mac>: AP MAC address type: Statistics data type client-os: Client OS types zone: AP Zone...
Page 481: Show Backup
Show Commands show backup period: Statistics period 8-h: 8 hours 30-d: 8 hours 7-d: 7 days 24-h: 24 hours Default This command has no default settings. Command Mode Privileged Example ruckus# show ap-stats 6C:AA:B3:26:68: air-time radio 5g period show backup To display a list of available system backup versions, use the following command: ruckus# show backup Syntax Description...
Page 482: Show Backup-Config
Show Commands show backup-config show backup-config To display a list of available configuration backup versions, use the following command: ruckus# show backup-config Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show backup-config...
Page 483: Show Backup-Network
Show Commands show backup-network show backup-network To display backup network configuration versions, use the following command: ruckus# show backup-network Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show backup-network show backup-schedule To display the schedule of system backup versions, use the following command: ruckus# show backup-schedule...
Page 484: Show Backup-Upgrade-State
Show Commands show backup-upgrade-state Default This command has no default settings. Command Mode Privileged Example ruckus# show backup-state show backup-upgrade-state To display the system backup system backup and upgrade state, use the following command: ruckus# show backup-upgrade-state Syntax Description This command has no arguments or keywords. Default This command has no default settings.
Page 485: Show Cgf-Cnxn-Stats
Show Commands show cgf-cnxn-stats show cgf-cnxn-stats To display the CGF connectivities statistics, use the following command: ruckus# show cgf-cnxn-stats Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show cgf-cnxn-stats show cgf-tx-stats To display the CGF transactions statistics, use the following command: ruckus# show cgf-tx-stats...
Page 486: Show Client
Show Commands show client show client To display current AP associated client sessions, use the following command: ruckus# show client Syntax Description This command uses the following syntax: <client-mac>: Client MAC address <mac-address>: MAC address of the wireless client <zone-name>: Zone name. Default This command has no default settings.
Page 487: Show Clock
Show Commands show clock # of Events Critical : 0 Major : 0 Minor : 0 Warning : 0 Informational : 0 show clock To display the current GMT date and time, use the following command: ruckus# show clock Syntax Description This command has no arguments or keywords.
Page 488: Show Cls-Sess-Range
Show Commands show cls-sess-range Example ruckus# show cls-sess msisdn 123456789012345 show cls-sess-range To display the session details of a user equipment created on or after the specified time at a node level, use the following command: ruckus# show cls-sess-range < sess establishment timestamp> <number of sessions>...
Page 489: Show Cluster-State
Show Commands show cluster-state Command Mode Privileged Example ruckus# show cluster ip-list Cluster Node IPs: 183.238.236.243 show cluster-state To display the system cluster state, use the following command: ruckus# show cluster-state Syntax Description This command has no arguments or keywords. Default This command has no default settings.
Page 490 Show Commands show control-plane Serial Number : 00000086 Model : SCG1k Description : SCG186 Management IP : 172.17.20.186 Cluster IP : 10.2.1.186 Control IP : 10.2.0.186 Firmware : 1.1.1.0.32 Status : In_Service Role : Follower # of APs : 1,233 Total Memory : 47.21G Total Disk : 500.76G # of Ports : 6...
Page 491: Show Control-Plane-Stats
Show Commands show control-plane-stats show control-plane-stats To display control plane status, use the following command: ruckus# show control-plane-stats <name> Syntax Description This command uses the following syntax: <name> type [ memory | disk | cpu ] period [ 7-d | 30-d | 24-h | 8-h ] <name>: Controlplane name type: Statistics data type memory: Memory usage...
Page 492 Show Commands show control-plane-stats <name> type interface [ management | control | cluster ] period [ 24-h | 7-d | 8- h | 30-d ] <name>: Controlplane name type: Statistics data type interface: Interface usage management: Management interface control: Control interface cluster: Cluster interface period: Statistics period 24-h: 24 hours...
Page 493: Show Counter
Show Commands show counter 2015-04-05 23:00:00 GMT 5.68% 0.43% 0.13% 2015-04-05 23:15:00 GMT 6.7% 0.53% 0.14% 2015-04-05 23:30:00 GMT 5.67% 0.44% 0.13% 2015-04-05 23:45:00 GMT 6.61% 0.55% 0.13% 2015-04-06 00:00:00 GMT 5.62% 0.44% 0.13% 2015-04-06 00:15:00 GMT 6.73% 0.63% 0.13% 2015-04-06 00:30:00 GMT 6.12% 0.44%...
Page 494: Show Cpuinfo
Show Commands show cpuinfo show cpuinfo To display the current CPU usage status, use the following command: ruckus# show cpuinfo Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show cpuinfo processor : 0 model name : Intel(R) Xeon(R) CPU E5645 @ 2.40GHz...
Page 495: Show Data-Plane-Stats
Show Commands show data-plane-stats Model : CN5750p2.1-750-SSP IP Address : 169.254.255.10 MAC Address : 00:1D:2E:87:00:18 Firmware : 1.1.1.0.29 Status : Fault # of Tunnels : 0 Managed By : SCG187 Uptime : 23h 37m Network Usage Summary ----------------------------------- Resource Data Type Last 15 Minutes Last 1 Hour Last 24 Hours Port 0 Bytes(Tx/Rx) 0/0 0/0 0/0 Port 0 Pkts(Tx/Rx/Tx Dropped/Rx Dropped) 0/0/0/0 0/0/0/0 0/0/0/0 Port 1 Bytes(Tx/Rx) 0/0 0/0 0/0...
Page 496: Show Dhcp-Relay-Stats
Show Commands show dhcp-relay-stats Command Mode Privileged Example ruckus# show data-plane stats show dhcp-relay-stats To display a list of DHCP relay statistics, use the following command: ruckus# show dhcp-relay-stats Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Privileged Example...
Page 497: Show Diameter-Gx-Stats
Show Commands show diameter-gx-stats show diameter-gx-stats To display the diameter Gx statistics, use the following command: ruckus# show diameter-gx-stats Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show diameter-gx-stats show diameter-sta-stats To display the diameter STA statistics, use the following command: ruckus# show diameter-sta-stats...
Page 498: Show Diameter-Stats
Show Commands show diameter-stats show diameter-stats To display the diameter server statistics, use the following command: ruckus# show diameter-stats Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example SCG00# show diameter-stats show diskinfo To display the current disk usage on the controller, use the following command: ruckus# show diskinfo...
Page 499: Show Event
Show Commands show event show event To see events based on staging zones, use the following command: ruckus# show event Syntax Description This command uses the following syntax: category <event-category> category: Filtered by event category <event-category>: Event category control-plane <name> control-plane: Control Plane <name>: Plane name data-plane <name>...
Page 500: Show Ggsn-Cnxn-Stats
Show Commands show ggsn-cnxn-stats critical: Critical info: Informational minor: Minor type <event-type> type: Filtered by Type <event-type>: Event type Default This command has no default settings. Command Mode Privileged Example ruckus# show event A1:87:45:34:56:FE show ggsn-cnxn-stats To display GGSN Connections statistics, use the following command: ruckus# show ggsn-cnxn-stats Syntax Description This command has no arguments or keywords...
Page 501: Show Ggsn-Gtpc-Stats
Show Commands show ggsn-gtpc-stats show ggsn-gtpc-stats To display GGSN GTP-C sessions statistics, use the following command: ruckus# show ggsn-gtpc-stats Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Privileged Example ruckus# show ggsn-gtpc-stats show history To display a list of CLI commands that have recently been executed, use the following command:...
Page 502: Show Hlr-Stats
Show Commands show hlr-stats show hlr-stats To display a list of HRL statistics, use the following command: ruckus# show hlr-stats Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode Privileged Example ruckus# show hlr-stats show hlr-sctp-stats To display a list of HLR SCTP associations statistics, use the following command:...
Page 503: Show Interface
Show Commands show interface show interface To display the interface runtime status, use the following command: ruckus# show interface <cluster> <control> <management> <user-defined> Syntax Description This command uses the following syntax: cluster - Cluster interface control - Control interface management - Management interface user-defined - User defined interface Default This command has no default settings.
Page 504: Show Internal-Subnet
Show Commands show internal-subnet Access & Core Separation : Disabled Default Gateway Interface : Control Primary DNS Server : 172.19.0.5 Secondary DNS Server : 4.2.2.2 User Defined Interfaces -------------------------------------------------------------- show internal-subnet To display the runtime internal subnet prefix, use the following command: ruckus# show internal-subnet Syntax Description This command has no arguments or keywords.
Page 505: Show License
Show Commands show ip show ip To display information about controller static route, use the following command: ruckus# show ip <route static> Syntax Description This command uses the following syntax: route: IP routing table static: Static routes Default This command has no default settings. Command Mode Privileged Example...
Page 506: Show Lma-Connectivity-Stats
Show Commands show lma-connectivity-stats -------------------------------------------------------------- License Type #of Units Total #of Units Consumed #of Units Available WiFi Controller License 10 1 (10%) 9 (90%) AP Direct Tunnel License 10 0 (0%) 10 (100%) SCG 3GPP Tunneling License 10 0 (0%) 10 (100%) SCG 3rd Party APs License 10 NA NA show lma-connectivity-stats To display the LMA connectivity status, use the following command:...
Page 507: Show Logs-Filter
Show Commands show logs-filter show logs-filter To display the LMA signalling status, use the following command: ruckus# show logs-filter Syntax Description This command has the following syntax: • client <mac> • client: Client MAC • <mac>: STA MAC Address • client <mac> copy <ftp-url> •...
Page 508: Show Md-Stats
Show Commands show md-stats show md-stats To display the md status, use the following command: ruckus# show md-stats Syntax Description This command has the following syntax: • scg • scg - display the Local MD shared memory Stats • peer-scg-mac ${scgMac} •...
Page 509: Show Meminfo
Show Commands show meminfo Default This command has no default settings. Command Mode Privileged Example To be updated show meminfo To view the current memory usage status, use the following command: ruckus# show meminfo Syntax Description This command has no arguments or keywords. Default This command has no default settings.
Page 510: Show Ntp
Show Commands show ntp show ntp To view the NTP status, use the following command: ruckus# show ntp <associations> Syntax Description This command uses the following syntax: associations: NTP peer status. Default This command has no default settings. Command Mode Privileged Example ruckus# show ntp associations...
Page 511 Show Commands show radius-proxy-stats CoA (AAA) DM (AAA) DM (NAS) Dropped requests due to rate Limiting (Auth/Acc) AP Accounting AP Accounting Request/ Response CoA (NAS) CoA Autz Only ----- -------------- -------------- ----------------- -------- 1 Super INDUS4-C 104.0.0.25 2015-03-20 12:46:20 GMT 2015-03-24 09:37:47 GMT Ruckus AP 0/0/0 0/0 6/6 0/0 0/0 0/0 6/6 0/0 0/0/0 0/0/0 0/0/0 0/0 0/2 6/0 0/0/0 0/0/0 2 Super INDUS4-C 104.0.0.2 2015-03-20 10:29:33 GMT 2015-03-24...
Page 512: Show Radius-Server-Stats
Show Commands show radius-server-stats show radius-server-stats To view statistics of RADIUS server on controller, use the following command: ruckus# show radius-server-stats Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show radius-server-stats No.
Page 513: Show Radshm-Stats
Show Commands show radshm-stats show radshm-stats To view RADIUS KPI (key performance indicators) captured per AAA server on the controller, use the following command: ruckus# show radius-server-stats <display> | <kill> | <send <ipaddress>> Syntax Description This command uses the following syntax: display: Displays the RADIUS KPI statistics captured on the controller kill: Stops sending the statistics collected to the elastic search database send: Sends the collected statistics to the elastic search database.
Page 514: Show Rogue-Aps
Show Commands show rogue-aps 1 2014-04-25 09:02:26 GMT Report1Client Number CSV Success 43ms 2 2014-04-25 00:00:02 GMT Report1 Client Number CSV Success 19ms 3 2014-04-24 00:00:02 GMT Report1 Client Number CSV Success 23ms 4 2014-04-23 00:00:02 GMT Report1 Client Number CSV Success 20ms show rogue-aps To view the rogue access points, use the following command: ruckus# show rogue-aps rogueMac ${rogueMac}...
Page 515: Show Run
Show Commands show run Example ruckus# show rogue-aps rogue-mac Rogue AP MAC rogue-type Rogue AP Type ruckus# show rogue-aps rogue-type ad-hoc ad-hoc mac-spoofing Malicious AP (MAC-spoof) rogue Rogue same-network Malicious AP (Same-Network) ssid-spoofing Malicious AP (SSID-spoof) show run To view a specific part of configuration during the running configuration, use the following commands: ruckus# show running-config <command name>...
Page 516 Show Commands show run control-plane Shows the control plane configurations data-plane Shows the data plane configurations dns-server-service Shows the DNS server service configurations domain Shows the management domain configurations dp-group Shows the data plane grouping configurations encrypt-mac-ip Shows the MAC and IP encryption for WISPr enriched URL configurations encrypt-zone-name Shows the AP Zone name encryption for WISPr enriched URL configurations...
Page 517 Show Commands show run outbound-firewall Shows the outbound firewall configurations radius-service Shows the RADIUS service configurations report Shows the report configurations rks-gre Shows the Ruckus GRE configurations sci-profile Shows the SCI profile configurations sci-setting Shows the SCI server configurations sms-server Shows the SMS server configurations smtp-server Shows the SMTP server configurations...
Page 518 Show Commands show run ruckus (config)# show running-config user-group admin Name Resource Manage by users Description Permission -------------------------------------------------------- ---- 1 Adb-Group,SZ,Admin Administration domain Adb-Jil Custom ruckus# show run cert Show Installed Certificates ruckus(config)# show run sci-profile SCI Configuration -------------------------------------------------------- Enable SCI :Disabled SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 519: Show Running-Config
Show Commands show running-config show running-config To view the current system configuration, use the following commands: ruckus# show running-config < Syntax Description This command uses the following syntax: zone <name> zone: Shows the AP Zone configurations <name>: AP Zone name zone <name>...
Page 520 Show Commands show running-config <name>: WISPr (Hotspot) name zone <name> guest-access <name> zone: Shows the AP Zone configurations <name>: AP Zone name guest-access: Shows the guest access configurations <name>: Guest access name zone <name> web-authentication <name> zone: Shows the AP Zone configurations <name>: AP Zone name web-authentication: Shows the web authentication configurations <name>: Web authentication name...
Page 521 Show Commands show running-config zone: ${zoneKey}: hotspot20-venue-profile: Shows the Hotspot 2.0 venue profile configuration <name>: Hotspot 2.0 venue profile name zone <name> ap-group <name> zone: Shows the AP Zone configurations <name>: AP Zone name ap-group: Shows the AP Group configurations <name>: AP Group name zone <name>...
Page 522 Show Commands show running-config <name>: AP Zone name diffserv: Show DiffServ configurations <name>: DiffServ name zone ${zoneKey} bonjour-gateway zone: ${zoneKey}: bonjour-gateway: Show Bonjour Gateway zone ${zoneKey} bonjour-policy <name> zone: ${zoneKey}: bonjour-policy: Show Bonjour Policy <name>: Policy Name zone ${zoneKey} bonjour-fencing zone: ${zoneKey}: bonjour-fencing: Show Bonjour Fencing...
Page 523 Show Commands show running-config zone: ${zoneKey}: l2-acl: Show Layer 2 Access Control List (ACL) <name>: ACL Name zone <name> usb-software <name> zone: Show AP Zone configurations <name>: AP Zone name usb-software: Show AP USB software packages <name>: AP USB software name. Format: {VID}-{PID}-{Version} ap <mac>...
Page 524 Show Commands show running-config <username>: User name admin-radius <name> admin-radius: <name>: RADIUS server name mvno <name> mvno: <name>: MVNO domain name user-group <domain> <group> user-group: <domain>: Domain name <group>: User Group name user-role <name> user-role: <name>: User Role name subpackages <name> subpackages: Shows the subscription packages configurations <name>: Subscription packages domain <name>...
Page 525 Show Commands show running-config domain <name> zone <name> wlan <name> domain: Shows the management domain configurations <name>: Domain name zone: Show AP Zone configurations <name>: AP Zone name wlan: Show WLAN configurations <name>: WLAN name domain <name> zone <name> aaa <name> domain: Shows the management domain configurations <name>: Domain name zone: Show AP Zone configurations...
Page 526 Show Commands show running-config <name>: AP Zone name hotspot20-venue-profile: Shows the Hotspot 2.0 venue profile configurations <name>: Shows the Hotspot 2.0 Venue profile name domain <name> zone <name> ap-group <name> domain: Shows the management domain configurations <name>: Domain name zone: Shows the AP Zone configurations <name>: AP Zone name ap-group: Shows the AP Group configurations <name>: AP Group name...
Page 527 Show Commands show running-config domain: Show Management Domain configurations <name>: Domain name zone: Shows the AP Zone configurations <name>: AP Zone name block-client: Shows the blocked client configurations <mac>: Blocked client MAC zone-template <name> zone-template: <name>: AP Zone Template name zone-template <name>...
Page 528 Show Commands show running-config wechat: Shows the WeChat configurations <name>: WeChat name zone-template <name> hotspot20-wlan-profile <name> zone-template: Shows the AP Zone template configurations <name>: AP Zone template name hotspot20-wlan-profile: Shows the Hotspot 2.0 WLAN profile configurations <name>: Hotspot 2.0 WLAN profile name zone-template <name>...
Page 529 Show Commands show running-config <name>: AP Zone Template name ap-model: Shows the AP model configurations <name>: AP model name zone-template <name> diffserv <name> zone-template: Shows the AP Zone template configurations <name>: AP Zone template name diffserv: Shows the DiffServ profile configurations <name>: DiffServ profile name zone-template <name>...
Page 530 Show Commands show running-config zone-template <name> guest-access <name> zone-template: Shows the AP Zone template configurations <name>: AP Zone Template name guest-access: Shows the guest access configurations <name>: Guest access name zone-template <name> l2-acl <name> zone-template: Shows the AP Zone template configurations <name>: AP Zone template name l2-acl: Shows the Layer 2 Access Control List (ACL) <name>: Layer 2 Access Control name...
Page 531 Show Commands show running-config <name>: WISPr (Hotspot) name wlan-template <name> wechat <name> wlan-template: Shows the WLAN template configurations <name>: WLAN template name wechat: Shows the WeChat configurations <name>: WeChat name wlan-template <name> hotspot20-wlan-profile <name> wlan-template: Shows the WLAN template configurations <name>: WLAN template name hotspot20-wlan-profile: Show Hotspot 2.0 WLAN profile configurations <name>: Hotspot 2.0 WLAN profile name...
Page 532 Show Commands show running-config wlan-template: Shows the WLAN template configurations <name>: WLAN template name guest-access: Shows the guest access configurations <name>: Guest access name wlan-template <name> device-policy <name> wlan-template: Shows the WLAN template configurations <name>: WLAN template name device-policy: Shows the device policy <name>: Device Policy name wlan-template <name>...
Page 533 Show Commands show running-config user-defined: Shows the user defined interface configurations <name>: User defined interface name control-plane <name> interface [ cluster | control | management ] control-plane: Shows the control plane configurations <name>: Control plane name interface: Shows the interface configurations cluster: Cluster interface control: Control interface management: Management interface...
Page 534 Show Commands show running-config ${eventCode}: snmp-v3-user <snmp-user> snmp-v3-user: Shows the SNMPv3 user configurations <snmp-user>: SNMPv3 User interface ${ifName}? interface: ${ifName}?: interface user-defined <name> interface: user-defined: Shows the user defined interface configurations <name>: User defined interface name ip route static ip: Shows the control plane IP configurations route: Shows the control plane routing configurations static: Shows the static routes internal-subnet...
Page 535 Show Commands show running-config dns-server-service: <name>: DNS server service name ipsec-profile <name> ipsec-profile: <name>: IPsec profile name rks-gre <name> rks-gre: <name>: Ruckus GRE name operator-profile <name> operator-profile: <name>: Wi-Fi operator profile name identity-provider <name> identity-provider: <name>: Identity provider name vlan-pooling ${profileName}? vlan-pooling: ${profileName}?: ntp-server...
Page 536 Show Commands show running-config mgmt-acl: <name>: ACL rule name web-cert web-cert: eth-port-validate-one-trunk eth-port-validate-one-trunk: user-agent-blacklist <name> user-agent-blacklist: Shows the user agent black list configurations <name>: User agent black name lwapp2scg lwapp2scg: Shows the LWAPP2SCG configuration encrypt-mac-ip encrypt-mac-ip: encrypt-zone-name encrypt-zone-name: node-affinity <name> node-affinity: Shows the node affinity configurations <name>: Node affinity profile name ap-control-mgmt-tos...
Page 537 Show Commands show running-config calea-server-ip calea-server-ip: Shows the CALEA Server IP configurations calea-mac calea-mac: Shows the CALEA MAC configurations zone-affinity <name> zone-affinity: Shows vSZ-D Zone affinity configurations <name>: vSZ-D Zone affinity profile name cert-store setting cert-store: Shows the Certificate Store configurations setting: Shows the service certificates cert-store cert <name>...
Page 538 Show Commands show running-config ldap-service <name> ldap-service: <name>: LDAP service name oauth-service <name> oauth-service: <name>: OAuth service name localdb-service localdb-service:. Default This command has no default settings. Command Mode Privileged Example ruckus# show running-config cert-store cert Show Installed Certificates Show Certificates Signing Request (CSR) setting Show Service Certificates INDUS4# show running-config cert-store cert...
Page 539: Show Service
Show Commands show service show service To view the system service state, use the following command: ruckus# show service Syntax Description This command uses the following syntax: name: System service name Default This command has no default settings. Command Mode Privileged Example ruckus# show service...
Page 540: Show Ttg-Client
Show Commands show ttg-client show ttg-client To view the current TTG client sessions, use the following command: ruckus# show ttg-client <client-mac> Syntax Description This command uses the following syntax: client-mac: Client MAC address Default This command has no default settings. Command Mode Privileged Example...
Page 541: Show Upgrade-State
Show Commands show upgrade-state show upgrade-state To display the system upgrade state, use the following command: ruckus# show upgrade-state Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# show upgrade-state show version To view the controller version, use the following command: ruckus# show version...
Page 542: Show Wired-Client
Show Commands show wired-client show wired-client To view the current AP’s associated wired client sessions, use the following command: ruckus# show wired-client <wired-client-mac> Syntax Description This command uses the following syntax: <wired-client-mac>: Wired client MAC address Default This command has no default settings. Command Mode Privileged Example...
Page 543 Show Commands show zone Default This command has no default settings. Command Mode Privileged Example SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 544: System Commands
System Commands System Commands This chapter describes the commands that you can use to configure administrative and system settings on the controller. The following table list the System Commands. Table 175. System commands backup backup config backup network backup schedule backup- cluster in- config...
Page 545 System Commands To display commands that are available on the command line, use the following command: ruckus# ? Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# backup Backups the system or configuration backup-upgrade Backups and upgrades the system cluster...
Page 546: Backup
System Commands backup backup To backup the controller whole cluster system, use the following command: ruckus# backup Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# backup backup config To backup controller configuration, use the following command: ruckus# backup config Syntax Description...
Page 547: Backup Network
System Commands backup network backup network To backup controller network configuration, use the following command: ruckus# backup network Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# backup network backup schedule To create a schedule for backing up the configuration, use the following command: ruckus# backup schedule <...
Page 548: Backup-Upgrade
System Commands backup-upgrade <minute>: Minute value daily <hour> minute <minute> daily: Daily <hour>: Hour value (GMT) minute: Minute <minute>: Minute value disable disable: Schedule disable Default This command has no default settings. Command Mode Privileged Example ruckus-Node1# backup-upgrade ftp://mahan:ruckus1!@172.19.7.100/ backup/AP_ad87453456fe.csv backup-upgrade To backup and upgrade the controller whole cluster system, use the following command:...
Page 549: Cluster In-Service
System Commands cluster in-service cluster in-service To restore the cluster to a normal state, use the following command: ruckus# cluster in-service Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# cluster in-service config...
Page 550: Copy
System Commands copy copy To copy backup, backup-config, or backup-network file from external FTP server, use the following command: ruckus# copy <ftp-url> backup ruckus# copy <ftp-url> backup-config ruckus# copy <ftp-url> backup-network Syntax Description This command uses the following syntax: <ftp-url> backup: Backup file. FTP URL format: ftp://<username>:<pass- word>@<ftp-host>[/<dir-path>] <ftp-url>...
Page 551: Copy Backup
System Commands copy backup new: Only copies APs that need to be exported <ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftp- host>[/<dir-path>] Default This command has no default settings. Command Mode Privileged Example ruckus# copy ap-certificate-request all ftp:// test:testpwd@172.17.22.11 copy backup To copy backup file to external FTP server, use the following command: ruckus# copy backup <ftp-url>...
Page 552: Copy Backup-Network
System Commands copy backup-network <ftp-url>: FTP directory. FTP URL format: ftp://<username>:<password>@<ftp- host>[/<dir-path>] Default This command has no default settings. Command Mode Privileged Example ruckus# copy backup-config ftp://test:testpwd@172.17.22.11/scg- config copy backup-network To copy backup network configuration file to external FTP server, use the following command: ruckus# copy backup-network <ftp-url>...
Page 553: Copy Report-Result
System Commands copy report-result <name> <ftp-url> <name>: AP Zone name <ftp-url>: FTP directory, FTP URL Format: ftp://<username>:<pass- word>@<ftp-host>[/<dir-path>] Default This command has no default settings. Command Mode Privileged Example ruckus# copy client test Zone ftp://test:testpwd@172.17.22.11 copy report-result To copy report result to external FTP server, use the following command: ruckus# copy report-result <name>...
Page 554: Copy Ftp-Url
System Commands copy ftp-url ruckus# copy report-result scg report ftp:// test:testpwd@172.17.22.11 copy ftp-url To copy files from external FTP server, use the following command: ruckus# copy ftp-url <name> <ftp-url> Syntax Description The command uses the following syntax: <ftp-url>: FTP directory, FTP URL format: ftp://<username>:<password>@<ftp- host>[/<dir-path>]] Default This command has no default settings.
Page 555 System Commands curl --compressed Request compressed response (using deflate or gzip) -K/--config <file> Specify which config file to read --connect-timeout <seconds> Maximum time allowed for connection -C/--continue-at <offset> Resumed transfer offset -b/--cookie <name=string/file> Cookie string or file to read cookies from (H) -c/--cookie-jar <file>...
Page 556: Delete Backup
System Commands delete backup -G/--get Send the -d data with a HTTP GET (H) -g/--globoff Disable URL sequences and ranges using {} and [] -H/--header <line> Custom header to pass to server (H) -I/--head Show document info only -h/--help This help text --hostpubmd5 <md5>...
Page 557 System Commands delete backup ruckus# delete backup <version> Syntax Description This command uses the following syntax: <version>: Backup version Default This command has no default settings. Command Mode Privileged Example ruckus# delete backup ruckus# delete backup 1 SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...
Page 558: Delete Backup-Config
System Commands delete backup-config delete backup-config To delete certain or all backup configuration files, use the following command: ruckus# delete backup-config <version> Syntax Description This command uses the following syntax: <version>: Backup configuration version Default This command has no default settings. Command Mode Privileged Example...
Page 559: Delete Client
System Commands delete client delete client To delete AP client, use the following command: ruckus# delete client <client-mac> Syntax Description This command uses the following syntax: <client-mac>: Client Mac address Default This command has no default settings. Command Mode Privileged Example ruckus# delete client A1:87:45:34:56:FE diagnostic...
Page 560 System Commands diagnostic Related Commands Table 176 lists the related diagnostic commands. Table 176. Commands related to ruckus(diagnostic) Syntax and Type Parameters (If Any) Description ruckus(diagnostic)# copy snapshot <ftp-url>: Copy snapshot to external FTP server. Type: Privileged FTP directory URL, Format: ftp:// <username>:<password >@<ftp-host>[/<dir-...
Page 561 System Commands diagnostic Table 176. Commands related to ruckus(diagnostic) Syntax and Type Parameters (If Any) Description ruckus(diagnostic)# remote- Enables remote packet capture packet-capture enable Type: Privileged ruckus(diagnostic)# show ipmi [ leds | fru | sel | rks | health ] Shows IPMI information.
Page 562: Enable
System Commands enable enable To enable privileged commands on the command line interface, use the following command: ruckus# enable Syntax Description This command uses the following syntax: password: Password to change the mode. Default This command has no default settings. Command Mode Privileged Example...
Page 563: Exit
System Commands exit Old Password: ********* New Password: ********* Retype: ********* Successful operation exit To exit from EXEC, use the following command: ruckus# exit Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode User Example...
Page 564: Logout
System Commands logout exit Turn off privileged commands help Display this help message logout Exit from the EXEC logout To exit from EXEC, use the following command: ruckus# logout Syntax Description This command has no arguments or keywords Default This command has no default settings. Command Mode User Example...
Page 565: No Service
System Commands no service Command Mode Privileged Example ruckus# log-diagnostic ap-log-level-set no service To stop all controller services, use the following command: ruckus# no service Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example...
Page 566: Ping
System Commands ping Command Mode User Example ruckus# patches ruckus(patches)# show <applied-patches> <uploaded-patches> Related Commands Table 177 lists the related patches commands. Table 177. Commands related to ruckus(patches) Syntax and Type Parameters (If Any) Description ruckus(patches)# apply <name> Applies a patch script. Once a patch is applied is cannot be re- Type: Privileged applied.
Page 567: Ping6
System Commands ping6 ruckus# ping <ip> <name> Syntax Description This command uses the following syntax: <ip>: IP address <name>: Domain name Default This command has no default settings. Command Mode User Example ruckus# ping 172.17.20.182 Start ping server (172.17.20.182) for 3 times... PING 172.17.20.182 (172.17.20.182) 56(84) bytes of data.
Page 568: Reload
System Commands reload Example ruckus# ping6 172.17.20.182 reload To reload the controller after 30 seconds, use the following command: ruckus# reload <seconds> Syntax Description This command uses the following syntax: seconds: Indicate the number of seconds before controller reboots itself. Default This command has no default settings.
Page 569: Reload Data-Plane
System Commands reload data-plane Example ruckus# reload ap 00:1c:2d:ee:ff:cc Success to trigger AP (00:1c:2d:ee:ff:cc) reboot reload data-plane To reboot a dataplane, use the following command ruckus# reload data-plane <name> Syntax Description This command uses the following syntax: name: Dataplane name Default This command has no default settings.
Page 570: Remote Ap-Cli
System Commands remote ap-cli remote ap-cli To display the name and firmware version of a remote access point, use the following command: ruckus# remote ap-cli <mac> <command> Syntax Description This command uses the following syntax: mac: MAC address of the access point command: Command that retrieves the access point name and firmware version, double-quoted Default...
Page 571: Restore Config
System Commands restore config Example ruckus# restore Please choose a backup to restore or ‘No’ to cancel This action will reboot the system. Do you want to restore "the entire" cluster system? (yes/no) # Yes: restore cluster, no: original restore local Do you want to restore the "local"...
Page 572: Restore Network
System Commands restore network restore network To restore the network configuration, use the following command: ruckus# restore network Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# restore network service restart To restart all the controller services, use the following command: ruckus# service restart...
Page 573: Service Start
System Commands service start service start To start all the controller services, use the following command: ruckus# service start Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# service start Please note that this command will cause current SSH connection closed for SSH restart.
Page 574: Set-Factory
Before resetting a node to factory settings, Ruckus Wireless strongly recommends that you export all of the backup files on the controller to an FTP server using either the web interface or CLI.
Page 575: Shutdown
System Commands shutdown Example ruckus# setup shutdown To shutdown the controller gracefully, use the following command: ruckus# shutdown <seconds> Syntax Description This command uses the following syntax: seconds: Indicates the number of seconds before controller shutdowns. Default This command has no default settings. Command Mode Privileged Example...
Page 576: Traceroute
System Commands traceroute traceroute To print the route that packets take to the network host, use the following command: ruckus# traceroute Syntax Description This command has no arguments or keywords. Default This command has no default settings. Command Mode Privileged Example ruckus# traceroute traceroute6...
Page 577: Upgrade
System Commands upgrade upgrade To upgrade the controller system, use the following command: ruckus# upgrade <ftp-url> Syntax Description This command uses the following syntax: <ftp-url>: Upgrade file. FTP URL format is: ftp://<username>:<password>@<ip>[/ <file-path>]. Default This command has no default settings. Command Mode Privileged Example...
Page 578 Index Index cgf-service-ftp-server cgf-service-server channel clock cluster in-service cluster redundancy cluster redundancy cluster 84, 85 cluster-ip-list Symbols cluster-redundancy config config-adv-forwarding-profile-ap related commands Numerics config-domain-zone-web-authentication 3rdparty-zone 3rd-zone-wlan config-zone-ap-group Connect the Administrative Computer to copy accessing the SCG CLI copy backup acct-profile copy backup-config acct-profile-realm copy client...
Page 579 Index domain-zone-ap-group ggsn-service-apn domain-zone-ap-group-lldp domain-zone-ap-group-port-setting domain-zone-ap-model 455, 563 help domain-zone-ap-model-lan1 hlr-mnc-ndc domain-zone-ap-registration-rule hlr-mnc-ndc server domain-zone-bonjour-policy 202, 203 hlr-service domain-zone-bonjour-policy-rule hlr-service- sctp domain-zone-client-isolation-whitelist hlr-service-sccp-gtt hlr-system-wide domain-zone-device-policy hotspot domain-zone-device-policy-policy-rule hotspot20-wlan-profile-cust-connect-ca- pabilities domain-zone-diffserv hotspot-profile domain-zone-ethernet-port-profile domain-zone-guest-access 146, 148 domain-zone-hotspot domain-zone-hotspot20-wlan-profile identity-provider domain-zone-hotspot20-wlan-profile identity-provider-acct-profile cust-connect-capabilities identity-provider-acct-profile-realm domain-zone-l2-acl...
Page 580 Index no snmp-v3-user no soft-gre management (Web) interface 302, 307 no ttg-pdg-profile mgmt-acl no zone mgmt-acl server node-affinity mgmt-acl-rule node-affinity-config 265, 266 mvno node-affinity-config-profile mvno-admin node-affinity-configuration mvno-admin-radius northbound-authtype northbound-portal ntp-server no 3rd-zone no acct-profile no admin oauth-service no admin-radius operator-profile no adv-forwarding-profile osu-portal-profile no ap...
Page 581 Index show ttg-client show upgrade-history 458, 459 screen-pagination show upgrade-state 17, 21 serial connection 541, 542 show version service restart show zone service start shutdown set-factory shutdown force 466, 574 setup shutdown now show admin-activity 332, 333, 335 sms-server show alarm 334, 335, 336 smtp-server 476, 477...
Page 582 Index zone-ap-group zone-ap-group-group-ap-snmp-options zone-ap-group-lldp zone-ap-group-port-setting zone-ap-model zone-ap-model-lan1 400, 401, 402 zone-ap-registration-rule zone-ap-snmp-options zone-ap-snmp-options-snmp-v2-com- munity zone-block-client zone-bonjour-fencing-policy zone-bonjour-policy zone-bonjour-policy-rule zone-device-policy zone-device-policy-policy-rule zone-diffserv zone-guest-access zone-hotspot zone-hotspot20-venue-profile zone-hotspot20-wlan-profile zone-l2-acl 441, 446 zone-template 424, 425 zone-web-authentication zone-wlan zone-wlan-group zone-wlan-scheduler SCG200, vSZ-H and SZ300 Command Line Interface Reference Guide for SmartZone 3.5.1, 800-71515-001 Rev A...

This manual is also suitable for:

Virtual smartzone high-scale Smartzone 300

Ruckus Wireless SmartCell Gateway 200 Command Line Interface Reference Manual

1 Introduction to the Controller Command Line Interface

2 Configuration Commands (a - D)

3 Rd-Zone

Configuration Commands (E - R)

4 Configuration Commands (S - Z)

5 Debug

6 Setup Commands

7 Show Commands

8 System Commands

Quick Links

Related Manuals for Ruckus Wireless SmartCell Gateway 200

Summary of Contents for Ruckus Wireless SmartCell Gateway 200