diff --git a/doc/man-pages/README b/doc/man-pages/README index cbe9baf063..8e4da53f81 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -206,7 +206,6 @@ Known Problems restorevol rmtsysd vldb_convert - vos changeloc vos clone vos convertROtoRW vos copy diff --git a/doc/man-pages/pod1/vos_changeloc.pod b/doc/man-pages/pod1/vos_changeloc.pod new file mode 100644 index 0000000000..944610d1d2 --- /dev/null +++ b/doc/man-pages/pod1/vos_changeloc.pod @@ -0,0 +1,150 @@ +=head1 NAME + +vos changeloc - Change a volume's entry in the VLDB + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-server> > >>> + S<<< B<-partition> > >>> + S<<< B<-id> > >>> + S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] + [B<-verbose>] [B<-encrypt>] [B<-help>] + +B S<<< B<-s> > >>> + S<<< B<-p> > >>> + S<<< B<-i> > >>> + S<<< [B<-c> >] >>> [B<-n>] [B<-l>] [B<-v>] [B<-e>] [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command changes the location of a volume in the +Volume Location Database (VLDB) without needing to contact the original +file server on which the volume was hosted. This is useful when a file +server has gone down permanently and the data that was stored on that +server has been moved to a new file server with a different name and IP +address (perhaps by mounting the same /vicepX partitions on a different +host). After moving the data and running B, run B and then B against the new server to ensure full +synchronization of the VLDB with the file server. + +In essence, B performs the same operations on the VLDB as +B, but it does NOT move the data from one server's file system +to another. + +=head1 CAUTIONS + +Using B changes the VLDB without modifying the file server +data, so it inherently causes the VLDB to be out of sync with the data on +the servers. It should only be used when recovering from server failure. +If the servers are on-line, B should be used instead. It is +highly recommended that B and B be run after +using the B command to ensure properly synchronization of +the VLDB with the file servers. + +=head1 OPTIONS + +B takes the following options: + +=over 4 + +=item B<-server> > + +Specifies the new server where the VLDB should believe the volume resides. +Provide the machine's IP address or its host name (either fully qualified +or using an unambiguous abbreviation). For details, see L. + +=item B<-partition> > + +Specifies the partition where the VLDB should believe the volume resides. +entries. Provide the B<-server> argument along with this one. Provide the +partition's complete name with preceding slash (for example, C) +or use one of the three acceptable abbreviated forms. For details, see +L. + +=item B<-id> > + +Specifies the name or volume ID number on which to operate. + +=item B<-cell> > + +Names the cell in which to run the command. Do not combine this argument +with the B<-localauth> flag. For more details, see L. + +=item B<-noauth> + +Assigns the unprivileged identity C to the issuer. Do not +combine this flag with the B<-localauth> flag. For more details, see +L. + +=item B<-localauth> + +Constructs a server ticket using a key from the local +F file. The B 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. + +=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 commands that are sent to the server. + +=item B<-help> + +Prints the online help for this command. All other valid options are +ignored. + +=back + +=head1 OUTPUT + +B shows a brief message upon completion: + + Changed location to server2 /vicepa for volume user.jdoe + +=head1 EXAMPLES + +The following command changes the location of the C volume to +be F on the file server machine C while being verbose: + + % vos changeloc server2 a user.jdoe -verbose + done + Changed location to server2 /vicepa for volume user.jdoe + +The following command changes the location of the C volume to +be F on C without being verbose: + + % vos changeloc server1 a user.jdoe + Changed location to server1 /vicepa for volume user.jdoe + +=head1 PRIVILEGE REQUIRED + +The issuer must be listed in the F file on each +database server machine. If the B<-localauth> flag is included, the issuer +must instead be logged on to a server machine as the local superuser +C. + +=head1 SEE ALSO + +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS.