restorevol - Restore a volume from vos dump to the local file system
restorevol [-file <dump file>] [-dir <restore dir> ] [-extension <name extension>] [-mountpoint <mount point root>] [-umask <mode mask>] [-help]
restorevol takes a volume dump file generated by vos_dump(1) and restores it to the local file system. Normally, the contents of a volume are maintained by the File Server in an opaque format and copying a volume's raw data does not make it easily accessible. This utility will produce a directory tree that is equivalent to that seen via a Cache Manager, but without preserving the Access Control Lists (ACLs). It's primary use is to recover data from a volume dump or backup and make it available via a file namespace other than /afs.
The dump output will read from standard input, or from a file if -file is specified.
The restore process is as follows:
The dump file will be restored within the current directory or that specified with -dir.
Within this directory, a subdir is created. It's name is the RW volume name that was dumped. An extension can be appended to this directory name with -extension.
All mountpoints will appear as symbolic links to the volume name. The path name to the volume will be either that in -mountpoint, or -dir. Symbolic links remain untouched.
You can change your umask during the restore with -umask. Otherwise, restorevol uses your current umask. Mode bits for directories are 0777 (then AND'ed with the umask). Mode bits for files are the owner mode bits duplicated accross group and user (then AND'ed with the umask).
For restores of full dumps, if a directory says it has a file and the file is not found, then a symbolic link AFSFile-<#> will appear in that restored tree. Restores of incremental dumps remove all these files at the end (expensive because it is a tree search).
If a file or directory was found in the dump but found not to be connected to the hierarchical tree, then the file or directory will be connected at the root of the tree as __ORPHANEDIR__.<#> or __ORPHANFILE__.<#>.
ACLs are not restored.
Normally, use vos_restore(1) instead of this command. restorevol is a tool of last resort to extract data from a volume dumpfile. Using restorevol bypasses checks done by the fileserver(8).
Specifies the volume dump file to be read and restored to the local filesystem. If this option is not given, the volume dump will be read from standard input.
Names the directory in which to create the restored filesystem. The current directory is used by default. Note that any mountpoints inside the volume will point to the same directory unless the -mountpoint option is also specified.
By default, the name of the directory created matches the RW volume name of the volume in the dump file. If this option is used, the directory name will be the RW volume name name extension as the suffix.
By default, mountpoints inside the volume being restored point to the value given by -dir. This option allows mountpoints to be resolved relative to another path. A common use for this would be to specify a path under /afs as the mount point root so that mountpoints inside the restored volume would be resolved via AFS.
The mount point root must exist, and the process running the command have read access to that directory, or the command will fail.
Sets the umask while creating files.
If not specified,
the current process umask is used.
All directories are created with mode
0777 (ANDed with the umask),
and files are created with the owner,
and user mode bits set to the owner mode bits of the file extracted from the dumpfile (ANDed with the umask).
Prints the online help for this command. All other valid options are ignored.
The following command restores the contents of the dumpfile in sample.dump to the directory /tmp/sample.2009-05-17, but having all mountpoints inside the volume point to /afs (note that this requires knowledge of where sample is mounted under /afs):
% restorevol -file sample.dump -dir /tmp -extension .2009-05-17 \ -mountpoint /afs/your-cell-name.com/sample Restoring volume dump of 'sample' to directory '/tmp/sample.2009-05-17'
The issuer must have read access to the dump file and write access to the directory into which the dump is restored. If the -mountpoint flag is given, the issuer must also have read access to that directory.
salvager(8), voldump(8), vos_dump(1), vos_restore(1)
Copyright 2009 Steven Jenkins <firstname.lastname@example.org>
This documentation is covered by the BSD License as written in the doc/LICENSE file. This man page was written by Steven Jenkins for OpenAFS.
"AFS" is a registered mark of International Business Machines Corporation, used under license. (USPTO Registration 1598389)
"OpenAFS" is a registered mark of International Business Machines Corporation. (USPTO Registration 4577045)
The "AuriStor" name, log 'S' brand mark, and icon are registered marks of AuriStor, Inc. (USPTO Registrations 4849419, 4849421, and 4928460) (EUIPO Registration 015539653).
"Your File System" is a registered mark of AuriStor, Inc. (USPTO Registrations 4801402 and 4849418).
"YFS" and "AuriStor File System" are trademarks of AuriStor, Inc.