doc/man-pages/pod1/vos_rename.pod

   1 =head1 NAME
   2
   3 vos_rename - Renames a volume
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos rename> S<<< B<-oldname> <I<old volume name>> >>>
  11     S<<< B<-newname> <I<new volume name>> >>>
  12     S<<< [B<-cell> <I<cell name>>] >>>
  13     [B<-noauth>] [B<-localauth>]
  14     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  15
  16 B<vos ren> S<<< B<-o> <I<old volume name>> >>>
  17     S<<< B<-ne> <I<new volume name>> >>>
  18     [-c <I<cell name>>] [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 rename> command changes the name of the read/write volume
  26 specified with the B<-oldname> argument to the name specified with the
  27 B<-newname> argument. The names of the read/write's read-only copies and
  28 backup copy, if any, change automatically to match.
  29
  30 After issuing this command, remember to correct any mount points that
  31 refer to the old volume name, by removing the old mount point with the
  32 B<fs rmmount> command and creating a new one with the B<fs mkmount>
  33 command.
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<-oldname> <I<old volume name>>
  40
  41 Is the current name of the read/write volume.
  42
  43 =item B<-newname> <I<new volume name>>
  44
  45 Is the desired new name for the volume.
  46
  47 =item B<-cell> <I<cell name>>
  48
  49 Names the cell in which to run the command. Do not combine this argument
  50 with the B<-localauth> flag. For more details, see L<vos(1)>.
  51
  52 =item B<-noauth>
  53
  54 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  55 combine this flag with the B<-localauth> flag. For more details, see
  56 L<vos(1)>.
  57
  58 =item B<-localauth>
  59
  60 Constructs a server ticket using a key from the local
  61 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  62 to the Volume Server and Volume Location Server during mutual
  63 authentication. Do not combine this flag with the B<-cell> argument or
  64 B<-noauth> flag. For more details, see L<vos(1)>.
  65
  66 =item B<-verbose>
  67
  68 Produces on the standard output stream a detailed trace of the command's
  69 execution. If this argument is omitted, only warnings and error messages
  70 appear.
  71
  72 =item B<-encrypt>
  73
  74 Encrypts the command so that the operation's results are not transmitted
  75 across the network in clear text. This option is available in OpenAFS
  76 versions 1.4.11 or later and 1.5.60 or later.
  77
  78 =item B<-noresolve>
  79
  80 Shows all servers as IP addresses instead of the DNS name. This is very
  81 useful when the server address is registered as 127.0.0.1 or when dealing
  82 with multi-homed servers. This option is available in OpenAFS
  83 versions 1.4.8 or later and 1.5.35 or later.
  84
  85 =item B<-help>
  86
  87 Prints the online help for this command. All other valid options are
  88 ignored.
  89
  90 =back
  91
  92 =head1 OUTPUT
  93
  94 The B<vos rename> command produces no output if the command succeeds.
  95
  96 If the volume named by the B<-oldname> argument does not exist, the
  97 following message appears:
  98
  99    vos: Could not find entry for volume <old volume name>.
 100
 101 =head1 EXAMPLES
 102
 103 The following example changes the mistaken volume name C<sun4x_56.afsws>
 104 to the correct alternative C<sun4x_56.usr.afsws>.
 105
 106    % vos rename -oldname sun4x_56.afsws -newname sun4x_56.usr.afsws
 107
 108 =head1 PRIVILEGE REQUIRED
 109
 110 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 111 machine specified with the B<-server> argument and on each database server
 112 machine. If the B<-localauth> flag is included, the issuer must instead be
 113 logged on to a server machine as the local superuser C<root>.
 114
 115 =head1 SEE ALSO
 116
 117 L<vos(1)>
 118
 119 =head1 COPYRIGHT
 120
 121 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 122
 123 This documentation is covered by the IBM Public License Version 1.0.  It was
 124 converted from HTML to POD by software written by Chas Williams and Russ
 125 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.