NAME

vos_backupsys - Creates a backup volume for several read/write volumes

SYNOPSIS

vos backupsys [-prefix <common prefix on volume(s)>+] [-server <machine name>] [-partition <partition name>] [-exclude] [-xprefix <negative prefix on volume(s)>+] [-dryrun] [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos backupsys command clones each read/write volume to create a backup version. The backup version is a read-only snapshot of the read/write volume at the time the command is executed.

Each backup version is stored on the same File Server and partition as the read/write volume. The backup volume's name is the name of the read/write volume with the .backup extension appended. Unlike .readonly sites created using the vos_addsite(1) command and populated with the vos_release(1) command, the .backup version cannot be replicated and can only exist on the same partition as the read/write volume.

A .backup volume is useful for providing end users a self-service mechanism to recover accidentally deleted files and directories. Use the fs_mkmount(1) command to create a mount point to the .backup volume where it can be accessed.

To clone every read/write volume known to the Location Service, omit all of the command's options. Otherwise, combine the command's options to clone various groups of volumes. The options use one of two basic criteria to select volumes: location (the -server and -partition arguments) or presence in the volume name of one of a set of specified character strings (the -prefix, -exclude, and -xprefix options).

To clone only volumes that reside on one File Server, include the -server argument. To clone only volumes that reside on one partition, combine the -server and -partition arguments. The -partition argument can also be used alone to clone volumes that reside on the indicated partition on every File Server. These arguments can be combined with those that select volumes based on their names.

Combine the -prefix, -exclude, and -xprefix options (with or without the -server and -partition arguments) in the indicated ways to select volumes based on character strings contained in their names:

The -prefix and -xprefix arguments both accept multiple values, which can be used to define disjoint groups of volumes. Each value can be one of two types:

To display a list of the volumes to be cloned, without actually cloning them, include the -dryrun flag. To display a statement that summarizes the criteria being used to select volume, include the -verbose flag.

This command can be used to clone a single read/write volume; specify its complete name as the -prefix argument. However, it is more efficient to use the vos_backup(1) command, which employs a more streamlined technique for specifying a single volume.

OPTIONS

-prefix <common prefix>

Specifies one or more simple character strings or regular expressions of any length; a volume whose name includes the string is placed on the set of volumes to be cloned. Include field separators (such as periods) if appropriate. This argument can be combined with any combination of the -server, -partition, -exclude, and -xprefix options.

-server <machine name>

Identifies the File Server where each read/write source volume resides. Provide a fully qualified host name, an IP address or UUID as reported by vos_listfs(1).

This argument can be combined with any combination of the -prefix, -partition, -exclude, and -xprefix options.

-partition <partition name>

Identifies the partition where each read/write source volume resides. 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).

This argument can be combined with any combination of the -prefix, -server, -exclude, and -xprefix options.

-exclude

Reverses the meaning of the -prefix or -xprefix argument. This flag can be combined with any combination of the -prefix, -server, -partition, and -xprefix options.

-xprefix <negative prefix>

Specifies a simple character string or regular expression of any length; a volume whose name includes the string is removed from the set of volumes to be cloned. Include field separators (such as periods) if appropriate. This argument can be combined with any combination of the -prefix, -server, -partition, and -exclude options.

-dryrun

Displays on the standard output stream a list of the volumes to be cloned, without actually cloning them.

-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(1).

-noauth

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

-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(1).

-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(1) or vos_source(1), 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.

OUTPUT

The command generates the following messages on the standard output stream to confirm that the operation was successful:

   done
   Total volumes backed up: <number_cloned>; failed to backup: <failures>

If the -dryrun flag is included, a list of the volumes to be backed up precedes the standard confirmation messages.

If the -verbose flag is included but not the -dryrun flag, the following messages appear for each volume. The output concludes with the standard confirmation messages.

   Creating backup volume for <volume_name> on <date/time>
   {Recloning backup volume | Creating a new backup clone} <backup_volumeID> . . .done

If both the -dryrun and -verbose flags are included, the output begins with a statement summarizing the criteria being used to select the volumes, followed by a list of the volumes and the standard confirmation messages. The format of the criteria summary statement depends on which other options are provided:

EXAMPLES

The following example creates a backup version of every read/write volume known to the cell's Location Service whose name begins with the string user.

   % vos backupsys -prefix user

The following example creates a backup version of every read/write volume on the File Server fs3.your-cell-name.com.

   % vos backupsys -server fs3.your-cell-name.com

The following example creates a backup version of every read/write volume on the File Server fs1.your-cell-name.com except those whose name includes the string temp.

   % vos backupsys  -server fs1.your-cell-name.com -prefix '^.*temp'

The following example creates a backup version of every volume known to the Location Service, excluding those whose names contain the string source, but including those whose names contain the string source.current.

   % vos backupsys  -prefix '^.*source' -exclude -xprefix '^.*source\.current'

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

backup_addvolentry(8), vos(1), vos_addsite(1), vos_backup(1)

UNIX manual page for regexp(5)

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.