openafs/doc/man-pages/pod1/vos_setaddrs.pod
Harald Barth 2a35e3a028 Add vos setaddrs command and man page
The vos setaddrs command sets the IP addresses for a server entry
in the Volume Location Database (VLDB). Specify one or serveral hosts.
All existing hosts in the VLDB entry are replaced with the new entries
on the command line.

Change-Id: I3c26e49c4a6e2aebae363017d074329ac265132a
Reviewed-on: http://gerrit.openafs.org/1744
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-16 10:15:29 -07:00

123 lines
3.2 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 serveral hosts.
All existing hosts in the VLDB entry are replaced with the new entries
on the command line.
To display all VLDB server entries, for example to find the UUID,
use the B<vos listaddrs> command.
=head1 CAUTIONS
Setting the wrong addresses will make the volumes on that file server
unreachable from AFS clients.
=head1 OPTIONS
=over 4
=item B<-uuid> <I<UUID of server>>
The unique ID as provided by the B<vos listaddrs> command.
=item B<-host> <I<IP address>>+
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. This option is available in OpenAFS
versions 1.4.11 or later and 1.5.60 or later.
=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<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.