NAME

vos_restore - Creates or replaces a volume from a dump file

SYNOPSIS

vos restore -server <machine name> -partition <partition name> -name <name of volume to be restored> [-file <dump file>] [-id <volume ID>] [-overwrite (abort | full | incremental)] [-offline] [-readonly] [-creation (dump | keep | new)] [-lastupdate (dump | keep | new)] [-nodelete] [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos restore command copies a volume dump file previously created with the vos dump command to the File Server specified by the -server argument, and restores it as a read/write volume to the partition named by the -partition argument on that machine.

The vos process assigns the volume name indicated with the -name argument, and resets the volume's creation timestamp to the time at which the restore operation begins (the creation timestamp is stored by the File Server and reported in the Creation field in the output from the vos examine and vos listvol commands.)

Use the -file argument to name the dump file, or omit the argument to provide the dump contents via the standard input stream, presumably through a pipe. The -file argument can be a named pipe, which enables interoperation with third-party backup utilities.

As described in the following list, the command can create a completely new volume or overwrite an existing volume. In all cases, the full dump of the volume must be restored before any incremental dumps. If there are multiple incremental dump files, they must be restored in the order they were created.

If the volume named by the -name argument already exists and the -overwrite argument is omitted, the command interpreter produces the following prompt:

   Do you want to do a full/incremental restore or abort? [fia](a):

Respond by entering one of the following values:

CAUTIONS

If the -file argument is omitted, the issuer must provide all other necessary arguments, because the standard input stream is unavailable for responding to the command interpreter's prompts for missing information. In particular, the issuer must provide the -overwrite argument if overwriting an existing volume.

OPTIONS

-server <server name>

Identifies the File Server on which to restore the volume. Provide a fully qualified host name, an IP address or UUID as reported by vos listfs.

-partition <partition name>

Identifies the partition (on the file server machine specified by the -server argument) onto which to restore the volume. 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(1).

-name <name of volume>

Specifies the name under which to restore the volume. It can be up to 22 characters long, but cannot end with a .readonly or .backup extension. If the volume already exists, it is overwritten subject to the value of the -overwrite argument. If restoring as a read-only volume, specify the volume's base name and the -readonly argument.

-file <dump file>

Names the dump file to restore. Incomplete pathnames are interpreted relative to the current working directory. Omit this argument to provide the dump file via the standard input stream.

-id <volume ID>

Specifies the volume ID number to assign to the restored volume.

-overwrite (a | f | i)

Specifies which type of dump file is being restored when overwriting an existing volume. Provide one of the following values:

This argument is mandatory if the -file argument is not provided.

-offline

Leaves the new volume flagged as off-line in the volume database.

-readonly

Flags the new volume as read-only in the volume database.

-creation <dump | keep | new>

Set the creation date of the new volume to the timestamp from the dumped volume (dump), from the target volume, if there is one (keep), or generate a new one using the current time (new).

-lastupdate <dump | keep | new>

Set the last updated date of the new volume to the timestamp from the dumped volume (dump), from the target volume, if there is one (keep), or generate a new one using the current time (new).

-nodelete

When restoring an existing volume, vos restore can restore the volume to the same server and partition or to a different server or partition.

When restoring an existing volume to the same server and partition, vos restore will delete the old copy of the volume and replace it with the new volume. -nodelete has no effect in this case.

When restoring an existing volume to a different server or partition, vos restore will also delete the old copy, unless the -nodelete flag is specified.

When specified, -nodelete instructs vos restore to leave the old existing volume in place on the File Server. The Location Service will list the new volume's location. (The volume at the previous location will be unknown to the Location Service and is therefore stranded -- but will still exist, allowing a non-destructive volume restore.)

Warning: Do not use the -nodelete option when restoring to the same server but a different partition. If the same volume is located on two partitions on the same File Server, one of the two volume instances will be attached at random.

-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 restores the contents of the dump file /afs/your-cell-name.com/common/dumps/terry.dump to the /vicepc partition on the File Server fs3.your-cell-name.com. The restored volume is named user.terry.

   % cd /afs/your-cell-name.com/common/dumps
   % vos restore -file terry.dump -server fs3.your-cell-name.com -partition c \
       -name user.terry

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.

SEE ALSO

restorevol(1), vos(1), vos_dump(1), vos_examine(1), vos_listfs(1), vos_listvol(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.