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