doc/man-pages/pod8/backup_addvolentry.pod

   1 =head1 NAME
   2
   3 backup addvolentry - Defines a volume entry in a volume set
   4
   5 =head1 SYNOPSIS
   6
   7 B<backup addvolentry -name> <I<volume set name>>  -server <I<machine name>>
   8 B<-partition> <I<partition name>>
   9                    -volumes <I<volume name (regular expression)>>
  10                    [B<-localauth>]  [B<-cell> <I<cell name>>]  [-help]
  11
  12 B<backup addvole -n> <I<volume set name>>  B<-s> <I<machine name>> -p <I<partition name>>
  13 B<-v> <I<volume name (regular expression)>>
  14                [B<-l>]  [B<-c> <I<cell name>>]  [-h]
  15
  16 =head1 DESCRIPTION
  17
  18 The backup addvolentry command adds a volume entry definition to
  19 the existing volume set named by the B<-name> argument. A
  20 volume entry definition can match one or more volumes, depending on the
  21 combination of the B<-server>, B<-partition>, and
  22 B<-volumes> arguments.
  23
  24 For the B<-server> and -partition arguments, provide
  25 either
  26
  27 =over 4
  28
  29 =item *
  30
  31 The name of one machine or partition
  32
  33
  34 =item *
  35
  36 The metacharacter expression .* (period and asterisk),
  37 which matches every machine name or partition name in the Volume Location
  38 Database (VLDB).
  39
  40
  41 =back
  42
  43 For the -volumes argument, specify a combination of alphanumeric
  44 characters and one or more metacharacters to wildcard part or all of the
  45 volume name. The B<Options> section lists the acceptable
  46 metacharacters.
  47
  48 =head1 CAUTIONS
  49
  50 It is best to issue this command in interactive mode. If issuing it
  51 at the shell prompt, enclose any strings containing metacharacters in double
  52 quotes, or escape the metacharacters with other delimiters, to prevent the
  53 shell from interpreting them. Adding volume entries to a temporary
  54 volume set is possible only within the interactive session in which the volume
  55 set was created.
  56
  57 =head1 OPTIONS
  58
  59 =over 4
  60
  61 =item -name
  62
  63 Names the volume set to which to add this volume entry definition.
  64 The volume set must already exist (use the B<backup addvolset> command
  65 to create it).
  66
  67 =item -server
  68
  69 Defines the set of one or more file server machines that house the volumes
  70 in the volume entry. Provide either one fully-qualified hostname (such
  71 as B<fs1.abc.com>) or the metacharacter expression
  72 B<.*> (period and asterisk), which matches all machine names in
  73 the VLDB.
  74
  75 =item -partition
  76
  77 Defines the set of one or more partitions that house the volumes in the
  78 volume entry. Provide either one complete partition name (such as
  79 B</vicepa>) or the metacharacter expression B<.*>
  80 (period and asterisk), which matches all partition names.
  81
  82 =item -volumes
  83
  84 Defines the set of one or more volumes included in the volume
  85 entry. Specify the volumes by name, by using any combination of regular
  86 alphanumeric characters and one or more of the following metacharacter
  87 expressions:
  88 L<(1)>
  89 L<(1)>
  90
  91 =over 4
  92
  93 =item .
  94
  95 The period matches any single character.
  96
  97 =item *
  98
  99 The asterisk matches zero or more instances of the preceding
 100 character. Combine it with any other alphanumeric character or
 101 metacharacter.
 102
 103 =item [ ]
 104
 105 Square brackets around a list of characters match a single instance of any
 106 of the characters, but no other characters; for example, B<[abc]>
 107 matches a single B<a> or B<b> or B<c>, but not
 108 B<d> or B<A>. This expression can be combined with the
 109 asterisk.
 110
 111 =item ^
 112
 113 The caret, when used as the first character in a square-bracketed set,
 114 designates a match with any single character I<except> the characters
 115 that follow it; for example, B<[^a]> matches any single character
 116 except lowercase B<a>. This expression can be combined with the
 117 asterisk.
 118
 119 =item \
 120
 121 A backslash preceding any of the metacharacters in this list makes it
 122 match its literal value only. For example, the expression
 123 B<\.> (backslash and period) matches a single period,
 124 B<\*> a single asterisk, and B<\\> a single backslash.
 125 Such expressions can be combined with the asterisk (for example,
 126 B<\.*> matches any number of periods).
 127
 128 =back
 129
 130 Perhaps the most common metacharacter expression is the period followed by
 131 an asterisk (B<.*>). This expression matches any string
 132 of any length, because the period matches any character and the asterisk means
 133 any number of that character. As mentioned, it is the only acceptable
 134 metacharacter expression for the B<-server> and B<-partition>
 135 arguments. In a volume definition it can stand alone (in which case it
 136 matches every volume listed in the VLDB), or can combine with regular
 137 characters. The following example matches any volume name that begins
 138 with the string B<user> and ends with B<backup>:
 139
 140    user.*backup
 141
 142 =item -localauth
 143
 144 Constructs a server ticket using a key from the local
 145 B</usr/afs/etc/KeyFile> file. The B<backup> command
 146 interpreter presents it to the Backup Server, Volume Server and VL Server
 147 during mutual authentication. Do not combine this flag with the
 148 B<-cell> argument. For more details, see the introductory
 149 B<backup> reference page.
 150
 151 =item -cell
 152
 153 Names the cell in which to run the command. Do not combine this
 154 argument with the B<-localauth> flag. For more details, see the
 155 introductory B<backup> reference page.
 156
 157 =item -help
 158
 159 Prints the online help for this command. All other valid options
 160 are ignored.
 161
 162 =back
 163
 164 =head1 EXAMPLES
 165
 166 The following command adds a volume entry to the volume set called
 167 B<sys>. The entry matches all volumes on any machine or
 168 partition whose names begin with the string B<sun4x_56> followed by a
 169 period:
 170
 171    backup> addvolentry sys .* .* sun4x_56\..*
 172
 173 The following command adds a volume entry to the volume set called
 174 B<fs2>, to match all volumes on the B</vicepb> partition of
 175 file server machine B<fs2.abc.com>. Because it is
 176 issued at the shell prompt, double quotes surround the metacharacters in the
 177 B<-volumes> argument. (The command is shown here on two lines
 178 only for legibility reasons.)
 179
 180    % backup addvolentry -name fs2 -server fs2.abc.com \
 181                         -partition /vicepb -volumes ".*"
 182
 183 The chapter in the I<IBM AFS Administration Guide> about
 184 configuring the AFS Backup System presents additional examples as well as
 185 advice on grouping volumes.
 186
 187 =head1 PRIVILEGE REQUIRED
 188
 189 The issuer must be listed in the /usr/afs/etc/UserList file on
 190 every machine where the Backup Server is running, or must be logged onto a
 191 server machine as the local superuser B<root> if the
 192 B<-localauth> flag is included.
 193
 194 =head1 SEE ALSO
 195
 196 L<backup(1)>,
 197 L<backup_addvolset(1)>,
 198 L<backup_delvolentry(1)>,
 199 L<backup_delvolset(1)>,
 200 L<backup_listvolsets(1)>
 201
 202 =head1 COPYRIGHT
 203
 204 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 205
 206 This documentation is covered by the IBM Public License Version 1.0.  It was
 207 converted from HTML to POD by software written by Chas Williams and Russ
 208 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.