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<-sleep> <I<seconds to sleep>>
  64
  65 Specifies to sleep for a certain number of seconds after taking the
  66 volume offline before bringing it online again. If this option is
  67 specified, the volume will be online when B<vos offline> successfully
  68 completes. If this option is not specified, B<vos online> must be run to
  69 bring the volume online.
  70
  71 =item B<-busy>
  72
  73 Specifies to mark the volume as `busy' instead of `offline'. This
  74 means that a program trying to access this volume will receive a VBUSY
  75 error instead of a VOFFLINE error (until the volume is brought back
  76 online).
  77
  78 Different programs may react differently when they see these two
  79 different states, but in general a `busy' volume is only unavailable
  80 for a short period of time and will become online soon. An `offline'
  81 volume, on the other hand, is typically unavailable for longer periods
  82 and may not come back online until an administrator intervenes.
  83
  84 As an example of when these states occur normally, a volume can be
  85 `busy' when it is being cloned (perhaps as the result of a
  86 B<vos backup> or B<vos release> operation). A volume can be `offline'
  87 if a non-DAFS fileserver has detected a problem in the volume, and an
  88 administrator must manually schedule a salvage for that volume before
  89 it becomes available again.
  90
  91 If B<-busy> is specified, the B<-sleep> option must also be specified, to
  92 indicate for how long to keep the volume busy.
  93
  94 =item B<-cell> <I<cell name>>
  95
  96 Names the cell in which to run the command. Do not combine this argument
  97 with the B<-localauth> flag. For more details, see L<vos(1)>.
  98
  99 =item B<-noauth>
 100
 101 Assigns the unprivileged identity anonymous to the issuer. Do not combine
 102 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
 103
 104 =item B<-localauth>
 105
 106 Constructs a server ticket using a key from the local
 107 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 108 to the Volume Server and Volume Location Server during mutual
 109 authentication. Do not combine this flag with the B<-cell> argument or
 110 B<-noauth> flag. For more details, see L<vos(1)>.
 111
 112 =item B<-verbose>
 113
 114 Produces on the standard output stream a detailed trace of the command's
 115 execution. If this argument is omitted, only warnings and error messages
 116 appear.
 117
 118 =item B<-encrypt>
 119
 120 Encrypts the command so that the operation's results are not transmitted
 121 across the network in clear text. This option is available in OpenAFS
 122 versions 1.4.11 or later and 1.5.60 or later.
 123
 124 =item B<-noresolve>
 125
 126 Shows all servers as IP addresses instead of the DNS name. This is very
 127 useful when the server address is registered as 127.0.0.1 or when dealing
 128 with multi-homed servers. This option is available in OpenAFS
 129 versions 1.4.8 or later and 1.5.35 or later.
 130
 131 =item B<-help>
 132
 133 Prints the online help for this command. All other valid options are
 134 ignored.
 135
 136 =back
 137
 138 =head1 EXAMPLES
 139
 140 The following example takes an online volume offline:
 141
 142    % vos offline -server sv7.example.org -partition /vicepb -id root.afs
 143
 144 =head1 PRIVILEGE REQUIRED
 145
 146 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 147 machine specified with the B<-server> argument and on each database server
 148 machine. If the B<-localauth> flag is included, the issuer must instead be
 149 logged on to a server machine as the local superuser C<root>.
 150
 151 =head1 SEE ALSO
 152
 153 L<vos(1)>,
 154 L<vos_online(1)>,
 155 L<bos_salvage(8)>,
 156
 157 =head1 COPYRIGHT
 158
 159 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 160
 161 This man page was created by Steven Jenkins.