.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BACKUP_ADDHOST 8"
.TH BACKUP_ADDHOST 8 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
backup_addhost \- Adds a Tape Coordinator entry to the Backup Database
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBbackup addhost\fR \fB\-tapehost\fR\ <\fItape\ machine\ name\fR>
    [\fB\-portoffset\fR\ <\fITC\ port\ offset\fR>]
    [\fB\-localauth\fR] [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-help\fR]
.PP
\&\fBbackup addh\fR \fB\-t\fR\ <\fItape\ machine\ name\fR>
    [\fB\-p\fR\ <\fITC\ port\ offset\fR>]
    [\fB\-l\fR] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBbackup addhost\fR command creates a Tape Coordinator entry in the
Backup Database. The entry records
.IP \(bu 4
The host name of the Tape Coordinator machine where the Tape Coordinator
(\fBbutc\fR) process runs, as specified with the \fB\-tapehost\fR argument.
.IP \(bu 4
The Tape Coordinator's port offset number, as specified with the
\&\fB\-portoffset\fR argument. An entry for the port offset must also appear in
the \fI/var/lib/openafs/backup/tapeconfig\fR file on the Tape Coordinator machine,
where it is mapped to a UNIX device name (for a tape device) or pathname
(for a backup data file).
.PP
Each Tape Coordinator must have its own port offset number, and the
command fails if a Backup Database entry already exists for the requested
port offset number. To display existing Tape Coordinator entries, use the
\&\fBbackup listhosts\fR command.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-tapehost\fR <\fItape machine name\fR>" 4
.IX Item "-tapehost <tape machine name>"
Specifies the fully-qualified hostname of the machine for which to create
a Tape Coordinator entry in the Backup Database. The machine must have an
entry in either the cell's naming service (such as the Domain Name
Service) or the host file (\fI/etc/hosts\fR or equivalent) on the machine
where the command is issued.
.IP "\fB\-portoffset\fR <\fITC port offset\fR>" 4
.IX Item "-portoffset <TC port offset>"
Specifies the Tape Coordinator's port offset number. Provide an integer
from the range \f(CW0\fR through \f(CW58510\fR, or omit this argument to use the
default value of \f(CW0\fR (zero). The value must match the port offset number
recorded for the same combination of Tape Coordinator and tape device or
file in the \fI/var/lib/openafs/backup/tapeconfig\fR file on the Tape Coordinator
machine named by the \fB\-tapehost\fR argument.
.IP \fB\-localauth\fR 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR file. The \fBbackup\fR command interpreter presents
it to the Backup Server, Volume Server and VL Server during mutual
authentication. Do not combine this flag with the \fB\-cell\fR argument. For
more details, see \fBbackup\fR\|(8).
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbackup\fR\|(8).
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH EXAMPLES
.IX Header "EXAMPLES"
The following command creates an entry in the Backup Database that assigns
port offset number 4 to a Tape Coordinator running on the machine
\&\f(CW\*(C`backup1.example.com\*(C'\fR:
.PP
.Vb 1
\&   % backup addhost \-tapehost backup1.example.com \-portoffset 4
.Ve
.PP
The following command creates a Backup Database entry that assigns port
offset number 0 to a Tape Coordinator on the machine \f(CW\*(C`backup3.example.com\*(C'\fR:
.PP
.Vb 1
\&   % backup addhost backup3.example.com
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on every
machine where the Backup Server is running, or must be logged onto a
server machine as the local superuser \f(CW\*(C`root\*(C'\fR if the \fB\-localauth\fR flag is
included.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbackup\fR\|(8),
\&\fBbackup_delhost\fR\|(8),
\&\fBbackup_listhosts\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.