NAME

vos_size - Computes the size of a volume dump

SYNOPSIS

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

DESCRIPTION

The vos size command shows the size of a volume's dump for backup purposes. The size of the dump is likely to be larger than the volume size as reported by vos examine or fs listquota commands. The size is shown in bytes.

This command is intended for use with backup systems that require an estimate of the size of the volume dumps before performing them. For example, to pre-allocate space.

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

-partition <partition name>

Specifies the partition on which the volume resides. Provide the -server argument along with this one.

-server <machine name>

Specifies the file server machine on which the volume resides. Provide a fully qualified host name, an IP address or UUID as reported by vos listfs.

-dump

Show the size of the volume dump for the specified volume. Currently, this flag should always be given for vos size to give useful information. It is present to allow this command to provide other size estimates in the future.

-time <dump from time>

Specifies whether the dump is full or incremental. Omit this argument to size a full dump. See vos dump for the valid values for this option.

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

OUTPUT

When run without -verbose, the output will be:

   Volume: <volume>
   dump_size: <size>

where <volume> is the name of the volume and <size> is the size of the dump in bytes. With -verbose, additional status messages will be printed between those two lines.

EXAMPLES

Sizing the volume user.thoron:

   % vos size user.thoron -dump
   Volume: user.thoron
   dump_size: 36430

or, more verbosely:

   % vos size user.thoron -dump -verbose
   Volume: user.thoron
   Starting transaction on volume 2003434023... done
   Getting size of volume on volume 2003434023... done
   Ending transaction on volume 2003434023... done
   dump_size: 36430

Sizing an incremental dump for the same volume:

   % vos size -id user.thoron -time '05/04/2007 00:00:00' -dump 
   Volume: user.thoron
   dump_size: 21095

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

fs_listquota(1), vos_dump(1), vos_examine(1)

COPYRIGHT

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