3 backup addvolentry - Defines a volume entry in a volume set
7 backup addvolentry B<-name> I<volume set name> B<-server> I<machine name>
8 B<-partition> I<partition name>
9 B<-volumes> I<volume name (regular expression)>
10 [B<-localauth>] [B<-cell> I<cell name>] [B<-help>]
12 backup addvole B<-n> I<volume set name> B<-s> I<machine name> B<-p> I<partition name>
13 B<-v> I<volume name (regular expression)>
14 [B<-l>] [B<-c> I<cell name>] [B<-h>]
18 The C<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
21 of 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 B<.*> (period and asterisk), which
34 matches every machine name or partition name in the Volume
35 Location Database (VLDB).
39 For the B<-volumes> argument, specify a combination of alphanumeric
40 characters and one or more metacharacters to wildcard part or all of
41 the volume name. The B<Options> section lists the acceptable
50 Names the volume set to which to add this volume entry
51 definition. The volume set must already exist (use the C<backup
52 addvolset> command to create it).
56 Defines the set of one or more file server machines that house
57 the volumes in the volume entry. Provide either one
58 fully-qualified hostname (such as B<fs1.abc.com>) or the
59 metacharacter expression B<.*> (period and asterisk), which
60 matches all machine names in the VLDB.
64 Defines the set of one or more partitions that house the
65 volumes in the volume entry. Provide either one complete
66 partition name (such as B</vicepa>) or the metacharacter
67 expression B<.*> (period and asterisk), which matches all
72 Defines the set of one or more volumes included in the volume
73 entry. Specify the volumes by name, by using any combination of
74 regular alphanumeric characters and one or more of the
75 following metacharacter expressions:
81 The period matches any single character.
85 The asterisk matches zero or more instances of the
86 preceding character. Combine it with any other
87 alphanumeric character or metacharacter.
91 Square brackets around a list of characters match a
92 single instance of any of the characters, but no other
93 characters; for example, B<[abc]> matches a single B<a> or B<b> or
94 B<c>, but not B<d> or B<A>. This expression can be combined with
99 The caret, when used as the first character in a
100 square-bracketed set, designates a match with any single
101 character I<except> the characters that follow it; for
102 example, B<[^a]> matches any single character except
103 lowercase B<a>. This expression can be combined with the
108 A backslash preceding any of the metacharacters in this
109 list makes it match its literal value only. For example,
110 the expression B<\.> (backslash and period) matches a single
111 period, B<\*> a single asterisk, and B<\\> a single backslash.
112 Such expressions can be combined with the asterisk (for
113 example, B<\.*> matches any number of periods).
117 Perhaps the most common metacharacter expression is the period
118 followed by an asterisk (B<.*>). This expression matches any
119 string of any length, because the period matches any character
120 and the asterisk means any number of that character. As
121 mentioned, it is the only acceptable metacharacter expression
122 for the B<-server> and B<-partition> arguments. In a volume
123 definition it can stand alone (in which case it matches every
124 volume listed in the VLDB), or can combine with regular
125 characters. The following example matches any volume name that
126 begins with the string B<user> and ends with B<backup>:
132 Constructs a server ticket using a key from the local
133 B</usr/afs/etc/KeyFile> file. The C<backup> command interpreter
134 presents it to the Backup Server, Volume Server and VL Server
135 during mutual authentication. Do not combine this flag with the
136 B<-cell> argument. For more details, see the introductory L<backup(1)> reference page.
140 Names the cell in which to run the command. Do not combine this
141 argument with the B<-localauth> flag. For more details, see the
142 introductory L<backup(1)> reference page.
146 Prints the online help for this command. All other valid
153 The following command adds a volume entry to the volume set called
154 B<sys>. The entry matches all volumes on any machine or partition whose
155 names begin with the string B<sun4x_56> followed by a period:
157 backup> addvolentry sys .* .* sun4x_56\..*
159 The following command adds a volume entry to the volume set called
160 fs2, to match all volumes on the /vicepb partition of file server
161 machine fs2.abc.com. Because it is issued at the shell prompt, double
162 quotes surround the metacharacters in the -volumes argument. (The
163 command is shown here on two lines only for legibility reasons.)
165 backup addvolentry -name fs2 -server fs2.abc.com \
166 -partition /vicepb -volumes ".*"
168 The chapter in the IBM AFS Administration Guide about configuring the
169 AFS Backup System presents additional examples as well as advice on
172 =head1 PRIVILEGE REQUIRED
174 The issuer must be listed in the B</usr/afs/etc/UserList> file on every
175 machine where the Backup Server is running, or must be logged onto a
176 server machine as the local superuser B<root> if the B<-localauth> flag is
181 It is best to issue this command in interactive mode. If issuing it at
182 the shell prompt, enclose any strings containing metacharacters in
183 double quotes, or escape the metacharacters with other delimiters, to
184 prevent the shell from interpreting them. Adding volume entries to a
185 temporary volume set is possible only within the interactive session
186 in which the volume set was created.
190 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
192 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
193 Stanford Linear Accelerator Center, a department of Stanford University.
198 L<backup_addvolset(1)>,
199 L<backup_delvolentry(1)>,
200 L<backup_delvolset(1)>,
201 L<backup_listvolsets(1)>