VSZ 36 GettingStartedGuide RevA 20171110 PDF
VSZ 36 GettingStartedGuide RevA 20171110 PDF
No part of this documentation may be used, reproduced, transmitted, or translated, in any form or by any means, electronic, mechanical,
manual, optical, or otherwise, without prior written permission of or as expressly provided by under license from Brocade.
Disclaimer
THIS DOCUMENTATION AND ALL INFORMATION CONTAINED HEREIN (“MATERIAL”) IS PROVIDED FOR GENERAL INFORMATION
PURPOSES ONLY. BROCADE and RUCKUS WIRELESS, INC. AND THEIR LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, WITH REGARD TO THE MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE MATERIAL IS ERROR-FREE,
ACCURATE OR RELIABLE. BROCADE and RUCKUS RESERVE THE RIGHT TO MAKE CHANGES OR UPDATES TO THE MATERIAL AT
ANY TIME.
Limitation of Liability
IN NO EVENT SHALL BROCADE or RUCKUS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL
DAMAGES, OR DAMAGES FOR LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY YOU OR ANY THIRD PARTY, WHETHER
IN AN ACTION IN CONTRACT OR TORT, ARISING FROM YOUR ACCESS TO, OR USE OF, THE MATERIAL.
Trademarks
Ruckus Wireless, Ruckus, the bark logo, BeamFlex, ChannelFly, Dynamic PSK, FlexMaster, Simply Better Wireless, SmartCell, SmartMesh,
SmartZone, Unleashed, ZoneDirector and ZoneFlex are trademarks of Ruckus Wireless, Inc. in the United States and in other countries.
Brocade, the B-wing symbol, MyBrocade, and ICX are trademarks of Brocade Communications Systems, Inc. in the United States and in
other countries. Other trademarks may belong to third parties.
Installation Preparation................................................................................................................................................................................ 11
Obtaining the vSZ Distribution.............................................................................................................................................................. 11
Preparing the vSZ Interface Settings to Use......................................................................................................................................... 11
Determining the System Resources That the Virtual Machine Requires.................................................................................................12
Clustering Limitations for vSZ-H.................................................................................................................................................... 13
Clustering Limitations for vSZ-E.................................................................................................................................................... 13
Upgrading the Controller for Microsoft Azure, AWS, and GCE Platforms....................................................................................................167
Upgrading the Controller for Microsoft Azure, AWS, and GCE Platforms............................................................................................ 167
Upgrading the Controller Software..................................................................................................................................................... 167
Verifying the Upgrade......................................................................................................................................................................... 169
Rolling Back to a Previous Software Version.......................................................................................................................................170
Backing Up and Restoring Clusters.............................................................................................................................................171
Document Conventions
The following tables list the text and notice conventions that are used throughout this guide.
NOTE
A NOTE provides a tip, guidance, or advice, emphasizes important information, or provides a reference to related information.
CAUTION
A CAUTION statement alerts you to situations that can be potentially hazardous to you or cause damage to hardware, firmware,
software, or data.
DANGER
A DANGER statement indicates conditions or situations that can be potentially lethal or extremely hazardous to you. Safety labels
are also attached directly to products to warn of these conditions or situations.
Convention Description
bold text Identifies command names, keywords, and command options.
Convention Description
italic text Identifies a variable.
[] Syntax components displayed within square brackets are optional.
Default responses to system prompts are enclosed in square brackets.
{x|y|z} A choice of required parameters is enclosed in curly brackets separated by vertical bars. You must select
one of the options.
x|y A vertical bar separates mutually exclusive elements.
<> Nonprinting characters, for example, passwords, are enclosed in angle brackets.
... Repeat the previous element, for example, member[member...].
\ Indicates a “soft” line break in command examples. If a backslash separates two lines of a command input,
enter the entire command at the prompt without the backslash.
Document Feedback
Ruckus is interested in improving its documentation and welcomes your comments and suggestions.
Ruckus resources
Visit the Ruckus website to locate related documentation for your product and additional Ruckus resources.
Release Notes and other user documentation are available at https://support.ruckuswireless.com/documents. You can locate
documentation by product or perform a text search.
White papers, data sheets, and other product documentation are available at www.ruckuswireless.com.
For product support information and details on contacting the Support Team, go directly to the Support Portal using https://
support.ruckuswireless.com, or go to https://www.ruckuswireless.com and select Support.
Open a Case
When your entire network is down (P1), or severely impacted (P2), call the appropriate telephone number listed below to get help:
• Continental United States: 1-855-782-5871
• Canada: 1-855-782-5871
• Europe, Middle East, Africa, and Asia Pacific, toll-free numbers are available at https://support.ruckuswireless.com/contact-us and
Live Chat is also available.
Self-Service Resources
The Support Portal at https://support.ruckuswireless.com/contact-us offers a number of tools to help you to research and resolve problems
with your Ruckus products, including:
• Technical Documentation—https://support.ruckuswireless.com/documents
• Community Forums—https://forums.ruckuswireless.com/ruckuswireless/categories
• Knowledge Base Articles—https://support.ruckuswireless.com/answers
• Software Downloads and Release Notes—https://support.ruckuswireless.com/software
• Security Bulletins—https://support.ruckuswireless.com/security
Using these resources will help you to resolve some issues, and will provide TAC with additional data from your troubleshooting analysis if
you still require assistance through a support case or RMA. If you still require help, open and manage your case at https://
support.ruckuswireless.com/case_management
Topics covered in this guide include preparing your chosen hypervisor, installing the vSZ image on to the hypervisor, and completing the vSZ
Setup Wizard.
This guide is intended for use by those responsible for installing and setting up network equipment. Consequently, it assumes a basic
working knowledge of local area networking, wireless networking, and wireless devices.
NOTE
If release notes are shipped with your product and the information there differs from the information in this guide, follow the
instructions in the release notes.
Most user guides and release notes are available in Adobe Acrobat Reader Portable Document Format (PDF) or HTML on the Ruckus
Wireless Support website at https://support.ruckuswireless.com/documents.
Notice Conventions
The following table lists the notice conventions that are used throughout this guide.
CAUTION
If you choose to operate the vSZ with three network interfaces, you must configure the three vSZ interfaces to be on three
different subnets when you run the Setup Wizard. Failure to do so may result in loss of access to the web interface or failure of
system functions and services.
• IP address
• Netmask
• Gateway
• Primary DNS server
• Secondary DNS server
vSZ is capable of automatically scaling to and supporting a higher number of APs and clients if it determines, at system bootup, that there
is sufficient CPU and memory on the virtual machine to support more APs and clients. The two tables below list the maximum
recommended number of APs and clients that the vSZ can support based on the available vCPU and memory available on the virtual
machine.
CAUTION
When either the AP count or the client count reaches the maximum limit specified in the tables, you must allocate additional
system resources to the VM. For example, if a VM is allocated with Level 3 resources to handle 100 APs and the AP count
increases to 101, you must update the VM to Level 4 resources to prevent performance-related issues.
All resource levels in the following tables are provided based on Intel Xeon CPU E5- 2630v2 @2.60 GHz. If the server on which you are
hosting the controller software is using a different CPU generation and/or model, it may perform differently. In this case, CPU adjustments
can be made to generate the same level of performance.
CAUTION
The minimum memory and CPU requirements have changed in this release. You may need to upgrade your infrastructure before
upgrading. Please read carefully. This is the minimum requirement recommended.
NOTE
Logic Processor 1 vCPU requirement is based on Intel Xeon CPU E5- 2630v2 @2.60 GHz.
Logic Processor 2 Azure with low CPU throughput unsupported. The vSZ with the lowest resource plan (2 core CPU, 13 GB
memory) can NOT be supported due to the low CPU throughput on Azure.
Preparing a Hypervisor
This section lists the hypervisors (and their release versions) on which you can install the vSZ.
Verify that you have the prerequisites before installing the vSZ on VMWare vSphere.
• Verify that vSphere client is installed.
• You can deploy the vSZ only on hosts that are running ESXi version 5.5 and later.
• The vSZ appliance requires at least 100GB of disk space and is limited to a maximum size of 600GB. The vSZ appliance can be
deployed with thinprovisioned virtual disks that can grow to the maximum size of 600GB.
1. Use the VMWare vSphere client to log on to the ESXi management interface.
2. Click File> Deploy OVF Template. The Source screen of the Deploy OVF Template wizard appears.
3. Click Browse to locate the .ova file that you downloaded earlier. Select the template.
FIGURE 2 Click Browse, and then locate and select .ova file
5. Review the OVA virtual appliance details, and then click Next. The End User License Agreement (EULA) screen appears.
6. Click Accept to agree to the EULA terms, and then click Next. The Host/Cluster screen appears.
7. Select the host or cluster on which you want to run the deployed template, and then click Next. The Resource Pool screen
appears.
8. Select the resource pool within which you want to deploy the template, and then click Next. The storage screen appears.
9. Select the destination storage (data store) for virtual machine files, and then click Next. The Disk Format screen appears.
FIGURE 7 Select the data store for the virtual machine files
10. Select the disk format that is appropriate for your deployment scenario. Options include:
• Thick Provision Lazy Zeroed
• Thick Provision Eager Zeroed
• Thin Provision
12. Select the ESXi virtual network interface that you want to use for the control interface, and then click Next. The Ready to Complete
screen appears.
The installation screen only allows you to select the virtual network interface for the control interface. After you complete the
installation (and before you power on and set up the vSZ), you will need to adjust the cluster and management interfaces as
appropriate.
FIGURE 9 Select the virtual network interface that the template will use
13. Review the settings that you have configured on the previous screens. If you find a setting that you want to change, click Back
until you reach the screen where you can edit the setting. Update the setting, and then click Next until you reach the Ready to
Complete screen again.
14. Make sure that the Power on after deployment check box is clear so you can adjust the network settings before the vSZ
setup.Caution: If you power on the vSZ after installation, you will no longer be able to adjust the network settings.
15. Click Finish.
ESXi deploys the new vSZ instance. When ESXi completes the deployment, the new vSZ instance appears on the list of installed virtual
machines on the target host.
You have completed creating a vSZ instance from the OVA file.
Ensure that you read steps 1-7 before starting the application.
Follow these steps to allocate resources and assign network interfaces to the vSZ.
5. Under Network adapter 2, select the ESXi network interface for the cluster interface from the drop-down list. Ensure that the
Connect at Power On option is selected.
6. Under Network adapter 3, select the ESXi network interface for the management interface from the drop-down list. Ensure that the
Connect at Power On option is selected.
7. Click OK. You have completed allocating resources and assigning network interfaces to the vSZ.
1. From the list of virtual machines on the host, click the vSZ instance.
2. Under Basic Tasks, click Power on the virtual machine.
3. Open a console window to monitor the startup process. To do this, click the Action menu, and then click Open Console.
After the vSZ completes its startup process, you are ready to perform the initial IP address setup of the vSZ. You will use the
console connection to perform this task.
5. In the Hyper-V Manager, select the Hyper-V core for which you want to create a virtual machine and click Virtual Machine >
Action > New > New Virtual Machine Wizard. The appears and displays the Before You Begin screen.
7. In Name, type a name for the virtual machine that you are installing (for example, Virtual SmartZone).
8. Specify the folder on the server where you want to install the virtual machine.
a) To install the virtual machine in the default location, make sure that the Store the virtual machine in a different location check
box is clear.
b) To install the virtual machine in a location other than the default, select and Store the virtual machine in a different location
check box, and then browse to or type the new location.
10. Select Generation 1 for the virtual machine that you are installing. Hyper-V offers Generation 1 and Generation 2. See the Hyper-V
documentation for more information about these two generations.
12. In Startup memory, type 13GB for vSZ High Scale or 15GB for vSZ Essentials (as relevant), which are the minimum memory that
Ruckus Wireless recommends for deploying vSZ. You can type a higher value if more memory is available on the server. For more
information, see Table 4 and Table 5.
14. In Connection, select the network adapter that you want the virtual machine to use.
15. Click Next. The Connect Virtual Hard Disk screen appears.
17. Click Browse to specify the location of the existing virtual hard disk for the virtual machine to use.
18. Click Next. The Completing New Virtual Machine Wizard screen appears.
19. Review the settings that you can configure for the virtual machine. If you find any setting that need to be changed, click Previous
until you reach the screen where you can update the setting. Update the setting, and then click Next until the Completing New
Virtual Machine Wizard screen appears again.
20. Click Finish to install the virtual machine. When Windows Server completes installing the virtual machine, the New Virtual Machine
Wizard disappears and the virtual machine you installed appears on the list of virtual machines on Hyper-V Manager.
FIGURE 23 The virtual machine you installed appears on the list of virtual machines on Hyper- V Manager
21. Right-click the virtual machine you installed, and then click Start to power on the virtual machine.
You have now completed installing the vSZ on Windows Server Hyper-V.
4. Make the image bin file executable by entering the following command: chmod +x {file name of the controller QCOW bin} See
Figure for an example.
The KVM continues to extract the contents of the image. When the extraction process is complete, the QCOW2 file appears in the
same directory as the .bin file.
FIGURE 29 The QCOW2 file appears in the same directory as the .bin file
NOTE
If the “uudecode: command not found” error appears during the extraction process, install the “sharutils” package on
the KVM, and then try extracting the image again.
7. Resize the vSZ disk image, if necessary. By default, the vSZ disk size is 50GB. If you want to allocate more disk space to the vSZ,
run the qemu-img command. The complete syntax is as follows: qemu-img resize {file name of the controller QCOW bin} +size
1. Start the Virtual Machine Manager by clicking Applications > System Tools > Virtual Machine Manager. Or double-click the Virtual
Machine Manager icon if it appears on the desktop. The Virtual Machine Manager interface appears.
2. In File, click Create New VM. Or click the New VM icon. The New VM screen appears
FIGURE 32 Type a name and select how you want to install the operating system
5. Browse to the location of the vSZ QCOW2 image, select the image file, and then click Open. The New VM (Step 2 of 4) screen
reappears and displays the storage path to the QCOW2 image file that you selected.
6. In the lower portion of the New VM (Step 2 of 4) screen, select the operating system type and version.
a) In OS type, select Linux.
b) In Version, select Generic 2.6.x kernel.
9. Click Forward. The New VM (Step 4 of 4) screen appears and displays a summary of the settings you configured.
10. Verify that the settings you configured on the previous screens are correct. If you need to make changes to any of the settings,
click Back until you reach the screen on which the setting appears, make the change, and then click Forward until you reach the
New VM (Step 4 of 4) screen again.
11. Click Finish to install the vSZ on the virtual machine.
12. After you complete installing the vSZ on the virtual machine, decide how many interfaces you want the vSZ to use. The vSZ
supports either a single interface or three interfaces. By default, a single interface exists after installation.
• If you want the vSZ to use a single interface, you do not need to take action in this step. Continue to the next step.
• If you want the vSZ to use three interfaces, you must create the two additional interfaces before the initial bootup of the vSZ.
Once the vSZ has completed its initial bootup, you will no longer be able to change the number of interfaces.
If you want to add interfaces, you must do so before the initial bootup of the vSZ. After the initial bootup, you will no longer be able
to change the number of interfaces.
13. Power on the virtual machine. The vSZ performs its initial bootup.
14. When the vSZ login prompt appears, enter admin.
You have completed setting up the vSZ on a KVM hypervisor. You are now ready to start the vSZ Setup Wizard. See Using the Setup
Wizard to Install vSZ for more information.
Introduction
You can install vSZ on Microsoft Azure using the procedure outlined.
NOTE
The minimum memory and CPU requirements have changed in this release. You may need to upgrade your infrastructure before
upgrading. Please read carefully. This is the minimum requirement recommended. Refer to the tables in Determining the System
Resources That the Virtual Machine Requires on page 12 in the Installation Preparation chapter.
4. The Microsoft Azure login page appears and redirects you to the Ruckus Wireless login page as shown in the figure.
If the page does not redirected to the Ruckus Wireless login page and asks to you choose a user account, select the Work or
school account as shown in the figure.
1. From the Microsoft Azure page, click Create a storage account. The Create a storage screen appears.
5. Click Create Storage Account. The Storage screen appears listing the new storage account.
6. Select the storage account and click Containers > Create a Container.
FIGURE 46 Containers
Ensure that you have installed Windows Azure Power Shell (web platform installer) from http://go.microsoft.com/fwlink/p/?
linkid=320376&clcid=0x409.
1. Open Microsoft Azure PowerShell and type the add-azureaccount command. The Microsoft Azure Login screen appears.
2. Type the User name and Password.
3. Click Sign in. A success message appears confirming your Microsoft Azure account is added.
1. From the Microsoft Azure page, click Virtual Machines > Images.
2. Click Create an Image. The Create an Image from VHD screen appears.
7.
Click the icon. The new image is listed in the Images tab.
Creating a Network
Follow these steps to create a virtual network.
1. From the Microsoft Azure page, click Networks > Virtual Networks.
2. Click Create a Virtual Network. The Virtual Network Details screen appears.
5.
Click the icon. The DNS Servers and VPN Connectivity screen appears.
8.
Click the icon. The Virtual Network Address Spaces screen appears.
FIGURE 58 The new virtual network is added and listed in the Networks page
1. From the Microsoft Azure page, click Virtual Machines > Instances. The New screen appears.
2. Click Compute > Virtual Machine > Quick Create > From Gallery. The Choose an Image screen appears.
4. Select an image.
5.
Click the icon. The Virtual Machine Configuration screen appears.
11.
Click the icon. The next configuration screen appears
18.
Click the icon. The next configuration screen appears.
1. From the Microsoft Azure page, click Virtual Machines > Instances.
FIGURE 66 Selecting a VM
6.
Click the icon. The next configuration screen appears.
11.
Click the icon. The endpoint is created and listed in the Endpoints tab for the VM.
1. Open the command prompt and create a static IP by typing the New-AzureReservedIP-ReservedIPName <name>-Label <label
name>-Location <location name> command.
2. Verify that the static IP address is created by typing the Get-AzureReservedIP command.
5. Verify that the static public IP address to assigned to the VM by typing the Get-AzureReservedIP command.
6. From the Microsoft Azure page, click Virtual Machines > Instances and verify that DNS Name.
7. Select the VM.
8. Click the Dashboard tab. Verify that you are able to see the updated Public IP address.
FIGURE 76 Verifying the DNS name and static public IP address changes
1. From the Microsoft Azure page, click Virtual Machines > Instances.
2. From the Virtual Machines page, select the VM.
An internal IP is assigned to the VM by default when it is created.
3. Click Shutdown.
7. Assign the available IP (10.250.1.10 in this example) to the VM using the Get-AzureVM -ServiceName vsz03 -Name vsz03 `|
Set-AzureStaticVNetIP -IPAddress 10.250.1.10 `| Update-AzureVM commands.
9. Click Start.
10. Click the VM properties and verify that the IP address has changed.
Introduction
You can install vSZ on the Google Computing Engine using the steps mentioned in this section.
NOTE
The minimum memory and CPU requirements have changed in this release. You may need to upgrade your infrastructure before
upgrading. Please read carefully. This is the minimum requirement recommended. Refer to the tables in Determining the System
Resources That the Virtual Machine Requires on page 12 in the Installation Preparation chapter.
Ensure that you have created an account with GCE and have the login details for the same.
NOTE
You can create projects by clicking Create a project in the drop-down.
5. Click Product and Services icon to view the list of GCE services.
1. From Google Developers Console, click Product and Services icon > Storage. The Cloud Storage Buckets screen appears.
4. Click Create. The storage bucket you created is listed in the browser.
1. Extract the vSZ raw.bin file that you obtained from Ruckus Wireless.
NOTE
• If the "Permission denied" error appears, execute the command "chmod +x vscg-3.5.0.0.808.raw.bin" before
extracting the file.
• If the "uudecode: command not found" error appears during the extraction process, install the "sharutils"
package, and then try extracting the image again.
2. Read the Virtual SmartZone (vSZ) Software License agreement that appears when you extract the raw.bin file.
3. When the Accept this agreement? prompt appears, enter yes to accept the license agreement.
6. Browse to the location of the .raw.tar.gz image file that you extracted, and then select it.
NOTE
You can only select .raw.tar.gz files.
Your browser displays the progress of the file upload process. After the upload process is complete, the image file appears in the
storage bucket.
3. Configure the properties of the new image by fillng out the boxes below.
a) In Name, type the name of the image.
b) In Description, provide a brief description about the image.
c) In Encryption, select an option from the drop-down list containing Automatic (recommended) and Customer supplied.
d) In Source, select Cloud storage file.
e) In Cloud Storage file, click Browse, and then select the .raw.tar.gz image file that you extracted previously.
GCE creates the new image. When the process is complete, the image you created from the .raw.tar.gz image file appears on the
Images page.
FIGURE 99 The new image you created appears on the Images page
1. From Google Developers Console, click Networking > Networks. A page displaying a list of networks appears. Select the default
network.
1. From Google Developers Console, click Compute > Compute Engine > VM instances.
The VM instances page appears.
3. Configure the new VM instance that you are creating by filling out the boxes below.
a) In Name, type the name of the VM instance.
b) In Zone, select a zone from the drop-down list.
c) In Machine type, accept or modify the default values for vCPUs and Memory.
d) Under Boot disk, click Change. The Boot disk page appears. Click Custom images.In Show images from, select the storage
bucket where you uploaded the controller image, and then select the image. Click Select.
e) In Project access, allow API access as appropriate.
l) Click Create. The VM instances page appears listing the new VM that is created.
# curl-O https://bootstrap.pypa.io/get-pip.py
# sudo python27 get-pip.py
# aws configure
AWS Access Key ID [None]: xxx
AWS Secret Access Key [None]: xxx
Default region name [None]: us-west-2
Default output format [None]: json
6. The default region should be the same as the bucket region. Refer to Table for the mapping details. In addition refer to you can
also refer to latest version.
Region Name Region
us-east-1 US East (N. Virginia)
us-west-2 US West (Oregon)
us-west-1 US West (N. California)
eu-west-1 EU (Ireland)
eu-central-1 EU (Frankfurt)
ap-southeast-1 Asia Pacific (Singapore)
ap-northeast-1 Asia Pacific (Tokyo)
ap-southeast-2 Asia Pacific (Sydney)
ap-northeast-2 Asia Pacific (Seoul)
sa-east-1 South America (Sao Paulo)
{ "Version":"2012-10-17",
"Statement":[
{
"Sid":"",
"Effect":"Allow",
"Principal":{ "Service":"vmie.amazonaws.com"
},
"Action":"sts:AssumeRole",
"Condition":{
"StringEquals":{
"sts:ExternalId":"vmimport"
}
}
}
]
}
4. Use the following command to create a role. Specify the name as vmimport and give the option VM Import/Export access.
5. Create a policy for the service role by creating a JSON file called role-policy.json using the following commands. Replace the
bucket name with the storage bucket name that you created.
{
"Version":"2012-10-17",
"Statement":[
{
"Effect":"Allow",
"Action":[
"s3:ListBucket",
"s3:GetBucketLocation"
],
"Resource":[
"arn:aws:s3:::<bucket-name>"
]
},
{
"Effect":"Allow",
"Action":[
"s3:GetObject"
],
"Resource":[
"arn:aws:s3:::<bucket-name>/*"
]
}
6. Run the following command to attach the policy to the service role created. # aws iam put-role-policy --role-name
vmimport --policy-name vmimport --policy-document file://role-policy.json
1. Navigate to Amazon Web Services > Storage and Content Delivery > S3, click Create Bucket as shown.
2. Type the name of the storage bucket and select a suitable regional endpoint to reduce data latency.
3. Click Create. The storage bucket you created is listed in the browser.
4. Check the storage bucket has been created.
3. Browse to the location of the vSZ image and select vSZ image file.
Only images with file-type *.raw or .ova or vmdk can be selected.
4. Click Start Upload to upload the file. The upload process is displayed.
5. The image is listed in the storage bucket after the image is uploaded.
NOTE
The vSZ image should be in the Bucket, which has Region information. Example: Test_bucket
# aws
configureAWS Access Key ID [None]:
AWS Secret Access Key
[None]: Default region name [None]:
us-west-2Default output format
[None]: json
{
"Version":"2012-10-17",
"Statement":[
{
"Effect":"Allow",
"Action":[
"s3:ListBucket",
"s3:GetBucketLocation"
],
"Resource":[
"arn:aws:s3:::<disk-image-file-bucket>"
]
},
{
"Effect":"Allow",
"Action":[
"s3:GetObject"
],
"Resource":[
"arn:aws:s3:::<disk-image-file-bucket>/*"
]
},
{
"Effect":"Allow",
"Action":[
"ec2:ModifySnapshotAttribute",
"ec2:CopySnapshot",
"ec2:RegisterImage",
"ec2:Describe*"
],
"Resource":"*"
}
]
}
6. Replace <disk-image-file-bucket> with the appropriate Amazon S3 bucket where the disk files are stored. Run the following
command to attach the policy to the role created above:
7. Replace <disk-image-file-bucket> with the appropriate Amazon S3 bucket where the disk files are stored. Run the following
command to attach the policy to the role created above aws iam put-role-policy --role-name vmimport --policy-name
vsz34-policy --policy-document file://role-policy.json
1. Create a JSON file called import.json using the following commands. Replace the bucket name with the storage bucket name that
you created. In this example, the vSZ image file name is vscg-3.4.0.0.750.ova.
{
"Description": "Import vSZ",
"DiskContainers": [
{
"Description": "vSZ 3.4.0.0.750",
"UserBucket":{
"S3Bucket": "<bucket-name>",
"S3Key": "vscg-3.4.0.0.750.ova"
}
}
]
}
2. Run the following command to attach the policy to the role created. # aws ec2 import-image --cli-input-json file://import.json
{
"Status": "active",
"Description": "Import vSZ",
"Progress": "2",
"SnapshotDetails": [
{
"UserBucket": {
"S3Bucket": "<bucket-name>", "S3Key": "vscg-3.4.0.0.750.ova"
},
"DiskImageSize": 0.0
}
],
"StatusMessage": "pending",
"ImportTaskId": "import-ami-ffgof9w1"
}
4. Check the status of the import vSZ image by running the following command. Ensure to enter the correct import task identifier.#
aws ec2 describe-import-image-tasks --import-task-ids "import-ami-ffgof9w1"
5. You will see the following converting status response. Check the status until the converting is complete. The estimated time for
conversion is 30 minutes.
{
"ImportImageTasks": [
{
"Status": "active",
"Description": "vSZ test",
"Progress": "28",
"SnapshotDetails": [
{
"UserBucket": {
"S3Bucket": "<bucket-name>",
"S3Key": "vscg-3.4.0.0.750.ova"
},
"DiskImageSize": 964430848.0,
"Format": "VMDK"
}
],
"StatusMessage": "converting",
"ImportTaskId": "import-ami-ffgof9w1"
}
]
}
2. Navigate to Images > AMIs to ensure that the imported Amazon Machine Image (AMI) exists. In this example the AMI file is
import-ami-ffgof9w1.
3. Navigate to Network & Security > Security Groups > Create Security Group. Security group acts as a virtual firewall that controls
the traffic for one or more instances.
4. Define the setup group name, description, ports and the firewall rule. The table lists the common service ports. For more
information, see Ports to open for AP-vSZ communication.
Port Number Description
UDP
161 SNMP
12223 ZD AP forward update using FTP (control connection)
TCP
21 ZD AP forward update using FTP (control connection)
22 AP SSH
91 SCG AP forward update using HTTP
443 Allows SCG AP get SSH private key and do AP FW udpate via HTTPs
7443 Public API
8022 SSH for management (mgmt-acl is enabled on 1 nic vSZ)
8080 vSZ setup wizard using the web user interface (User will be redirected to the port 8443)
8443 vSZ web user interface
8090, 8099 WISPr for non-web-proxy user equipment
8100 WISPr for web-proxy user equipment
9998 Tomcat for WISPr (internal WISPr portal uses the port 9998)
9080, 9443 Northbound API (NBI)
16384-65000 ZD AP forward update using FTP (data connection)
b) Navigate to My AMIs and choose the Amazon Machine Image (AMI) that you imported previously.
c) Click Next.
d) Choose a suitable instance type. In this example the instance type is m4.xlarge. Based on the number of APs and client
counts, select the instance type to fit the recommended system resources.
The minimum memory and CPU requirements have changed in this release. You may need to upgrade your infrastructure
before upgrading. Please read carefully. This is the minimum requirement recommended. Refer to Table 5 and Table 6 in the
chapter Preparing to Install the vSZ.
e) Click Next.
f) Select the required network, subnet, and private IP address.
The private IP address cannot be changed once the vSZ image is launched.
g) Click Next.
h) Change the size of storage as required.
i) Click Next.
j) Specify the vSZ instance by giving it a name.
k) Click Next.
l) Create a new security group or select an existing group. Configure the rules if required.
m) Click Next.
n) Review the configuration settings.
o) Click Launch
p) Select the Proceed without a key pair for vSZ instance.
q) Verify that the vSZ instance is running. Connect the vSZ instance with the selected key pair using the SSH interface.
1. Navigate to EC2 Dashboard > Elastic Block Store > Volumes and click Create Volume as shown.
3. Click Create.
4. Right click on the newly created disk and select Attach Volume. Enter the instance identifier and the desired device name.
5. Click Attach.
1. Navigate to EC2 Dashboard > Network & Security > Elastic IPs. Click Allocate New Address as shown.
2. Click Create.
3. Right click on the newly created IP address and select Associate Address. Enter the instance identifier or network interface and
the desired device name.
4. Click Associate.
1. Navigate to Instances and right click to select the vSZ instance that you want to delete.
3. Confirm deletion of the vSZ instance by clicking on Yes, Terminate. The vSZ instance is deleted from AWS.
Follow the procedure below that corresponds to the number of interfaces that the vSZ you are installing has:
• Setting Up the vSZ with One Interface on page 137
• Setting Up the vSZ with Three Interfaces on page 141
NOTE
By default, the VMWare ESXi package comes with three network interfaces. If you want to deploy the vSZ with only one interface,
you can edit the virtual machine settings to remove the extra interfaces. The KVM package, on the other hand, comes with a
single interface. If you want to deploy the vSZ with three interfaces, edit the virtual machine settings to create two additional
interfaces.
4. Enter setup. The console displays the current network settings (if any), and then displays the following prompt: Do you want to
setup network? [YES/no]
5. Enter YES. The next screen prompts you to select the profile configuration that you want to use for this instance of vSZ. The
options include: (1) High-Scale (2) Essentials
6. Enter the number that corresponds to the profile configuration that you want to deploy.
If you selected Essentials and the virtual machine has insufficient memory resources available (for example, the VM has only 8GB
of RAM when the minimum RAM requirement is 12GB), you will be unable to continue with the setup process.
FIGURE 141 Enter the number that corresponds to the profile that you want to deploy
7. At the Select IP Version Support prompt, enter one of the following options: 1: IPv4 Only 2: IPv4 and IPv6
8. At the Select IP configuration prompt, enter 1 to set up the single vSZ interface (for Control [AP], Cluster, and Management [Web])
manually.
9. Configure the IP address, netmask, and gateway of the control interface, and then press <Enter>. The IP address configuration
that you entered appears.
10. When the prompt Are these correct? (y/n) appears, enter y to confirm the IP address configuration.
11. When the prompt Select system default gateway (Control, Cluster, Management)? appears, enter Control.
This entry is case-sensitive. Make sure you enter the system default gateway exactly as shown at the prompt.
FIGURE 143 When prompted for the system default gateway, enter Control
12. At the Primary DNS Server prompt, enter the primary DNS server on the network.
13. At the Secondary DNS Server prompt, enter the secondary DNS server (if any) on the network.
14. At the Control NAT IP prompt, enter the public IP address of the NAT server on the network. If you are not deploying the vSZ
behind a NAT server, press <Enter> without typing an IP address.
Ensure that each vSZ is associated with a dedicated NAT device.
FIGURE 144 Enter the public IP address of the NAT server (if any)
You have completed configuring the vSZ interfaces. You are now ready to run the vSZ Setup Wizard. See Using the Setup Wizard to Install
vSZ.
4. Enter setup. The console displays the current network settings (if any), and then displays the prompt: Do you want to setup
network? [YES/no]
5. At the Select IP configuration prompt, enter 1 to set up the control interface manually.
a) Configure the IP address, netmask, and gateway of the control interface, and the press <Enter>. The IP address configuration
that you entered appears.
a) When the message Are these correct? appears, enter y to confirm the IP address configuration.
6. At the Select IP configuration prompt, enter 1 to set up the cluster interface manually.
a) Configure the IP address, netmask, and gateway of the cluster interface, and then press <Enter>. The IP address
configuration that you entered appears.
b) When the message Are these correct? appears, enter y to confirm the IP address configuration.
7. At the Select IP configuration prompt, enter 1 to set up the management interface manually.
a) Configure the IP address, netmask, and gateway of the management interface, and the press <Enter>. The IP address
configuration that you entered appears.
Take note of the IP address that you assign to the management interface – you will use this IP address to log on to the vSZ
web interface.
b) When the message Are these correct? appears, enter y to confirm the IP address configuration.
8. When the message Select system default gateway (Control, Cluster, Management)?, enter Control or Management, depending on
your network topology (see Important Notes About Selecting the System Default Gateway on page 144).
This entry is case-sensitive. Make sure you enter the system default gateway exactly as shown at the prompt.
FIGURE 147 When prompted for the system default gateway, enter either Management or Control (depending on your network design)
9. When prompted, enter the primary and secondary DNS server IP addresses.
10. Enter restart network.
You have completed configuring the vSZ interfaces. You are now ready to run the vSZ Setup Wizard. See Using the Setup Wizard to Install
vSZ on page 145.
• If all of the managed APs are located in different locations on the Internet, the vSZ may not know all of the IP subnets of these
APs. In this case, the control interface should be set as the default gateway for the vSZ and you will need to add a static route to
reach the management network.
• If all of the managed APs belong to a single subnet or to multiple subnets on which you can set the route statically, then you can
set the management interface as the default gateway users can set default gateway for the vSZ and set static routes for the vSZ to
reach all of its managed APs.
The Setup Wizard will prompt you to select one of the two available profile configurations (High-Scale profile and Essentials profile). You
must select the profile configuration that corresponds to the vSZ license that you purchased. Before you start the Setup Wizard, make sure
you know the profile configuration that you need to select. If you are unsure which profile configuration you need to select, contact Ruckus
Wireless Support.
Follow these steps to run and complete the vSZ Setup Wizard:
• Start the Setup Wizard and Set the Language
• Select the Profile Configuration That Corresponds to Your vSZ License
• Configure the Management IP Address Settings
• Configure Dual Mode IP Address Settings Using CLI
• Configure the Cluster Settings
• Set the Administrator Password
• Verify the Settings
NOTE
This guide describes the Setup Wizard screens that appear when you select the High-Scale profile configuration. If you select the
Essentials profile configuration, the screens that appear may be slightly different.
2. Select your preferred language for the vSZ web interface. Available options include:
• English
• Traditional Chinese
• Simplified Chinese
3. Click Next. The Profile page appears.
• High Scale
• Essentials
2. Click Apply. The message Applying profile appears, and then the Management IP page appears.
FIGURE 149 Select a profile configuration that matches your vSZ license
If the vSZ that you are installing comes with three network interfaces, you must configure each of the three interfaces to be on three different
subnets. Failure to do so may result in loss of access to the web interface or failure of system functions and services.
3. On the Cluster tab, click Static under the IPv4 section, and then enter the network settings that you want to assign to the cluster
interface, through which cluster data will be sent and received.
Although it is possible to use DHCP to assign IP address settings to the Cluster interface automatically, Ruckus Wireless strongly
recommends assigning a static IP address to this interface. The following network settings are required (others are optional):
• IP address
• Netmask
• Default gateway
5. On the Management (Web) tab, configure the IP address settings of the management interface.
a) Under the IPv4 section, click Static, and then enter the network settings that you want to assign to the AP/DataPlane
interface, through which client traffic and configuration data are sent and received.
Although it is possible to use DHCP to assign IP address settings to the Control interface automatically, Ruckus Wireless
strongly recommends assigning a static IP address to this interface. The following network settings are required (others are
optional):
• IP address
• Netmask
• Default gateway
b) If you clicked IPv4 and IPv6 at the beginning of this procedure, under the IPv6 section, click Auto Configuration if you want
the management (web) interface to obtain its IP address from Router Advertisements (RAs) or from a DHCPv6 server on the
network. If you want to manually assign the IPv6 network address, click Static, and then set the values for the following: IP
address (IPv6): Enter an IPv6 address (global only) with a prefix length (for example, 1234::5678:0:C12/123). Link-local
addresses are unsupported.Gateway: Enter an IPv6 address (global or link-local) without a prefix length. Here are examples:
9. Update the IP address settings of the administrative computer with the same subnet settings that you assigned to the
Management (Web) interface (see Step 4). Continue to Step 5: Configure the Cluster Settings on page 161
• If all of the managed APs are located in different locations on the Internet, the vSZ may not know all of the IP subnets of these
APs. In this case, the control interface should be set as the default gateway for the vSZ and you will need to add a static route to
reach the management network.
• If all of the managed APs belong to a single subnet or to multiple subnets on which you can set the route statically, then you can
set the management interface as the default gateway users can set default gateway for the vSZ and set static routes for the vSZ to
reach all of its managed APs.
FIGURE 153 Choose 2. IPv4 and IPv6 to use dual mode IP addresses
4. Configure the IPv4 address settings that you want to assign to the AP/DataPlane interface, through which client traffic and
configuration data are sent and received.
a) Enter the setup for Control as either:
1. Manual
2. DHCP
b) Enter the IP configuration as 2 (DHCP).
c) Enter following network settings as required:
• IP address
• Netmask
• Default gateway
d) Save the networking configuration of Control settings.
• IP Address
• Netmask
• Gateway
The available gateway for Control, Cluster and Management will be displayed. You can select the system default gateway.
5. If the controller is behind a NAT server, add the control NAT server IP address, and then hit Enter.
6. Configure the IPv6 address settings that you want to assign to the AP/Data Plane interface, through which client traffic and
configuration data are sent and received.
NOTE
The cluster interface setting does not support IPv6 addresses.
• IPv6 Address
• Gateway
d) Save the networking configuration of Control settings.
The available gateway for Control and Management will be displayed. You can select the system default gateway.
8. Go back to the controller's web interface, and then go to System > Cluster > Control Planes. Then, expand the node, select the
Cluster plane, and click Configure.
9. Verify that the Control Plane network settings display the IPv4 and IPv6 addresses that you configured.
10. Continue to Step 5: Configure the Cluster Settings on page 161
FIGURE 163 The Cluster Information page, showing the New Cluster option
2. In Cluster Name, type a name for the new cluster that you are creating.
NOTE
The Cluster Name and Controller Name boxes only accept alphanumeric characters, hyphens (-), and underscores (_).
They do not accept the space character or other special characters (for example, $, *, #, !).
3. In Controller Name, type a name for the vSZ controller in this new cluster.
4. In Controller Description, type a brief description for the vSZ controller.
5. In NTP Server, type the address of the NTP server from which members of the cluster will obtain and synchronize time. The default
NTP server isntp.ruckuswireless.com
6. If you want ZoneDirector APs that are in factory default settings to be converted to SmartZone APs automatically, select the AP
Conversion check box.
7. Click Next to continue to the Administrator page.
A vSZ cluster supports a maximum of four nodes. If you are building a vSZ-E cluster with more than two nodes, two (2) additional cores
must be added to each node to support the added search and replication capabilities.
NOTE
To add this vSZ to an existing cluster, the entire target cluster must be in a healthy state (no node must be in “out of service”
state). If any member node is out of service, the join request will fail. You will need to remove any out-of-service node from the
cluster before you can add a new node successfully.
FIGURE 164 The Cluster Information page, showing the Join Existing Cluster option
If the firmware version on this vSZ (shown in the bottom-left area of the Cluster Information page) does not match the firmware version of
the cluster, a message appears and prompts you to upgrade the vSZ firmware. Click Upgrade, and then follow the prompts to perform the
upgrade.
Follow these steps to set the web interface and CLI passwords.
NOTE
The web interface and CLI passwords must be at least eight (8) characters in length and must include one number, one letter, and
one special character (for example, $, *, #, !).
1. In Admin Pasword, type a password that you want to use to access the web interface.
2. In Confirm Password, retype the password above to confirm.
3. In Enable Password, type a password that you want to use to enable CLI access to the vSZ.
4. In Confirm Password, retype the password above to confirm.
5. Click Next to continue. The Confirmation page appears and displays all the controller settings that you have configured using the
Setup Wizard.
Follow these steps to verify the controller settings that you have configured.
1. Verify that all the settings displayed on the Confirmation page are correct.
2. If they are all correct, click Finish to apply the settings and activate the controller on the network.
NOTE
If you find an incorrect setting, click the Back button until you reach the related page, and then edit the settings. When
you finish editing the settings, click the Next button until you reach the Confirmation page again.
A progress bar appears and displays the progress of applying the settings, starting the vSZ services, and activating the vSZ on the
network.
When the process is complete, the progress bar shows the message 100% Done. The page also shows the IP address through
which you can access the vSZ web interface to manage the controller.
FIGURE 167 Setup is complete when the progress bar shows “100% Done”
Congratulations! You have completed the Setup Wizard. You are now ready to log on to the web interface. Go to https://{management-IP-
adddress}:8443, and then log on with the user name and password that you assigned to the web interface.
1. On a computer that is on the same subnet as the Management (Web) interface, start a web browser.
2. In the address bar, enter the IP address that you assigned to the Management (Web) interface and append a colon and 8443 (vSZ
management port number) at the end of the address. The vSZ web interface logon page appears.
If the IP address that you assigned to the Management (Web) interface is 10.10.101.1, then you should enter:
https://10.10.101.1:8443
You are now ready to configure the controller. For information on how to configure the controller, refer to the Administrator Guide for the
controller platform that you have installed.
These software updates may be made available on the Ruckus Wireless support website or released through authorized channels.
CAUTION
Although the software upgrade process has been designed to preserve all controller settings, Ruckus Wireless strongly
recommends that you back up the controller cluster before performing an upgrade. Having a cluster backup will ensure that you
can easily restore the controller system if the upgrade process fails for any reason.
CAUTION
Ruckus Wireless strongly recommends that you ensure that all interface cables are intact during the upgrade procedure.
CAUTION
Ruckus Wireless strongly recommends that you ensure that the power supply is not disrupted during the upgrade procedure.
NOTE
If you are managing a vSZ, you can also perform system configuration backup, restore, and upgrade from the controller
command line interface.
CAUTION
®
Ruckus Wireless strongly recommends backing up the controller cluster before performing the upgrade. If the upgrade process
fails for any reason, you can use the latest backup file to restore the controller cluster.
NOTE
®
Before starting this procedure, you should have already obtained a valid controller software upgrade file from Ruckus Wireless
Support or an authorized reseller.
®
1. Copy the software upgrade file that you received from Ruckus Wireless to the computer where you are accessing the controller
web interface or to any location on the network that is accessible from the web interface.
2. Go to Administration > Upgrade.
3. In the Upload section, click the Browse button, and then browse to the location of the software upgrade file.
Select the Run Pre-Upgrade Validations check box to verify if the data migration was successful. This option allows you to verify
data migration errors before performing the upgrade. If data migration was unsuccessful, the following error is displayed:
Exception occurred during the validation of data migration. Please apply the system
configuration backup and contact system administrator.
FIGURE 169 Click Browse in the Upload section to upload the software upgrade file
CAUTION
®
Ruckus Wireless strongly recommends using Backup & Upgrade when performing the upgrade. If the upgrade
process fails for any reason, you can use the latest backup file to restore the controller cluster.
7. Click Yes.
The controller starts the process that you selected. The screens that appear next will depend on the process that you selected to
upgrade immediately or to back up and then upgrade the controller.
FIGURE 170 The System Upgrade page displays the status of the upgrade process
When the upgrade (or backup-and-upgrade) process is complete, the controller logs you off the web interface automatically. Wait for a few
minutes until the web interface log on page appears.
FIGURE 171 The controller web interface may display the following message as it completes the upgrade process
When the controller logon page appears again, you have completed upgrading the controller.
Continue to the Verifying the Upgrade task to check if the upgrade was completed successfully.
3. In the Current System Information section, check the value for Controller Version.
If the firmware version is newer than the firmware version that controller was using before you started the upgrade process, then
the upgrade process was completed successfully.
NOTE
APs periodically send scheduled configuration requests to the controller, including the firmware version. Therefore, when
an AP joins a zone for the first time, the firmware version is verified by the controller. If the firmware version is different
from that which is configured for the zone, the controller responds with a request to upgrade it, after which the AP
initiates a request to upgrade the firmware using HTTP.
1. You encounter issues during the software upgrade process and the controller cannot be upgraded successfully. In this scenario,
you can only perform the software rollback from the CLI using the restore local command. If you have a two-node controller
cluster, run the restore local command on each of the nodes to restore them to the previous software before attempting to
upgrade them again.
2. You prefer a previous software version to the newer version to which you have upgraded successfully. For example, you feel that
the controller does not operate normally after you upgraded to the newer version and you want to restore the previous software
version, which was more stable. In this scenario, you can perform the software rollback either from the web interface or the CLI. If
you have a two-node controller cluster, you must have cluster backup on both of the nodes.
®
To ensure that you will be able to roll back to a previous version, Ruckus Wireless strongly recommends the following before attempting to
upgrade the controller software:
• Always back up the controller before attempting a software upgrade. If you are managing a multi-node cluster, back up the entire
cluster, and then verify that the backup process completes successfully. See Creating a Cluster Backup on page 171 for more
information.
• If you have an FTP server, back up the entire cluster and upload the backup files from all the nodes in a cluster to a remote FTP
server.
NOTE
You can also perform these procedures from the vSZ command line interface. Note, however, that you will need to execute the
commands on each node.
To view the current system time, go to System > General Settings > Time.
2. Go to Administration > Backup & Restore.
3. Click Backup Entire Cluster.
The following confirmation message appears: Are you sure you want to back up the cluster?
4. Click Yes.
The following message appears: The cluster is in maintenance mode. Please wait a few minutes.
When the cluster backup process is complete, a new entry appears in the Cluster Backups section with a Created On value that is
approximate to the time when you started the cluster backup process.
NOTE
If you have an FTP server, back up the entire cluster and upload the backup files from all the nodes in a cluster to a remote FTP
server.
2. In the Cluster Backups History section, locate the cluster backup that you want to restore.
3. Select the backup file that you want to restore, and then click Restore.
FIGURE 174 Select the backup file, and then click Restore
4. The following confirmation message appears: Are you sure you want to restore the cluster?. Click Yes.
The page refreshes, and then the following message appears: System is restoring! Please wait...
NOTE
The cluster restore process may take several minutes to complete.
When the restore process is complete, the controller logs you off the web interface automatically.
Do not refresh the controller web interface while the restore process is in progress. Wait for the restore process to
complete successfully.
NOTE
If the web interface displays the message Cluster is out of service. Please try again in a few
minutes. appears after you log on to the controller web interface, wait for about three minutes. The dashboard will
appear shortly. The message appears because the controller is still initializing its processes.
6. Go to Administration > Upgrade, and then check the Current System Information section and verify that all nodes in the cluster
have been restored to the previous version and are all in service.
7. Go to Diagnostics > Application Logs .
8. Check the Health Status column and verify that all of the controller processes are online.
You have completed restoring the cluster backup. After the upgrade is complete, go to the Application Logs page and verify that all of the
controller processes are online.
FIGURE 176 On the Application Logs page, verify that all controller processes are online
VSCG35> en
Password:
VSCG35> restore
All the cluster backups are listed in an order of the cluster backup created date.
4. Specify the number mentioned against the cluster backup that you wish to restore.
The cluster backup becomes highlighted, which indicates that you have selected it.
3.
Click .
FIGURE 178 After you click the Delete button, a confirmation message appears
4. Click Yes.
The page refreshes, and then the cluster backup that you deleted disappears from the Cluster Backups History section.