a6239ff3504c96df4a357ccc3e4e691435d37c85
[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>]
14     S<<< [B<-config> <I<config directory>>] >>>
15     [B<-help>]
16
17 B<vos seta> S<<< B<-u> <I<UUID of server>> >>>
18     S<<< B<-ho> <I<IP address>>+ >>>
19     S<<< [B<-c> <I<cell name>>] >>>
20     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
21     S<<< [B<-co> <I<config directory>>] >>>
22     [B<-h>]
23
24 =for html
25 </div>
26
27 =head1 DESCRIPTION
28
29 The B<vos setaddrs> command sets the IP addresses for a server entry in
30 the Volume Location Database (VLDB). Specify one or several IP addresses.
31 All existing addresses in the VLDB server entry are replaced with the new
32 addresses given on the command line.
33
34 To find the UUID for a server entry, use the C<vos listaddrs -printuuid>
35 command to display all VLDB server entries with their UUIDs.
36
37 =head1 CAUTIONS
38
39 Normally, the best way to change the registered addresses for a server
40 entry is to restart the File Server process after changing the network
41 configuration for that server and possibly the F<NetInfo> and
42 F<NetRestrict> files for that server.  See L<NetInfo(5)> and
43 L<NetRestrict(5)> for more information about configuring the File Server
44 to register the correct set of addresses.  This command can be used to
45 change the registered addresses without restarting the File Server, but
46 the next time the File Server is restarted, it will register all of its
47 known addresses again.  You should therefore always ensure that the File
48 Server configuration is correct for whenever it is next restarted before
49 using this command.
50
51 Setting the wrong addresses will make the volumes on that file server 
52 unreachable from AFS clients.
53
54 This command was introduced in OpenAFS 1.5.74, but can be used with any
55 version of the Volume Location Server.
56
57 =head1 OPTIONS
58
59 =over 4
60
61 =item B<-uuid> <I<UUID of server>>
62
63 The unique ID as provided by the C<vos listaddrs -printuuid> command.
64
65 =item B<-host> <I<IP address>>+
66
67 The new list of IP addresses for the File Server.
68
69 =item B<-cell> <I<cell name>>
70
71 Names the cell in which to run the command. Do not combine this argument
72 with the B<-localauth> flag. For more details, see L<vos(1)>.
73
74 =item B<-noauth>
75
76 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
77 combine this flag with the B<-localauth> flag. For more details, see
78 L<vos(1)>.
79
80 =item B<-localauth>
81
82 Constructs a server ticket using a key from the local
83 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
84 to the Volume Server and Volume Location Server during mutual
85 authentication. Do not combine this flag with the B<-cell> argument or
86 B<-noauth> flag. For more details, see L<vos(1)>.
87
88 =item B<-verbose>
89
90 Produces on the standard output stream a detailed trace of the command's
91 execution. If this argument is omitted, only warnings and error messages
92 appear.
93
94 =item B<-encrypt>
95
96 Encrypts the command so that the operation's results are not transmitted
97 across the network in clear text.
98
99 =item B<-noresolve>
100
101 Shows all servers as IP addresses instead of the DNS name. Lets you
102 work with IP addresses for input, without the DNS translation between
103 the input and the registration of the IP address in the VLDB.
104
105 =item B<-help>
106
107 Prints the online help for this command. All other valid options are
108 ignored.
109
110 =back
111
112 =head1 EXAMPLES
113
114 The following command sets addresses C<192.12.107.214> and C<10.47.11.17>
115 for the UUID 008f157e-bad0-157c-0ffee-357c4d1faa77
116
117    % vos setaddrs -uuid 008f157e-bad0-157c-0ffee-357c4d1faa77 \
118        -host 192.12.107.214 -host 10.47.11.17 -verbose
119    vos: Changed UUID with addresses:
120    UUID: 008f157e-bad0-157c-0ffee-357c4d1faa77
121    192.12.107.214
122    10.47.11.17
123
124 =head1 PRIVILEGE REQUIRED
125
126 Issuer must be listed in the F</usr/afs/etc/UserList> file on each
127 database server machine.
128
129 =head1 SEE ALSO
130
131 L<CellServDB(5)>,
132 L<NetInfo(5)>,
133 L<NetRestrict(5)>,
134 L<UserList(5)>,
135 L<sysid(5)>,
136 L<fileserver(8)>,
137 L<vos(1)>,
138 L<vos_listaddrs(1)>
139
140 =head1 COPYRIGHT
141
142 KTH 2010. All Rights Reserved.
143
144 This documentation is covered by the IBM Public License Version 1.0.