format-disk

Use this command to format and initialize a removable drive or standby Terminal Disk Module (TDM).

Note:

The format-disk command leaves the disk unusable until the chg-db and copy-gpl commands are entered.

Parameters

type (mandatory)

The type of drive to format.

Range:

fixed: The standby fixed disk on the standby TDM
meas: The removable measurement drive
system: The removable system drive (latched recessed USB port on the MASP card).
usb: The flush-mounted (not-latched) USB port on the MASP card.

force (optional)

This parameter provides some protection against data loss due to reformatting a used system removable drive.

Range:

yes
no

Default:

no

loc (optional)

The location of the disk that is being formatted.

Range:

1114: The TDM
1116: The TDM
1113: The latched USB port
1115: The latched USB port

low (optional)

This parameter provides control over whether a low-level format will be performed on the target disk. Specifying low=no can be used to decrease formatting time.

Range:

yes
no

Default:

yes

prtngrp (optional)

Partition group. The disk partition group to be formatted. Specifying the inactive group is relevant only when type=fixed is specified.

Caution:

Do not enter the format-disk:prtngrp=inactive command unless directed to by the Customer Care Center to avoid possible loss of a previously archived software release.

Range:

active
inactive

Default:

active

Example

format-disk:type=system

format-disk:type=meas:force=yes

Dependencies

The type=fixed parameter must be specified before the prtngrp parameter can be specified.

If the prtngrp parameter is specified, then the low=no parameter must be specified.

Measurements collection must be inhibited during execution of this command. If measurements are not inhibited, this command cannot be executed.

Do not enter the chg-measopts:collect=on command while the format-disk command is in progress. This results in read and write errors, because the standby disk is not accessible.
Do not enter the format-disk command until the 30 minute measurements processing or the midnight measurements processing has completed, because inhibiting measurements during these periods results in the loss of measurement data for the period being processed.

If a removable flash drive that is inserted into the latched USB port contains EAGLE data, then the force=yes parameter is required.

If a plug-in flash drive that is inserted into the flush-mounted USB port contains EAGLE data, then the force=yes parameter is required.

If the medium that is being formatted contains system data, then the force=yes parameter is required.

The force=yes parameter must be specified if the drive to be formatted is recognized as a system removable drive. This parameter is optional if the drive is not recognized as a system removable drive. Only drives that have a dms.cfg file are recognized as system removable drives.

A removable drive must be inserted and made ready before the type=meas or type=system parameter can be specified in the command.

If the force=yes parameter is specified, the disk should not require low-level formatting, and the format=no parameter should be specified.

The card with the standby OAM must be available when this command is entered.

The standby fixed disk could not be accessed. There could be a hardware problem.

The active fixed disk could not be accessed. There could be a hardware problem.

The source and destination disks are not compatible. There could be a hardware problem.

The system cannot determine the capacity of the disk that is being formatted.

Refer to Database Administration - System Management User's Guide for detailed instructions to resolve this issue.

The standby fixed disk contains security log entries that have not yet been uploaded. Upload the log entries before formatting the disk to avoid loss of log data.

The OAMHC GPL version that is running in the active OAM card location must be the same GPL version that is running in the standby OAM card location.

OAM Measurements collection cannot be in progress when this command is entered.

A value of 1114 or 1116 must be specified for the loc parameter before the type=fixed parameter can be specified.

An E5-MCAP card must be installed before the type=usb parameter can be specified.

The OAM card must be able to read the media being formatted.

The format-disk command cannot be issued when SFAPP(P)->OAM sync is ON.

Notes

The low=no parameter should be specified when upgrading a spare TDM. The low=yes parameter should be specified when there is a suspected hardware problem.

When the type=meas parameter is specified, a measurements removable drive is built.

When the type=system parameter is specified, a system removable drive is built.

A system removable drive can contain only GPLs and the database, not measurement data. After formatting, the drive does not contain any data, but can be used as the destination disk of the copy-gpl and chg-db:action=backup:dest=remove commands. The copy-gpl command copies all approved GPLs from the fixed disk on the active TDM to the system removable drive, providing a backup copy of the approved GPLs. The chg-db:action=backup:dest=remove command copies the database from the current partition of the fixed disk on the active TDM to a system removable drive, providing a backup copy of the database.

A measurements removable drive can contain only measurement data, not database information and GPLs. After formatting, the drive does not contain any data, but can be used as the destination disk of the copy-meas command. The copy-meas command copies all measurement data from the fixed disk on the active TDM to a measurements removable drive for offline processing of the measurement data.

The database audit and GPL audit facilities are automatically disabled during execution of this command. When this command has completed (successful or not), the database and GPL audit facilities are automatically re-enabled.

All commands that affect the database are disallowed for the duration of the command. Attempts to use such commands are rejected, and an error message is displayed explaining that the command has been rejected.

During the upgrade process, files made obsolete by the upgrade process are deleted, freeing up disk space.

If the format-disk command is initiated and the standby OAM initialization is not complete, command processing is delayed. If standby initialization fails, the command proceeds to allow the standby TDM to recover from a previous format-disk or copy-disk failure. In such cases, the following messages appear:


Standby MASP has not finished initializing - please wait...


Standby MASP initialization timed out - continuing...

The dms.cfg file on either the active TDM or a system formatted removable drive is used by the format-disk command when formatting the target disk. The location of the dms.cfg file cannot be specified by the format-disk command. The value of the type parameter is used to determine the target disk to format and the location of the dms.cfg file on which to base the format. Table 4-37 shows the location of the dms.cfg file based on the value of the type parameter for the format-disk command.

Table 4-37 DMS.CFG File Location for format-disk Command

Value of the type Parameter	Target Disk (Card Location)	Location of the DMS.CFG File
fixed	Standby TDM (1114 or 1116)	Latched USB Port (1113 or 1115)
system	Latched USB Port (1113 or 1115)	Active TDM (1114 or 1116)
meas	Latched USB Port (1113 or 1115)	Active TDM (1114 or 1116)

The format-disk command can create a maximum disk partition size of 2047 Mbytes, based on a 16-bit cluster size. A cluster is composed of 64 512-Kilobyte sectors. The physical capacity of the disk being formatted determines the formatted size of the disk and the number of partitions created on the disk.

Table 4-38 shows the format capacities of each type of disk used on the system and the number of partitions created on each disk.

Table 4-38 Disk Format Capacity

Target Disk Type	Disk Location	Target Capacity	Number of Partitions	Formatted Size of Partition
Latched USB Port	1113 or 1115	2 Gigabytes	1	1.9 GB
TDM	1114 or 1116	540 Mbytes	1	507 Mbytes
TDM	1114 or 1116	2 Gigabytes	1	2014 Mbytes
TDM	1114 or 1116	4 Gigabytes	2	2047 Mbytes

Output

format-disk:type=system


    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk of system removable media started.
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk (removable media) format in progress.
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk (removable media) format in progress.
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk (removable media) format is complete.
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk of system removable media completed.
    Measurements collection may be turned on now if desired. 
;

format-disk:type=fixed:low=no:force=yes


    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk of standby fixed disk started.
    Extended processing required, please wait. 
;
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk (fixed) format in progress.
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk (fixed) format is complete.
    
    rlghncxa03w 04-01-07 00:57:31 EST  EAGLE 31.3.0
    Format-disk of standby fixed disk completed.
    Measurements collection may be turned on now if desired. 
;

4.369 format-disk