qfsdump, qfsrestore - Dump or restore file system data
qfsdump [ -dHqTv ] [-B size ] [-b bl_factor ] [-I
include_file ] [-X excluded-dir ] -f dump_file [ file... ]
qfsrestore [ -dilrRstTv2 ] [-B size ] [-b bl_factor ] -f
dump_file [file... ]
qfsdump creates a dump file of the control structures and
data of each specified file and, if the file is a directory,
(recursively) its subdirectories. Any file specified with
an absolute path will be stored in the dump file with an
absolute path and any file specified with a relative path
will be stored in the dump file with a relative path. If no
file is specified, qfsdump creates a dump file of the con-
trol structures and data of the current relative directory
(referenced as ".") and (recursively) its subdirectories
(referenced as "./<subdirectory_name>").
qfsrestore uses the contents of the dump file to restore the
control structures and data for all the files in the dump
file or each specified file. If a file is specified, its
path and filename must match exactly what exists in the dump
file. All files will be restored to the absolute or rela-
tive location as each file is described in the dump file,
unless the -s option is specified. With the -s option
specified, all filenames with an absolute path in the dump
file are restored relative to the current directory, using
the entire path as contained in the dump file.
In both qfsdump and qfsrestore, the dump file must be speci-
fied in -f dump_file, where dump_file specifies the name of
the dump file to write or read, respectively. If a - (dash)
is specified for the dump_file, qfsdump will write the dump
file to stdout or qfsrestore will read the dump file from
stdin. The dump file data can be passed through appropriate
filters, such as compression or encryption, after being
written by qfsdump or before being read by qfsrestore.
If dump file contains ACLs, they could be either of POSIX
ACLs or NFSv4 ACLs. Each type of ACL would normally be
restored to the filesystem supporting that type of ACL. If
the dump file contains POSIX ACLs and the filesystem sup-
ports NFSv4 ACLs, the POSIX ACLs will automatically be con-
verted to NFSv4 ACLs. If the dump file contains NFSv4 ACLs
and the filesystem supports POSIX ACLs, no conversion will
be performed, a warning will be issued, and files will be
restored with empty ACLs.
qfsdump and qfsrestore require the superuser for execution.
Sun Microsystems recommends that a site create qfsdump
dumps on a periodic basis as part of a disaster recovery
-d Enable debugging messages. Useful only to Sun
Microsystems to trace execution for verification
-H (qfsdump only) Specifies the dump file is to be
created without a dump header record, or the
existing dump file has no header record. This
option be used to create control structure dump
files which can be concatenated using cat (see
-i (qfsrestore only) Prints inode numbers of the
files when listing the contents of the dump. See
also the -l, -t, and -2 options.
(qfsdump only) Takes the list of files to dump
from include_file. This file has one relative or
absolute path to be dumped per line. After pro-
cessing include_file, any [file] arguments from
the command line are processed.
-l (qfsrestore only) Prints one line per file similar
to sls -l when listing the contents of the dump.
(This option is the lower case letter `ell'.) See
also the -i, -t, and -2 options.
-q (qfsdump only) Suppresses printing of warning mes-
sages during the dump for those files which will
be damaged should the dump be restored. By
default, such warning messages are displayed.
-r (qfsrestore only) Replaces existing files when
restoring control structures if the existing files
have an older modification time than the dumped
-R (qfsrestore only) Replaces existing files when
restoring control structures.
-s (qfsrestore only) Causes leading slashes to be
stripped from filenames prior to restoring them.
This is useful if the dump was made with an abso-
lute pathname, and it's now necessary to restore
the dump to a different location. Any directories
required for the restoration and not defined in
the dump file are automatically created.
-t (qfsrestore only) Instead of restoring the dump,
qfsrestore will list the contents of the dump
file. See also the -i, -l, and -2 options.
-T Displays statistics at termination, including
number of files and directories processed, number
of errors and warnings, etc. An example is:
Symbolic links: 0
Resource files: 8
File archives: 0
Damaged files: 0
Files with data: 24102
File warnings: 0
Unprocessed dirs: 0
File data bytes: 0
The numbers after "Files", "Directories", "Sym-
bolic links", and "Resource files" are the counts
of files, directories and symbolic links whose
inodes are contained in the dump.
"File archives" refers to the number of archive
images associated with the above Files, Direc-
tories, Symbolic links and Resource files. "Dam-
aged files" refers to the number of Files, Direc-
tories, Symbolic links, and Resource files which
are either already marked damaged (for a qfsdump),
or were damaged during a restore because of having
no archive image (for a qfsrestore).
"Files with data" refers to the number of Files
that have online (full or partial) data dumped or
"File warnings" refers to the number of Files,
Directories, Symbolic links and Resource files
which would be damaged should the dump be restored
(because they had no archive images at the time of
"Errors" refers to the number of error messages
which were printed during the dump or restore.
These errors are indications of a problem, but the
problem is not severe enough to cause an early
exit from qfsdump or qfsrestore. Examples of
errors during restore are failing to create a sym-
bolic link, failing to change the owner or group
of a file. Errors which might occur during a dump
include pathname too long, failing to open a
directory for reading, failing to read a symbolic
link or resource file, or finding a file with an
"Unprocessed dirs" refers to the number of direc-
tories which were not processed due to an error
(such as being unable to create the directory).
"File data bytes" is the amount of file data
dumped or restored.
-v Prints file names as each file is processed. This
option is superseded by options -l or -2.
(qfsdump only) -X excluded-dir
specifies directory paths to be excluded from the
dump. Multiple (up to 10) directories may be
excluded by using multiple -X parameters. A
directory which resolves to . or NULL causes an
error message to be issued.
-2 Prints two lines per file similar to sls -2 when
listing the contents of the dump. See also the
-i, -l, and -t options.
-B size Specifies a buffer size in units of 512 bytes.
Note that there are limits on the buffer size, as
specified in the error message when the limits
have been exceeded. The default buffer size is 512
* 512 bytes.
Specifies a blocking factor in units of 512 bytes.
When specified, all I/O to the dump image file is
done in multiples of the blocking factor. There is
no blocking done by default.
file... Gives a list of files to be dumped or restored.
Note that the names given to restore must match
exactly the names as they are stored in the dump;
you can use qfsrestore -t to see how the names are
qfsdump only supports full dumps of specified files and
directories. Incremental dump support should be added at a
qfsdump dumps all data of a sparse file, and qfsrestore will
restore all data. This can lead to files occupying more
space on dump files and on restored file systems than anti-
cipated. Support for sparse files should be added at a
"Not a SAM-FS file" means that you are attempting to operate
on a file which is not contained in a Sun QFS file system.
"file: Unrecognised mode (0x..)" means that qfsdump is being
asked to dump a file which is not a regular file, directory,
symbolic link or request file. While Sun QFS allows the
creation of block special, character special, fifo ...
files, these do not function correctly, and qfsdump does not
attempt to dump them.
"file: Warning! File will be damaged." during a qfsdump
means that the file in question does not currently have any
archive copies. The file is dumped to the qfsdump file, but
if the qfsdump file is used to restore this file, the file
will be marked damaged.
"file: Warning! File is already damaged." during a qfsdump
means that the file is currently marked damaged. During
restore, the file will still be damaged.
"file: File was already damaged prior to dump" during a
qfsrestore means that the file was dumped with the "damaged"
".: Not a SAM-FS file." means that you are attempting to
dump files from a non-QFS file system or restore files from
a qfsdump dump file into a non-QFS file system.
"file: stat() id mismatch: expected: %d.%d, got %d.%d" dur-
ing a dump indicates one of two things. If the %d. portions
match, but the .%d portions differ, then a directory or file
was deleted and recreated while qfsdump was operating on it.
The file is not dumped. If the %d. portions do not match,
then a serious error has been encountered; consult your ser-
vice provider for help.
"Corrupt samfsdump file. name length %d" during a restore
means that the pathname of a file to be restored was less
than zero, or larger than MAXPATHLEN. This should not
occur. qfsrestore aborts.
"Corrupt samfsdump file. %s inode version incorrect" during
a restore means that a the inode for the indicated file was
in an old format. This should not occur. qfsrestore
"file: pathname too long" during a dump indicates that the
pathname of the indicated file is longer than 1024 charac-
ters. The file is not dumped.
The following example creates a control structure dump of
the entire /sam file system:
example# cd /qfs1
example# qfsdump -f /destination/of/the/dump/qfsdump.today
To restore a file system dump to /qfs1:
example# cd /qfs1
example# qfsrestore -f /source/of/the/dump/qfsdump.yesterday