HCoop / hcoop / debian / openafs.git / blame
| Commit | Line | Data |
|---|---|---|
| 805e021f CE |
1 | =head1 NAME |
| 2 | ||
| 3 | backup_addhost - Adds a Tape Coordinator entry to the Backup Database | |
| 4 | ||
| 5 | =head1 SYNOPSIS | |
| 6 | ||
| 7 | =for html | |
| 8 | <div class="synopsis"> | |
| 9 | ||
| 10 | B<backup addhost> S<<< B<-tapehost> <I<tape machine name>> >>> | |
| 11 | S<<< [B<-portoffset> <I<TC port offset>>] >>> | |
| 12 | [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>] | |
| 13 | ||
| 14 | B<backup addh> S<<< B<-t> <I<tape machine name>> >>> | |
| 15 | S<<< [B<-p> <I<TC port offset>>] >>> | |
| 16 | [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>] | |
| 17 | ||
| 18 | =for html | |
| 19 | </div> | |
| 20 | ||
| 21 | =head1 DESCRIPTION | |
| 22 | ||
| 23 | The B<backup addhost> command creates a Tape Coordinator entry in the | |
| 24 | Backup Database. The entry records | |
| 25 | ||
| 26 | =over 4 | |
| 27 | ||
| 28 | =item * | |
| 29 | ||
| 30 | The host name of the Tape Coordinator machine where the Tape Coordinator | |
| 31 | (B<butc>) process runs, as specified with the B<-tapehost> argument. | |
| 32 | ||
| 33 | =item * | |
| 34 | ||
| 35 | The Tape Coordinator's port offset number, as specified with the | |
| 36 | B<-portoffset> argument. An entry for the port offset must also appear in | |
| 37 | the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator machine, | |
| 38 | where it is mapped to a UNIX device name (for a tape device) or pathname | |
| 39 | (for a backup data file). | |
| 40 | ||
| 41 | =back | |
| 42 | ||
| 43 | Each Tape Coordinator must have its own port offset number, and the | |
| 44 | command fails if a Backup Database entry already exists for the requested | |
| 45 | port offset number. To display existing Tape Coordinator entries, use the | |
| 46 | B<backup listhosts> command. | |
| 47 | ||
| 48 | =head1 OPTIONS | |
| 49 | ||
| 50 | =over 4 | |
| 51 | ||
| 52 | =item B<-tapehost> <I<tape machine name>> | |
| 53 | ||
| 54 | Specifies the fully-qualified hostname of the machine for which to create | |
| 55 | a Tape Coordinator entry in the Backup Database. The machine must have an | |
| 56 | entry in either the cell's naming service (such as the Domain Name | |
| 57 | Service) or the host file (F</etc/hosts> or equivalent) on the machine | |
| 58 | where the command is issued. | |
| 59 | ||
| 60 | =item B<-portoffset> <I<TC port offset>> | |
| 61 | ||
| 62 | Specifies the Tape Coordinator's port offset number. Provide an integer | |
| 63 | from the range C<0> through C<58510>, or omit this argument to use the | |
| 64 | default value of C<0> (zero). The value must match the port offset number | |
| 65 | recorded for the same combination of Tape Coordinator and tape device or | |
| 66 | file in the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator | |
| 67 | machine named by the B<-tapehost> argument. | |
| 68 | ||
| 69 | =item B<-localauth> | |
| 70 | ||
| 71 | Constructs a server ticket using a key from the local | |
| 72 | F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents | |
| 73 | it to the Backup Server, Volume Server and VL Server during mutual | |
| 74 | authentication. Do not combine this flag with the B<-cell> argument. For | |
| 75 | more details, see L<backup(8)>. | |
| 76 | ||
| 77 | =item B<-cell> <I<cell name>> | |
| 78 | ||
| 79 | Names the cell in which to run the command. Do not combine this argument | |
| 80 | with the B<-localauth> flag. For more details, see L<backup(8)>. | |
| 81 | ||
| 82 | =item B<-help> | |
| 83 | ||
| 84 | Prints the online help for this command. All other valid options are | |
| 85 | ignored. | |
| 86 | ||
| 87 | =back | |
| 88 | ||
| 89 | =head1 EXAMPLES | |
| 90 | ||
| 91 | The following command creates an entry in the Backup Database that assigns | |
| 92 | port offset number 4 to a Tape Coordinator running on the machine | |
| 93 | C<backup1.example.com>: | |
| 94 | ||
| 95 | % backup addhost -tapehost backup1.example.com -portoffset 4 | |
| 96 | ||
| 97 | The following command creates a Backup Database entry that assigns port | |
| 98 | offset number 0 to a Tape Coordinator on the machine C<backup3.example.com>: | |
| 99 | ||
| 100 | % backup addhost backup3.example.com | |
| 101 | ||
| 102 | =head1 PRIVILEGE REQUIRED | |
| 103 | ||
| 104 | The issuer must be listed in the F</usr/afs/etc/UserList> file on every | |
| 105 | machine where the Backup Server is running, or must be logged onto a | |
| 106 | server machine as the local superuser C<root> if the B<-localauth> flag is | |
| 107 | included. | |
| 108 | ||
| 109 | =head1 SEE ALSO | |
| 110 | ||
| 111 | L<backup(8)>, | |
| 112 | L<backup_delhost(8)>, | |
| 113 | L<backup_listhosts(8)> | |
| 114 | ||
| 115 | =head1 COPYRIGHT | |
| 116 | ||
| 117 | IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved. | |
| 118 | ||
| 119 | This documentation is covered by the IBM Public License Version 1.0. It was | |
| 120 | converted from HTML to POD by software written by Chas Williams and Russ | |
| 121 | Allbery, based on work by Alf Wachsmann and Elizabeth Cassell. |