'; Firmware Management | Incognito Help
Array
(
    [0] => Array
        (
            [version] => 4.3
            [language] => en
        )

    [1] => Array
        (
            [version] => 4.2
            [language] => en
        )

    [2] => Array
        (
            [version] => 4.1
            [language] => en
        )

    [3] => Array
        (
            [version] => 4.0
            [language] => en
        )

    [4] => Array
        (
            [version] => 3.5
            [language] => en
        )

    [5] => Array
        (
            [version] => 3.4
            [language] => en
        )

    [6] => Array
        (
            [version] => 3.3
            [language] => en
        )

    [7] => Array
        (
            [version] => 3.2
            [language] => en
        )

    [8] => Array
        (
            [version] => 3.1
            [language] => en
        )

    [9] => Array
        (
            [version] => 4.2
            [language] => fr
        )

    [10] => Array
        (
            [version] => 4.2
            [language] => es
        )

)
Rel: acs/topics/acs/dita/firmware_management
URI: acs/topics/firmware_management
=== Tags ===
Array
(
    [824] => firmware_management
)

=== Related ===
Array
(
)

Firmware Management

Firmware management automates the rollout of large scale firmware update operations. Firmware updates are deployed in campaigns and can be either upgrades or downgrades.

Target firmware versions and procedures are managed in a library of firmware recipes. The service uses firmware recipes to define the update process. Firmware recipes include general information such as the update type (upgrade or downgrade), the firmware version to be updated, and the target version. When you execute a change in firmware, the service automatically executes all of the steps defined in the recipe.

Firmware recipes can also include the following steps for post-processing: “Reboot” and “Factory Reset”.

To do this: Follow these steps:
View percentage of devices with available firmware updates View the Firmware Updates Available tile.
View available firmware updates Click Firmware Updates Available.
View firmware operations currently in progress Click In Progress.
View scheduled firmware operations Click Scheduled.
View completed firmware operations Click Completed.
View archived firmware operations Click Archived.
View and manage firmware recipes Click Firmware Recipes.

Monitoring Firmware Update Progress

The Firmware Management dashboard provides you with a quick view of the number of devices that are in various stages of the firmware upgrade process. Click any tile in this dashboard for details about firmware updates in that specific state.



Firmware Updates Available

The dashboard tile provides the percentage of devices eligible for an update. The service lists the vendors that have updates (upgrades or downgrades) available, the number of updates, and the number of devices eligible. Use these settings to view and manage firmware versions and recipes.

To do this: Follow these steps:
Change firmware version filter type From the dropdown list, select one of:
  • Production Versions
  • Production - Required
  • Production - Optional
  • Test Versions
View available update for a device vendor Click a device vendor, and in the action bar, click View.
Import a firmware version In the action bar, click Import.

Firmware Update Details

The firmware library displays the available firmware actions for a device model. Use these settings to upgrade or downgrade firmware versions.

Tip: Firmware versions highlighted in blue are required updates.
To do this: Follow these steps:
Change firmware version filter type From the dropdown list, select one of:
  • Production Versions
  • Production - Required
  • Production - Optional
  • Test Versions
Upgrade or downgrade firmware Click the arrow indicating a firmware target version (either upgrade or downgrade). A screen appears for selecting devices or devices groups to which the target firmware will be applied.

Selecting Devices for Firmware Updates

When you create a firmware update, you can select to apply the update to individual devices or to one or more groups of devices. Use these settings to select which devices to apply the firmware update against.

To do this: Follow these steps:
Change selection filter type From the dropdown, select one of:
  • Devices
  • Device Groups
Upgrade or downgrade firmware Select devices or device groups, and in the action bar, click Confirm.
Select all records In the action bar, click Select All.
Accept selection and move to scheduling options In the action bar, click Confirm.
Switch to table view/grid view Click the table symbol ()/grid symbol ().

Scheduling Firmware Updates

You can schedule the update immediately, on next contact from the device, or during a specific time window. When you want to schedule the upgrades after hours, when the operation is less likely to cause service interruptions, use the time window option. Use these settings to schedule firmware updates.

Name* Descriptive name for the firmware update.
Limit To Limit the number of devices to which this update is applied. Value must be less than or equal to the number of devices you have selected for this update. The devices are randomly chosen from the selected devices.
Save Device Selection Save this list of devices to a device group which becomes accessible from Device Groups in the main Hub.
Device Selection Name* Name for the device group you are creating with the Save Device Selection setting.
Schedule Create a time window in which to execute the firmware update. Window scheduling is useful for scheduling events that may disrupt service.
Next Contact The service waits to send the firmware update until the next contact from the device.
Execute Now Firmware update executes immediately.
Table 1. Window - Scheduling Options
Date The date the service can run the operation.
Start Time The start of a time window in which the service can run the operation.
End Time The end of a time window in which the service can run the operation.
Note: Operations are only sent to the device within the active time window(s). Operations that are not completed at the end of this period move into a failed state.
Notify Device When the time window becomes active, the service notifies the device. Otherwise, the service waits to send the operation until the next contact from the device.
Repeat Enable to define a daily or weekly recurring schedule.
Repeats Daily or weekly.
Run Length of time to run the repeat schedule. Select one of:
  • Until completion
  • After ___ occurrence(s)
  • Until date ___

Completed

Use these settings to view and manage completed firmware operations.

To do this: Follow these steps:
View operation details Click an operation
Retry a completed operation Click Select, and select an operation. Then, in the action bar, click Retry.
Archive a completed operation Click Select, and select an operation. Then, in the action bar, click Archive.
Switch to table view/grid view Click the table symbol ()/grid symbol ().

In Progress

These settings provide a real-time view into progress of firmware update campaigns, including a success and failure ratio.

To do this: Follow these steps:
View an operation Click an operation.
Pause an operation Click Select, and select an operation. Then, in the action bar, click Pause.
Resume an operation Click Select, and select an operation. Then, in the action bar, click Resume.
Cancel an operation Click Select, and select an operation. Then, in the action bar, click Terminate.
Switch to table view/grid view Click the table symbol ()/grid symbol ().

Archived

Campaigns are kept in the active operations table indefinitely unless you archive them.

When you no longer want to retry failed operations in a campaign, you terminate the campaign which sends it to an archived state. It is kept in the archived operations table until the service purges it. Use these settings to view and manage archived firmware operations.

Note: You can define the purge frequency, period, and start time in the AUDITREMOVALFREQUENCY, AUDITREMOVALPERIOD, and AUDITREMOVALSTARTTIME configuration parameters. For further information, refer to the ACS CLI Reference.
To do this: Follow these steps:
View operation details Click an operation.
Search for an operation Click the search symbol (), type search terms, and press Enter.
Search fields In table view, type search terms in any of the available column heading fields and press Enter.
Select multiple operations Press and hold CTRL and click the records you want to select.
Select all operations In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Switch to table view/grid view Click the table symbol ()/grid symbol ().
Go back one screen Click the back symbol ().
Return to the main screen of the service Click the hub symbol ().

Scheduled

Use these settings to view and manage scheduled firmware operations.

To do this: Follow these steps:
View operation schedule Use the back and forward arrows to navigate through the calendar.
View a scheduled operation Click an operation.

Firmware Recipe Management

Firmware recipes allow administrators to define a sequence steps that can be applied to devices targeted for a firmware update. The firmware recipe can be defined as an upgrade or downgrade recipe. Use these settings to view and manage firmware recipes.

Note: A firmware upgrade recipe may include multiple upgrade steps, in order to upgrade devices through several firmware updates.
Each step in the firmware update defines the:
  • Firmware image download protocol
  • Firmware image file name and path
  • Server that the firmware image can be downloaded from
  • Login credentials for secure image downloads
  • Action to take after the firmware image is downloaded (e.g. Reboot)

Once a firmware recipe has been created, it is available for scheduling against different devices or device groups.

To do this: Follow these steps:
Search for a firmware recipe Click the search symbol (), type search terms, and press Enter.
View details for a firmware recipe Click a firmware recipe.
Create a firmware recipe In the action bar, click Create.
Import a firmware recipe In the action bar, click Import.
Switch to table view/grid view Click the table symbol ()/grid symbol ().
Note: The service searches for an exact match. If you need to search for a partial match, type a wildcard (*) for the character(s) you do not know.

Creating Firmware Recipes

To do this: Follow these steps:
Add steps to recipe Click Steps.
Create the recipe Click Save.
Name Name for the firmware recipe you are creating.
Description Description for the firmware recipe you are creating.
Category* Select ‘Production - optional’, ‘Production - Required’, or ‘Test Versions’ from the dropdown list.
Update Type* Select ‘Upgrade’ or ‘Downgrade’ from the dropdown list.
OUI* Enter the hardware manufacturer's Organizationally Unique Identifier(s) (OUI) to define the type of devices to which this update applies.
Product class* Enter the Product Class to define the type of devices to which this update applies.
Update on Discovery Radio button. When selected: If a new device is discovered with the required firmware version, the device is updated immediately to the targeted version.
Required versions When specified, the recipe will apply only to devices that have one of the listed versions.
Target version* Specifies the firmware version the device will have after a successful update.
Apply device model Add a device model to define the type of devices to which this update applies.
Firmware Recipe Update Steps Define the steps in the recipe.
Table 2. Firmware Update Steps
Protocol Download protocol. Files may be downloaded by TFTP, FTP, HTTP, or HTTPS (depending on device support).
Choose File Firmware image file name.
File type Type of file to upload to device.
Note: Firmware is only one of several choices.
File path Filepath to the firmware image on the file server where the firmware image is located.
Server Hostname or IP address of the file server where the firmware image is located.
Username Username to access the file server, if required.
Password Password to access the file server, if required.
Post download action* After the file has been downloaded, the service can request the device reboot or to reset to factory defaults.
Delay Seconds* Time (in seconds) to delay a firmware image download.
File Size Read-only value that reflects the size of the firmware image.
Top