install image

install image fname {partition} [ active | inactive]{msm slotid} {reboot}

On a SummitStack use:

install image fname {partition} {slot slot number} {reboot}

Description

Installs a new version of the ExtremeXOS software image.

Note

Note

Beginning with ExtremeXOS 12.1, an ExtremeXOS core image must be installed on the alternate (non-active) partition. If a user tries to install on an active partition, the following error message is displayed:
Error: Image can only be installed to the non-active partition.

Syntax Description

fname Specifies the software image file.
partition Specifies which partition the image should be saved to: primary or secondary. Select primary to save the image to the primary partition and secondary to save the image to the secondary partition.
active Specifies automatic determination for active (primary) partition.
inactive Specifies automatic determination for inactive (secondary) partition.
slotid

Specifies the MSM/MM where the software image file should be installed.

A specifies the MSM/MM installed in slot A.B specifies the MSM/MM installed in slot B.

Note: This parameter is available only on modular switches and SummitStack.

On a SummitStack, the slotid specifies the node to which the BootROM image should be installed.

reboot Reboots the switch after the image is installed.

Default

N/A.

Usage Guidelines

When you download a software image, you are asked if you want to install the image immediately after the download is finished. If you choose to install the image at a later time, use this command to install the software on the switch.

The software image file can be an .xos file, which contains an ExtremeXOS core image, or an .xmod file, which contains additional functionality to supplement a core image.

SummitStack Only

You can issue this command only from a Master node. The slot parameter is available only on a stack.

Displaying the Software Image Version

To display the software image version running on the switch, use the show version or show switch commands.

Displaying the Downloaded Software Image Version.

To display a software image version that has been downloaded but not installed, use the install image ? command.

Local Filename Character Restrictions

This section provides information about the characters supported by the switch for local filenames.

When specifying a local filename, the switch permits only the following characters:
  • Alphabetical letters, upper case and lower case (A-Z, a-z)
  • Numerals (0-9)
  • Period ( . )
  • Dash ( - )
  • Underscore ( _ )

When naming a local, remember the requirements listed above.

Installing an ExtremeXOS core image

Install the software image on the alternate partition. You can continue to run the currently booted image, but to run the newly installed image, you will need to set the boot partition with the use image {partition} partition {msm slotid} command and reboot the switch.

Installing an ExtremeXOS module image

An ExtremeXOS module image has functionality that supplements a core image. You will install a module onto an already installed core image. The version number of the core image and the module must match. For example, the module bdx8-15.6.1.25-ssh.xmod can only be installed onto the core image bdx8-15.6.1.25.xos.

To install a module to the alternate partition, use the install firmware command to install the module. Remember, the core image on the alternate partition must be of the same version as the module. When you make the alternate partition active, by issuing the use image command and rebooting the switch, the module is also activated at boot time.

To install a module to the active partition, use the install firmware command to install the module. Remember, the core image on the active partition must be of the same version as the module. If you reboot the switch, the module will also be activated, but you can activate the module without rebooting the switch by issuing the run update command. After issuing that command, all the functionality, and CLI commands, of the module will be available.

Performing a Hitless Upgrade--Modular Switches Only

If you specify the msm parameter on a BlackDiamond 8800 series switch, you can initiate hitless upgrade between the primary and backup MSMs installed in the switch.

Hitless upgrade is a mechanism that allows you to upgrade the ExtremeXOS software running on the switch without taking the switch out of service. Some additional benefits of using hitless upgrade include:
  • Minimizing network downtime
  • Reducing the amount of traffic lost

Although any method of upgrading software can have an impact on network operation, including interrupting Layer 2 network operation, performing a hitless upgrade can decrease that impact.

Regardless of how you upgrade the software, you must:
  • Review the following list to confirm that your system supports hitless upgrade:
    • BlackDiamond 8800 series switch with a mix of BlackDiamond 8000 c-, e-, and xl-series modules installed—Both MSMs are running ExtremeXOS 11.5 or later.
  • View the current switch information to determine your selected and booted image partitions, verify which MSM is the primary and which is the backup, and confirm that the MSMs are synchronized using the show switch command
  • Select the partition to use when downloading the image using the download image [[hostname | ipaddress] filename {{vr} vrname} | memorycard filename] {partition} {msm slotid} command.

When performing a hitless upgrade, you must:

  • Download the software to the backup MSM. Download the image to the alternate partition.
  • Use the install image fname {partition} {msm slotid} {reboot} command to install the software image at a later time.
  • Reboot the Backup MSM using the reboot msm b command.
  • Use the run msm-failover command to initiate failover from the primary MSM to the backup MSM. The original primary MSM becomes the new backup MSM.
  • Download the software to the new backup MSM. Again, download the image to the alternate partition, and use the install image fname {partition} {msm slotid} {reboot} command to install the software image at a later time.

For more detailed information about hitless upgrade, see the download image command.

Example

The following example installs the software image file bd8800-11.3.0.10.xos on a BlackDiamond 8810 switch:

install image bd8800-11.3.0.10.xos

The following example installs the software image file summitX440-11.5.1.2.xos on a Summit family switch:

install image summitX440-11.5.1.2.xos

The following example displays a software image version that has been downloaded but not displayed:

install image ?

A message similar to the following is displayed:

# install image ?
<fname>         Image file name
"summitX-12.1.0.52.xos"

History

This command was first available in ExtremeXOS 10.1.

The msm parameter was added in ExtremeXOS 11.1.

The slot parameter was added to support SummitStack in ExtremeXOS 12.0.

Platform Availability

This command is available on all platforms.