doc/html/AdminReference/auarf063.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
   8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
  10 </HEAD><BODY>
  11 <!-- (C) IBM Corporation 2000. All Rights Reserved    -->
  12 <BODY bgcolor="ffffff">
  13 <!-- End Header Records  ============================================ -->
  14 <A NAME="Top_Of_Page"></A>
  15 <H1>Administration Reference</H1>
  16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf062.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf064.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
  17 <P>
  18 <H2><A NAME="HDRBK_ADDVOLENTRY" HREF="auarf002.htm#ToC_77">backup addvolentry</A></H2>
  19 <A NAME="IDX4239"></A>
  20 <A NAME="IDX4240"></A>
  21 <A NAME="IDX4241"></A>
  22 <A NAME="IDX4242"></A>
  23 <A NAME="IDX4243"></A>
  24 <A NAME="IDX4244"></A>
  25 <A NAME="IDX4245"></A>
  26 <A NAME="IDX4246"></A>
  27 <A NAME="IDX4247"></A>
  28 <A NAME="IDX4248"></A>
  29 <A NAME="IDX4249"></A>
  30 <A NAME="IDX4250"></A>
  31 <A NAME="IDX4251"></A>
  32 <A NAME="IDX4252"></A>
  33 <P><STRONG>Purpose</STRONG>
  34 <P>Defines a volume entry in a volume set
  35 <P><STRONG>Synopsis</STRONG>
  36 <PRE><B>backup addvolentry -name</B> &lt;<VAR>volume set name</VAR>>  <B>-server</B> &lt;<VAR>machine&nbsp;name</VAR>>
  37                    <B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>
  38                    <B>-volumes</B> &lt;<VAR>volume&nbsp;name&nbsp;(regular&nbsp;expression)</VAR>>
  39                    [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
  40
  41 <B>backup addvole -n</B> &lt;<VAR>volume set name</VAR>>  <B>-s</B> &lt;<VAR>machine&nbsp;name</VAR>> <B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>
  42                <B>-v</B> &lt;<VAR>volume&nbsp;name&nbsp;(regular&nbsp;expression)</VAR>>
  43                [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
  44 </PRE>
  45 <P><STRONG>Description</STRONG>
  46 <P>The <B>backup addvolentry</B> command adds a volume entry definition to
  47 the existing volume set named by the <B>-name</B> argument. A
  48 volume entry definition can match one or more volumes, depending on the
  49 combination of the <B>-server</B>, <B>-partition</B>, and
  50 <B>-volumes</B> arguments.
  51 <P>For the <B>-server</B> and <B>-partition</B> arguments, provide
  52 either
  53 <UL>
  54 <P><LI>The name of one machine or partition
  55 <P><LI>The metacharacter expression <B>.*</B> (period and asterisk),
  56 which matches every machine name or partition name in the Volume Location
  57 Database (VLDB).
  58 </UL>
  59 <P>For the <B>-volumes</B> argument, specify a combination of alphanumeric
  60 characters and one or more metacharacters to wildcard part or all of the
  61 volume name. The <B>Options</B> section lists the acceptable
  62 metacharacters.
  63 <P><STRONG>Cautions</STRONG>
  64 <P>It is best to issue this command in interactive mode. If issuing it
  65 at the shell prompt, enclose any strings containing metacharacters in double
  66 quotes, or escape the metacharacters with other delimiters, to prevent the
  67 shell from interpreting them. Adding volume entries to a temporary
  68 volume set is possible only within the interactive session in which the volume
  69 set was created.
  70 <P><STRONG>Options</STRONG>
  71 <DL>
  72 <P><DT><B>-name
  73 </B><DD>Names the volume set to which to add this volume entry definition.
  74 The volume set must already exist (use the <B>backup addvolset</B> command
  75 to create it).
  76 <P><DT><B>-server
  77 </B><DD>Defines the set of one or more file server machines that house the volumes
  78 in the volume entry. Provide either one fully-qualified hostname (such
  79 as <B>fs1.abc.com</B>) or the metacharacter expression
  80 <B>.*</B> (period and asterisk), which matches all machine names in
  81 the VLDB.
  82 <P><DT><B>-partition
  83 </B><DD>Defines the set of one or more partitions that house the volumes in the
  84 volume entry. Provide either one complete partition name (such as
  85 <B>/vicepa</B>) or the metacharacter expression <B>.*</B>
  86 (period and asterisk), which matches all partition names.
  87 <P><DT><B>-volumes
  88 </B><DD>Defines the set of one or more volumes included in the volume
  89 entry. Specify the volumes by name, by using any combination of regular
  90 alphanumeric characters and one or more of the following metacharacter
  91 expressions:
  92 <A NAME="IDX4253"></A>
  93 <A NAME="IDX4254"></A>
  94 <DL>
  95 <P><DT><B>.
  96 </B><DD>The period matches any single character.
  97 <P><DT><B>*
  98 </B><DD>The asterisk matches zero or more instances of the preceding
  99 character. Combine it with any other alphanumeric character or
 100 metacharacter.
 101 <P><DT><B>[ ]
 102 </B><DD>Square brackets around a list of characters match a single instance of any
 103 of the characters, but no other characters; for example, <B>[abc]</B>
 104 matches a single <B>a</B> or <B>b</B> or <B>c</B>, but not
 105 <B>d</B> or <B>A</B>. This expression can be combined with the
 106 asterisk.
 107 <P><DT><B>^
 108 </B><DD>The caret, when used as the first character in a square-bracketed set,
 109 designates a match with any single character <I>except</I> the characters
 110 that follow it; for example, <B>[^a]</B> matches any single character
 111 except lowercase <B>a</B>. This expression can be combined with the
 112 asterisk.
 113 <P><DT><B>\
 114 </B><DD>A backslash preceding any of the metacharacters in this list makes it
 115 match its literal value only. For example, the expression
 116 <B>\.</B> (backslash and period) matches a single period,
 117 <B>\*</B> a single asterisk, and <B>\\</B> a single backslash.
 118 Such expressions can be combined with the asterisk (for example,
 119 <B>\.*</B> matches any number of periods).
 120 </DL>
 121 <P>
 122 <P>Perhaps the most common metacharacter expression is the period followed by
 123 an asterisk (<B>.*</B>). This expression matches any string
 124 of any length, because the period matches any character and the asterisk means
 125 any number of that character. As mentioned, it is the only acceptable
 126 metacharacter expression for the <B>-server</B> and <B>-partition</B>
 127 arguments. In a volume definition it can stand alone (in which case it
 128 matches every volume listed in the VLDB), or can combine with regular
 129 characters. The following example matches any volume name that begins
 130 with the string <B>user</B> and ends with <B>backup</B>:
 131 <PRE>   <B>user.*backup</B>
 132
 133 </PRE>
 134 <P><DT><B>-localauth
 135 </B><DD>Constructs a server ticket using a key from the local
 136 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
 137 interpreter presents it to the Backup Server, Volume Server and VL Server
 138 during mutual authentication. Do not combine this flag with the
 139 <B>-cell</B> argument. For more details, see the introductory
 140 <B>backup</B> reference page.
 141 <P><DT><B>-cell
 142 </B><DD>Names the cell in which to run the command. Do not combine this
 143 argument with the <B>-localauth</B> flag. For more details, see the
 144 introductory <B>backup</B> reference page.
 145 <P><DT><B>-help
 146 </B><DD>Prints the online help for this command. All other valid options
 147 are ignored.
 148 </DL>
 149 <P><STRONG>Examples</STRONG>
 150 <P>The following command adds a volume entry to the volume set called
 151 <B>sys</B>. The entry matches all volumes on any machine or
 152 partition whose names begin with the string <B>sun4x_56</B> followed by a
 153 period:
 154 <PRE>   backup> <B>addvolentry sys .* .* sun4x_56\..*</B>
 155
 156 </PRE>
 157 <P>The following command adds a volume entry to the volume set called
 158 <B>fs2</B>, to match all volumes on the <B>/vicepb</B> partition of
 159 file server machine <B>fs2.abc.com</B>. Because it is
 160 issued at the shell prompt, double quotes surround the metacharacters in the
 161 <B>-volumes</B> argument. (The command is shown here on two lines
 162 only for legibility reasons.)
 163 <PRE>   % <B>backup addvolentry -name fs2 -server fs2.abc.com \
 164                         -partition /vicepb -volumes ".*"</B>
 165
 166 </PRE>
 167 <P>The chapter in the <I>IBM AFS Administration Guide</I> about
 168 configuring the AFS Backup System presents additional examples as well as
 169 advice on grouping volumes.
 170 <P><STRONG>Privilege Required</STRONG>
 171 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
 172 every machine where the Backup Server is running, or must be logged onto a
 173 server machine as the local superuser <B>root</B> if the
 174 <B>-localauth</B> flag is included.
 175 <P><STRONG>Related Information</STRONG>
 176 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
 177 <P><A HREF="auarf064.htm#HDRBK_ADDVOLSET">backup addvolset</A>
 178 <P><A HREF="auarf070.htm#HDRBK_DELVOLENTRY">backup delvolentry</A>
 179 <P><A HREF="auarf071.htm#HDRBK_DELVOLSET">backup delvolset</A>
 180 <P><A HREF="auarf082.htm#HDRBK_LISTVOLSETS">backup listvolsets</A>
 181 <P>
 182 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf062.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf064.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
 183 <!-- Begin Footer Records  ========================================== -->
 184 <P><HR><B>
 185 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 186 </B>
 187 <!-- End Footer Records  ============================================ -->
 188 <A NAME="Bot_Of_Page"></A>
 189 </BODY></HTML>