fs scg 3.0 new licensing framework v1.1

22
Page 1 of 22 Ruckus Wireless, Inc. Company Confidential All printed copies are considered un-Controlled copies and on-line version should be referred for latest version. Document Number: XXX Revision: 1.1 SCG 3.0 New Licensing Framework Functional Specification FS Version 1.1 FS Date 05/21/2014 Author (s) Name: Michael Yap, Ryan Chao

Upload: shiva-prasad

Post on 09-Nov-2015

28 views

Category:

Documents


8 download

TRANSCRIPT

  • Page 1 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Document Number: XXX

    Revision: 1.1

    SCG 3.0

    New Licensing Framework

    Functional Specification

    FS Version 1.1

    FS Date 05/21/2014

    Author (s) Name: Michael Yap, Ryan Chao

  • Page 2 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Document History

    Revision Change User Date

    0.1 Initial draft Michael Yap Feb. 19, 2014

    0.2 Revised base on Stephen Chu recommendation Michael Yap Feb. 21, 2014

    0.3 Rephrase section 1.4.1 Rephrase section 4.2

    Michael Yap Feb. 25, 2014

    0.4 Change Document Title to New Licensing Framework Added periodically fetch license data time Add License UI and CLI Support section

    Michael Yap Mar. 04, 2014

    0.5 Add UI Mockup Ryan Chao Mar. 17, 2014

    0.6 Add SCG supported current license types Michael Yap Mar. 19, 2014

    0.7 Add PRD Coverage Section Update UI Mockup pictures

    Michael Yap Mar. 20, 2014

    0.8

    Upgrade Flexera FlexNet Embedded Java User Guide to new version (2013 R2)

    Remove Remove License from Client section Add trial license use case

    Michael Yap Apr. 02, 2014

    0.9

    Add Support license feature and use cases Remove License Statistic section Change UI Mockup to match new requirement Add the use cases that upload license file is disabled

    when configure to connect with local license server

    Michael Yap Ryan Cho

    Apr. 11, 2014

    0.10 Update with PRD 0.4 Add Non-Transferable License Type Add Web UI to handle Non-Transferable License Type

    Michael Yap Apr. 30, 2014

    1.0

    Update with PRD 0.5 Change Non-Transferable License Type to AP Capacity

    Base License Add Instance License Type Add Feature Functional List with PRD section

    Michael Yap May 21, 2014

    1.1 Update with Project Manager comments Update Web GUI pages screen-shot

    Michael Yap May 30, 2014

  • Page 3 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Table of Contents

    1 Introduction ..................................................................................................................... 6

    1.1 Objective ................................................................................................................... 6 1.2 Scope ....................................................................................................................... 6 1.3 Feature Brief Description .......................................................................................... 6 1.4 Impacted Systems .................................................................................................... 6

    1.4.1 Backend Service ............................................................................................... 6 1.4.2 UI ...................................................................................................................... 6

    1.5 Limitations and Exceptions ....................................................................................... 6 1.6 Terminology .............................................................................................................. 6

    2 References ..................................................................................................................... 8

    2.1 Internal Document References ................................................................................. 8 2.2 External Document References ................................................................................ 8

    3 Feature Overview ........................................................................................................... 8

    3.1 Feature Functional Overview .................................................................................... 8 3.2 Work Flows Diagrams ............................................................................................... 8 3.3 Feature Functional List ............................................................................................10 3.4 License Type ...........................................................................................................13

    3.4.1 AP Capacity License ........................................................................................13 3.4.2 AP Capacity Base License ...............................................................................13 3.4.3 Instance License ..............................................................................................13 3.4.4 Support License ...............................................................................................13

    3.5 License Data ............................................................................................................13 3.6 Feature/Function Dependencies ..............................................................................13

    3.6.1 Publisher Identity Data File ..............................................................................13 3.6.2 License Type ....................................................................................................13 3.6.3 License Server .................................................................................................13

    4 Feature Requirements ...................................................................................................14

    4.1 General Requirements .............................................................................................14 4.2 Licensing UI .............................................................................................................14

    4.2.1 Licensing Management Page ...........................................................................14 4.2.2 System Upgrade Page .....................................................................................17 4.2.3 CLI Support ......................................................................................................18

    4.3 Use Cases ...............................................................................................................18 4.3.1 SCG powers up and cannot connect with license server .................................18 4.3.2 SCG powers up and connect with license server but no license data available in license server .............................................................................................................19 4.3.3 Connect to the cloud license server (FNO-OD) and retrieve Permanent Instance License ............................................................................................................19 4.3.4 Connect to the cloud license server (FNO-OD) and retrieve new AP Controller license data ...................................................................................................................19 4.3.5 Change license server configuration ................................................................19 4.3.6 Manually retrieve license data from cloud license server .................................19 4.3.7 Upload an encrypted binary license data file from local machine and retrieves license information .........................................................................................................20 4.3.8 Enforce support license in System Software Upgrade .....................................20

  • Page 4 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    4.4 Backend Service Requirements ...............................................................................21 4.5 User Interface Requirements ...................................................................................21

    4.5.1 UI Mockup ........................................................................................................21 4.5.2 CLI Requirements ............................................................................................21

    4.6 Performance Requirements .....................................................................................21 4.6.1 System Performance .......................................................................................21

    4.7 Interface Requirements ...........................................................................................21 4.7.1 Internal Interface Requirements .......................................................................21 4.7.2 External Interface Requirements ......................................................................21

    5 The 3rd party tools and frameworks ..............................................................................22

    5.1 Flexera FlexNet Embedded Licensing SDK .............................................................22

  • Page 5 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Table of Figures

    Figure 1: Customer Environment with Internat Connection .................................................. 9

    Figure 2: Customer Environment with LLS ........................................................................... 9

    Figure 3: Customer Environment without Internet Connection ............................................10

    Figure 4: License Management Page ..................................................................................14

    Figure 5: Synchronization Section .......................................................................................15

    Figure 6: License Server Configuration Selection ................................................................15

    Figure 7: License Server Configuration Confirmation Dialog ...............................................16

    Figure 8: License File Upload Section .................................................................................16

    Figure 9: License Summary Section ....................................................................................16

    Figure 10: License Entitlement List Section .........................................................................17

    Figure 11: System Upgrade Page .......................................................................................17

    Figure 12: Support License Warning Dialog ........................................................................18

  • Page 6 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    1 Introduction

    1.1 Objective The purpose for this document is to provide a detail description of the way that new licensing feature should be implemented for SCG 3.0 in the scope of SZ100 and vSCG. The description includes all information required to implement a process that connects with Flexera FlexNet license server, retrieve license information from license server or manually upload binary license data, and enforce support license for SCG software upgrade process.

    1.2 Scope This document provides functional specification of the new licensing feature for SCG 3.0 in the scope of SZ100 and vSCG. The features in this document, however, are limited to expend the existing feature of the SCG licensing and do not include the wider scope of features that Flexera FlexNet licensing can support.

    1.3 Feature Brief Description Current SCG supports the licensing feature where user can manually upload the license data into SCG. The new licensing feature will allow SCG to connect with a license server and periodically or manually fetch the license data from it. Uploading license data manually will also be provided when SCG has difficulty communicating with cloud license server. Furthermore, the new license feature also enforces the support license for SCG software upgrade process.

    1.4 Impacted Systems

    1.4.1 Backend Service SCG backend service should include new modules to support new licensing features. These modules include a client that connect with license server and automatic fetch license data every twenty-four hours, a mechanism that allow user to upload binary license data file, a procedure that read the license data and store license information into database, and a method that enforce the support license for software upgrade process.

    1.4.2 UI The UI should be extended to provide inputs for local license server address, allow user to retrieve license information from server or upload a binary license data file, display all assigned license entitlements, and restrict user to upgrade the SCG software if the current support license has expired.

    1.5 Limitations and Exceptions 1. The release of SCG where the features specified in this document should be included is not

    defined in this document and is yet to be determined at the time of SCG 3.0 June 12

    Integration.

    2. The upload binary license data file will only available when SCG configured to connect with

    cloud license server.

    3. To be determined.

    1.6 Terminology

    Name Definition

  • Page 7 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    AP Access point the reference to a family of Ruckus products. An access point is a wireless end-point that is managed by a SCG.

    CLI Command-Line user interface

    Cluster A configuration of up to 4 physical and/or virtual SCGs that share a pool of managed AP capacity that provide high availability, scalability and flexibility of AP management

    Entitlement A record of the type and quantity of each product for which a customer has purchased license rights, and, any associated rights (e.g. right to move software).

    FNE Flexera FlexNet Embedded. This is the name for the license technology SDK from Flexera Software that will be integrated with the SCG

    FNO FlexNet Operations. This is the hosted entitlement management system for electronic software delivery and license key activation provided by Flexera Software. FNO is part of the ELMS system.

    FNOOD Flexera FlexNet Operation On-Demand

    Host ID

    A physical machine or environment identification number that can be used to bind license rights to that environment, and, used one source of information to retrieve entitlement rights from an entitlement management system.

    Instance License A type of license metric where the pricing is based upon the number of instances of the configuration. This will be used for base vCSG licenses.

    Local License Server (LLS)

    A small, lightweight process that is part of the license subsystem that resides at a customer site and performs the following: 1) Activates entitlement rights which create license files with license keys 2) Manages the provisioning of those licenses to various clients who request access. A license server is usually bound at the physical or virtual device identifier.

    RMA Return Material Authorization. The process to return defective or unneeded demo hardware or software to Ruckus. The RMA process should not be required to return licenses to an entitlement pool in FNO, or, move licenses among devices.

    SCG SmartCell Gateway. A WLAN controller product family that comes in a physical or virtual appliance footprint. The SCGs can be configured as individual controllers, or, grouped in a cluster.

    SFDC Salesforce.com. This is the system that will be sending entitlements to FNO.

    SKU SKU refers to a stock-keeping unit, a unique identifier for each distinct product and service that can be purchased in business.

    SZ100

    A mid-tier next generation model of the SCG family targeted initially to enterprises. SZ100, when released, will be positioned for the same customer group that currently uses ZD3K and ZD5K. This product is in scope for the project and the main focus of the initial release 3.0 deployment.

    Trial License A special license file created that matches the entitlement, but, is limited in duration to up to 90 days. The actual trial license duration can be decided as the product gets closer to release.

    Trusted storage

    Trusted storage is mechanism for storing license rights in a secure location bound to a particular device. In addition to its contents being encrypted, security features of trusted storage include: Binding - detects if trusted storage has been copied to another device by using manufacturer-defined system identity characteristics.

    Anchoring - provides trust that trusted storage has not been deleted or rolled back to an earlier state on the same device.

  • Page 8 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    vSCG Virtual SmartCell Gateway. This is the virtual appliance version of the SCG.

    2 References

    2.1 Internal Document References

    Document name Version Description

    Licensing PRD v5 20140520-kk.docx 0.5 Product Requirement Document: Licensing Framework

    2.2 External Document References

    Document name Version Description

    Flexera FlexNet Embedded Java XT User Guide

    2013 R2

    An overview of the FlexNet Embedded product and is intended for implementers to begin creating license-enabled code which makes use of FlexNet Embedded.

    3 Feature Overview

    3.1 Feature Functional Overview SCG currently includes a license feature that takes a proprietary license file and stores them into SCG. As part of this feature, the new license feature implementation will use Flexera FlexNet Licensing to handle license management. SCG will use the Flexera license server as primary license source and periodically fetch license from it for any updates. The manually uploading a binary license file from local machine is also supported.

    In addition to display all assigned license entitlements on the UI, UI should provide a method to set the Local License Server (LLS) address and allow user manually ask SCG to fetch license data from license server. UI should enforce the System Upgrade process by checking the availability of support license.

    3.2 Work Flows Diagrams

  • Page 9 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Figure 1: Customer Environment with Internat Connection

    Figure 2: Customer Environment with LLS

  • Page 10 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Figure 3: Customer Environment without Internet Connection

    3.3 Feature Functional List The following feature functional list is based on PRD

    PRD Section Feature 2nd Drop Support Model

    3rd Drop Support Model

    Comments

    Use Case 1 Update license server configuration SZ100 vSCG

    Use Case 1 Synchronize license data with FNO-OD license server

    SZ100 vSCG

    Use Case 1 Synchronized license data with FNE local license server

    SZ100 vSCG

    Use Case 1 Retrieve Customer ID data and display on UI

    SZ100 vSCG If license data contain Customer ID

    Use Case 1 and 7

    90-days Instance License SZ100 vSCG

    Use Case 1 Display a link where customer can go to active their product

    SZ100 vSCG

    Use Case 2 Retrieve support license data from FNO-OD license server

    SZ100 vSCG

    Use Case 2 Retrieve support license data from FNE local license server

    SZ100 vSCG

    Use Case 2 Display support license expiration date on UI

    SZ100 vSCG

    Use Case 3 Display AP capacity license data information on UI

    SZ100 vSCG

  • Page 11 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Use Case 4 RMA Operation

    RMA operation cant be done at SCG side. User must contact support people to do the changes for them.

    Use Case 5 Remove AP capacity license from controller

    All the license reallocation should be done at FNOOD or Local License Server, not at Controller UI

    Use Case 5

    Remove license(s) after synchronized with license server if the license(s) no longer exist in license server for this controller

    SZ100 vSCG

    Use Case 6

    Automatic synchronize license data with FNO-OD license server every 24 hours and get all/any license updates and show on UI

    SZ100 vSCG

    Use Case 8 Emergency license from Ruckus Support team

    The procedure on the controller is not right. Our support team will create the Support license at FNOOD, and if the controller cant connect to FNOOD to get the license, user needs to download the licenses to a file and manually import the licenses in.

    Corner Case 1

    Manually upload license key to controller and display on UI

    SZ100 vSCG

    This feature only available if controller configures to connect with FNO-OD license server. For FNE local license server, the license key download from FNO-OD license server need to upload into FNE local license server in order for controller to use.

    Corner Case 2

    Manually upload support license key to controller and display the support license expiration date on UI

    SZ100 vSCG

    This feature only available if controller configures to connect with FNO-OD license server. For FNE local license server, the license key download from FNO-OD license server need to upload into FNE local license server in order for controller to use.

    Corner Case 3

    Display Virtual controller serial number on UI

    N/A vSCG

  • Page 12 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Installation Corner Case

    1

    Frequency of communication: default 24 hours

    SZ100 vSCG Same as Use Case 1

    Installation Corner Case

    1

    Frequency of communication: changeable by end-customer, options are: once in two-days, once-a-week, once-a-month, manual

    Recommend for post SCG 3.0

    Installation Corner Case

    1 and 2

    Frequency of communication: manual sync up option

    SZ100 vSCG

    Installation Corner Case

    3

    Local license server (LLS) failure occurs: The controller shall continue to poll for updates at the default of once every 24 hours default.

    SZ100 vSCG

    Installation Corner Case

    3

    Local license server (LLS) failure occurs: The controller shall continue to keep the last known successful support licenses and AP licenses for a 10 day period.

    SZ100 vSCG

    Installation Corner Case

    3

    Local license server (LLS) failure occurs: The controller shall send updated information: Need license update by 10 day counter from last successful known license data received

    SZ100 vSCG

    Installation Corner Case

    4

    Controller UI shall show the last time it successfully communicated with license server. and at the minimum the following statistics: Statistics for the last 30-days: # of successes, # of failures. Last 5 communications status sequence: e.g.: S S F S S.

    Recommend for post SCG 3.0

    Installation Corner Case

    5

    Manual license downloads: The controller UI must provide a "manual license upload" option - just like how things are today

    SZ100 vSCG Same as Corner Case 1

    Installation Corner Case

    5

    Manual license downloads: If there is a local license server (LLS) the controller UI shall pull the license from the LLS

    SZ100 vSCG Same as Corner Case 1

    Product Default State

    1

    Base AP Capability License - 50 counts

    SZ100 N/A For SZ100 series only

    Product Default State

    1 and 2

    90-days access without activation (Instance License)

    SZ100 vSCG

  • Page 13 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Product Default State

    2 Base AP Capability License - 1 count N/A vSCG For vSCG only

    Controller Activation Use Case 1

    and 2

    Permanent Instance License SZ100 vSCG

    3.4 License Type The SZ100 and vSCG will support AP Capacity License, AP Capacity Base License, Instance License and Support License.

    3.4.1 AP Capacity License AP Capacity License enables the management of Ruckus Access Point. It is a permanent license (no expiration date) and base unit is 1 Ruckus Access Point

    3.4.2 AP Capacity Base License AP Capacity Base License is same as AP Capacity License. This license is embedded inside the controller and it is not transferable. The default count for SZ100 is 50, and 1 for vSCG.

    3.4.3 Instance License Instance license can be considered as "Right to Use" license. Controller will not enable license without a instance available. Each controller will build in with 90-days trial Instance License. User must obtain the permanent instance license within 90-days. After 90-days trial period time and controller still not have permanent Instance License, all licenses in controller will be disabled.

    3.4.4 Support License SCG Support License enables SCG to do the system upgrade.

    3.5 License Data SCG will either pull the license data from license server or read it from upload binary license file. There are several required fields need to be include in the license data.

    3.6 Feature/Function Dependencies

    3.6.1 Publisher Identity Data File The new licensing feature use Flexera FlexNet Licensing as license management tools. A Publisher Identity Data File is required in order for Flexera FlexNet Licensing SDK to work. The file can be either generated by using SDK tools and upload to license server or download from license server.

    3.6.2 License Type Each license need to have a unique feature name as identifier. The feature name and format need to be defined in order for backend service knows what features need to be controlled by license.

    3.6.3 License Server The new licensing feature fetches license data from either FNO-OD Server or FNE-LLS Server. This implementation assumed that either one of server is available for fetch license right.

  • Page 14 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    4 Feature Requirements

    4.1 General Requirements The new licensing feature supports the SCG cluster model by each SCG box (node). The license entitlements are assigned to each individual SCG box (node). The total granted AP capacity licenses should add all assigned license together and display in License Summary. If any SCG box departs from the cluster, the total granted licenses should remain unchanged for 45 days. After 45 days the total granted license should recalculated within remaining SCG box in the cluster.

    Each SZ100 box has embedded in it a 90-days trial license of 50 AP capacities. The trial license will be activated when the SZ100 first starts up. Once the SCG is able to connect with license server and successfully pull the permanent license data from it, the trail license will be disabled. If later on within the 90 days trial period, the permanent license is removed for whatever reason, the trial license will be enabled again.

    The SCG will fully trust the license data provided by either from license server or upload binary license data file. On the other hand, the previous license data information will be overwritten by new license data. The license data will store in trusted storage for reference purpose, and decode into current existing license format to store in database.

    4.2 Licensing UI Licensing UI includes two separate pages: Licensing Management page and System Upgrade page. The License Management page provide all license related information, allow user to manually synchronize license data with license server and upload binary license data into the SCG when configure to connect with cloud license server. The System Upgrade page will show the warning message when support license has expired.

    4.2.1 Licensing Management Page

    Figure 4: License Management Page

    License Management page includes following sections:

    License Sync Section: Provide manual license sync button and sync status.

    License Server Configuration Section: Provide selection of cloud license server or local license server. Handle input of local license server address and port. Once user submitted the selection, the backend service will immediately sync with selected license server.

    License File Upload Section: Handle upload binary license data file.

    License Summary Section: Display all licenses current count and usage across the cluster.

  • Page 15 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    License Entitlement List Section: List current assigned license entitlements.

    4.2.1.1 License Sync Section

    Figure 5: Synchronization Section

    The Synchronize Section provides following information:

    A Sync now button that allows user to manually trigger synchronization process with license server.

    Display the synchronization result. o After Sync now button clicked, a message Start sync with license server will

    display. o If sync successful, it will display a message Sync license with license server

    success. o If sync failed, it will display a message Fail to sync with license server.

    4.2.1.2 License Server Configuration Section

    Figure 6: License Server Configuration Selection

    License Server Configuration Section provides following functions:

    Allow user to select cloud license server or local license server

    If selected local license server, allow user to input servers address and port. In each field: o IP Field: Allow either IP address or FQDN o Port Field: The number range is from 0 to 65535. The default port is 3333 o Clean button: Clean both IP field and Port field.

    When user click the Apply button, a dialog window as show in figure 4 will pop-up to confirm with user that license server configuration is going to change. Once user confirm with selection, the SCG will save the configuration, wipe out all current license data, and trigger a synchronization action with selected license server immediately.

  • Page 16 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Figure 7: License Server Configuration Confirmation Dialog

    4.2.1.3 License File Upload Section

    Figure 8: License File Upload Section

    License File Upload Section provides the functionality to allow user uploads the license file into SCG. This section will only available when user chooses to connect with cloud license server. If user chooses to connect with local license server, the whole section will be either gray out or not appear on UI. User can browse the local file system to choose binary license data file, indicate the license file type and click the Upload button to upload file into SCG.

    4.2.1.4 License Summary Section

    Figure 9: License Summary Section

    The License Summary Section provides the overall information about current licenses. The information include the License Type, Total number of license count, number of licenses has been consumed and number of licenses still available.

  • Page 17 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    4.2.1.5 License Entitlement List Section

    Figure 10: License Entitlement List Section

    License Entitlement List Section displayed all license entitlements that currently assign to SCGs.

    4.2.2 System Upgrade Page

    Figure 11: System Upgrade Page

    Current SCG has a System Upgrade page as show in figure 8. The additional function will added when user click Upload button.

    When user click the Upload button, UI will ask backend server to check the SCG or all SCGs within the cluster has valid support license. If support license has expired, a dialog window show in figure 9 will pop-up indicates that support license has expired. Otherwise will continue upload software image file for system upgrade.

  • Page 18 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    Figure 12: Support License Warning Dialog

    4.2.3 CLI Support All UI functionalities will also be supported in CLI. The following are the list of commands:

    Select license server configuration

    Add local license server configuration

    Synchronize with license server

    Upload binary license data file

    Display current license entitlements

    4.3 Use Cases

    4.3.1 SCG powers up and cannot connect with license server Scenario: A SCG powers up and try to connect with license server. However, SCG cannot connect with any license server.

    Result: SCG will read license data from permanent license trusted storage.

    1. SCG find the previous loaded license data with permanent instance license in permanent license trusted storage. SCG will continue use those license data to operate.

    2. SCG find the previous loaded license data with 90-days trial instance license in permanent license trusted storage. SCG will continue use those license data to operate until the trial instance license expired or get the permanent instance license.

    3. SCG cannot find any valid instance license in permanent license trusted storage. It will try to activate 90-days trial instance license. It will enable AP Capacity Base license features for 90-days once activation successful and message will display on UI indicates that the trial license is expired and please contact with customer support.

    4. SCG cannot find any valid instance license in permanent license trusted storage. It will try to activate 90-days trial instance license. If SCG fail to activate a trial instance license, a message will display on UI indicates that the trial license is expired and please contact with customer support.

    5. SCG cannot find any existing license data in permanent license trusted storage. It will start to search the default trial license from trial license trusted storage. If SCG cannot find any trial license data, it will start read the trial license data file from a default license file location and import the trial license into the trial license trusted storage. Once trial license file successful loaded, SCG will enable all features that trial license allowed for 90 days.

    6. SCG cannot find any valid instance license in permanent license trusted storage and fail to activate a trial instance license. A message will display on UI indicate that there is technical issue and recommend user to contact with customer support.

  • Page 19 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    4.3.2 SCG powers up and connect with license server but no license data available in license server

    Scenario: SCG powers up and connect with license server but no license data available in license server for this SCG.

    Result: SCG will remove all existing license data for this SCG from database.

    4.3.3 Connect to the cloud license server (FNO-OD) and retrieve Permanent Instance License

    Scenario: Customer purchases a new SZ100 with a 50 counts of AP Capacity Base License and Permanent Instance License.

    Result: After power up the SCG, SCG starts to connect with cloud license server and fetches the licenses.

    1. SCG successfully connects with cloud license server and fetches the licenses. Customer will see the Permanent Instance License and the AP Capacity Base License with 50 counts display on SCG Web UI License page.

    2. SCG fail to connect with cloud license server. Follow the use case 4.3.1 for rest of actions.

    4.3.4 Connect to the cloud license server (FNO-OD) and retrieve new AP Controller license data

    Scenario: Customers SCG already has Permanent Instance license with 50 counts of AP Capacity License and purchases extra 100 counts of AP Capacity License.

    Result: SCG start to connect with cloud license server and fetches the license data.

    1. SCG successfully connect with cloud license server and fetch the license data. Customer will see a Permanent Instance License and 200 counts of AP Controller License list on Web UI License page.

    2. SCG fail to connect with cloud license server. Follow the use case 4.3.1 for rest of actions.

    4.3.5 Change license server configuration Scenario: Customer changes SCG license server configuration from cloud license server to local license server.

    Result: A warning message will show in UI to confirm user want to switch license server and all current license data will be wipe out.

    1. If user acknowledges the warning message, SCG will start wipe out the all current license data and start fetch new license from new license server.

    4.3.6 Manually retrieve license data from cloud license server Scenario: The 100 counts of AP Controller License stored in cloud license server. Customer opens SCG Web UI License Management page and click Sync Now button to manually retrieve the license data.

    Result: SCG start to connect with license server after customer click the Sync Now button on Web UI License Management page.

  • Page 20 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    1. SCG successfully connect with license server and fetch the new license data. A message of successful communicates with license server will show and customer will see an AP Capacity License entitlement list on Web UI License Management page.

    2. SCG fail to connect with cloud license server. A record of failure communicates with license server will show in Web UI License Management page. Follow the use case 4.3.1 for rest of actions.

    4.3.7 Upload an encrypted binary license data file from local machine and retrieves license information

    Scenario: Customer configures SCG to connect with cloud license server. A network issue block customers SCG to communicate with license server. Ruckus customer support team sends the license data as a binary license data file to customer. Customer opens the SCG Web UI and uploads the binary license data file into SCG.

    Result: Customer received an encrypted binary license data file either from email or flash drive and upload it into SCG via Web UI.

    1. Customer uploads an encrypted binary license data file from Web UI but the file is broken or invalid. A message will shows in Web UI License page indicates the upload binary license file is invalid.

    2. Customer uploads an encrypted binary license data file from Web UI but the licenses Host ID does not match with Customers SCG. A message will shows in Web UI License page indicates the licenses Host ID does not match with SCG and direct customer to contact with customer support for future assistance.

    3. Customer successfully uploads the encrypted binary license data file into SCG. A message of successful upload binary license file will show and customer will see licenses information display on Web UI License Management page.

    4.3.8 Enforce support license in System Software Upgrade Scenario: Customer gets the new SCG software version image file and try to upload into SCG for system upgrade.

    Result: Customer opens the Web UI System Upgrade page and click Upload button to upload new software image file into SCG. SCG start to search support license.

    1. SCG start to search the support license and found an unexpired support license. SCG will grand the upload process and allow SCG to upgrade.

    2. SCG start to search the support license and found an expired support license. SCG will start connect with license server and fetch new support license.

    a. If license server has new support license, SCG will fetch the new support license and grand the upload process.

    b. If license server does not have new support license, SCG will decline the upload process and a message will shows in Web UI System Upgrade page indicates that the support license is expired and recommend user to connect customer support for future assistance.

    3. SCG start to search the support license and does not find any support license. SCG will start connect with license server and fetch new support license.

    a. If license server has new support license, SCG will fetch the new support license and grand the upload process.

  • Page 21 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    b. If license server does not have new support license, SCG will decline the upload process and a message will shows in Web UI System Upgrade page indicates that the support license is expired and recommend user to connect customer support for future assistance.

    4.4 Backend Service Requirements In order to support the new licensing feature, the following functions are required.

    A communication client that communicate with license server.

    Fetch license data from license server.

    Read the license data and save license information into database.

    Read license information from database and return to UI.

    Read the upload binary license data file and save license information into database.

    A scheduler that periodically fetch license data from license server.

    A enforce mechanism for system upgrade need to in place for supporting support license

    4.5 User Interface Requirements Here is a summary of all UI requirements list in this specification:

    1. Licensing Management Page

    License Sync Section

    License Server Configuration Section

    License File Upload Section

    License Summary Section

    License Entitlement List Section 2. System Upgrade Page

    4.5.1 UI Mockup Detail in License UI

    4.5.2 CLI Requirements Please look at CLI Support

    4.6 Performance Requirements

    4.6.1 System Performance

    4.7 Interface Requirements

    4.7.1 Internal Interface Requirements To be determined

    4.7.2 External Interface Requirements The Flexera FlexNet license server should be running and accessible.

  • Page 22 of 22

    Ruckus Wireless, Inc. Company Confidential

    All printed copies are considered un-Controlled copies and on-line version should be referred for latest version.

    5 The 3rd party tools and frameworks

    5.1 Flexera FlexNet Embedded Licensing SDK The new licensing feature use Flexera FlexNet Embedded Licensing as the license management tools. FlexNet Embedded is a software product toolkit that provides a secure licensing framework.

    It provides a variety of libraries and utilities used by each implementer to create license-enabled code.