HCoop / hcoop / debian / openafs.git / blame
| Commit | Line | Data |
|---|---|---|
| 805e021f CE |
1 | =head1 NAME |
| 2 | ||
| 3 | kadb_check - Checks the integrity of the Authentication Database | |
| 4 | ||
| 5 | =head1 SYNOPSIS | |
| 6 | ||
| 7 | =for html | |
| 8 | <div class="synopsis"> | |
| 9 | ||
| 10 | B<kadb_check> S<<< B<-database> <I<kadb file>> >>> [B<-uheader>] [B<-kheader>] | |
| 11 | [B<-entries>] [B<-verbose>] S<<< [B<-rebuild> <I<out file>>] >>> [B<-help>] | |
| 12 | ||
| 13 | B<kadb_check> S<<< B<-d> <I<kadb file>> >>> [B<-u>] [B<-k>] [B<-e>] [B<-v>] | |
| 14 | S<<< [B<-r> <I<out file>>] >>> [B<-h>] | |
| 15 | ||
| 16 | =for html | |
| 17 | </div> | |
| 18 | ||
| 19 | =head1 DESCRIPTION | |
| 20 | ||
| 21 | The B<kadb_check> command checks the integrity of the Authentication | |
| 22 | Database, reporting any errors or corruption it finds. If there are | |
| 23 | problems, do not issue any B<kas> commands until the database is repaired. | |
| 24 | ||
| 25 | =head1 CAUTIONS | |
| 26 | ||
| 27 | The B<kadb_check> command is only used with the database used by the | |
| 28 | obsolete Authentication Server, which should no longer be used. It is | |
| 29 | provided for sites that have not yet migrated to a Kerberos version 5 | |
| 30 | KDC. The Authentication Server and supporting commands, including B<kdb>, | |
| 31 | will be removed in a future version of OpenAFS. | |
| 32 | ||
| 33 | The results can be unpredictable if the Authentication Server makes | |
| 34 | changes to the Authentication Database while this command is running. Use | |
| 35 | the B<bos shutdown> command to shutdown the local B<kaserver> process | |
| 36 | before running this command, or before creating a second copy of the | |
| 37 | F<kaserver.DB0> file (with a different name) on which to run the command. | |
| 38 | ||
| 39 | =head1 OPTIONS | |
| 40 | ||
| 41 | =over 4 | |
| 42 | ||
| 43 | =item B<-database> <I<kadb file>> | |
| 44 | ||
| 45 | Names the Authentication Database (copy of the F<kaserver.DB0> file) to | |
| 46 | check. If the current working directory is not the location of the file, | |
| 47 | provide a pathname, either full or relative to the current working | |
| 48 | directory. | |
| 49 | ||
| 50 | =item B<-uheader> | |
| 51 | ||
| 52 | Displays information which Ubik maintains in the database's header. | |
| 53 | ||
| 54 | =item B<-kheader> | |
| 55 | ||
| 56 | Displays information which the Authentication Server maintains in the | |
| 57 | database's header. | |
| 58 | ||
| 59 | =item B<-entries> | |
| 60 | ||
| 61 | Outputs every entry in the database, providing information similar to that | |
| 62 | returned by the B<kas examine> command. | |
| 63 | ||
| 64 | =item B<-verbose> | |
| 65 | ||
| 66 | Reports additional information about the database, including the number of | |
| 67 | free (allocated but unused) entries in the database. | |
| 68 | ||
| 69 | =item B<-rebuild> <I<out file>> | |
| 70 | ||
| 71 | Names the file in which to record a list of B<kas> commands which, if | |
| 72 | issued in the command shell, recreate the current state of the database | |
| 73 | being verified. Partial pathnames are interpreted relative to the current | |
| 74 | working directory. | |
| 75 | ||
| 76 | =item B<-help> | |
| 77 | ||
| 78 | Prints the online help for this command. All other valid options are | |
| 79 | ignored. | |
| 80 | ||
| 81 | =back | |
| 82 | ||
| 83 | =head1 OUTPUT | |
| 84 | ||
| 85 | If there are errors in the database, the output always reports them on the | |
| 86 | standard error stream. If any options other than B<-database> or B<-help> | |
| 87 | are provided, the output written to the standard output stream includes | |
| 88 | additional information as described for each option in L</OPTIONS>. The | |
| 89 | output is intended for debugging purposes and is meaningful to someone | |
| 90 | familiar with the internal structure of the Authentication Database. | |
| 91 | ||
| 92 | =head1 PRIVILEGE REQUIRED | |
| 93 | ||
| 94 | The issuer must be logged in as the local superuser C<root>. | |
| 95 | ||
| 96 | =head1 SEE ALSO | |
| 97 | ||
| 98 | L<kaserver.DB0(5)>, | |
| 99 | L<bos_shutdown(8)>, | |
| 100 | L<kas_examine(8)>, | |
| 101 | L<kaserver(8)> | |
| 102 | ||
| 103 | =head1 COPYRIGHT | |
| 104 | ||
| 105 | IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved. | |
| 106 | ||
| 107 | This documentation is covered by the IBM Public License Version 1.0. It was | |
| 108 | converted from HTML to POD by software written by Chas Williams and Russ | |
| 109 | Allbery, based on work by Alf Wachsmann and Elizabeth Cassell. |