Start Up From the Execution File On the External Memory

Summary

This function enables you to start the router using the firmware file and configuration file stored on the external memory (such as USB flash drive and microSD card).

Since this function is enabled by default, you can use it simply by connecting an external memory and switching on the power of the router.

You can use this function to greatly simplify the router installation work at the installation location.
Instead of logging into the router and configuring the settings manually, you can complete the installation simply by switching on the router after connecting an external memory containing the configuration file.

Furthermore, if you run the router using the files stored on the external memory, you can quickly switch to an alternate device simply by replacing the external memory.

If the power of the router is switched on and an external memory is plugged in, you can also start up the router using the files stored on the external memory by holding down the external memory button and DOWNLOAD button simultaneously for more than three seconds. In this case, a file on the external memory is copied to the built-in nonvolatile memory (built-in Flash ROM) of the router.

For more information on the basic usage of the external memory and details of the SYSLOG messages, refer to "Using the External Memory".

Notes

This function uses the firmware and configuration files in the built-in Flash ROM in order to be able to recognize the external memory. To use this function, make sure that the "usbhost use" or "sd use" command and the "external-memory boot permit" command are set to 'on' in the configuration file in the built-in Flash ROM (The default value of all of these commands are 'on').

You can prohibit the use of this function by setting the "usbhost use" or "sd use" command and the "external-memory boot permit" command to 'off’ in the configuration file in the built-in Flash ROM.

When the router is running using the files on the external memory, the firmware update and saving of the settings are performed on the respective files on the external memory.

  • If the router has been started using a configuration file on the external memory, the "save" command will save the configuration file to the external memory.
    • If the directory structure on the external memory is different between when the configuration file is loaded and when the "save" command is executed, the same directory structure will be created when you execute the "save" command.
    • If no external memory is connected, you can change the save destination to the built-in Flash ROM.
  • If the router has been started using a firmware file on the external memory, the TFTP revision update is performed on the firmware file on the external memory (except when specified in exec0 or exec1).
    • An error will occur if no external memory is connected.
  • If the router has been started using a firmware file on the external memory, the HTTP revision update is performed on the firmware file on the external memory.
    • An error will occur if no external memory is connected.

Compatible Models & Firmware Revisions

The following Yamaha router models/firmware support the "Start up from the execution file on the external memory" function:

Model Firmware
RTX5000 Rev.14.00.15 or later
FWX120 Rev.11.03.16 or later
RTX810 Rev.11.01.15 or later

Details

Start up the Router from Files on the External Memory

Prepare the firmware file and configuration file. You should name the files as "(Model name)_en.bin" and "config.txt", respectively; and the files should be stored on the external memory. These files will be searched in and loaded from the external memory.

  • Connect the external memory to the router and switch on the power of the router unit.
    You do not need to make any selection in the boot selector (It will time out in 10 seconds). The external memory LED lamp on the front side of the main unit blinks while the external memory is being accessed. The LED lamp will light when the startup is complete.
    This function is only enabled when the "external-memory boot permit" command is set to 'on' (Default value is 'on').

You can also start the router using the firmware file and configuration file stored on the external memory by following the procedure below.

  • Press the external memory and DOWNLOAD buttons simultaneously for more than three seconds.
    After three seconds, the firmware file and configuration file on the external memory are copied to the built-in Flash ROM. The router will restart when the copying process completes, and it will start up using the copied firmware file and configuration file.
    This function is only enabled when the "operation external-memory download permit" command is set to 'on' (Default value is 'on').
    For details, refer to "Copy File To the External Memory".

You can change the name of the files to be loaded using the "external-memory exec filename" command or the "external-memory config filename" command. The firmware file and configuration file are configured as shown below in the factory default configuration.

RTX810 and FWX120 RTX5000
Firmware file *:(Model name)_en.bin SD 1: (Model name)_en.bin
Configuration file *:config.rtfg,*:config.txt sd1:config.rtfg,sd1:config.txt

The files are searched automatically in the external memory. For details, refer to "Using the External Memory".
To change the file name using this command, refer to the descriptions below for more information.

Verify that the Router has Started from Files on the External Memory

When the router startup using files on the external memory is complete, the LED lamp on the router unit will blink to notify the startup completion. See here for more information on the LED illumination patterns.
You can sound a buzzer at startup by configuring the "alarm startup" command in the configuration file on the external memory.
This enables you to verify that the router has been started using a configuration file on the external memory.

You can also check the active firmware file and configuration file using the "show environment" command and on the top page of the GUI.

If you update the revision while running the router using a firmware file on the external memory, the updated firmware will vary depending on how the firmware save destination has been specified.

Specified save destination Windows command example (Command prompt) Firmware revision to be updated
exec tftp -i 192.168.100.1 put rtx810.bin exec Active firmware
= Firmware on the external memory
exec0 tftp -i 192.168.100.1 put rtx810.bin exec0 Firmware in the exec0 area of the built-in Flash ROM
exec1 tftp -i 192.168.100.1 put rtx810.bin exec1 Firmware in the exec1 area of the built-in Flash ROM

Rename the Files Loaded From the External Memory

If you use the files on the external memory to start up the router in the factory default configuration, the files "(Model name).bin" and "config.rtfg" (if encrypted) or "config.txt" are loaded from the external memory as the firmware file and configuration file, respectively. You can change the file names using the "external-memory exec filename" command or the "external-memory config filename" command.

  • Example: Set the firmware file name to "rtx810_tokyo.bin" and configuration file name to "config_tokyo.txt" on the microSD memory card, respectively.
# external-memory exec filename sd1:rtx810_tokyo.bin
# external-memory config filename sd1:config_tokyo.txt
# save 0 

During the initial phase of the startup, the router uses the firmware file and configuration file in the built-in Flash ROM to recognize the external memory and search for files.
Therefore, to search for files on the external memory, you need to save the setting in the configuration file in the built-in Flash ROM.

If the router is running using a configuration file on the external memory, the settings will be saved to the configuration file on the external memory when you execute the "save" command.
By specifying the destination file name using the "save" command, (configuration file 0 in the built-in Flash ROM in the above example), you can save the settings to the built-in Flash ROM even while the router is running using a configuration file on the external memory.

Security

You can encrypt the configuration file on the external memory to prevent it from being opened on a PC, etc. You can also start the router using an encrypted configuration file.

If you configure the Yamaha router first and then use the "copy config" to encrypt and save the configuration to the external memory, you will not need to specify a password for the encryption. If you encrypt the configuration file using this method, you can directly apply it to devices in their factory default configuration without any password.

Follow the procedure below to encrypt the configuration file.

  1. Create a configuration file on the router console or on the PC.
  2. If you have created the configuration file on a PC, you need to transfer the file to the router
    (PUT via TFTP or copy using the external memory).

    ▪When using TFTP (PUT to config0 on the router at 172.16.0.1 from Windows, for example)
    tftp 172.16.0.1 put config.txt config0
    
    ▪When using the external memory (Copy from the SD memory to config0, for example)
    # copy config sd1:config.txt 0
    
  3. Encrypt and save the settings stored on the router to the external memory. No password is required at this time.
    A command example for selecting the "aes256" encryption algorithm is shown below.
    # copy config 0 sd1:config aes256
    
  4. An encrypted file called "config.rtfg" is saved in the SD memory card.

You can then start the router using the external memory containing this encrypted file.
For details on the "copy config" command, refer to "Copy File To the External Memory".

Startup Sequence

The startup sequence of the router is as described below.

Startup sequence
Status of the external memory Startup file
A Firmware file and configuration file are present on the external memory Startup using the firmware file and configuration file on the external memory
B Only the firmware file is present on the external memory Startup using the firmware file on the external memory and the configuration file in the built-in Flash ROM
C Only the configuration file is present on the external memory Startup using the firmware file in the built-in Flash ROM and the configuration file on the external memory
D The firmware file and configuration file do not exist on the external memory, the files exist but cannot be opened, or no external memory is inserted. Startup using the firmware file and configuration file in the built-in Flash ROM (Same as normal startup)
E A firmware file or configuration file is present on the external memory but is invalid. An error message is displayed; and the router is not started

The operations performed during the startup are as described below.

  1. First, start up the router using the firmware file and configuration file in the built-in Flash ROM.
    In the case of models incorporating the firmware multiplexing function or the configuration file multiplexing function, the firmware file and configuration file specified in "set-default-exec/set-default-config" will be loaded.
  2. A short alarm will sound when the external memory is recognized by the router.
  3. Searches the files on the external memory.
  4. The following message is displayed while searching the files on the external memory. The external memory LED will blink.
    Searching the microSD memory card: Searching files in microSD...
    Searching the USB flash drive: Searching files in USB Memory...
  5. "Done." will be displayed when the search is complete.
    ▪ If no files are found during the search, the following message will appear:
      ▪ If no configuration file was found: Configuration file is not found.
      ▪ If no firmware was found: Firmware file is not found.
    ▪ If the file is found during the search, the loading will start and the following message will appear:
      ▪ While the configuration file is being loaded: Reading configuration file in microSD...
      ▪ While the firmware is being loaded: Reading firmware file in microSD...
      ▪ "Done." will be displayed when the loading is complete.
  6. If the search time limit is exceeded, the "Canceled by timeout" message will appear meaning that no files were found.
  7. You cannot enter commands or perform other operations until the startup of A, B, C, or D is complete.
  8. The LED lamps on the router unit blink three times when the startup of A, B or C is complete.
  9. If the case of 'E', an error message is output to the console and log; and the LED lamps on the router unit continues blinking.

LED Illumination Patterns

When the startup using the files on the external memory, the following LED lamps will blink three times:

Model LED
RTX810 microSD, USB
FWX120 microSD, USB
RTX5000 microSD, LAN1 to LAN4

If the router fails to start because the file on the external memory is invalid, the following LED lamp will continue blinking:

Model LED
RTX810 STATUS, microSD, USB
FWX120 STATUS, microSD, USB
RTX5000 ALM, microSD, LAN1 to LAN4

Command

For details on the "external-memory config filename" and "external-memory exec filename" commands, refer to "Copy File To the External Memory".

Set Whether to Allow the Router to Start Using Files in the External Memory

[Syntax]
external-memory boot permit SWITCH
no external-memory boot permit [SWITCH]
[Setting Value]
  • SWITCH
    • on .... Permit
    • off .... Prohibit
[Initial Value]
  • on
[Description]

Sets whether to allow the router to start using files in the external memory. If this setting is set to OFF, the router cannot start by using files in the external memory.

You can set the name of the setup file and the firmware file that the router loads when it starts with the "external-memory config filename" and "external-memory exec filename" commands.

[Applicable Models]
RTX5000 RTX810 FWX120

Set the Timeout for External Memory Detection at Router Startup

[Syntax]
external-memory boot timeout TIME
no external-memory boot timeout [TIME]
[Setting Value]
  • TIME ... Timeout in seconds (1..30)
[Initial Value]
  • 1
[Description]

Sets the timeout for detecting the external memory at router startup. This is valid if the "external-memory boot permit on" command has been set to allow booting from a file in the external memory. If the device takes a long time to be recognized, increasing the timeout value may help with the recognition.

[Note]

A good reference to use for this setting is the time displayed in "boot device attach" in the External Memory Performance Test command.

[Applicable Models]
RTX810 FWX120

Set Whether to Sound an Alarm at Startup

[Syntax]
alarm startup SWITCH [PATTERN]
no alarm startup [SWITCH]
[Setting Value]
  • SWITCH
    • on .... Sound alarms.
    • off .... Do not sound alarms.
  • PATTERN .... The alarm pattern (1...3, 1 when omitted.)
[Initial Value]
  • SWITCH ... off
[Description]

Sets whether to sound an alarm at startup.

[Applicable Models]
RTX5000 RTX810 FWX120

Return to Top