Firmware Update Management by Switches

The RUCKUS One web interface supports RUCKUS ICX switch firmware updates at the switch level.
To provide an overview of a feature and its benefits. May require several Concept topics to keep content in short, manageable, and reusable chunks of content.

The intention of this new template is to outline the information that you will need to collect from SMEs and provide to readers.

NOTE: Feature Configuration / Troubleshooting are *not* part of the Feature Concept template. These templates are likely to be part of seperate task/reference templates (to be developed).

General Notes for Concept Topics:
  • Optional sections are to be used with discretion based on the feature characteristics.

Feature Overview

This section is required. Providing detailed and accurate information in the feature overview is crucial as it helps users understand the functionality, benefits, and usage of the feature. Moreover, it ensures consistency in communication across all platforms, enhancing user experience and product perception.
  • What is the name of the feature? (What do users call the feature? If the feature is referred to by an acronym, what is the acronym expansion? What is the formal name to be used in documentation?)
    Note: Typically, the name is used as part of the section titles, such as the overview title and the configuration section titles.
  • Where does the feature fit within our taxonomy? (What are the taxonomy group and sub-group? This information is important for categorizing the feature documentation and incorporating it into the existing document sets.)
  • What standard or standards govern the feature? (Sometimes needed.)
  • Is the feature a new feature or an enhancement to an existing feature?
  • Does the feature replace another feature?
  • What does the feature do? (General description)
  • How does the feature benefit the user?
  • What set of terms do the writer and reader need to know to understand the feature and its use?
  • How does the feature work? (Detailed description, if needed.)

The Firmware Update Management by Switches feature offers enhanced capabilities for managing update tasks at the switch level associated with one venue or across multiple venues.

  • Update Now: Immediately update one or more specifically selected switches
  • Change Update Schedule: Change the update schedule for one or more specifically selected switches
  • Skip Update: Cancel a scheduled update for one or more specifically selected switches
  • Disable Firmware Management: Stops switch firmware management through RUCKUS One.

Requirements

Management of switch firmware updates, such as changing an update schedule, requires the RUCKUS ICX switch to be onboarded to RUCKUS One and associated with a venue.

Switch firmware update, whether scheduled or by Update Now, requires the RUCKUS ICX switch to be onboarded to RUCKUS One, associated with a venue, in the Operational state, and running a firmware version that is older than the latest released version.

This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no requirements, use the following default wording:

This feature has no special hardware or software requirements for feature enablement or usage.

If there are requirements, include the applicable below points (depending on product line):

  • What releases support the feature?
    Note: Typically, this is not documented in the configuration guides; however, we need to know where to include the information.
  • What hardware models support the feature?
  • Does the feature require specific modules?
  • Does the feature run only on certain ports?
  • Does the feature have special memory requirements?
  • In an integrated system, can the feature be managed or configured from another device? What are the related release and system requirements?
  • Does the feature introduce new user requirements?
  • Does the feature introduce physical or location-based requirements?

Considerations

  • After selecting one or more venues and choosing the Update Now or the Schedule Updates option, you then have the choice of updating all switches in the selected venue(s) or selecting specific switches to be updated.
  • If a switch is offline during its scheduled update, it will, upon returning online, select the missed target version for updating, provided that the switch’s current firmware version is older than the target version.
  • Switches will be upgraded to match the respective generation of firmware version. For example, if you trigger an update to firmware versions 9.0.10xx_xxxx and 10.0.10x_xxxx. The switches that are 9.0.x releases will be updated to 9.0.10x_xxxx and the switches that are 10.0.x releases will be updated to 10.0.10x_xxxx.
  • If a switch has already been updated to the target version during a previous update cycle, it will not be updated again in the current cycle.
  • Switch-level scheduling takes precedence over venue-level scheduling while renewing a schedule for a switch update for an existing venue-level schedule, consider the following:
    • If you apply a new schedule on specific switches (for example, switch A and switch B) of a venue where the rest of the switches are following an existing venue-level schedule, then the new schedule will be effective only on those switches (switch A and switch B) and rest of the switches will use the existing venue-level schedule.
    • If you are applying a new schedule on all the switches of the venue, then the existing schedule on the switches will be canceled and all the switches of the venue will use the new schedule.
    • If you are applying a new schedule on a specified switch that is part of another existing schedule, then the specified switch will use the new schedule.
  • While skipping a scheduled switch upgrade, consider the following:
    • If you skip a switch update for a specific venue, then all scheduled updates on the venue are cancelled whether the switches follow the existing venue-level or switch-level schedules.
    • If you skip a switch update for a specific switch on a venue, then only the schedule related to that particular switch is cancelled. The other switch-level and venue-level schedules on the venue remain unaffected.
This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no considerations, use the following default wording:

This feature has no special considerations or limitations pertaining to feature enablement or usage.

If there are considerations, include the applicable below points (depending on product line).

Note: A separate section on Limitations may sometimes be needed.
  • Does the feature replace an existing feature?
  • Does the feature work only with a certain protocol or with a limited set of protocols?
  • Is the feature meant to be used in combination with another feature or a set of features?
  • Is the feature incompatible with any features?
  • What happens when the feature is enabled?
  • What happens when the feature is disabled?
  • Does enabling/disabling the feature enable/disable another feature?
  • What system behavior changes, if any, does the feature introduce?
  • Are performance issues associated with the feature? How can these be mitigated?

Best Practices

This feature has no special recommendations for feature enablement or usage.

This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no best practices (recommendations), use the following default wording:

This feature has no special recommendations for feature enablement or usage.

If there are considerations, include the applicable below points (depending on product line).

  • Brief list of RUCKUS recommendations on product use to optimize performance.

Prerequisites

This feature has no prerequisites to feature enablement or usage.

This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no prerequisites, use the following default wording:

This feature has no prerequisites to feature enablement or usage.

If there are prerequisites, include the applicable below points (depending on product line).

Note: This section is sometimes part of a general overview and sometimes part of a configuration overview.
  • What are the task prerequisites that the user must ensure are met,for configuration? (For example, must you be running certain protocols, or must you configure other features first?)

In this section:

  1. Upgrading Switch Firmware at the Switch Level
    The RUCKUS One web interface supports RUCKUS ICX switch firmware updates at the individual switch level.
Parent topic: Version Management