Copy File To the External Memory

Summary

This function allows you to manipulate data between the router and external memory by connecting an external memory device (USB flash drive or microSD memory card) to the router unit. Compatible external memory devices vary depending on the models.

This function enables you to perform the following:

  • Perform operations using the external memory and download buttons
    • Copy the configuration file and firmware file from the external memory by pressing the external memory and download buttons simultaneously for more than three seconds
  • Perform operations via command input
    • Export the SYSLOG messages to the external memory
    • Copy the configuration file to the external memory
    • Copy the configuration file from the external memory
    • Copy the firmware file from the external memory
    • Export the statistics information to the external memory
    For more information on the basic usage of the external memory, button operations, LED/buzzer specifications and details of the SYSLOG messages, refer to "Using the External Memory".

Compatible Models & Firmware Revisions

The following Yamaha router models/firmware support 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

How to Use

Operation of the External Memory and Download Buttons

You can hold down the external memory and download buttons simultaneously for three seconds to copy the firmware file and configuration file on the external memory to the built-in Flash ROM of the router. Copying occurs in the order of first the configuration file then the firmware file. An alarm will sound when the copy operation completes, followed by the restart of the router.

The models supporting the "Start up from the execution file on the external memory" will start up using the firmware file and configuration file stored on the external memory if the external memory is connected at startup. If you remove the external memory while the POWER lamp is blinking during startup, the router will start with the firmware file and configuration file in the built-in Flash ROM. Since the external memory is not recognized for approx. 10 seconds while the POWER lamp is blinking, you do not yet need to press the external memory button before removing the external memory.
You can also use the "external-memory boot permit off" command to prevent the router from starting up from the external memory.
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.

The router models that do not incorporate the "Start up from the execution file on the external memory" function are started up using the firmware file and configuration file in the built-in Flash ROM.

You can specify the files to be copied using the external-memory config filename command or the external-memory exec filename command.
In the factory default configuration, the router copies the 'config.txt' and '(Model name).bin' files on the external memory to the built-in Flash ROM of the router as the configuration and firmware files, respectively. For example, the firmware file name will be 'rtx810.bin' for the RTX810.

  • Example 1: Specify ‘rt_config.txt’ as the configuration file to be copied via button operation
    # external-memory config filename sd1:rt_config.txt 0 
    
  • Example 2: Specify 'rt_firmware.bin' as the firmware file to be copied via button operation
    # external-memory exec filename sd1:rt_firmware.bin 0 
    

Even if the configuration and firmware files are not in the root directory, you can locate them using automatic search. For details, refer to "Using the External Memory".

  • Example 1: Search for the specified file (rt_config.txt) on the microSD memory card to obtain the copy target
    # external-memory config filename sd1:rt_config.txt 0 
    
  • Example 2: Set the specified file in the root directory (rt_config.txt) as the copy target
    # external-memory config filename sd1:/rt_config.txt 0 
    

If you perform the button operation when neither the specified configuration file nor the firmware file exist, no copying process will take place and an alarm will go off.

Operation via Command Input

Writing the SYSLOG messages to the external memory

You can use the "external-memory syslog filename" command to specify the SYSLOG file name to be written to the external memory. The SYSLOG messages will not be written if these commands are not configured.

  • Example: Write the SYSLOG to the USB flash drive
    # external-memory syslog filename usb1:rt_syslog.log 
    
  • Example: Write the SYSLOG to the microSD memory card
    # external-memory syslog filename sd1:rt_syslog.log 
    
  • Example: Set the maximum SYSLOG file size to 100MB and the maximum number of backup files to 30
    # external-memory syslog filename sd1:rt_syslog.log limit=100 backup=30 
    

A backup file is created as necessary when writing to a file on the external memory. Refer to "File Backup System" for more information on the backup files.

Copy the configuration file between the router and external memory

You can use the "copy config" command to write the configuration file from the built-in Flash ROM of the router to the external memory, or vice versa.

  • Example 1: Copy the configuration file called ‘rt_config1.txt’ on the USB flash drive to the built-in Flash ROM of the router
    # copy config usb1:rt_config1.txt 0 
    
  • Example 2: Copy the configuration file stored in the built-in Flash ROM of the router to the microSD memory card with the file name ‘rt_config2.txt’
    # copy config 0 sd1:rt_config2.txt 
    

Copy the firmware file from the external memory

The "copy exec" command enables you to copy the firmware file on the external memory to the built-in Flash ROM of the router.

  • Example: Copy the firmware file called ‘rt_firmware.bin’ to the built-in Flash ROM of the router
    # copy exec usb1:rt_firmware.bin 0 
    

The contents you have copied to the built-in Flash ROM using the "copy config" and "copy exec" commands will not immediately be applied to the actual operation. To apply the copied content, you need to restart the router after executing the command.

Export the statistics information to the external memory

Select the statistics information items you wish to retrieve using the "statistics" command by setting them to ‘on’, and then configure the name of the output file to the external memory using the "external-memory statistics filename prefix" command or the "usbhost statistics filename prefix" command. The statistics information will not be output if these commands are not configured.
Refer to the command reference for details.

Details

Save the SYSLOG to the External Memory

File Backup System

The following section describes how the SYSLOG backup files are saved. It should be noted that the operation will slightly vary depending on the models/firmware.

When saving the SYSLOG messages to the external memory, two types of files are used in a series of processes. One is the file specified using the "external-memory syslog filename" command to which new SYSLOG messages are written (hereafter referred to as "main file"); and the other is the backup file to which the main file is backed up when the size of the main file reaches the maximum limit specified by this command or the automatically calculated maximum limit (hereafter referred to as "backup file").

Newly added SYSLOG messages are always written to the main file (Figure 1 below). If the size of the main file reaches the maximum limit specified by the "external-memory syslog filename" command or the maximum limit calculated automatically based on the amount of free space, the main will temporarily be closed, renamed and saved as a backup file (Figure 2 below). A new file is then opened using the main file name to resume the writing process (Figure 3 below). When the maximum size of the main file is reached again, the file will be saved to the backup file in the same manner. If the number of backup files reaches the maximum limit specified by the "external-memory syslog filename" command or if the external memory runs out of free space, the backup file containing the oldest time/date string in the file name (in "_yyyymmdd_hhmmss" format) will be deleted (Figure 4 below).

1. New SYSLOG messages are always written to the main file. 
    +-------------+
    | — — — — —   |
    | — — —       |
    | — — — —     |
    | — — — — —   |
    | — — — I     |
    |             |
    |             |
    +-------------+
      main file

2. When the main file reaches its maximum size, it is renamed as saved as a backup file. 
    +-------------+        +-------------+
    | — — — — —   |        | — — — — —   |
    | — — —       |        | — — —       |
    | — — — —     | rename | — — — —     |
    | — — — — —   | =====> | — — — —     |
    | — — — —     |        | — — — —     |
    | — — —       |        | — — —       |
    | — — — — —   |        | — — — — —   |
    +-------------+        +-------------+
      main file                backup file

3. A new file is opened with the main file name to resume the writing process. 
    +-------------+        +-------------+
    | — — I       |        | — — — — —   |
    |             |        | — — —       |
    |             |        | — — — —     |
    |             |        | — — — — —   |
    |             |        | — — — —     |
    |             |        | — — —       |
    |             |        | — — — — —   |
    +-------------+        +-------------+
      main file              backup file

4. When the main file reaches its maximum size, the main file is renamed and saved as a backup file.
The oldest file is deleted if certain conditions are met. 

    +-------------+        +-------------+   +-------------+   +-------------+        +-------------+
    | — — — — —   |        | — — — — —   |   | — — — — —   |   | — — — — —   |        |             |
    | — — —       |        | — — —       |   | — — —       |   | — — —       |        |             |
    | — — — —     | rename | — — — —     |   | — — — —     |   | — — — —     | delete |             |
    | — — — — —   | =====> | — — — — —   |   | — — — — —   |   | — — — — —   | =====> |             |
    | — — — —     |        | — — — —     |   | — — — —     |   | — — — —     |        |             |
    | — — —       |        | — — —       |   | — — —       |   | — — —       |        |             |
    | — — — — —   |        | — — — — —   |   | — — — — —   |   | — — — — —   |        |             |
    +-------------+        +-------------+   +-------------+   +-------------+        +-------------+
      main file             backup file       backup file       backup file
                            20110103_000000   20110102_000000   20110101_000000

5. A new file with the main file name is opened to resume the writing process.
   Step 2 to 4 are repeated thereafter. 

The backup file name created at this time will be the main file name appended by a string in _yyyymmdd_hhmmss format which indicates the save date/time.
The meaning of the "_yyyymmdd_hhmmss" string is described below.

  • yyyy ... Year (Four digits)
  • mm ... Month (Two digits)
  • dd ... Day (Two digits)
  • hh ... Hour (Two digits)
  • mm ... Minute (Two digits)
  • ss ... Second (Two digits)

For example, if the main file name is "syslog.txt" and the backup file is created at 12:34:56 on January 1, 2011, the name of the backup file will be "syslog_20110101_123456.txt".

If there is sufficient free space on the external memory, the file size specified by the "external-memory syslog filename" command will be the maximum size of the main file; and the specified number of backup files of the same size will be saved. However, it should be noted that the backup files will not adhere to the file size or the number of files specified by this command if there is insufficient free space available.
Also, you can use the "rotate external-memory syslog" command as required to save the file regardless of the file size. If a backup file with the same name already exists, no saving will take place.
For more information on the automatic calculation of the maximum size of the main file, refer to "Automatic Calculation of the SYSLOG File Size" in the next section.

Automatic Calculation of the SYSLOG File Size

When outputting SYSLOG messages to the external memory, the router will try to keep as many messages as possible in the available space on the external memory. Specifically, the router checks the free space available on the external memory before it starts writing the SYSLOG messages and distributes the space for different applications in the ratio described below. At this time, the SYSLOG messages are written within the range allocated for the main file or the backup file.

    +-------------------+  ----
    | For saving config |   ∧
    |            (Note) |
    +-------------------+
    |                   |   External
    |                   |   
    |   For main file   |   Memory
    |                   |   
    |                   |   
    +-------------------+   Free
    |                   |   
    |                   |   Space
    |  For backup file  |   
    |                   |
    |                   |   ∨
    +-------------------+  ----

  (Note) A separate area for saving the statistical information file is allocated for models
  incorporating the statistical information save function. 

If the main file and/or the backup file already exists, those file areas will also be calculated as free space.

If you let 'En' be the free space on the external memory, 'Cn' be the area for saving the config, and 'Mn' be the area for the main file, the approximate size of each area can be calculated as described below.

Cn:  1MB or En/10, whichever is larger However, the maximum limit of En/10 is 100MB
Bn:  (En - Cn)/2
Mn:  En - Cn - Bn

* The actual setting value may be slightly smaller than the calculated value above.

If the main file could not be written to its maximum size due to a change in the amount of free space on the external memory during the writing process, the main file at that point will be saved as a backup file. Each used space will then be calculated again using the above-mentioned method.

Operating Status Check

You can use the "show status external-memory" command or "show status usbhost" command to check the operating status of this function. The following shows a display example during command input:

Display the operating status of the external memory
# show status external-memory
Host controller:           Running
Syslog profiles
  Syslog file name:        usb1:rt_syslog.log [Writable]
  Backup file name:        usb1:rt_syslog_YYYYMMDD_HHMMSS.log
  Maximum file size:       10485760 bytes
  Buffering:               OK
  Last write time:         2016/11/24 19:38:46
Statistics profiles
  Syslog file name:        [Not specified]
Syslog statistics
  Recorded times:          1 (TIMER:1, FULL:0)
  Discarded times:         0 (FULL:0)
  Dropped lines:           0
File Operation statistics
  Syslog aborted:          0
  Open failed:             0
  Backup created:          0
  Backup failed:           0 (DELETE:0, RENAME:0, CLOSE:0)
  Write error:             0
  Write retry failed:      0

usb1
Bus power feed:            ON
Attached device
  Device name:             0x0111 
  Vendor name:             0x0411 
  Maximum transfer rate:   480Mbps(High speed)
  Memory capacity:         3905600 KB
MASS Storage Class Transmit statistics
  Timeout:                 0
  Stalled:                 0
  Canceled:                0
  I/O error:               0
  Unknown:                 0

sd1
Bus power feed:            ON
Attached device            Not attached
  1. Whether the host controller is operating normally
  2. SYSLOG write setting information (destination file name, backup file name, maximum destination file size)
  3. Power supply status (ON or OFF). A notification is displayed if the power supply has been forced to OFF due to an overcurrent)
  4. Device information of the connected external memory (device name, vendor name, maximum transfer rate, memory capacity)
    * This information will not be displayed if no external memory is connected.

(Note) This line is not displayed on models that do not incorporate the statistics information function.

Display the operating status of the USB host function
# show status usbhost
Host controller:           Running

usb1
Bus power feed:            ON
Attached device
  Device name:             0x0111 
  Vendor name:             0x0411 
  Maximum transfer rate:   480Mbps(High speed)
  Memory capacity:         3905600 KB
MASS Storage Class Transmit statistics
  Timeout:                 0
  Stalled:                 0
  Canceled:                0
  I/O error:               0
  Unknown:                 0

Notes on Saving the SYSLOG

  1. If the file specified using the "external-memory syslog filename" command for storing the SYSLOG already exists on the inserted external memory, additional data will be appended on the end of the file until it reaches its maximum size.
  2. The saving of the SYSLOG will not start until the external memory is recognized by the router. Therefore, the SYSLOG file that is output during the router startup, etc. will not be saved to the external memory; and the SYSLOG displayed on the router unit and the SYSLOG saved to the external memory may not necessarily be the same.
  3. If the SYSLOG files containing the same contents are output in a succession, the writing process to the external memory will be omitted and only the repetition count will be saved ("same message repeated N times").

Command

Specify the Name of the SYSLOG File to Save in External Memory

[Syntax]
external-memory syslog filename NAME [CRYPTO PASSWORD] [limit=SIZE] [backup=NUM]
no external-memory syslog filename [NAME]
[Setting Value]
  • NAME ... SYSLOG File Name
    • usb1:FILENAME ... File name in the USB memory (cannot specify a name containing extension ".bak")
    • sd1:FILENAME ... File name in the microSD card (cannot specify a name containing extension ".bak")
  • CRYPTO ... Select the encryption algorithm for encrypting and saving SYSLOG
    • aes128 ... Encrypt in AES128
    • aes256 ... Encrypt in AES256
  • PASSWORD ... Password expressed in ASCII ((at least 8 half-width characters and less than 32 characters)
  • SIZE ... Maximum size of SYSLOG file (1 - 1024, Unit: MB)
  • NUM ... Maximum number of backup files (1-100)
[Initial Value]
  • SIZE ... 10
  • NUM ... 10
[Description]

Specifies the name of the SYSLOG file to save in the external memory.

You cannot specify a name for NAME that contains the extension ".bak." In addition, if not encrypting, you cannot specify a file name for NAME that contains the extension ".rtfg".

If you specify CRYPTO and PASSWORD, SYSLOG will be encrypted and then saved to the external memory. To encrypt, you must include the extension ".rtfg" in NAME, or specify a name with no extension. If the extension is omitted, "rtfg" will be automatically added as the extension.

Once the SYSLOG file reaches the maximum size, a backup of the SYSLOG file will be performed.The name of the backup file created at this time will vary by firmware.

The name of the backup file will be the file name specified in NAME, appended with the date and time when the backup was performed, in the format _yyyymmdd_hhmmss.

  • yyyy ... Year (4 digits)
  • mm ... Month (2 digits)
  • dd ... Day (2 digits)
  • hh ... Hour (2 digits)
  • mm ... Minute (2 digits)
  • ss ... Second (2 digits)

When the number of backup files has reached its upper limit specified in NUM, or when the available space in the external memory runs out, the oldest backup file is deleted, and then the new backup file is created.
If the NAME has an extension:

  • Saved without encryption ... The extension is replaced with ".bak".
  • Encrypted and saved ... "_bak" appended before the extension.
If the NAME does not contain file extension ... The extension ".bak" is added.

When the time specified by INTERVAL parameter is over, or the number of SYSLOG specified by LINE parameter is outputted, the SYSLOG will be outputted to external memory. Maximum number of logging line that can be specified by LINE:

  • RTX810 ... 3000
  • RTX5000 ... 20000
  • FWX120 ... 3000

Unless this command is set, SYSLOG will not be written to the external memory.

[Note]

To make the following changes, NAME must be changed.

  • To change from saving SYSLOG without encryption to saving with encryption
  • To change from saving SYSLOG with encryption to saving without encryption
  • To change the encryption algorithm or password

name must be within 99 half-width characters.

RTX810 supports inerval parameter and line parameter in Rev.11.01.23 or later.

[Applicable Models]
RTX5000 RTX810 FWX120

Rotate (Back Up) the SYSLOG Files Stored in the External Memory

[Syntax]
rotate external-memory syslog
[Description]

Rotates (backs up) the SYSLOG files stored in the external memory.
Saves the current SYSLOG file to a backup file, and creates a new SYSLOG file to write to.
If the backup file with a same name already exists, this is not performed.
Moreover, when creating the backup file, if the number of backup files has reached the maximum specified in the "external-memory syslog filename" command, or if you run out of available space in the external memory, the oldest backup file is deleted, and then the new backup file is created.
For the naming format of the backup file, refer to the "external-memory syslog filename" command.
Note that this command works only if the SYSLOG file name has been set by the "external-memory syslog filename" command, and the external memory is connected to the specified external storage interface.

[Note]

By executing this command regularly using the schedule at command, you will be able to to automatically create backup files of SYSLOG on a daily, weekly or monthly basis.

[Example]
schedule at 1 */* 00:00 * rotate external-memory syslog
# Run backup daily

schedule at 1 */mon 00:00 * rotate external-memory syslog
# Run backup every Monday

schedule at 1 */1 00:00 * rotate external-memory syslog
# Run backup every 1st of the month
[Applicable Models]
RTX5000 RTX810 FWX120

Clear the SYSLOG Saved in the External Memory and Deleting the Backup Files

[Syntax]
clear external-memory syslog
[Description]

Clears the log entries in the current SYSLOG file stored in the external memory, and deletes all SYSLOG backup files. The backup files of SYSLOG to be deleted are those that exist in the path specified in the "external-memory syslog filename" command. Note that this command works only if the SYSLOG file name has been set by the "external-memory syslog filename" command, and the external memory is connected to the specified external storage interface.

[Applicable Models]
RTX5000 RTX810 FWX120

Set Whether to Permit Setup File and Firmware File Copying through the Simultaneous Holding Down of an External Memory Button and the DOWNLOAD button

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

Sets whether to permit setup file and firmware file copying through the simultaneous holding down of an external memory button and the DOWNLOAD button.

[Applicable Models]
RTX810 FWX120

Specify the Name of the Setup File That the Router Loads When It Starts or When an External Memory Button and the DOWNLOAD Button Are Held Down

[Syntax]
external-memory config filename FROM[,FROM] [TO] [PASSWORD]
external-memory config filename off
no external-memory config filename [FROM] [TO] [PASSWORD]
no external-memory config filename [off]
[Setting Value]
  • FROM ... External memory and setup file name
    • usb1:FILENAME ... A setup file on the USB memory
    • sd1:FILENAME ... A setup file on the microSD card
    • *:FILENAME ... A firmware file on the USB memory or microSD card
  • TO ... Copy destination file name
    • NUM ... Number of the setup file on the internal flash ROM (0..4; 0 when omitted)
  • PASSWORD ... Decryption password (ASCII text string between 8 and 32 characters in length)
[Initial Value]
  • FROM ... *:config.rtfg,*:config.txt 0 (RTX810, FWX120)
  • FROM ... sd1:config.rtfg,sd1:config.txt 0 (RTX5000)
  • TO ... 0
[Description]

Sets the name of the setup file that is loaded when the router is started with external memory connected to it and when the external memory and DOWNLOAD buttons are held down at the same time.

You can specify what setup file number on the internal flash ROM to copy to when the external memory and DOWNLOAD buttons are pressed at the same time.

If you use an asterisk to specify the external memory, the router starts searching the microSD memory card for the specified file. If the router can't find the file on the memory card, it searches for it in the USB memory. When you load the firmware file using buttons, only the memory that corresponds to the external memory button that you press is searched.

You can specify the filename parameter with an absolute path or a file name. If you only specify a file name, the router searches through the specified external memory device for the file.

If the router finds multiple files, it chooses the file in the directory that is closest to the root directory and first in alphabetical order.

To decrypt a file that was encrypted with a specified password, set the password parameter to the password that was used to encrypt the file.

If you specify off, the router does not search for and load a setup file.

[Note]

Depending on the file structure of the external memory and the number of files, it may take time for the router to search for the file.
To make searching faster, avoid creating deep directory structures, and save the firmware file in a directory that is close to the root directory, or specify the file directly using an absolute path.
You can set the timeout for automatic searching using the "external-memory auto-search time" command.

The number of characters used for filename is up to 99 characters.

[Example]

Search for the "config.txt" file on the microSD card and load it as the setup file.

# external-memory config filename sd1:config.txt

Search for the "config.txt" file in the "test" directory of the microSD card and load it as the setup file.

# external-memory config filename sd1:/test/config.txt
[Applicable Models]
RTX5000 RTX810 FWX120

Specify the Name of the Firmware File That the Router Loads When It Starts or When an External Memory Button and the DOWNLOAD Button Are Held Down

[Syntax]
external-memory exec filename FROM [TO]
external-memory exec filename off
no external-memory exec filename [FROM] [TO]
no external-memory exec filename [off]
[Setting Value]
  • FROM ... External memory and firmware file name
    • usb1:FILENAME ... A firmware file on the USB memory
    • sd1:FILENAME ... A firmware file on the microSD card
    • *:FILENAME ... A firmware file on the USB memory or microSD card
  • TO ... Copy destination file name
    • NUM ... Number of the executable firmware file on the internal flash ROM (0 or 1; 0 when omitted)
[Initial Value]
  • FROM ... *:(Model name).bin 0 (RTX810, FWX120)
  • FROM ... sd1:(Model name).bin 0 (RTX5000)
  • TO ... 0
[Description]

Sets the name of the firmware file that is loaded when the router is started with external memory connected to it and when an external memory button and the DOWNLOAD button are held down at the same time.

You can specify what firmware file number on the internal flash ROM to copy to when an external memory button and the DOWNLOAD button are pressed at the same time.

If you use an asterisk to specify the external memory, the router starts searching the microSD memory card for the specified file. If the router can't find the file on the memory card, it searches for it in the USB memory. When you load the firmware file using buttons, only the external memory device that corresponds to the external memory button that you press is searched.

You can specify the FILENAME parameter with an absolute path or a file name. If you only specify a file name, the router searches through the specified external memory device for the file.

If the router finds multiple files, it chooses the file in the directory that is closest to the root directory and first in alphabetical order.

If you specify off, the router does not search for and load a firmware file.

[Note]

Depending on the file structure of the external memory and the number of files, it may take time for the router to search for the file.
To make searching faster, avoid creating deep directory structures, and save the firmware file in a directory that is close to the root directory, or specify the file directly using an absolute path.
You can set the timeout for automatic searching using the "external-memory auto-search time" command.

The number of characters used for filename is up to 99 characters.

[Example]

Search for the "fwx120_en.bin" file on the microSD card and load it as the firmware file.

# external-memory exec filename sd1:fwx120_en.bin

Search for the "fwx120_en.bin" file in the "test" directory of the microSD card and load it as the firmware file.

# external-memory exec filename sd1:/test/fwx120_en.bin
[Applicable Models]
RTX5000 RTX810 FWX120

Duplicate the Configuration File

[Syntax]
copy config FROM TO
copy config FROM TO CRYPTO [PASSWORD]
copy config FROM TO [PASSWORD]
[Setting Value]
  • FROM ... Duplicate the Configuration File
    • 0 to 4.2 ... Configuration file number of the internal Flash ROM
    • usb1:FILENAME ... A setup file on the USB memory
    • sd1:FILENAME ... A setup file on the microSD card
    • *:filename ... A firmware file on the USB memory or microSD card
  • TO ... Copy destination file name
    • 0 to 4 ... Configuration file number of the internal Flash ROM
    • usb1:FILENAME ... A setup file on the USB memory (FILENAME must be 64 characters or less)
    • sd1:FILENAME ... A setup file on the microSD card (FILENAME must be 64 characters or less)
  • CRYPTO ... The encryption algorithm
    • aes128 ... Encrypt using AES128.
    • aes256 ... Encrypt using AES256.
  • PASSWORD ... Password expressed using ASCII text characters (between 8 and 32 characters in length)
[Description]

Duplicate a saved configuration file.
The copy source and copy destination cannot both be located on the external memory.
There is no setup file after a cold start, so the router cannot copy the setup file from the internal flash ROM to the external memory. In this case, you have to save the settings by executing the save command before you execute this command.
To apply the settings that you copy to the internal flash ROM, you need to restart the router after executing this command.

If you use an asterisk to specify the external memory, the router starts searching the microSD card for the specified file. If the router can't find the file on the memory card, it searches for it in the USB memory. You can specify the FILENAME parameter with an absolute path or a file name. If you only specify a file name for the FILENAME parameter, the router will automatically search through the external memory for the file.
If the router finds multiple files, it chooses the file in the directory that is closest to the root directory and first in alphabetical order.
When you specify a copy destination in the external memory, set the FILENAME parameter to an absolute path.

You can use the encryption function on the external memory.
If you specify CRYPTO, the setup file is encrypted before it is saved to the external memory. To encrypt a file before copying it, you must include the .rftg extension in the file name or omit the extension when you specify the file name. If you omit the extension, the .rtfg extension is automatically added to the filename.
You can encrypt files without specifying a password.

[Note]

You cannot copy an encrypted setup file from the external memory to the internal flash ROM without decrypting it.
The second syntax can only be used to copy a file from the internal flash ROM to the external memory and encrypt it.
The third syntax can only be used to decrypt an encrypted file and copy it from the external memory to the internal flash ROM.
When the file is decrypted, the encryption algorithm is determined automatically. Therefore, the encryption algorithm does not need to be specified at the time of decryption.
You can only specify a file in the external memory on models that have external memory interfaces.
If you specify a configuration file number on the internal flash ROM as the copy destination, the original file that was at that file number becomes a backup file after this command is executed.

Automatic file searching is possible.
Depending on the file structure of the external memory and the number of files, it may take time for the router to search for the file.
To make searching faster, avoid creating deep directory structures, and save the firmware file in a directory that is close to the root directory, or specify the file directly using an absolute path.
You can set the timeout for automatic searching using the "external-memory auto-search time" command.

The number of characters used for filename is up to 99 characters.

[Applicable Models]
RTX5000 RTX810 FWX120

Copy the Firmware File to the Internal Flash ROM

[Syntax]
copy exec FROM TO
[Setting Value]
  • FROM ... Duplicate the Configuration File
    • usb1:FILENAME ... A firmware file on the USB memory (only on models with USB interfaces)
    • sd1:FILENAME ... A firmware file on the microSD card (only on models with microSD interfaces)
    • *:FILENAME ... A firmware file on the USB memory or microSD card
  • TO ... Copy destination file name
    • Number ... Number of the executable firmware file on the internal flash ROM (can be specified on all units except RTX810 and FWX120), can be specified as 0
[Description]

Copies the executable firmware file to the internal Flash ROM.
To apply the settings that you copy to the internal flash ROM, you need to restart the router after executing this command.

If you use an asterisk to specify the external memory, the router starts searching the microSD card for the specified file. If the router can't find the file on the memory card, it searches for it in the USB memory.
You can specify the FILENAME parameter with an absolute path or a file name. If you only specify a file name for the FILENAME parameter, the router will automatically search through the external memory for the file.
If the router finds multiple files, it chooses the file in the directory that is closest to the root directory and first in alphabetical order.

[Note]

You can only specify a file in the external memory on models that have external memory interfaces.
You can only set the copy destination firmware file number to a value other than 0 on models that have the multiple firmware function. (For RTX5000 and RTX810)

Automatic file searching is possible.
Depending on the file structure of the external memory and the number of files, it may take time for the router to search for the file.
To make searching faster, avoid creating deep directory structures, and save the firmware file in a directory that is close to the root directory, or specify the file directly using an absolute path.
You can set the timeout for automatic searching using the "external-memory auto-search time" command.

The number of characters used for FILENAME is up to 99 characters.

[Applicable Models]
RTX5000 RTX810 FWX120

Return to Top