DEVEL15-man-fs-uuid-tweaks-20071128
[openafs.git] / doc / man-pages / pod1 / fs_uuid.pod
1 =head1 NAME
2
3 fs_uuid - Prints the uuid of the client or generates a new one
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs uuid> [B<-generate>] [B<-help>]
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 B<fs uuid> prints the current UUID of an OpenAFS client.  It can
18 optionally force the generation of a new UUID, if needed.  The client UUID
19 is used by the B<fileserver> to differentiate clients with the same IP
20 address.
21
22 =head1 CAUTIONS
23
24 The B<fs uuid> command is only available in OpenAFS versions after 1.4.5
25 and 1.5.8.  The behavior differs slightly between versions.  In OpenAFS
26 1.4.5 and later, the B<-generate> option is required and the UUID for the
27 client machine is never printed.  OpenAFS versions 1.5.8 and later will
28 print the UUID.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-generate>
35
36 Generates a new UUID for the cache manager.  This is useful if two clients
37 share the same UUID (if systems were cloned incorrectly, for example).
38 B<-generate> is optional in OpenAFS versions 1.5.8 and later, but it is
39 required in OpenAFS versions 1.4.5 and later.
40
41 =item B<-help>
42
43 Prints the online help for this command.  All other valid options are
44 ignored.
45
46 =back
47
48 =head1 OUTPUT
49
50 B<fs uuid> prints out the current UUID for the client or the new UUID
51 if the B<-generate> option is passed to it.
52
53 =head1 EXAMPLES
54
55 There are only two ways to invoke B<fs uuid> under 1.5.8 and later:
56
57    % fs uuid
58    UUID: 8ac66f9308a8e-47d7-80f7-50d0040cddc2
59
60    % fs uuid -generate
61    New UUID: 436bd660-1720-429508e470cff38f5c6fb0
62
63 Here is the only way to invoke B<fs uuid> under OpenAFS 1.4.5 and later:
64
65    % fs uuid -generate
66    New uuid generated.
67
68 =head1 PRIVILEGE REQUIRED
69
70 The issuer must be logged on as the local superuser C<root>.
71
72 =head1 SEE ALSO
73
74 L<fs(1)>
75
76 =head1 COPYRIGHT
77
78 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
79
80 This documentation is covered by the IBM Public License Version 1.0. This
81 man page was written by Jason Edgecombe for OpenAFS.