.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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_BACKUPSYS 1" .TH VOS_BACKUPSYS 1 "2021-01-14" "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_backupsys \- Creates a backup volume for several read/write volumes .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBvos backupsys\fR [\fB\-prefix\fR\ <\fIcommon\ prefix\ on\ volume(s)\fR>+] [\fB\-server\fR\ <\fImachine\ name\fR>] [\fB\-partition\fR\ <\fIpartition\ name\fR>] [\fB\-exclude\fR] [\fB\-xprefix\fR\ <\fInegative\ prefix\ on\ volume(s)\fR>+] [\fB\-dryrun\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 backups\fR [\fB\-pr\fR\ <\fIcommon\ prefix\ on\ volume(s)\fR>+] [\fB\-s\fR\ <\fImachine\ name\fR>] [\fB\-pa\fR\ <\fIpartition\ name\fR>] [\fB\-ex\fR] [\fB\-x\fR\ <\fInegative\ prefix\ on\ volume(s)\fR>+] [\fB\-d\fR] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-noa\fR] [\fB\-l\fR] [\fB\-v\fR] [\fB\-en\fR] [\fB\-nor\fR] [\fB\-co\fR\ <\fIconfig\ directory\fR>] [\fB\-h\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBvos backupsys\fR command clones each indicated read/write volume to create a backup version, placing each clone at the same site as its read/write source version. It assigns each clone the same name as the read/write source, adding a \f(CW\*(C`.backup\*(C'\fR extension. It assigns the volume \s-1ID\s0 number already allocated for the backup version in the Volume Location Database (\s-1VLDB\s0). If a backup version already exists for a given volume, the new clone replaces it. .PP To clone every read/write volume listed in the \s-1VLDB,\s0 omit all of the command's options. Otherwise, combine the command's options to clone various groups of volumes. The options use one of two basic criteria to select volumes: location (the \fB\-server\fR and \fB\-partition\fR arguments) or presence in the volume name of one of a set of specified character strings (the \fB\-prefix\fR, \fB\-exclude\fR, and \fB\-xprefix\fR options). .PP To clone only volumes that reside on one file server machine, include the \&\fB\-server\fR argument. To clone only volumes that reside on one partition, combine the \fB\-server\fR and \fB\-partition\fR arguments. The \fB\-partition\fR argument can also be used alone to clone volumes that reside on the indicated partition on every file server machine. These arguments can be combined with those that select volumes based on their names. .PP Combine the \fB\-prefix\fR, \-exclude, and \fB\-xprefix\fR options (with or without the \fB\-server\fR and \fB\-partition\fR arguments) in the indicated ways to select volumes based on character strings contained in their names: .IP "\(bu" 4 To clone every read/write volume at the specified location whose name includes one of a set of specified character strings (for example, begins with \f(CW\*(C`user.\*(C'\fR or includes the string \f(CW\*(C`afs\*(C'\fR), use the \fB\-prefix\fR argument or combine the \fB\-xprefix\fR and \fB\-exclude\fR options. .IP "\(bu" 4 To clone every read/write volume at the specified location except those whose name includes one of a set of specified character strings, use the \&\fB\-xprefix\fR argument or combine the \fB\-prefix\fR and \fB\-exclude\fR options. .IP "\(bu" 4 To clone every read/write volume at the specified location whose name includes one of one of a set of specified character strings, except those whose names include one of a different set of specified character strings, combine the \fB\-prefix\fR and \fB\-xprefix\fR arguments. The command creates a list of all volumes that match the \fB\-prefix\fR argument and then removes from the list the volumes that match the \fB\-xprefix\fR argument. For effective results, the strings specified by the \fB\-xprefix\fR argument must designate a subset of the volumes specified by the \fB\-prefix\fR argument. .Sp If the \fB\-exclude\fR flag is combined with the \fB\-prefix\fR and \fB\-xprefix\fR arguments, the command creates a list of all volumes that do not match the \&\fB\-prefix\fR argument and then adds to the list any volumes that match the \&\fB\-xprefix\fR argument. As when the \fB\-exclude\fR flag is not used, the result is effective only if the strings specified by the \fB\-xprefix\fR argument designate a subset of the volumes specified by the \fB\-prefix\fR argument. .PP The \fB\-prefix\fR and \fB\-xprefix\fR arguments both accept multiple values, which can be used to define disjoint groups of volumes. Each value can be one of two types: .IP "\(bu" 4 A simple character string, which matches volumes whose name begin with the string. All characters are interpreted literally (that is, characters that potentially have special meaning to the command shell, such as the period, have only their literal meaning). .IP "\(bu" 4 A regular expression, which matches volumes whose names contain the expressions. Place a caret (\f(CW\*(C`^\*(C'\fR) at the beginning of the expression, and enclose the entire string in single quotes (\f(CW\*(Aq\*(Aq\fR). Explaining regular expressions is outside the scope of this reference page; see the \s-1UNIX\s0 manual page for \fBregexp\fR\|(5) or (for a brief introduction) \&\fBbackup_addvolentry\fR\|(8). As an example, the following expression matches volumes that have the string \f(CW\*(C`aix\*(C'\fR anywhere in their names: .Sp .Vb 1 \& \-prefix \*(Aq^.*aix\*(Aq .Ve .PP To display a list of the volumes to be cloned, without actually cloning them, include the \fB\-dryrun\fR flag. To display a statement that summarizes the criteria being used to select volume, include the \fB\-verbose\fR flag. .PP This command can be used to clone a single read/write volume; specify its complete name as the \fB\-prefix\fR argument. However, it is more efficient to use the \fBvos backup\fR command, which employs a more streamlined technique for finding a single volume. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-prefix\fR <\fIcommon prefix\fR>" 4 .IX Item "-prefix " Specifies one or more simple character strings or regular expressions of any length; a volume whose name includes the string is placed on the set of volumes to be cloned. Include field separators (such as periods) if appropriate. This argument can be combined with any combination of the \&\fB\-server\fR, \fB\-partition\fR, \fB\-exclude\fR, and \fB\-xprefix\fR options. .IP "\fB\-server\fR <\fImachine name\fR>" 4 .IX Item "-server " Identifies the file server machine where each read/write source volume resides. Provide the machine's \s-1IP\s0 address or its host name (either fully qualified or using an unambiguous abbreviation). For details, see \&\fBvos\fR\|(1). .Sp This argument can be combined with any combination of the \fB\-prefix\fR, \&\fB\-partition\fR, \fB\-exclude\fR, and \fB\-xprefix\fR options. .IP "\fB\-partition\fR <\fIpartition name\fR>" 4 .IX Item "-partition " Identifies the partition where each read/write source volume resides. Provide the partition's complete name with preceding slash (for example, \f(CW\*(C`/vicepa\*(C'\fR) or use one of the three acceptable abbreviated forms. For details, see \fBvos\fR\|(1). .Sp This argument can be combined with any combination of the \fB\-prefix\fR, \&\fB\-server\fR, \fB\-exclude\fR, and \fB\-xprefix\fR options. .IP "\fB\-exclude\fR" 4 .IX Item "-exclude" Reverses the meaning of the \fB\-prefix\fR or \fB\-xprefix\fR argument. This flag can be combined with any combination of the \fB\-prefix\fR, \fB\-server\fR, \&\fB\-partition\fR, and \fB\-xprefix\fR options. .IP "\fB\-xprefix\fR <\fInegative prefix\fR>" 4 .IX Item "-xprefix " Specifies a simple character string or regular expression of any length; a volume whose name includes the string is removed from the set of volumes to be cloned. Include field separators (such as periods) if appropriate. This argument can be combined with any combination of the \&\fB\-prefix\fR, \fB\-server\fR, \fB\-partition\fR, and \fB\-exclude\fR options. .IP "\fB\-dryrun\fR" 4 .IX Item "-dryrun" Displays on the standard output stream a list of the volumes to be cloned, without actually cloning them. .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 \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. 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 "OUTPUT" .IX Header "OUTPUT" The command generates the following messages on the standard output stream to confirm that the operation was successful: .PP .Vb 2 \& done \& Total volumes backed up: ; failed to backup: .Ve .PP If the \fB\-dryrun\fR flag is included, a list of the volumes to be backed up precedes the standard confirmation messages. .PP If the \fB\-verbose\fR flag is included but not the \fB\-dryrun\fR flag, the following messages appear for each volume. The output concludes with the standard confirmation messages. .PP .Vb 2 \& Creating backup volume for on \& {Recloning backup volume | Creating a new backup clone} . . .done .Ve .PP If both the \fB\-dryrun\fR and \fB\-verbose\fR flags are included, the output begins with a statement summarizing the criteria being used to select the volumes, followed by a list of the volumes and the standard confirmation messages. The format of the criteria summary statement depends on which other options are provided: .IP "\(bu" 4 If only the \fB\-prefix\fR argument is provided, or the \fB\-xprefix\fR and \&\fB\-exclude\fR options are combined: .Sp .Vb 1 \& Would have backed up volumes which are prefixed with [or ] . . .Ve .IP "\(bu" 4 If only the \fB\-xprefix\fR argument is provided, or the \fB\-prefix\fR and \&\fB\-exclude\fR options are combined: .Sp .Vb 1 \& Would have backed up volumes which are not prefixed with [nor ] . . .Ve .IP "\(bu" 4 If the \fB\-prefix\fR and \fB\-xprefix\fR arguments are combined: .Sp .Vb 2 \& Would have backed up volumes which are prefixed with [or ] \e \& removing those which are prefixed with [or ] . . .Ve .IP "\(bu" 4 If the \fB\-prefix\fR, \fB\-xprefix\fR, and \fB\-exclude\fR options are provided: .Sp .Vb 2 \& Would have backed up volumes which are not prefixed with [nor ] \e \& adding those which are prefixed with [or ] . . .Ve .SH "EXAMPLES" .IX Header "EXAMPLES" The following example creates a backup version of every read/write volume listed in the cell's \s-1VLDB\s0 whose name begins with the string \fBuser\fR. .PP .Vb 1 \& % vos backupsys \-prefix user .Ve .PP The following example, appropriate in the Example Corporation cell, creates a backup version of every read/write volume on the file server machine \&\f(CW\*(C`fs3.example.com\*(C'\fR. .PP .Vb 1 \& % vos backupsys \-server fs3.example.com .Ve .PP The following example, appropriate in the Example Organization cell, creates a backup version of every read/write volume on the file server machine \&\f(CW\*(C`db1.example.org\*(C'\fR except those whose name includes the string \f(CW\*(C`temp\*(C'\fR. .PP .Vb 1 \& % vos backupsys \-server db1.example.org \-prefix \*(Aq^.*temp\*(Aq .Ve .PP The following example creates a backup version of every volume listed in the cell's \s-1VLDB,\s0 excluding those whose names contain the string \f(CW\*(C`source\*(C'\fR, but including those whose names contain the string \f(CW\*(C`source.current\*(C'\fR. .PP .Vb 1 \& % vos backupsys \-prefix \*(Aq^.*source\*(Aq \-exclude \-xprefix \*(Aq^.*source\e.current\*(Aq .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" \&\fBbackup_addvolentry\fR\|(8), \&\fBvos\fR\|(1), \&\fBvos_backup\fR\|(1) .PP \&\s-1UNIX\s0 manual page for \fBregexp\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.