Administration Reference

vos restore

Purpose

Converts an ASCII file into proper volume format and writes it to the file system

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>]  
            [-cell <cell name>]  [-noauth]  [-localauth]  [-verbose]  
            [-help]
   
vos res -s <machine name>  -p <partition name>  
        -na <name of volume to be restored>  [-f <dump file>]  
        [-i <volume ID>]  [-o <a | f | inc>]  [-c <cell name>]  
        [-no]  [-l]  [-v]  [-h]

Description

The vos restore command converts a volume dump file previously created with the vos dump command from ASCII into the volume format appropriate for the machine type indicated by the -server argument, and restores it as a read/write volume to the partition named by the -partition argument on that machine. The Volume Server 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 in the volume header 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 file via the standard input stream, presumably through a pipe. The pipe can be named, 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.

To create a new read/write volume, use the -name argument to specify a volume name that does not already exist in the Volume Location Database (VLDB), and the -server and -partition arguments to specify the new volume's site. It is best to omit the -id argument so that the Volume Location (VL) Server allocates a volume ID automatically. Do not include the -overwrite argument, because there is no existing volume to overwrite.
To overwrite an existing volume at its current site, specify its name and site with the -name, -server, and -partition arguments. The volume retains its current volume ID number unless the -id argument is provided. Specify the value f or i for the -overwrite argument to indicate whether the dump file is full or incremental, respectively.
To overwrite an existing volume and move it to a new site, specify its name and the new site with the -name, -server, and -partition arguments. The volume retains its current volume ID number unless the -id argument is provided. The volume is removed from its original site. Specify the value f for the -overwrite argument to indicate that the dump file is a full dump (it is not possible to restore an incremental dump and move the volume at the same time).

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:

f if restoring a full dump file
i if restoring an incremental dump file
a or <Return> to cancel the restore operation

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

Identifies the file server machine onto which to restore the volume. Provide the machine's IP address or its host name (either fully qualified or using an unambiguous abbreviation). For details, see the introductory reference page for the vos command suite.

-partition

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 the introductory reference page for the vos command suite.

-name

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.

-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

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

-overwrite

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

a to terminate the restore operation.
f if restoring a full dump file.
i if restoring an incremental dump file. This value is not acceptable if the -server and -partition arguments do not indicate the volume's current site.

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

-cell

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

-noauth

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

-localauth

Constructs a server ticket using a key from the local /usr/afs/etc/KeyFile file. The vos command interpreter presents it to the Volume Server and Volume Location Server during mutual authentication. Do not combine this flag with the -cell argument or -noauth flag. For more details, see the introductory vos reference page.

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

-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/abc.com/common/dumps/terry.dump to the /vicepc partition on the file server machine fs3.abc.com. The restored volume is named user.terry.

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

Privilege Required

The issuer must be listed in the /usr/afs/etc/UserList file on the machine specified with the -server argument and on each database server machine. If the -localauth flag is included, the issuer must instead be logged on to a server machine as the local superuser root.

Related Information