外部存储的使用

概要

路由器连接了外部存储(microSD存储卡、USB存储)时,可以使用以下功能。

文件复制功能

路由器内部的设置内容和syslog作为文件输出至外部存储,外部存储中的信息复制到路由器内部。
从外部存储中复制的操作可以使用按钮操作,可以简化设备设置导入的作业。

启动功能

将保存了设置内容文件和固件文件的部存储连接在路由器上,只要简单的打开电源,路由器就可以用该设置内容和固件进行运作。可以大幅简化设备设置的导入,以及故障时的恢复作业。

批处理文件执行功能

记载了命令的批处理文件,可以通过按钮进行操作,可以在任意时间执行命令。
命令的执行结果也可以输出至外部存储中。
可以简单的进行运行检测。

重定向功能

执行输出内部信息的命令时,可以指定输出目标为不是控制台,而是外部存储。
维护时可以简单地保存内部信息。

关于功能的详细请参考各功能的说明资料。
关于外部存储的基本的使用方法,LED,蜂鸣器的规格和SYSLOG信息请参考本文档的说明。

支持的机型和可以使用的外部存储

可以使用的外部存储因机型而异。

机型 可以使用的外部存储 固件
RTX5000 microSD/SDHC内存卡 Rev.14.00系
RTX820 microSD/SDHC内存卡、USB存储 Rev.11.03系
RTX1200 microSD/SDHC内存卡、USB存储 Rev.10.01系
RTX800 USB存储 Rev.10.01系

注意事项

  • 支持的文件格式如下所示。
    • FAT
    • FAT32
  • 不能保证所有的外部存储都能正常运行(已经确认运行的USB存储信息)。
  • 不能通过HUB等同时连接了多个外部存储。
  • 某些形状的外部存储会使接口附近的外部存储按钮无法操作,这不在保证运行中。这时,请另外使用延长线,转换器等。
  • 拔出外部存储时,必须按照基本操作的说明步骤进行。有可能破坏外部存储内部的数据。
  • 使用本功能的相关命令指定外部存储内的文件时,文件名可以使用以下的半角字符。
    • 英数字
    • 下划线'_'
    • 半角句号'.'
      但是,不区分大写/小写。另外,不可以指定以句号结尾的名称。

另外,关于USB存储有以下特别的注意点。

  • 本功能支持USB1.1/2.0。但是,必须满足以下规格。
    • USB Host Controller为OHCI(USB1.1),或者EHCI(USB2.0)
    • 支持USB Mass Storage Class驱动
    • 消耗电量250mA以下的Bus Power供给可以运行的Flash存储
  • 连接在路由器上的USB存储消耗了允许范围外的电流的话,蜂鸣器响4次,同时USB LED为持续闪烁状态(USB设备错误状态)。这个错误状态一直持续的话,路由器重新连接了其他的USB存储,也无法识别。从本机恢复本状态,请参照以下的步骤。
    1. 路由器连接着USB存储的状态的话,拔出USB存储。
    2. 进行以下任意项。
      ■按下USB按钮。
      ■再设置usbhost use命令为on。
        ※设置为off,也会恢复

基本操作

连接外部存储

请确认路由器侧的usbhost use命令(使用USB存储时),或者sd use命令(使用microSD内存卡时)为on(出厂默认为on)。设置为off时,即使连接了外部存储,路由器也无法识别。

例:使用USB存储时,开启此功能

# usbhost use on

将外部存储连接至路由器。
蜂鸣器响,同时外部存储LED亮灯的话,说明路由器已经识别了外部存储。这种状态下,可以使用各种外部存储的功能。

外部存储损坏,或者无法正常识别时,蜂鸣器不响,外部存储LED也不亮灯。这时请拔出此外部存储,使用其他的外部存储。

蜂鸣器响4次,LED闪烁的话,表示检测到了消耗了允许范围外的电流。这时请参考恢复手册注意事項

拔出外部存储

从路由器拔出外部存储前,请持续按压外部存储按钮2秒钟。
路由器会进行安全拔出外部存储的准备。请在确认了蜂鸣器响,外部存储LED灭灯后,拔出外部存储。

请不要在外部存储LED亮灯时拔出外部存储。

可以自动检索外部存储的目录中的文件。

自动检索的设置

自动检索在以下情景运行。

  • 连接了外部存储的状态启动时的启动文件检索
  • 同时按住外部存储按钮和DOWNLOAD按钮3秒以上进行复制时的复制源文件检索
  • copy exec命令、copy config命令的复制源文件检索
  • 执行execute batch命令时的批处理文件检索
  • 由DOWNLOAD按钮执行批处理文件时的批处理文件检索

使用文件复制功能或启动功能时,使用external-memory exec filename命令或external-memory config filename命令来只指定文件名。
使用批处理文件运行功能时,使用external-memory batch filename命令的文件名设置来只指定文件名。
这些命令在默认只指定文件名时,进行自动检索。

执行copy命令时,复制源文件名只指定外部存储的文件名时,会自动检索外部存储内的文件。

通过绝对路径(以'/'开始)直接指定文件时,不进行自动检索,只以指定位置的文件为对象。

以下,以external-memory exec filename命令为例,显示由指定方法不同动作的不同。

例1:只指定文件名时

# external-memory exec filename sd1:rtx1200.bin

在microSD内存卡内检索"rtx1200.bin"

例2:使用绝对路径指定文件时

# external-memory exec filename sd1:/rtx1200.bin

在microSD内存卡内的根目录下搜索"rtx1200.bin"

# external-memory exec filename sd1:/dir1/rtx1200.bin

在microSD内存卡内的"dir1"目录下搜索"rtx1200.bin"

例3:不检索文件时

# external-memory exec filename off

不检索固件文件

例4:错误的设置

# external-memory exec filename sd1:dir1/rtx1200.bin

指定路径时,因为使用绝对路径,所以必须要在前面加上表示根目录的(/)。 改设置会将"dir1/rtx1200.bin"视为文件名,判断了文件名不能使用的字符(/),所以报错。

根据外部存储保存的文件和目录数或结构,文件的自动检索可能需要花费很长时间。
为了缩短检索时间,尽量不要生成层次深的目录,请保存在离根目录近的位置,使用绝对路径(以'/'开始)直接指定文件。
不存在检索对象文件时也需要检索全目录而花费大量时间,所以不需要检索文件时请设置上述命令为off。

自动检索的规则

检索遵从以下的规则。

  • 外部存储中指定"*:"时,按照先microSD内存卡,然后USB存储的顺序检索。
    这时,在microSD内存卡内找到对象文件的话,不检索USB存储。
  • 根目录中存在对象文件时,选择该文件。
  • 从根目录开始往下层目录搜索。
    最大可以检索16层次下的目录。
  • 选择离根目录最近的目录层次里的对象文件。
  • 同一阶层数的目录中的文件,选择字符编码较小的目录阶层的文件。
    目录的检索顺序,遵从GUI页面显示的文件的一览显示(「管理」的「设置文件的复制」的设置页面的「参考」等)的顺序。
  • 到达了自动检索的限制时间时,停止自动检索,当做没有找到文件进行处理。
  • 指定的文件只找到一个时,以该文件为对象。
  • OS管理用目录(Recycled, System Volume Information 等)不在搜索对象中。

自动检索的的取消

检索要花费很长时间时,可以用以下的设置,操作来终止检索。

  • 从开始检索,经过了external-memory auto-search time命令设置的时间(默认值为300秒)的话,因超时而停止检索
  • 执行copy exec命令、copy config命令、execute batch命令时,检索文件中可以按下Ctrl+C 来终止检索
  • 按住外部存储按钮+DOWNLOAD按钮复制文件时,文件检索中可以按下DOWNLOAD按钮1秒来终止检索
  • 按下DOWNLOAD按钮执行批处理文件时,文件检索中可以按下DOWNLOAD按钮1秒来终止检索
  • 可以按下DOWNLOAD按钮1秒来终止检索时,鸣响表示检索终止的蜂鸣时请放开按钮。连续按下DOWNLOAD按钮3秒以上的话,将执行Download按钮功能。请参考外部存储按钮和download按钮的动作
  • 终止检索的方法和终止时的运行如下。
    另外,在文件检索中,按下外部存储按钮2秒的话,可以使外部存储变为未连接(DETACH)状态。
操作 超时 按下DOWNLOAD按钮1秒 Ctrl+C
从外部存储启动 所有的外部存储为DETACH
copy exec命令
copy config命令
检索中止 检索中止
外部存储按钮

DOWNLOAD按钮
(文件复制)
检索中止
蜂鸣器鸣响"噗噗噗噗"
检索中止
蜂鸣器鸣响"噗噗噗噗"
execute batch命令 检索中止 检索中止
DOWNLOAD按钮
(执行批处理文件)
检索中止
蜂鸣器鸣响"噗噗噗噗"
检索中止
蜂鸣器鸣响"噗噗噗噗"

文件访问的高速化

Rev.11.03 系以后的固件中,以保存在外部存储的单个目录中的多个文件和目录为对象,访问该目录的文件和目录的性能得到改善。
关于本功能的说明如下。

首先,为了使用本功能,通过external-memory accelerator cache size 命令。设置文件访问高速化功能为有效(默认值为有効)。设置为off 以外时,文件访问高速化功能有效。

例)连接在usb1接口上的外部存储的文件访问使用的缓存的大小设置为 "1"。

# external-memory accelerator cache size usb1 1

其次,高速访问的适用条件的说明如下。

  • 高速化功能设置为有效(默认值为有効)
  • 保存有对象文件或目录的目录中的文件和目录的总数超过100个
  • 对象文件或目录的管理信息被缓存

这些条件都满足时,高速访问被适用。除此之外,将不适用高速访问,以通常(和之前相同)访问。

如上述说明所示,为了适用高速访问,缓存対象文件和目录的管理信息是必须的。通常在连接外部存储时进行缓存。另外,在生成文件或目录时,目录中的总数超过100个以上时缓存。反之,在删除文件或目录时,目录中总数不满100个时,清除缓存。访问性能没有提高时,存在缓存空间不足,对象文件或目录的管理信息没有被缓存的可能性,使用external-memory accelerator cache size 命令增加缓存的使用空间。但是,增加空间大小的话,根据外部存储内的目录・文件结构,从连接外部存储到可以使用为止的时间将变长。
详细请参考external-memory accelerator cache size 命令的说明。

※注意事项

  • 本功能不能改善外部存储内的所有的文件或目录的访问性能。
  • 外部存储内不存在满足适用条件的目录时,和通常相同(高速化功能无效)。
  • 外部存储内存在多个满足适用条件的目录时,将花费较长的生成管理信息缓存的时间。
  • 根据外部存储内的目录・文件结构,可能即使设置缓存的大小为最大值也缓存不足,将通常访问(和之前相同)。这种情况时,需要删除调整外部存储内的文件或目录数。
  • 外部存储的用途为复制设置文件或保存日志时,即使使用的外部存储内存在大量的目录和文件,因为操作对象的目录中的文件数很少,也以高速化功能无效(off)的状态使用。

命令格式

设置是否使用USB Host功能

[格式]

usbhost use [PORT] SWITCH
no usbhost use [PORT [SWITCH]]

[设置值]

  • PORT ... USB 端口号
    • 1 ... USB端口1
    • 2 ... USB端口2
    • 省略 ... 省略时为所有的端口号
  • SWITCH
    • on ... 使用USB端口
    • off ... 不使用USB端口

[说明]

设置是否使用USB Host功能。本命令设置为off时,即使连接了USB存储,路由器也不会识别。
另外,过电流等发生USB Host功能故障时,在不连接USB存储的状态时,执行本命令可以恢复。

[默认值]

on

[适用机型]

RTX1200RTX820RTX800

设置是否使用microSD卡插槽

[格式]

sd use SWITCH
no sd use [SWITCH]

[设置值]

  • SWITCH
    • on ... 使用microSD卡插槽
    • off ... 不使用microSD卡插槽

[说明]

设置是否使用microSD卡插槽。本命令设置为off时,即使连接了microSD内存卡,路由器也不能识别。

[默认值]

on

[适用机型]

RTX5000RTX1200RTX820

USB总线的过电流保护功能运行的时间的设置

[格式]

usbhost overcurrent duration [PORT] DURATION
no usbhost overcurrent duration [PORT]

[设置值]

  • PORT ... USB 端口号
    • 1 ... USB端口1
    • 2 ... USB端口2
    • 省略 ... 省略时为所有的端口号
  • DURATION ... 时间(5..100、1个单位是10毫秒)

[说明]

过电流保护功能运行的时间的设置。此处设置的时间内,连续检测出过电流的话,将运行过电流保护功能。

[默认值]

5(50毫秒)

[适用机型]

RTX1200RTX820RTX800

设置文件检索时的超时时间

[格式]

external-memory auto-search time TIME
no external-memory auto-search time [TIME]

[设置值]

  • TIME ... 秒数(1..600)

[说明]

设置文件检索时的超时时间。

[默认值]

300

[适用机型]

RTX5000RTX1200RTX820RTX800

外部存储性能测试命令

[格式]

external-memory performance-test go [INTERFACE]

[设置值]

  • INTERFACE
    • usb1 ... 测试连接在USB端口1上的USB存储的性能
    • usb2 ... 测试连接在USB端口2上的USB存储的性能
    • sd1 ... 测试microSD卡的性能

[说明]

确认外部存储是否具有满足该功能规格的性能。
外部存储的识别时间,数据的读写速度的确认,一连串的测试完成后,判断为满足规格性能的话,显示
  ・OK:succeeded
不满足的话,显示
  ・NG:failed

[Note]

本功能必须在不使用其他功能时执行。

本命令执行中会设置syslog debug on、no syslog host。因此即使设置为syslog debug off,也会输出DEBUG类型的SYSLOG。另外,即使设置了syslog host 命令,也不能将Log发送至SYSLOG服务器。

device attach测试中,显示NG判定时,按下USB按钮,暂时取出设备再次连接并执行测试的话,可能会判定为OK。

在使用雅马哈路由器的外部存储功能时,请确认所要求的外部存储的最低性能的要求,本功能的结果不能保证该外部存储所有的运行正常。
使用外部存储功能时,推荐定期使用show status external-memory 命令确认外部存储的读写不会发生错误。

[适用机型]

RTX5000RTX1200RTX820RTX800

设置USB Host功能相关的蜂鸣器是否鸣响

[格式]

alarm usbhost SWITCH
no alarm usbhost [SWITCH]

[设置值]

  • SWITCH
    • on ... 鸣响
    • off ... 不鸣响

[说明]

设置USB Host功能相关的蜂鸣器是否鸣响

[默认值]

on

[适用机型]

RTX1200RTX820RTX800

设置microSD功能相关的蜂鸣器是否鸣响

[格式]

alarm sd SWITCH
no alarm sd [SWITCH]

[设置值]

  • SWITCH
    • on ... 鸣响
    • off ... 不鸣响

[说明]

设置microSD功能相关的蜂鸣器是否鸣响

[默认值]

on

[适用机型]

RTX5000RTX1200RTX820

显示USB host功能的运行状态

[格式]

show status usbhost [PORT]

[设置值]

  • PORT ... USB 端口号
    • 1 ... USB端口1
    • 2 ... USB端口2
    • 省略 ... 省略时为所有的端口号

[说明]

显示USB host功能的运行状态。

[适用机型]

RTX1200RTX820RTX800

显示microSD接口的运行状态

[格式]

show status sd

[设置值]

[说明]

显示microSD接口的运行状态。

[适用机型]

RTX5000RTX1200RTX820

显示外部存储的运行状态

[格式]

show status external-memory

[设置值]

[说明]

显示外部存储的运行状态。

[适用机型]

RTX5000RTX1200RTX820RTX800

设置外部存储用的缓存的运行模式

[格式]

external-memory cache mode MODE
no external-memory cache mode [MODE]

[设置值]

  • MODE ... 模式
    • write-through ... write-through模式
    • copy-back1 ... copy-back模式1
    • copy-back2 ... copy-back模式2

[说明]

设置外部存储用的缓存的运行模式。
支持write-through模式,copy-back模式1和copy-back模式2三种类型的运行模式,各模式在 FAT、DIR、FILE 的各缓存数据写入外部存储的时间点有所不同。

关于各运行模式的说明如下。

  • 指定为write-through时,分配给FAT、DIR、FILE的缓存通过write-through运行,通常的向外部存储写入。安全性最高。
  • 指定为copy-back1时,FAT和DIR缓存通过copy-back运行,FILE缓存通过write-through运行。比write-through模式的速度更快。
  • 指定为copy-back2时,FAT、DIR、FILE缓存通过copy-back运行。这种设置可以抑制向外部存储写入,可以最高速运行。但是因为持续为写入未完成状态,如果发生预期外的断电的话,外部存储的文件系统有较大可能发生损坏。

FAT : File Allocation Table 的简称
DIR : Directory Entry 的简称

[默认值]

copy-back1

[Note]

本命令的变更在连接外部存储时反映。已经连接了外部存储的状态下输入命令时,需要取出后再连接。

[适用机型]

RTX5000RTX820

设置文件访问高速化用缓存的大小

[格式]

external-memory accelerator cache size INTERFACE SIZE
no external-memory accelerator cache size INTERFACE [SIZE]

[设置值]

  • INTERFACE
    • usb1 ... USB 端口 1
    • usb2 ... USB 端口 2
    • sd1 ... microSD 卡槽
  • SIZE.....缓存的大小
    • 1 - 5 ... 缓存的大小(数值越大,存储大小越大)
    • off ... 不使用文件访问高速化功能

[说明]

为了使用文件访问高速化,设置缓存的大小。

  • 指定了SIZE时,文件访问高速化的功能开始运行,目录数和文件数较多的结构的外部存储的访问性能提升。不能提升访问性能时,提高SIZE的值可能可以提升性能。但是,SIZE越大,外部存储从连接到可以使用为止的时间越长。
  • 指定SIZE为off时,不确保缓存。

另外,对所有接口都将SIZE设置为最大值时,同时将外部存储连接至所有接口使用的话,可能会影响系统全体的性能,所以推荐使用本命令只设置一个接口的文件访问高速化。

[默认值]

1

[Note]

本命令的变更在连接外部存储时反映。已经连接了外部存储的状态下输入命令时,需要取出后再连接。
另外,本命令中即使设置SIZE为最大值也可能不能提升访问性能,请按照以下的操作进行改善。

  • 如果可能的话,减少外部存储内的目录和文件
  • 调整外部存储内的目录总数在2,000个以内
  • 调整频繁访问的目录内的总文件数(包括目录)在20,000个以内
  • 文件名和目录名尽量缩短(推荐半角32字符以内)

[适用机型]

RTX5000RTX820

运行表

外部存储按钮和download按钮的动作

按下外部存储按钮和Download按钮的各时间的运行组合如下。


外部存储按钮
不按 0秒~ 1秒~ 2秒~ 3秒~
DOWNLOAD
按钮
不按 什么都不做 ※2 ※2 外部存储切断
※2
※2
0秒~ 什么都不做 什么都不做 什么都不做 什么都不做 什么都不做
1秒~ 取消Downlaod按钮功能的运行
※1、※4
什么都不做 什么都不做 什么都不做 什么都不做
2秒~ 什么都不做 什么都不做 什么都不做 什么都不做 什么都不做
3秒~ 开始执行Download按钮功能
※4
什么都不做 什么都不做 什么都不做 开始从外部存储中下载设置文件/固件文件
※3

※1. 由按钮执行的自动检索中时,可以中断自动检索
※2. 由于过电流USB设备错误状态时,按下按钮并离开时解除错误状态
※3. 由于过电流USB设备错误状态时,不运行
※4. download按钮功能为HTTP版本升级。
按下Downlaod按钮时的动作可以用operation button function download 命令变更。详细请参考批处理文件执行功能的资料。

蜂鸣器的鸣响模式

各状况下的蜂鸣器鸣响模式的一览如下所示。另外,以下列举的蜂鸣器可以通过alarm usbhost命令和alarm sd命令控制鸣响/不鸣响。

状况 鸣响模式
识别外部存储时 哔哔(低音→高音)
同时按下外部存储按钮和Download按钮开始下载时
同时按下外部存储按钮和Download按钮开始下载时,没有发现文件时 哔哔哔哔
由于过电流USB设备错误状态时哔ー、哔ー、哔ー、哔ー
从过电流USB设备错误状态恢复时 哔哔(高音→低音)
外部存储切断时

外部存储LED的亮灯模式

使用外部存储功能时的外部存储LED的亮灯(灭灯)模式如下所示。

状况 亮灯模式
外部存储识别时 亮灯
访问外部存储时 根据访问符合闪烁
外部存储按钮和download按钮同时按下进行下载,或者由copy exec命令进行固件更新时 和其他的固件更新动作相同(※1)
由按钮操作进行自动更新时,系统会自动重新启动。
外部存储按钮和download按钮同时按下进行下载,没有发现一个文件时 闪烁3次
外部存储切断时 (从亮灯状态)灭灯
由于过电流USB设备错误状态时 持续闪烁
从过电流USB设备错误状态恢复时 (从闪烁状态)灭灯

※1. 路由器本体的LED从左向右依次亮灯。在向内置式Flash ROM写入完成前,重复亮灯。

SYSLOG信息

关于使用外部存储功能时输出的SYSLOG信息、如下所示。实际输出的各信息会在前面加上"[SD]"或"[USB_HOST]"的前缀。
外部存储启动功能相关的log加上"[EXTMEMBOOT]"的前缀。

级别 输出信息 内容
INFO 共通 device attached: vendor=0xXXXX <VendorName>, product=0xXXXX <ProductName> 设备连接
device detached: vendor=0xXXXX <VendorName>, product=0xXXXX <ProductName> 设备移除
microSD storage device is attached microSD设备连接,处于可以使用的状态
Medium formatted by unsupported file system 检测出不支持的文件系统格式的设备
Detection of USB device error status(wrong device) 连接的USB设备损坏(无法识别)
Detection of USB device error status(over current) 连接的USB设备发生过电流的硬件故障
Recovery from USB device error status(over current) USB设备从过电流的故障中恢复
Ready to detach USB device safely USB设备可以移除,安全拔出的状态
Timeout in file search 文件检索中超时
外部存储文件复制功能 Logfile is opened ("sd1:FILENAME", maximum size: XXXX bytes) 打开向microSD存储写入的SYSLOG的文件
FAILED : Logfile is not opened ("sd1:FILENAME") 打开向microSD存储写入的SYSLOG的文件失败
Logfile is closed ("sd1:FILENAME") 关闭向microSD存储写入的SYSLOG的文件
Logfile is backed up from "sd1:LOG_FILENAME" to "sd1:BAK_FILENAME" microSD存储内的SYSLOG文件到达上限大小,回退至备份文件
FAILED : Logfile is not backed up from "sd1:LOG_FILENAME" to "sd1:BAK_FILENAME" microSD存储内的SYSLOG文件到达上限大小,回退至备份文件失败
Configuration is copied from "0(internal)" to "sd1:FILENAME" 复制设置文件到microSD存储中
FAILED : Configuration is not copied from "0(internal)" to "sd1:FILENAME" 向microSD存储中复制设置文件失败
Configuration is copied from "sd1:FILENAME" to "0(internal)" 向内置式Flash ROM中复制设置文件
FAILED : Configuration is not copied from "sd1:FILENAME" to "0(internal)" 向内置式Flash ROM中复制设置文件失败
Firmware is copied from "sd1:FILENAME" to "0(internal)" 向内置式Flash ROM中复制固件文件
FAILED : Firmware is not copied from "sd1:FILENAME" to "0(internal)" 向内置式Flash ROM中复制固件文件失败
外部存储启动功能
[EXTMEMBOOT]
Configuration file is found in microSD("sd1:/config.txt") 在miscoSD存储内发现设置文件
Firmware file is found in microSD("sd1:/rtx1200.bin") 在SD内发现固件
MD5 Checksum is differ 固件文件不正确
Configuration file is not found. 没有发现设置文件
Firmware file is not found. 没有发现固件文件
批处理执行功能 cannot find "sd1:FILENAME" 没有批处理文件"FILENAME"
Batch-log file was opened("sd1:FILENAME") 打开日志文件"FILENAME"
Execute batch file "sd1:FILENAME" 执行批处理文件"FILENAME"
Executing batch file was canceled 中断批处理文件的执行
Batch-log file was closed("sd1:FILENAME") 关闭日志文件"FILENAME"
DEBUG 共通 File open error ("sd1:FILENAME") 打开文件失败
File write error ("sd1:FILENAME") 写入文件失败
File read error ("sd1:FILENAME") 文件的读取失败
File size error ("sd1:FILENAME") 文件的大小超过限制
File encrypt error ("sd1:FILENAME") 文件加密失败
File decrypt error ("sd1:FILENAME") 文件的解密失败

返回顶部Return to Top