doc/man-pages/pod1/vos_offline.pod

   1 =head1 NAME
   2
   3 vos_offline - Takes a volume offline
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos offline> S<<< B<-server> <I<machine name>> >>>
  11     S<<< B<-partition> <I<partition name>> >>>
  12     S<<< B<-id> <I<volume name or ID>> >>>
  13     S<<< [B<-sleep> <I<seconds to sleep>>] >>>
  14     [B<-busy>] S<<< [B<-cell> <I<cell name>>] >>>
  15     [B<-noauth>] B<-localauth>]
  16     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  17
  18 B<vos of> S<<< B<-se> <I<machine name>> >>>
  19     S<<< B<-p> <I<partition name>> >>>
  20     S<<< B<-i> <I<volume name or ID>> >>>
  21     S<<< [B<-sl> <I<seconds to sleep>>] >>>
  22     [B<-b>] S<<< [B<-c> <I<cell name>>] >>>
  23     [B<-noa>] B<-l>]
  24     [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  25
  26 =for html
  27 </div>
  28
  29 =head1 DESCRIPTION
  30
  31 The B<vos offline> command takes a volume offline on the
  32 B<fileserver>.
  33
  34 =head1 CAUTIONS
  35
  36 Taking a volume offline that has existing
  37 callbacks will result in those callbacks being broken
  38 and clients not being able to access the volume.
  39
  40 =head1 OPTIONS
  41
  42 =over 4
  43
  44 =item B<-server> <I<machine name>>
  45
  46 Identifies the file server machine where the volume resides.
  47 Provide the machine's IP address or its host name (either fully
  48 qualified or using an unambiguous abbreviation). For details, see
  49 L<vos(1)>.
  50
  51 =item B<-partition> <I<partition name>>
  52
  53 Identifies the partition where the volume resides, on the
  54 file server machine named by the B<-server> argument. Provide the
  55 partition's complete name with preceding slash (for example, C</vicepa>)
  56 or use one of the three acceptable abbreviated forms. For details, see
  57 L<vos(1)>.
  58
  59 =item B<-id> <I<volume name or ID>>
  60
  61 Specifies either the complete name or volume ID number of the volume.
  62
  63 =item B<-cell> <I<cell name>>
  64
  65 Names the cell in which to run the command. Do not combine this argument
  66 with the B<-localauth> flag. For more details, see L<vos(1)>.
  67
  68 =item B<-noauth>
  69
  70 Assigns the unprivileged identity anonymous to the issuer. Do not combine
  71 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
  72
  73 =item B<-localauth>
  74
  75 Constructs a server ticket using a key from the local
  76 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  77 to the Volume Server and Volume Location Server during mutual
  78 authentication. Do not combine this flag with the B<-cell> argument or
  79 B<-noauth> flag. For more details, see L<vos(1)>.
  80
  81 =item B<-verbose>
  82
  83 Produces on the standard output stream a detailed trace of the command's
  84 execution. If this argument is omitted, only warnings and error messages
  85 appear.
  86
  87 =item B<-encrypt>
  88
  89 Encrypts the command so that the operation's results are not transmitted
  90 across the network in clear text. This option is available in OpenAFS
  91 versions 1.4.11 or later and 1.5.60 or later.
  92
  93 =item B<-noresolve>
  94
  95 Shows all servers as IP addresses instead of the DNS name. This is very
  96 useful when the server address is registered as 127.0.0.1 or when dealing
  97 with multi-homed servers. This option is available in OpenAFS
  98 versions 1.4.8 or later and 1.5.35 or later.
  99
 100 =item B<-help>
 101
 102 Prints the online help for this command. All other valid options are
 103 ignored.
 104
 105 =back
 106
 107 =head1 EXAMPLES
 108
 109 The following example takes an online volume offline:
 110
 111    % vos offline -server sv7.stateu.edu -partition /vicepb -id root.afs
 112
 113 =head1 PRIVILEGE REQUIRED
 114
 115 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 116 machine specified with the B<-server> argument and on each database server
 117 machine. If the B<-localauth> flag is included, the issuer must instead be
 118 logged on to a server machine as the local superuser C<root>.
 119
 120 =head1 SEE ALSO
 121
 122 L<vos(1)>,
 123 L<vos_online(1)>,
 124 L<bos_salvage(8)>,
 125
 126 =head1 COPYRIGHT
 127
 128 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 129
 130 This man page was created by Steven Jenkins.