NAME

vos_lock - Locks a volume

SYNOPSIS

vos lock -id <volume name or ID> [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos lock command locks the indicated volume, blocking any operation that requires a modification to the volume metadata. Volume locks are acquired by most vos(1) command to ensure that the volume cannot be modified by another vos(1) command simultaneously. Locking a volume does not prevent Cache Managers from accessing or modifying the volume content.

Cell administrators can use the vos lock command to prevent the execution of vos(1) commands. Cell administrators that lock a volume must remember to vos_unlock(1) the volume at a later date.

The lock applies to all of the volume versions (read/write, read-only, backup) and not just the one specified with the -id argument.

To unlock a single volume, use the vos_unlock(1) command. To unlock all (or some) of the locked volumes, use the vos_unlockall(1) command.

CAUTIONS

The vos lock command will lock a volume preventing the operation of most vos(1) commands on the volume.

OPTIONS

-id <volume name or ID>

Specifies either the complete name or volume ID number of a volume of the any of the three types.

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

EXAMPLES

The following command locks the volume user.terry.

   % vos lock 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

vos(1), vos_unlock(1), vos_unlockall(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.