3 backup addvolentry - Defines a volume entry in a volume set
7 B<backup addvolentry> B<-name> <I<volume set name>>
8 B<-server> <I<machine name>> B<-partition> <I<partition name>>
9 B<-volumes> <I<volume name (regular expression)>>
10 [B<-localauth>] [B<-cell> <I<cell name>>] [B<-help>]
12 B<backup addvole> B<-n> <I<volume set name>> B<-s> <I<machine name>>
13 B<-p> <I<partition name>> B<-v> <I<volume name (regular expression)>>
14 [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
18 The B<backup addvolentry> command adds a volume entry definition to the
19 existing volume set named by the B<-name> argument. A volume entry
20 definition can match one or more volumes, depending on the combination of
21 the B<-server>, B<-partition>, and B<-volumes> arguments.
23 For the B<-server> and B<-partition> arguments, provide either
29 The name of one machine or partition.
33 The metacharacter expression .* (period and asterisk), which matches every
34 machine name or partition name in the Volume Location Database (VLDB).
38 For the B<-volumes> argument, specify a combination of alphanumeric
39 characters and one or more metacharacters to wildcard part or all of the
40 volume name. L<OPTIONS> lists the acceptable metacharacters.
44 It is best to issue this command in interactive mode. If issuing it at the
45 shell prompt, enclose any strings containing metacharacters in double
46 quotes, or escape the metacharacters with other delimiters, to prevent the
47 shell from interpreting them. Adding volume entries to a temporary volume
48 set is possible only within the interactive session in which the volume
55 =item B<-name> <I<volume set name>>
57 Names the volume set to which to add this volume entry definition. The
58 volume set must already exist (use the B<backup addvolset> command to
61 =item B<-server> <I<machine name>>
63 Defines the set of one or more file server machines that house the volumes
64 in the volume entry. Provide either one fully-qualified hostname (such as
65 C<fs1.abc.com>) or the metacharacter expression C<.*> (period and
66 asterisk), which matches all machine names in the VLDB.
68 =item B<-partition> <I<partition name>>
70 Defines the set of one or more partitions that house the volumes in the
71 volume entry. Provide either one complete partition name (such as
72 C</vicepa>) or the metacharacter expression C<.*> (period and asterisk),
73 which matches all partition names.
75 =item B<-volumes> <I<volume name>>
77 Defines the set of one or more volumes included in the volume
78 entry. Specify the volumes by name, by using any combination of regular
79 alphanumeric characters and one or more of the following metacharacter
86 The period matches any single character.
90 The asterisk matches zero or more instances of the preceding character.
91 Combine it with any other alphanumeric character or metacharacter.
95 Square brackets around a list of characters match a single instance of any
96 of the characters, but no other characters; for example, C<[abc]> matches
97 a single C<a> or C<b> or C<c>, but not C<d> or C<A>. This expression can
98 be combined with the asterisk.
102 The caret, when used as the first character in a square-bracketed set,
103 designates a match with any single character I<except> the characters that
104 follow it; for example, C<[^a]> matches any single character except
105 lowercase C<a>. This expression can be combined with the asterisk.
109 A backslash preceding any of the metacharacters in this list makes it
110 match its literal value only. For example, the expression C<\.> (backslash
111 and period) matches a single period, C<\*> a single asterisk, and C<\\> a
112 single backslash. Such expressions can be combined with the asterisk (for
113 example, C<\.*> matches any number of periods).
117 Perhaps the most common metacharacter expression is the period followed by
118 an asterisk (C<.*>). This expression matches any string of any length,
119 because the period matches any character and the asterisk means any number
120 of that character. As mentioned, it is the only acceptable metacharacter
121 expression for the B<-server> and B<-partition> arguments. In a volume
122 definition it can stand alone (in which case it matches every volume
123 listed in the VLDB), or can combine with regular characters. The following
124 example matches any volume name that begins with the string C<user> and
131 Constructs a server ticket using a key from the local
132 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
133 it to the Backup Server, Volume Server and VL Server during mutual
134 authentication. Do not combine this flag with the B<-cell> argument. For
135 more details, see L<backup(8)>.
137 =item B<-cell> <I<cell name>>
139 Names the cell in which to run the command. Do not combine this argument
140 with the B<-localauth> flag. For more details, see L<backup(8)>.
144 Prints the online help for this command. All other valid options are
151 The following command adds a volume entry to the volume set called
152 C<sys>. The entry matches all volumes on any machine or partition whose
153 names begin with the string C<sun4x_56> followed by a period:
155 backup> addvolentry sys .* .* sun4x_56\..*
157 The following command adds a volume entry to the volume set called C<fs2>,
158 to match all volumes on the F</vicepb> partition of file server machine
159 C<fs2.abc.com>. Because it is issued at the shell prompt, double quotes
160 surround the metacharacters in the B<-volumes> argument. (The command is
161 shown here on two lines only for legibility reasons.)
163 % backup addvolentry -name fs2 -server fs2.abc.com \
164 -partition /vicepb -volumes ".*"
166 The chapter in the I<IBM AFS Administration Guide> about configuring the
167 AFS Backup System presents additional examples as well as advice on
170 =head1 PRIVILEGE REQUIRED
172 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
173 machine where the Backup Server is running, or must be logged onto a
174 server machine as the local superuser C<root> if the B<-localauth> flag is
180 L<backup_addvolset(8)>,
181 L<backup_delvolentry(8)>,
182 L<backup_delvolset(8)>,
183 L<backup_listvolsets(8)>
187 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
189 This documentation is covered by the IBM Public License Version 1.0. It was
190 converted from HTML to POD by software written by Chas Williams and Russ
191 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.