mmimgrestore command

Availability

Available with IBM Spectrum Scale™ Standard Edition or higher. Available on AIX® and Linux.

Description

The mmimgrestore command restores a single GPFS file system from a metadata image.

The mmrestoreconfig command must be run prior to running the mmimgrestore command. For more information, see Scale Out Backup and Restore (SOBAR) in IBM Spectrum Scale: Administration and Programming Reference.

Parameters

Device

The device name of the file system whose metadata image is to be restored. The file system must be empty and mounted read-only. File system names need not be fully-qualified. fs0 is as acceptable as /dev/fs0.

This must be the first parameter.

ImagePath

The fully-qualified path name to an image fileset containing GPFS backup images. The path must be accessible by every node participating in the restore.

-g GlobalWorkDirectory

The directory to be used for temporary files that need to be shared between the mmimgrestore worker nodes. If not specified, the default working directory will be the ImagePath specified.

-L n

Controls the level of information displayed by the mmimgrestore command. The default for mmimgrestore is 1. Larger values indicate the display of more detailed information. n should be one of the following values:

0

Displays only serious errors.

1

Displays some information as the command executes, but not for each file. This is the default.

2

Displays each chosen file and the scheduled action.

3

Displays the same information as 2, plus each candidate file and the applicable rule.

4

Displays the same information as 3, plus each explicitly EXCLUDEd file and the applicable rule.

5

Displays the same information as 4, plus the attributes of candidate and EXCLUDEd files.

6

Displays the same information as 5, plus non-candidate files and their attributes.

-N {Node[,Node...] | NodeFile | NodeClass}

Specifies the nodes that will participate in the restore. This command supports all defined node classes. The default is to run only on the node where the mmimgrestore command is running or the current value of the defaultHelperNodes parameter of the mmchconfig command.

Note: If more than one node is specified, ensure all nodes have the same operating system or unexpected results may occur.

For general information on how to specify node names, see Specifying nodes as input to GPFS commands in the IBM Spectrum Scale: Administration and Programming Reference.

--image ImageSetName

Specifies the image set name representing the metadata image to be restored. The ImageSetName must match the ImageSetName_YYYYMMDD_hh.mm.ss that was created during the backup with the mmimgbackup command.

POLICY-OPTIONS

The following mmapplypolicy options may also be used with mmimgrestore:

-m ThreadLevel

The number of threads that will be created and dispatched within each image restore process during the policy execution phase of restore. The default is calculated to divide the work of processing all image files being restored evenly among all nodes specified with -N. The valid range is 1 to 20.

-s LocalWorkDirectory

Specifies the directory to be used for local temporary storage during command processing. The default directory is /tmp.

--single-instance

Ensures that only one instance of mmimgrestore is running for each file system at a time.

Exit status

0

Successful completion.

nonzero

A failure has occurred.

Security

You must have root authority to run the mmimgrestore command.

The node on which the command is issued must be able to execute remote shell commands on any other node in the cluster without the use of a password and without producing any extraneous messages. For more information, see Requirements for administering a file system in IBM Spectrum Scale: Administration and Programming Reference.

See also

Location