mmimgbackup command

Availability

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

Description

The mmimgbackup command performs a backup of a single GPFS file system metadata image.

You must run the mmbackupconfig command before you run the mmimgbackup command. For more information, see the topic Scale Out Backup and Restore (SOBAR) in the IBM Spectrum Scale: Administration and Programming Reference.

Parameters

Device

The device name of the file system whose metadata image is to be backed up. File system names need not be fully-qualified. fs0 is as acceptable as /dev/fs0.

This must be the first parameter.

-g GlobalWorkDirectory

The directory to be used for temporary files that need to be shared between the mmimgbackup worker nodes and to hold backup images until sent to archive. The default is:

mount_point_for_Device/.mmimgbackup

-L n

Controls the level of information displayed by the mmimgbackup command. The default for mmimgbackup 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 backup. This command supports all defined node classes. The default is to run only on the node where the mmimgbackup 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.

-S SnapshotName

Archives the files in the specified global snapshot rather than in the active file system. The snapshot specified cannot be a fileset-level snapshot.

--image ImageSetName

Saves the image files using the provided argument as the base set name. Image file names use the following format:

ImageSetName_YYYYMMDD_hh.mm.ss_BBB.sbr

or

ImageSetName_YYYYMMDD_hh.mm.ss.idx

where:

ImageSetName

The default ImageSetName is ImageArchive.

YYYY

A four-digit year.

MM

A two-digit month.

DD

A two-digit day.

hh

A two-digit hour.

mm

A two-digit minute.

ss

A two-digit second.

BBB

A three-digit bucket number.

--notsm | --tsm

Omits (enables) archiving an image fileset to TSM through the dsmc commands.

--tsm-server ServerName

Specifies the server name to provide to the TSM dsmc command used to store the image data files in the TSM server.

POLICY-OPTIONS

The following mmapplypolicy options may also be used with mmimgbackup:

-A IscanBuckets

Specifies the number of buckets of inode numbers (number of inode/filelists) to be created and processed by the parallel inode scan. The default is 17. A bucket will typically represent 1,000,000 in-use inodes.

-a IscanThreads

Specifies the number of threads and sort pipelines each node will run during parallel inode scan and policy evaluation. The default is 4.

-D yyyy-mm-dd[@hh:mm[:ss]]

Specifies the date and (UTC) time to be used by the mmimgbackup command when evaluating the policy rules. The default is the current date and time. If only a date is specified, the time will default to 00:00:00.

-M name=value

Indicates a user defined macro specification. There can be more than one -M argument. These macro specifications are passed on to the m4 preprocessor as -D specifications.

-n DirThreadLevel

Specifies the number of threads that will be created and dispatched within each mmimgbackup process during the directory scan phase. The default is 24.

-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 mmimgbackup is running for each file system at a time.

--sort-buffer-size Size

Specifies the size for the main memory buffer to be used by sort command.

Exit status

0

Successful completion.

nonzero

A failure has occurred.

Security

You must have root authority to run the mmimgbackup 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