openafs/doc/man-pages/pod1/vos_setaddrs.pod
Russ Allbery e6f6c3493e Fixes and clarifications to vos setaddrs man page
Add a caution explaining how the file server addresses are registered
and pointing users at NetInfo and NetRestrict plus restarting the file
server for the normal case.

Mention what version of OpenAFS introduced this command.  Drop the note
about the version of OpenAFS that added the -encrypt flag, since the
whole command is newer than that.

Reference vos listaddrs -printuuid specifically to get the UUID.

General formatting and wording cleanup: use terminology more consistently,
continue a long example line, wrap long lines, fix a spelling error, and
add cross-references to NetInfo and NetRestrict.

Change-Id: Idd6175339dc0feb1b777963bbb09731e42b83522
Reviewed-on: http://gerrit.openafs.org/1787
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-19 20:24:11 -07:00

141 lines
4.1 KiB
Plaintext

=head1 NAME
vos_setaddrs - Set new addresses for a file server's entry in the VLDB
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<vos setaddrs> S<<< B<-uuid> <I<UUID of server>> >>>
S<<< B<-host> <I<IP address>>+ >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
[B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
B<vos seta> S<<< B<-u> <I<UUID of server>> >>>
S<<< B<-ho> <I<IP address>>+ >>>
S<<< [B<-c> <I<cell name>>] >>>
[B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<vos setaddrs> command sets the IP addresses for a server entry in
the Volume Location Database (VLDB). Specify one or several IP addresses.
All existing addresses in the VLDB server entry are replaced with the new
addresses given on the command line.
To find the UUID for a server entry, use the C<vos listaddrs -printuuid>
command to display all VLDB server entries with their UUIDs.
=head1 CAUTIONS
Normally, the best way to change the registered addresses for a server
entry is to restart the File Server process after changing the network
configuration for that server and possibly the F<NetInfo> and
F<NetRestrict> files for that server. See L<NetInfo(5)> and
L<NetRestrict(5)> for more information about configuring the File Server
to register the correct set of addresses. This command can be used to
change the registered addresses without restarting the File Server, but
the next time the File Server is restarted, it will register all of its
known addresses again. You should therefore always ensure that the File
Server configuration is correct for whenever it is next restarted before
using this command.
Setting the wrong addresses will make the volumes on that file server
unreachable from AFS clients.
This command was introduced in OpenAFS 1.5.74, but can be used with any
version of the Volume Location Server.
=head1 OPTIONS
=over 4
=item B<-uuid> <I<UUID of server>>
The unique ID as provided by the C<vos listaddrs -printuuid> command.
=item B<-host> <I<IP address>>+
The new list of IP addresses for the File Server.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<vos(1)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<vos(1)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
to the Volume Server and Volume Location Server during mutual
authentication. Do not combine this flag with the B<-cell> argument or
B<-noauth> flag. For more details, see L<vos(1)>.
=item B<-verbose>
Produces on the standard output stream a detailed trace of the command's
execution. If this argument is omitted, only warnings and error messages
appear.
=item B<-encrypt>
Encrypts the command so that the operation's results are not transmitted
across the network in clear text.
=item B<-noresolve>
Shows all servers as IP addresses instead of the DNS name. Lets you
work with IP addresses for input, without the DNS translation between
the input and the registration of the IP address in the VLDB.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command sets addresses C<192.12.107.214> and C<10.47.11.17>
for the UUID 008f157e-bad0-157c-0ffee-357c4d1faa77
% vos setaddrs -uuid 008f157e-bad0-157c-0ffee-357c4d1faa77 \
-host 192.12.107.214 -host 10.47.11.17 -verbose
vos: Changed UUID with addresses:
UUID: 008f157e-bad0-157c-0ffee-357c4d1faa77
192.12.107.214
10.47.11.17
=head1 PRIVILEGE REQUIRED
Issuer must be listed in the F</usr/afs/etc/UserList> file on each
database server machine.
=head1 SEE ALSO
L<CellServDB(5)>,
L<NetInfo(5)>,
L<NetRestrict(5)>,
L<UserList(5)>,
L<sysid(5)>,
L<fileserver(8)>,
L<vos(1)>,
L<vos_listaddrs(1)>
=head1 COPYRIGHT
KTH 2010. All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0.