afsmonitor-document-usage-20040729
[openafs.git] / doc / html / AdminReference / auarf062.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="auarf061.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="auarf063.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_ADDHOST" HREF="auarf002.htm#ToC_76">backup addhost</A></H2>
19 <A NAME="IDX4229"></A>
20 <A NAME="IDX4230"></A>
21 <A NAME="IDX4231"></A>
22 <A NAME="IDX4232"></A>
23 <A NAME="IDX4233"></A>
24 <A NAME="IDX4234"></A>
25 <A NAME="IDX4235"></A>
26 <A NAME="IDX4236"></A>
27 <A NAME="IDX4237"></A>
28 <A NAME="IDX4238"></A>
29 <P><STRONG>Purpose</STRONG>
30 <P>Adds a Tape Coordinator entry to the Backup Database
31 <P><STRONG>Synopsis</STRONG>
32 <PRE><B>backup addhost -tapehost</B> &lt;<VAR>tape&nbsp;machine&nbsp;name</VAR>> [<B>-portoffset</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]
33                [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
34    
35 <B>backup addh -t</B> &lt;<VAR>tape&nbsp;machine&nbsp;name</VAR>>  [<B>-p</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]
36             [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
37 </PRE>
38 <P><STRONG>Description</STRONG>
39 <P>The <B>backup addhost</B> command creates a Tape Coordinator entry in
40 the Backup Database. The entry records
41 <UL>
42 <P><LI>The host name of the Tape Coordinator machine where the Tape Coordinator
43 (<B>butc</B>) process runs, as specified with the <B>-tapehost</B>
44 argument.
45 <P><LI>The Tape Coordinator's port offset number, as specified with the
46 <B>-portoffset</B> argument. An entry for the port offset must also
47 appear in the <B>/usr/afs/backup/tapeconfig</B> file on the Tape
48 Coordinator machine, where it is mapped to a UNIX device name (for a tape
49 device) or pathname (for a backup data file).
50 </UL>
51 <P>Each Tape Coordinator must have its own port offset number, and the command
52 fails if a Backup Database entry already exists for the requested port offset
53 number. To display existing Tape Coordinator entries, use the
54 <B>backup listhosts</B> command.
55 <P><STRONG>Options</STRONG>
56 <DL>
57 <P><DT><B>-tapehost
58 </B><DD>Specifies the fully-qualified hostname of the machine for which to create
59 a Tape Coordinator entry in the Backup Database. The machine must have
60 an entry in either the cell's naming service (such as the Domain Name
61 Service) or the host file (<B>/etc/hosts</B> or equivalent) on the machine
62 where the command is issued.
63 <P><DT><B>-portoffset
64 </B><DD>Specifies the Tape Coordinator's port offset number. Provide
65 an integer from the range <B>0</B> through <B>58510</B>, or omit this
66 argument to use the default value of <B>0</B> (zero). The value
67 must match the port offset number recorded for the same combination of Tape
68 Coordinator and tape device or file in the
69 <B>/usr/afs/backup/tapeconfig</B> file on the Tape Coordinator machine
70 named by the <B>-tapehost</B> argument.
71 <P><DT><B>-localauth
72 </B><DD>Constructs a server ticket using a key from the local
73 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
74 interpreter presents it to the Backup Server, Volume Server and VL Server
75 during mutual authentication. Do not combine this flag with the
76 <B>-cell</B> argument. For more details, see the introductory
77 <B>backup</B> reference page.
78 <P><DT><B>-cell
79 </B><DD>Names the cell in which to run the command. Do not combine this
80 argument with the <B>-localauth</B> flag. For more details, see the
81 introductory <B>backup</B> reference page.
82 <P><DT><B>-help
83 </B><DD>Prints the online help for this command. All other valid options
84 are ignored.
85 </DL>
86 <P><STRONG>Examples</STRONG>
87 <P>The following command creates an entry in the Backup Database that assigns
88 port offset number 4 to a Tape Coordinator running on the machine
89 <B>backup1.abc.com</B>:
90 <PRE>   % <B>backup addhost -tapehost backup1.abc.com -portoffset 4</B>
91    
92 </PRE>
93 <P>The following command creates a Backup Database entry that assigns port
94 offset number 0 to a Tape Coordinator on the machine
95 <B>backup3.abc.com</B>:
96 <PRE>   % <B>backup addhost backup3.abc.com</B>
97    
98 </PRE>
99 <P><STRONG>Privilege Required</STRONG>
100 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
101 every machine where the Backup Server is running, or must be logged onto a
102 server machine as the local superuser <B>root</B> if the
103 <B>-localauth</B> flag is included.
104 <P><STRONG>Related Information</STRONG>
105 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
106 <P><A HREF="auarf069.htm#HDRBK_DELHOST">backup delhost</A>
107 <P><A HREF="auarf081.htm#HDRBK_LISTHOSTS">backup listhosts</A>
108 <P>
109 <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="auarf061.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="auarf063.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> 
110 <!-- Begin Footer Records  ========================================== -->
111 <P><HR><B> 
112 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
113 </B> 
114 <!-- End Footer Records  ============================================ -->
115 <A NAME="Bot_Of_Page"></A>
116 </BODY></HTML>