pod-man-fs-uuid-20071023
[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
19 uuid is used by the B<fileserver> to differentiate clients with the
20 same IP address.
21
22 =head1 CAUTIONS
23
24 The B<fs uuid> command is only available in OpenAFS versions after
25 1.4.5 and 1.5.8. The behavior differs slightly between versions. In
26 OpenAFS 1.4.5 and later, the B<-generate> option is required and the
27 uuid for the client machine is never printed. OpenAFS versions 1.5.8
28 and later will 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
37 clients share the same uuid. B<-generate> is optional in OpenAFS
38 versions 1.5.8 and later, but it is required in OpenAFS versions 1.4.5
39 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
69 =head1 PRIVILEGE REQUIRED
70
71 The issuer must be logged on as the local superuser C<root>.
72
73 =head1 SEE ALSO
74
75 L<fs(1)>
76
77 =head1 COPYRIGHT
78
79 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
80
81 This documentation is covered by the IBM Public License Version 1.0. This
82 man page was written by Jason Edgecombe for OpenAFS.