.\" Automatically generated by Pod::Man 4.14 (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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VOS 1" .TH VOS 1 "2023-12-24" "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 \- Introduction to the vos command suite .SH "DESCRIPTION" .IX Header "DESCRIPTION" The commands in the \fBvos\fR command suite are the administrative interface to the Volume Server and Volume Location (\s-1VL\s0) Server. System administrators use \fBvos\fR commands to create, move, delete, replicate, back up and examine volumes, among other operations. The \s-1VL\s0 Server automatically records in the Volume Location Database (\s-1VLDB\s0) changes in volume status and location that result from \fBvos\fR commands. .PP The operations invoked by most \fBvos\fR commands are idempotent, meaning that if an operation is interrupted by a network, server machine, or process outage, then a subsequent attempt at the same operation continues from the interruption point, rather than starting over at the beginning of the operation. Before executing a command, the Volume and \s-1VL\s0 Servers check the current state of the volumes and \s-1VLDB\s0 records to be altered by the command. If they are already in the desired end state (or a consistent intermediate state), there is no need to repeat the internal steps that brought them there. Idempotency does not apply if the command issuer explicitly interrupts the operation with the Ctrl-C command or another interrupt signal. In that case, the volume is left locked and the administrator must use the \fBvos unlock\fR command to unlock it before proceeding. .PP It is important that the \s-1VLDB\s0 accurately indicate the status of the volumes on file server machines at all times. \fBvldb.DB0\fR\|(5) and \&\fBafs_volume_header\fR\|(5) describe the information recorded in the \s-1VLDB\s0 and volume headers, respectively. If a \fBvos\fR command changes volume status, it automatically records the change in the corresponding \s-1VLDB\s0 entry. The most common cause of discrepancies between the \s-1VLDB\s0 and volume status on file server machines is interrupted operations; to restore consistency, use the \fBvos syncserv\fR and \&\fBvos syncvldb\fR commands. .PP There are several categories of commands in the vos command suite: .IP "\(bu" 4 Commands to create, move, and rename volumes: \&\fBvos backup\fR, \&\fBvos backupsys\fR, \&\fBvos changeloc\fR, \&\fBvos create\fR, \&\fBvos move\fR, and \fBvos rename\fR. .IP "\(bu" 4 Commands to remove \s-1VLDB\s0 volume records or volumes or both: \&\fBvos delentry\fR, \&\fBvos remove\fR, and \fBvos zap\fR. .IP "\(bu" 4 Commands to edit or display \s-1VLDB\s0 server entries: \&\fBvos changeaddr\fR, \&\fBvos listaddrs\fR \&\fBvos setaddrs\fR, and \fBvos remaddrs\fR. .IP "\(bu" 4 Commands to create, size, and restore dump files: \&\fBvos dump\fR, \&\fBvos restore\fR, and \fBvos size\fR. .IP "\(bu" 4 Commands to administer replicated volumes: \&\fBvos addsite\fR, \&\fBvos release\fR, and \fBvos remsite\fR. .IP "\(bu" 4 Commands to display \s-1VLDB\s0 records, volume headers, or both: \&\fBvos examine\fR, \&\fBvos listvldb\fR, and \fBvos listvol\fR. .IP "\(bu" 4 Commands to display information about partitions that house volumes: \&\fBvos listpart\fR and \fBvos partinfo\fR. .IP "\(bu" 4 Commands to restore consistency between the \s-1VLDB\s0 and volume headers: \&\fBvos syncserv\fR and \fBvos syncvldb\fR. .IP "\(bu" 4 Commands to lock and unlock \s-1VLDB\s0 entries: \&\fBvos lock\fR, \&\fBvos unlock\fR, and \fBvos unlockvldb\fR. .IP "\(bu" 4 A command to report Volume Server status: \&\fBvos status\fR. .IP "\(bu" 4 A command to end Volume Server transactions: \&\fBvos endtrans\fR. .IP "\(bu" 4 A command to change volume fields: \&\fBvos setfields\fR. .IP "\(bu" 4 Commands to obtain help: \&\fBvos apropos\fR and \fBvos help\fR. .SH "CAUTIONS" .IX Header "CAUTIONS" Currently, the maximum quota for a volume is 2 terabytes (2^41 bytes). Note that this only affects the volume's quota; a volume may grow much larger if the volume quota is disabled. However, volumes over 2 terabytes in size may be impractical to move, and may have their size incorrectly reported by some tools, such as \fBfs_listquota\fR\|(1). .SH "OPTIONS" .IX Header "OPTIONS" The following arguments and flags are available on many commands in the \&\fBvos\fR suite. The reference page for each command also lists them, but they are described here in greater detail. .IP "\fB\-cell\fR <\fIcell name\fR>" 4 .IX Item "-cell " Names the cell in which to run the command. It is acceptable to abbreviate the cell name to the shortest form that distinguishes it from the other entries in the \fI/etc/openafs/CellServDB\fR file on the local machine. If the \fB\-cell\fR argument is omitted, the command interpreter determines the name of the local cell by reading the following in order: .RS 4 .IP "\(bu" 4 The value of the \s-1AFSCELL\s0 environment variable. .IP "\(bu" 4 The local \fI/etc/openafs/ThisCell\fR file. .RE .RS 4 .Sp Do not combine the \fB\-cell\fR and \fB\-localauth\fR options. A command on which the \fB\-localauth\fR flag is included always runs in the local cell (as defined in the server machine's local \fI/etc/openafs/server/ThisCell\fR file), whereas a command on which the \fB\-cell\fR argument is included runs in the specified foreign cell. .RE .IP "\fB\-config\fR <\fIconfig directory\fR>" 4 .IX Item "-config " The location of the directory to use to obtain configuration information, including the CellServDB. This is primarily provided for testing purposes. .IP "\fB\-help\fR" 4 .IX Item "-help" Prints a command's online help message on the standard output stream. Do not combine this flag with any of the command's other options; when it is provided, the command interpreter ignores all other options, and only prints the help message. .IP "\fB\-localauth\fR" 4 .IX Item "-localauth" Constructs a server ticket using the server encryption key with the highest key version number in the local \fI/etc/openafs/server/KeyFile\fR file. The \&\fBvos\fR command interpreter presents the ticket, which never expires, to the Volume Server and \s-1VL\s0 Server during mutual authentication. .Sp Use this flag only when issuing a command on a server machine; client machines do not usually have a \fI/etc/openafs/server/KeyFile\fR file. The issuer of a command that includes this flag must be logged on to the server machine as the local superuser \f(CW\*(C`root\*(C'\fR. The flag is useful for commands invoked by an unattended application program, such as a process controlled by the \s-1UNIX\s0 \fBcron\fR utility or by a cron entry in the machine's \&\fI/etc/openafs/BosConfig\fR file. It is also useful if an administrator is unable to authenticate to \s-1AFS\s0 but is logged in as the local superuser \&\fBroot\fR. .Sp Do not combine the \fB\-cell\fR and \fB\-localauth\fR options. A command on which the \fB\-localauth\fR flag is included always runs in the local cell (as defined in the server machine's local \fI/etc/openafs/server/ThisCell\fR file), whereas a command on which the \fB\-cell\fR argument is included runs in the specified foreign cell. Also, do not combine the \fB\-localauth\fR and \&\fB\-noauth\fR flags. .IP "\fB\-noauth\fR" 4 .IX Item "-noauth" Establishes an unauthenticated connection to the Volume Server and \s-1VL\s0 Server, in which the servers treat the issuer as the unprivileged user \&\f(CW\*(C`anonymous\*(C'\fR. It is useful only when authorization checking is disabled on the server machine (during the installation of a file server machine or when the \fBbos setauth\fR command has been used during other unusual circumstances). In normal circumstances, the servers allow only privileged users to issue commands that change the status of a volume or \s-1VLDB\s0 record, and refuses to perform such an action even if the \&\fB\-noauth\fR flag is provided. Do not combine the \fB\-noauth\fR and \&\fB\-localauth\fR flags. .IP "\fB\-partition\fR <\fIpartition name\fR>" 4 .IX Item "-partition " Identifies the \s-1AFS\s0 server partition on a file server machine that houses, or is to house, the volumes of interest, or about which to list information. The \fBvos\fR command interpreter accepts any of the following four name formats: .Sp .Vb 2 \& /vicepa = vicepa = a = 0 \& /vicepb = vicepb = b = 1 .Ve .Sp After /vicepz (for which the index is 25) comes .Sp .Vb 2 \& /vicepaa = vicepaa = aa = 26 \& /vicepab = vicepab = ab = 27 .Ve .Sp and so on through .Sp .Vb 1 \& /vicepiv = vicepiv = iv = 255 .Ve .Sp The \fB\-frompartition\fR and \fB\-topartition\fR arguments to the \&\fBvos move\fR command also accept this notation. .IP "\fB\-server\fR <\fImachine name\fR>" 4 .IX Item "-server " Identifies the file server machine that houses, or is to house, the volumes or \s-1AFS\s0 server partitions of interest. Provide the machine's \s-1IP\s0 address in dotted decimal format, its fully qualified host name (for example, \f(CW\*(C`fs1.example.com\*(C'\fR), or the shortest abbreviated form of its host name that distinguishes it from other machines. Successful use of an abbreviated form depends on the availability of a name resolution service (such as the Domain Name Service or a local host table) at the time the command is issued. .Sp The \fB\-fromserver\fR and \fB\-toserver\fR arguments to the \&\fBvos move\fR command also accept these name formats. .IP "\fB\-noresolve\fR" 4 .IX Item "-noresolve" Shows all servers as \s-1IP\s0 addresses instead of the \s-1DNS\s0 name. This is very useful when the server address is registered as 127.0.0.1 or when dealing with multi-homed servers. The \fB\-noresolve\fR option is available in OpenAFS versions 1.4.8 or later and 1.5.35 or later. .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. .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" To issue most vos commands, the issuer must be listed in the \&\fI/etc/openafs/server/UserList\fR file on each server machine that houses or is to house an affected volume, and on each database server machine. The most predictable performance results if all database server and file server machines in the cell share a common \fIUserList\fR file. Alternatively, if the \fB\-localauth\fR flag is included, the issuer must be logged on to a server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .PP To issue a vos command that only displays information, no privilege is required. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBvos_addsite\fR\|(1), \&\fBvos_apropos\fR\|(1), \&\fBvos_backup\fR\|(1), \&\fBvos_backupsys\fR\|(1), \&\fBvos_changeaddr\fR\|(1), \&\fBvos_convertROtoRW\fR\|(1), \&\fBvos_clone\fR\|(1), \&\fBvos_copy\fR\|(1), \&\fBvos_create\fR\|(1), \&\fBvos_delentry\fR\|(1), \&\fBvos_dump\fR\|(1), \&\fBvos_endtrans\fR\|(1), \&\fBvos_examine\fR\|(1), \&\fBvos_help\fR\|(1), \&\fBvos_listaddrs\fR\|(1), \&\fBvos_listpart\fR\|(1), \&\fBvos_listvldb\fR\|(1), \&\fBvos_listvol\fR\|(1), \&\fBvos_lock\fR\|(1), \&\fBvos_move\fR\|(1), \&\fBvos_partinfo\fR\|(1), \&\fBvos_release\fR\|(1), \&\fBvos_remove\fR\|(1), \&\fBvos_remsite\fR\|(1), \&\fBvos_rename\fR\|(1), \&\fBvos_restore\fR\|(1), \&\fBvos_setfields\fR\|(1), \&\fBvos_shadow\fR\|(1), \&\fBvos_size\fR\|(1), \&\fBvos_status\fR\|(1), \&\fBvos_syncserv\fR\|(1), \&\fBvos_syncvldb\fR\|(1), \&\fBvos_unlock\fR\|(1), \&\fBvos_unlockvldb\fR\|(1), \&\fBvos_zap\fR\|(1), \&\fBCellServDB\fR\|(5), \&\fBUserList\fR\|(5) .SH "COPYRIGHT" .IX Header "COPYRIGHT" \&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.