.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "VOS_LOCK 1" .TH VOS_LOCK 1 2024-03-20 OpenAFS "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME vos_lock \- Locks a VLDB volume entry .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBvos lock\fR \fB\-id\fR\ <\fIvolume\ name\ or\ ID\fR> [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-verbose\fR] [\fB\-encrypt\fR] [\fB\-noresolve\fR] [\fB\-config\fR\ <\fIconfig\ directory\fR>] [\fB\-help\fR] .PP \&\fBvos lo\fR \fB\-i\fR\ <\fIvolume\ name\ or\ ID\fR> [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-noa\fR] [\fB\-l\fR] [\fB\-v\fR] [\fB\-e\fR] [\fB\-nor\fR] [\fB\-co\fR\ <\fIconfig\ directory\fR>] [\fB\-h\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" The \fBvos lock\fR command locks the Volume Location Database (VLDB) entry for the indicated volume, blocking any operation that requires a write to that entry. The lock applies to all of the volume versions associated with the entry, not just the one specified with the \fB\-id\fR argument. .PP To unlock a single VLDB entry, use the \fBvos unlock\fR command. To unlock several entries, or all locked entries in the VLDB, use the \fBvos unlockvldb\fR command. .SH CAUTIONS .IX Header "CAUTIONS" Do not use this command in normal circumstances. It is useful for guaranteeing that the volume stays unchanged when there is reason to believe that volume operations cannot properly lock VLDB volume entries as they normally do to synchronize with one another. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-id\fR <\fIvolume name or ID\fR>" 4 .IX Item "-id " Specifies either the complete name or volume ID number of a volume of the any of the three types. .IP "\fB\-cell\fR <\fIcell name\fR>" 4 .IX Item "-cell " Names the cell in which to run the command. Do not combine this argument with the \fB\-localauth\fR flag. For more details, see \fBvos\fR\|(1). .IP \fB\-noauth\fR 4 .IX Item "-noauth" Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not combine this flag with the \fB\-localauth\fR flag. For more details, see \&\fBvos\fR\|(1). .IP \fB\-localauth\fR 4 .IX Item "-localauth" Constructs a server ticket using a key from the local \&\fI/etc/openafs/server/KeyFile\fR file. The \fBvos\fR command interpreter presents it to the Volume Server and Volume Location Server during mutual authentication. Do not combine this flag with the \fB\-cell\fR argument or \&\fB\-noauth\fR flag. For more details, see \fBvos\fR\|(1). .IP \fB\-verbose\fR 4 .IX Item "-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. .IP \fB\-encrypt\fR 4 .IX Item "-encrypt" Encrypts the command so that the operation's results are not transmitted across the network in clear text. This option is available in OpenAFS versions 1.4.11 or later and 1.5.60 or later. .IP \fB\-noresolve\fR 4 .IX Item "-noresolve" Shows all servers as IP addresses instead of the DNS name. This is very useful when the server address is registered as 127.0.0.1 or when dealing with multi-homed servers. This option is available in OpenAFS versions 1.4.8 or later and 1.5.35 or later. .IP "\fB\-config\fR <\fIconfiguration directory\fR>" 4 .IX Item "-config " Set the location of the configuration directory to be used. This defaults to \&\fI/etc/openafs\fR, except if \fB\-localauth\fR is specified, in which case the default is \fI/etc/openafs/server\fR. This option allows the use of alternative configuration locations for testing purposes. .IP \fB\-help\fR 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH EXAMPLES .IX Header "EXAMPLES" The following command locks the VLDB entry for \f(CW\*(C`user.terry\*(C'\fR. .PP .Vb 1 \& % vos lock user.terry .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the machine specified with the \fB\-server\fR argument and on each database server machine. If the \fB\-localauth\fR flag is included, the issuer must instead be logged on to a server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBvos\fR\|(1), \&\fBvos_unlock\fR\|(1), \&\fBvos_unlockvldb\fR\|(1) .SH COPYRIGHT .IX Header "COPYRIGHT" IBM Corporation 2000. All Rights Reserved. .PP 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.