Format Command

Reinitialize the /flash disk or /NVRAM device, erasing all user data.

Format [-ERASE] -v

Prerequisites

Make sure you want to erase the disk or NVRAM!  Backup any data you want to save.

Parameters

-v

If specified, the progress of the format operation is displayed on the console as the format operation proceeds. Useful when formatting the larger flash device.

-jffs2

Only valid for the /flash device. If specified, the /flash device is formatted using the JFFS2 file system rather than the default MS-DOS file system. See the section File System Selection for more information on using JFFS2. Note that JFFS2 does not support sub-partitions.

-ERASE

An optional switch that erases the flash or NVRAM immediately without additional prompts. Must be specified exactly, with matching case.  This is provided as a convenience for executing the Format command from a script or device that does not support interactive commands.

device

An optional device name. /flash or /flashn (where n ranges from 2 to 8 for the flash sub-partitions) to erase the main user flash area or one of its sub-partitions or /NVRAM to erase all user files on the optional Non-Volatile memory device.   If this parameter is omitted, /flash will be erased.

Remarks

This command will erase all user files stored on the /flash disk or the /NVRAM. It does not erase the FPGA program, GPL system, license information, power-on meter data or the user contents of DataID 1892 for the NVRAM. However, if the /flash disk is initialized, it will erase all GPL projects and custom Application Web's that have been stored.  This command should only be used to clear /flash after the flash disk size has been changed, or if the flash has been corrupted.

If your controller has sub-partitions, you can format the main partition /flash or any of the sub-partitions /flash2, …, /flash8, without affecting the data in the other sub-partitions. However, if you change the size of any /flash sub-partition, all of the /flash and /flashn partitions must be reformatted.

After the Format command is issued, if the -ERASE switch is not specified, GPL responds with the prompt:

WARNING: This command will erase the user area on device /flash (or /NVRAM)
Type ERASE to continue:

You must enter the word "ERASE," in upper case, for the command to continue. Otherwise the command is canceled.

Examples

Format
WARNING: This command will erase the user area on device /flash
Type ERASE to continue:
ERASE
Success

Format /NVRAM
WARNING: This command will erase the user area on device /NVRAM
Type ERASE to continue:
*Cancelled*

See Also

Console Commands