Firmware Update

1. Function Overview

This product offers the following two firmware update functions, in order to correct problems in the program and to add new functionality.

  1. Firmware updates can be transmitted and applied to this product from a remote terminal such as a computer.

  2. This product’s built-in HTTP client can access an HTTP server, to download and apply the latest firmware.

  3. A firmware update placed on the SD card can be applied to this product.

These update functions can be used to upgrade or downgrade the version of firmware used on this product.
During firmware updating, all port LEDs flash green, regardless of the LED display mode setting.

When a stack is configured, the updated firmware is written simultaneously to the stack main and member switches.
When successfully finished writing the updated firmware, the system is automatically rebooted in order to apply the new firmware.
For instructions on how to specify rebooting the system, refer to Reboot after writing.

2. Definition of Terms Used

None

3. Function Details

3.1. Update by transmitting the firmware update

This function transmits firmware updates to this product from a remote terminal, such as a computer, and applies it as boot firmware.
The update process is executed using a TFTP client or the Web GUI.

3.1.1. Using a TFTP client to update the firmware

Firmware can be updated by using a TFTP client installed on a computer or other remote terminal to transmit the updated firmware to this device.
In order to operate this product’s TFTP server, use the steps shown below to set up a network environment that allows remote access.

  1. Decide on the VLAN that will be used for maintenance.

  2. Set the IPv4 address on the maintenance VLAN. Set it using the ip address command.

  3. Permit access from the maintenance VLAN to the TFTP server. Use the tftp-server interface command or the management interface command to specify that setting.

  4. Enable the TFTP server. Enable the server using the tftp-server enable command.

Follow the rules below when sending the firmware update using the TFTP client.

  • Set the transmission mode to “binary mode”.

  • As shown in the table below, specify the remote path to which the firmware update is sent.

  • Specify the administrative password in the form “/PASSWORD” at the end of the remote path.
    However, the firmware update cannot be applied if the administrative password is still set to the default setting. The administrative password setting must be changed in advance.

When updating firmware that uses TFTP clients, the following three types of updates are possible.

  • Updated firmware

    Type Remote path

    Internal firmware

    exec

If there is no problem with the firmware update that was sent, the firmware update will be saved.

3.1.2. Updating the firmware by specifying a local file in the Web GUI

Specify the firmware update located on the terminal accessing the Web GUI, and apply it to this product.
This function does not do a version comparison with the existing firmware, and will overwrite the specified firmware regardless of version.

To update firmware by specifying a local file, click [Maintenance] - [Firmware update] in the Web GUI on the computer. (Refer to the part shown in a red frame on the screenshot below.)
Refer to the help contents within the GUI for the specific operation method.

  • Initial screen on the Web GUI for updating firmware using a computer
    image

3.2. Using an HTTP client to update the firmware

This method of firmware update uses an HTTP client to obtain the firmware update from a specified URL, and then apply it to this product.
This function assumes that the firmware version will be upgraded. Downgrading to a previous version will only be permitted if “revision-down” is allowed.
The firmware cannot be rewritten with the same version of firmware.
This function cannot be used when the stack is enabled.
An HTTP client can be used to update the firmware using the methods below.

  • Use the firmware-update command in the CLI (command-line interface).

  • Execute update firmware via network in the Web GUI.

Updating the firmware with an HTTP client is done by using the settings value shown in the table below.

Setting parameter Explanation

Download source URL

Sets the source URL from which the firmware is downloaded. A URL of up to 255 characters in length can be set.
The input format is “\http://IPv4/IPv6 address of the server” or “\http://hostname/path name”.
If an IPv6 address is specified, it must be enclosed in square brackets like “[IPv6 address]”.
If the server port number is other than 80, it must be specified within the URL in the form “\http://IP address of the server:port number/path name” or “\http://hostname:port number/path name”.
Default value settings are specified in the following location.
http://www.rtpro.yamaha.co.jp/firmware/revision-up/swx2310p.bin

Proxy Server URL

Specifies the proxy server to use for updating firmware.
Specify it either as an IPv4/IPv6 address or FQDN. FQDNs can be up to 255 characters long.
No proxy server is specified in default settings.
Proxy servers must be specified as an IPv4/IPv6 address or in the form “\http://hostname/path name port number”.
If an IPv6 address is specified, it must be enclosed in square brackets like “[IPv6 address]”.

Permit downward revision

Sets whether the current version of firmware can be downgraded to a previous version.
The default value is “Don’t allow”.
Overwriting the firmware with the same version of firmware is not permitted.

Timeout

Specifies the timer for monitoring the completion of the processes shown below.
* Version check of old and new firmware
* The download monitoring timer from the specified URL can be specified from 100 seconds to 86,400 seconds, and the initial setting is set to 300 seconds.

For instructions on using the firmware-update command, refer to “Examples of Command Execution” or the “Command Reference”.
To update firmware over the network using the Web GUI, execute [Maintenance] - [Firmware update] on the Web GUI. (Refer to the part shown in a red frame on the screenshot below.)
Refer to the help contents within the GUI for the specific operation method.

  • Initial Web GUI Screen for Updating Firmware via the Network
    image

3.3. Update using an SD card

The firmware stored on the SD card inserted in the unit will be applied as the updated firmware.
This update is performed from the CLI (Command-line interface) using the firmware-update sd execute command.
If a stack was configured, commands can only be executed from the main switch in the stack.
After entering the firmware update confirmation, the update will continue even if the SD card is removed. To unmount the SD card when executing the command, enter “N” in the confirmation of continued SD card mounting status, or specify the “sd-unmount” option with the command.
If the system is rebooted with the SD card inserted in the main unit, the system will be booted using the firmware in the SD card, as specified by the boot prioritize sd command.

  • File path in SD card /swx2310p/firmware/swx2310p.bin

3.4. Reboot after writing

When successfully finished writing the firmware update, the system is automatically rebooted.
However, the system is not rebooted if the “no-reboot” option is specified for firmware-update execute or firmware-update sd execute commands.
If the firmware-update reload-time command is specified without specifying the “no-reboot” option, then the system is rebooted according to the reboot time setting.
The revision after the next reboot can be confirmed by executing the show firmware-update command.

If a stack is configured, the firmware update method can be selected using the firmware-update reload-method command.

  • How to simultaneously update member switches in a configuration

  • How to update without stopping network services

For an operation overview of the firmware update methods, refer to Firmware Update in the stack public technical data.

4. Related Commands

Related commands are indicated below.
For details, refer to the Command Reference.

Operations Operating commands

Set firmware update site

firmware-update url

Set proxy server

firmware-update http-proxy

Execute firmware update

firmware-update execute

Set firmware download timeout duration

firmware-update timeout

Permit downward revision

firmware-update revision-down

Show firmware update function settings

show firmware-update

Execute firmware update from SD card

firmware-update sd execute

Set firmware update reboot time

firmware-update reload-time

Set the firmware update restart method during stack configuration

firmware-update reload-method

5. Examples of Command Execution

5.1. Using an HTTP client to update the firmware

In this example, the firmware update is stored on the local HTTP server, and this product is set to manage the firmware in order to perform the update.

  • Change the download URL to http://192.168.100.1/swx2310p.bin.

  • The downward revision setting is left disabled.

  • The timeout value is left at 300 sec.

  • A reboot time is not specified, but the system is rebooted immediately after updates.

    1. The download URL is changed, and the firmware update settings are confirmed.

          Yamaha(config)#firmware-update url http://192.168.100.1/swx3210p.bin (1)
    Yamaha(config)#exit
    Yamaha#show firmware-update (2)
    url:http://192.168.100.1/swx2310p.bin
    http-proxy: -
    timeout: 300 (seconds)
    revision-down: Disable
    firmware revision for next boot: -
    reload-time: -
    reload-method: Normal
      1 Set download source URL
      2 Show firmware update function settings

    2. The firmware update is executed.

          Yamaha#firmware-update execute (1)
    Found the new revision firmware
    Current Revision: Rev.2.02.01
    New Revision:     Rev.2.02.03
    Downloading...
    Update to this firmware? (y/n)y (2)
    Updating...
    Finish

    (3)
      1 Execute firmware update
      2 Enter y
      3 The system automatically reboots

    3. Pressing “CTRL+C” during the firmware update process will interrupt the update.

          Yamaha#firmware-update execute
    Found the new revision firmware
    Current Revision: Rev.2.02.01
    New Revision:     Rev.2.02.03
    Downloading... (1)
    ^CCanceled the firmware download
      1 Press the Ctrl and C keys

5.2. Using an HTTP client to update the firmware (in a proxy server environment)

This updates the firmware by specifying a proxy server.

  • The initial download URL setting is left unchanged.

  • The proxy server is set to http://192.168.100.1:8080.

  • The downward revision setting is left disabled.

  • The timeout value is left at 300 sec.

  • A reboot time is not specified, but the system is rebooted immediately after updates.

    1. Specify the HTTP proxy settings and confirm the firmware update settings.

          Yamaha(config)#firmware-update http-proxy http://192.168.100.1 8080 (1)
    Yamaha(config)#exit
    Yamaha#show firmware-update (2)
    url: http://www.rtpro.yamaha.co.jp/firmware/revision-up/swx3220.bin
    http-proxy: http://192.168.100.1:8080
    timeout: 300 (seconds)
    revision-down: Disable
    firmware revision for next boot: -
    reload-time: -
    reload-method: Normal
      1 Set HTTP proxy
      2 Show firmware update function settings

    2. The firmware update is executed.

          Yamaha#firmware-update execute (1)
    Found the new revision firmware
    Current Revision: Rev.2.02.01
    New Revision:     Rev.2.02.03
    Downloading...
    Update to this firmware? (y/n)y (2)
    Updating...
    Finish

    (3)
      1 Execute firmware update
      2 Enter y
      3 The system automatically reboots

5.3. Update using an SD card

In this example, the firmware update is placed on an SD card inserted in the unit, and this product is set to manage the firmware in order to perform the update.
This is an example of a two-stack configuration.

  • Change the reboot time to 23:30.

  • Change the reboot method to reboot the stack main and member switches sequentially.

    1. Change the reboot time and reboot method.

          Yamaha(config)#firmware-update reload-time 23 30 (1)
    Yamaha(config)#firmware-update reload-method sequential (2)
    Yamaha(config)#exit
      1 Set the reboot time
      2 Set the reboot method

    2. Insert the SD card into the main switch in the stack and execute the firmware update.

          Yamaha#firmware-update sd execute (1)
    Update the firmware.
    Current Revision: Rev.2.02.01
    New Revision:     Rev.2.02.03

    Update to this firmware? (y/n)y (2)
    Continue without unmounting the SD card? (y/n)n (3)
    Unmounted the SD card.  Pull out the SD card.
    Updating...
    Finish
    Yamaha#
    (Reboots at specified reboot time)
      1 Execute firmware update
      2 Enter y
      3 Enter n

    3. The stack member firmware is updated at the same time as the stack main switch, but the members are rebooted after the firmware in the stack main switch has been rebooted.
      The following log history is displayed on stack member consoles.

          (Press ENTER on the stack main. The firmware is received and the update starts.)
    Receiving exec file...
    Testing received file...
    Writing to Nonvolatile memory...
    Done.

    (Wait for restart of stack main then reboot)

    4. After checking the version of the update firmware, you can enter “n” to cancel.

          Yamaha#firmware-update sd execute (1)
    Update the firmware.
    Current Revision: Rev.2.02.01
    New Revision:     Rev.2.02.03

    Update to this firmware? (y/n)n (2)
    Yamaha#
      1 Execute firmware update
      2 Enter n

6. Points of Caution

If the system is rebooted or the power is turned off during firmware update, the update will be interrupted and the system will start with the firmware before the update operation.

7. Related Documentation