NAME

vos_dump - Converts a volume into ASCII format and writes it to a file

SYNOPSIS

vos dump -id <volume name or ID> [-time <dump from time>] [-file <dump file>] [-server <server>] [-partition <partition>] [-omitdirs] [-clone [<yes|no>]] [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos dump command converts the contents of the indicated volume, which can be read/write, read-only or backup, into ASCII format. The vos process writes the converted contents to the file named by the -file argument, or to the standard output stream. In the latter case, the output can be directed to a named pipe, which enables interoperation with third-party backup utilities.

To dump the complete contents of a volume (create a full dump), omit the -time argument or specify the value 0 (zero) for it. To create an incremental dump, which includes only the files and directories in the volume that have been modified after the date and time specified as the -time argument. The File Server maintains a private modification time which is different from the last modification time reported in a directory listing. The File Server's modification time cannot be reset by applications.

The vos command interpreter consults the Location Service to determine the File Server and partition to read the volume from. The -server and -partition arguments can be provided to force the use of an explicit File Server and partition. When the -id argument provides a volume ID number (rather than a name) and is combined with both -server and -partition the Location Service query is skipped.

If the -id argument identifies a read-only volume that resides at multiple sites, vos dump dumps the contents of one of them; the one listed first in the output of vos examine or vos listloc. To dump the read-only volume from a particular site, use the -server and -partition arguments to specify the site.

To restore a volume dump, use the vos restore command.

CAUTIONS

Support for incremental dumps is provided to facilitate interoperation with third-party backup utilities. The vos dump command does not provide any of the administrative facilities of an actual backup system, so the administrator must keep manual records of dump times and the relationship between full and incremental dumps of a volume. For a volume's contents to be consistent after restoration of incremental dumps, there must be no gap between the time at which a prior dump of the volume was created and the value of the -time argument to the vos dump command that creates the incremental dump. More specifically, for a read/write volume, the -time argument must specify the time that the prior dump was performed, and for a read-only or backup volume it must specify the time that the volume was last released (using the vos release command) or cloned (using the vos backup or vos backupsys command) prior to dumping it. The parent dump can be either a full dump or another incremental dump.

As a result of a partially failed "vos release"|vos_release(1)> operation it is possible for one or more of the read-only sites to house the new volume version and for others to house the older version. When such a condition exists the output of vos examine and vos listloc will designate the sites as New release and Old release. The vos dump command favors the new volume version.

OPTIONS

-id <volume name or ID>

Specifies either the complete name or volume ID number of the read/write, read-only, or backup volume to dump.

-time <dump from time>

Specifies whether the dump is full or incremental. Omit this argument to create a full dump, or provide one of three acceptable values:

-file <dump file>

Specifies the pathname of the file to which to write the dump. The file can be under /afs, but not in a path that requires access to the volume being dumped. A partial pathname is interpreted relative to the current working directory. If this argument is omitted, the dump is directed to the standard output stream.

-server <server name>

Specifies the File Server on which the data resides for the volume indicated by the -id argument. Provide a fully qualified host name, an IP address or UUID as reported by vos listfs.

The -partition argument must be provided.

-partition <partition name>

Specifies the partition on which the data resides for the volume indicated by the -id argument. Provide the partition's complete name with preceding slash (for example, /vicepa) or use one of the three acceptable abbreviated forms. For details, see vos. The -server argument must be provided.

-omitdirs

By default, vos dump includes all directory objects in an incremental dump whether they've been changed or not. If this option is given, unchanged directories will be omitted. This will reduce the size of the dump and not cause problems if the incremental is restored, as expected, on top of a volume containing the correct directory structure (such as one created by restoring previous full and incremental dumps).

-clone [<yes|no>]

The -clone option defaults to yes. When set to no, vos dump dumps the source volume without first creating a temporary clone on the source partition. Disabling cloning will keep the source volume offline for as long as is required to copy the data to the File Server designated by the -server argument.

-cell <cell name>

Names the cell in which to run the command. Do not combine this argument with the -localauth flag. For more details, see vos.

-noauth

Assigns the unprivileged identity anonymous to the issuer. Do not combine this flag with the -localauth flag. For more details, see vos.

-localauth

Obtains an authentication token using the server encryption key with the highest key version number in the local /etc/yfs/server/KeyFileExt file. The resulting token never expires and has Super User privileges. Do not combine this flag with the -cell argument or -noauth flag. For more details, see vos.

-auth

Use the calling user's tokens from the kernel or as obtained using the active Kerberos ticket granting ticket to communicate with the Volume Server and Location Service. This is the default if neither -localauth nor -noauth is given.

Since this option is the default, it is usually not useful for running single command line operations. However, it can be useful when running commands via vos interactive or vos source, since otherwise it would be impossible to switch from, for example, -localauth back to using regular tokens during a bulk operation.

-verbose

Produces on the standard output stream a detailed trace of the command's execution. If this argument is omitted, only warnings and error messages appear.

-encrypt [<yes|no>]

Enables or disables encrytion for the command so that the operation's results are not transmitted across the network in clear text.

-noresolve

Shows all servers as IP addresses instead of the reverse DNS lookup hostname. -noresolve useful when troubleshooting no such volume and volume moved errors.

-config <configuration file>

Set the location of the configuration file to be used. The default file is /etc/yfs/yfs-client.conf.

-help

Prints the online help for this command. All other valid options are ignored.

EXAMPLES

The following command writes a full dump of the volume user.terry to the file /afs/your-cell-name.com/common/dumps/terry.dump.

   % vos dump -id user.terry -time 0 -file /afs/your-cell-name.com/common/dumps/terry.dump

The following command writes an incremental dump of the volume user.smith to the file smith.990131.dump in the current working directory. Only those files in the volume with modification time stamps later than 6:00 p.m. on 31 January 1999 are included in the dump.

   % vos dump -id user.smith -time "01/31/1999 18:00" -file smith.990131.dump

PRIVILEGE REQUIRED

The issuer must be listed in the /etc/yfs/server/UserListExt file on the File Server specified by the -server argument and on each Location Server. If the -localauth flag is included, the issuer must instead be logged on to a server with an account capable of reading the /etc/yfs/server/KeyFileExt file.

If the -file argument is included, the issuer must also have permission to insert and write in the directory that houses the file.

SEE ALSO

restorevol(1), vos(1), vos_examine(1), vos_listloc(1), vos_restore(1)

COPYRIGHT

IBM Corporation 2000. http://www.ibm.com/ All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.

ACKNOWLEDGEMENTS

"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.