Add vos setaddrs command and man page
[openafs.git] / doc / man-pages / pod1 / vos_setaddrs.pod
1 =head1 NAME
2
3 vos_setaddrs - Set new addresses for a file server's entry in the VLDB
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos setaddrs> S<<< B<-uuid> <I<UUID of server>> >>>
11     S<<< B<-host> <I<IP address>>+ >>>
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
14
15 B<vos seta> S<<< B<-u> <I<UUID of server>> >>>
16     S<<< B<-ho> <I<IP address>>+ >>>
17     S<<< [B<-c> <I<cell name>>] >>>
18     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
19
20 =for html
21 </div>
22
23 =head1 DESCRIPTION
24
25 The B<vos setaddrs> command sets the IP addresses for a server entry 
26 in the Volume Location Database (VLDB). Specify one or serveral hosts.
27 All existing hosts in the VLDB entry are replaced with the new entries
28 on the command line. 
29
30 To display all VLDB server entries, for example to find the UUID,
31 use the B<vos listaddrs> command.
32
33 =head1 CAUTIONS
34
35 Setting the wrong addresses will make the volumes on that file server 
36 unreachable from AFS clients.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-uuid> <I<UUID of server>>
43
44 The unique ID as provided by the B<vos listaddrs> command.
45
46 =item B<-host> <I<IP address>>+
47
48 List of IP addresses for the file server.
49
50 =item B<-cell> <I<cell name>>
51
52 Names the cell in which to run the command. Do not combine this argument
53 with the B<-localauth> flag. For more details, see L<vos(1)>.
54
55 =item B<-noauth>
56
57 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
58 combine this flag with the B<-localauth> flag. For more details, see
59 L<vos(1)>.
60
61 =item B<-localauth>
62
63 Constructs a server ticket using a key from the local
64 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
65 to the Volume Server and Volume Location Server during mutual
66 authentication. Do not combine this flag with the B<-cell> argument or
67 B<-noauth> flag. For more details, see L<vos(1)>.
68
69 =item B<-verbose>
70
71 Produces on the standard output stream a detailed trace of the command's
72 execution. If this argument is omitted, only warnings and error messages
73 appear.
74
75 =item B<-encrypt>
76
77 Encrypts the command so that the operation's results are not transmitted
78 across the network in clear text. This option is available in OpenAFS
79 versions 1.4.11 or later and 1.5.60 or later.
80
81 =item B<-noresolve>
82
83 Shows all servers as IP addresses instead of the DNS name. Lets you
84 work with IP addresses for input, without the DNS translation between
85 the input and the registration of the IP address in the VLDB.
86
87 =item B<-help>
88
89 Prints the online help for this command. All other valid options are
90 ignored.
91
92 =back
93
94 =head1 EXAMPLES
95
96 The following command sets addresses C<192.12.107.214> and C<10.47.11.17> for the UUID 008f157e-bad0-157c-0ffee-357c4d1faa77
97
98    % vos setaddrs -uuid 008f157e-bad0-157c-0ffee-357c4d1faa77 -host 192.12.107.214 -host 10.47.11.17 -verbose
99    vos: Changed UUID with addresses:
100    UUID: 008f157e-bad0-157c-0ffee-357c4d1faa77
101    192.12.107.214
102    10.47.11.17
103
104 =head1 PRIVILEGE REQUIRED
105
106 Issuer must be listed in the F</usr/afs/etc/UserList> file on 
107 each database server machine.
108
109 =head1 SEE ALSO
110
111 L<CellServDB(5)>,
112 L<UserList(5)>,
113 L<sysid(5)>,
114 L<fileserver(8)>,
115 L<vos(1)>,
116 L<vos_listaddrs(1)>
117
118 =head1 COPYRIGHT
119
120 KTH 2010. All Rights Reserved.
121
122 This documentation is covered by the IBM Public License Version 1.0.