NAME

vos_shadow - Creates a shadow copy of a volume on a different server/partition

SYNOPSIS

vos shadow -id <volume name or ID on source> -toserver <machine name on destination> -topartition <partition name on destination> [-fromserver <machine name on source>] [-frompartition <partition name on source>] [-toname <volume name on destination>] [-toid <volume ID on destination>] [-offline] [-readonly] [-clone [<yes|no>]] [-incremental] [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos shadow command creates a shadow copy of a volume on a different file server and partition.

The vos command interpreter consults the Location Service to determine the File Server and partition to read the volume from. The -fromserver and -frompartition arguments can be provided to force the use of an explicit File Server and partition.

A shadow volume is a copy of a volume that is not listed with the Location Service. It is a primitive operation that is meant to be used when constructing backup or disaster recovery solutions outside the scope of the AuriStor File System administration commands.

CAUTIONS

This command is not supported by AuriStor, Inc. and is therefore hidden.

Using this command on a volume when the source volume is not the same as parent volume used to create the shadow will leave the destination volume in a unknown state.

Running vos syncfs or vos syncloc on a File Server containing shadow volumes will not update the Location Service with the shadowed Read/Write volumes as long as the entries for the source volumes still exist. In a disaster recovery situation the Location Service listings must be modified by the cell administrator based upon the desired results.

Currently, the maximum partition size and volume quota is 16 zettabytes (2^74 bytes). Note that tools such as fs_listquota(1) can only report sizes up to 2 terabytes (2^41 bytes) when accessing a volume housed on an IBM AFS or OpenAFS File Server.

OPTIONS

-id <volume name or ID>

Specifies either the complete name or volume ID number of a read/write volume.

-fromserver <machine name for source>

Identifies the file server machine where the source volume resides. Provide the machine's IP address or its host name (either fully qualified or using an unambiguous abbreviation). For details, see vos(1).

-frompartition <partition name for source>

Names the partition where the source volume resides. Provide the full partition name (for, example, /vicepa) or one of the abbreviated forms described in vos(1).

-toserver <machine name for destination>

Identifies the file server machine to which to copy the volume. Provide the machine's IP address or its host name (either fully qualified or using an unambiguous abbreviation). For details, see vos(1).

-topartition <partition name for destination>

Names the partition to which to copy the volume. Provide the full partition name (for, example, /vicepa) or one of the abbreviated forms described in vos(1).

-toname <volume name for new copy>

The complete name of the new volume to create.

-toid <volume ID for new copy>

The volume ID number to use for the new volume.

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

-clone [<yes|no>]

The -clone option defaults to yes. When set to yes, vos shadow copies 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.

-incremental

Copy the changes from the source volume to a previously created shadow volume.

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

OUTPUT

This command has no output unless -verbose is specified or there is an error.

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

vos(1), vos_backup(1), vos_copy(1), vos_move(1)

http://www.openafs.org/pipermail/openafs-info/2005-July/018469.html discusses motivation for the creation of this command.

http://workshop.openafs.org/afsbpw06/talks/drh.scs.html discusses one possible use for it.

COPYRIGHT

Copyright 2008 Jason Edgecombe <jason@rampaginggeek.com>

This documentation is covered by the BSD License as written in the doc/LICENSE file. This man page was written by Jason Edgecombe for OpenAFS.

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.