mirror of
https://git.openafs.org/openafs.git
synced 2025-01-21 08:20:16 +00:00
1cc8feb6fc
There were several different real and made-up hostnames and company names used throughout our documentation examples. The IETF has reserved "example.com" and other "example" TLDs for use in examples (RFC 2606). Replace almost all references to ABC Corporation, DEF Corporation, and State University, as well as "abc.com", "bigcell.com", "def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu", "stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com". Standardize on "Example Corporation", "Example Network", "Example Organization" (example.com, example.net, and example.org). The Scout documentation in the Admin Guide contains PNG images that contain the old cell names, so I left those references until the images can be replaced. Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367 Reviewed-on: http://gerrit.openafs.org/6697 Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com> Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
162 lines
5.0 KiB
Plaintext
162 lines
5.0 KiB
Plaintext
=head1 NAME
|
|
|
|
vos_offline - Takes a volume offline
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<vos offline> S<<< B<-server> <I<machine name>> >>>
|
|
S<<< B<-partition> <I<partition name>> >>>
|
|
S<<< B<-id> <I<volume name or ID>> >>>
|
|
S<<< [B<-sleep> <I<seconds to sleep>>] >>>
|
|
[B<-busy>] S<<< [B<-cell> <I<cell name>>] >>>
|
|
[B<-noauth>] B<-localauth>]
|
|
[B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
|
|
|
|
B<vos of> S<<< B<-se> <I<machine name>> >>>
|
|
S<<< B<-p> <I<partition name>> >>>
|
|
S<<< B<-i> <I<volume name or ID>> >>>
|
|
S<<< [B<-sl> <I<seconds to sleep>>] >>>
|
|
[B<-b>] S<<< [B<-c> <I<cell name>>] >>>
|
|
[B<-noa>] B<-l>]
|
|
[B<-v>] [B<-e>] [B<-nor>] [B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<vos offline> command takes a volume offline on the
|
|
B<fileserver>.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Taking a volume offline that has existing
|
|
callbacks will result in those callbacks being broken
|
|
and clients not being able to access the volume.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-server> <I<machine name>>
|
|
|
|
Identifies the file server machine where 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<vos(1)>.
|
|
|
|
=item B<-partition> <I<partition name>>
|
|
|
|
Identifies the partition where the volume resides, on the
|
|
file server machine named by the B<-server> argument. Provide the
|
|
partition's complete name with preceding slash (for example, C</vicepa>)
|
|
or use one of the three acceptable abbreviated forms. For details, see
|
|
L<vos(1)>.
|
|
|
|
=item B<-id> <I<volume name or ID>>
|
|
|
|
Specifies either the complete name or volume ID number of the volume.
|
|
|
|
=item B<-sleep> <I<seconds to sleep>>
|
|
|
|
Specifies to sleep for a certain number of seconds after taking the
|
|
volume offline before bringing it online again. If this option is
|
|
specified, the volume will be online when B<vos offline> successfully
|
|
completes. If this option is not specified, B<vos online> must be run to
|
|
bring the volume online.
|
|
|
|
=item B<-busy>
|
|
|
|
Specifies to mark the volume as `busy' instead of `offline'. This
|
|
means that a program trying to access this volume will receive a VBUSY
|
|
error instead of a VOFFLINE error (until the volume is brought back
|
|
online).
|
|
|
|
Different programs may react differently when they see these two
|
|
different states, but in general a `busy' volume is only unavailable
|
|
for a short period of time and will become online soon. An `offline'
|
|
volume, on the other hand, is typically unavailable for longer periods
|
|
and may not come back online until an administrator intervenes.
|
|
|
|
As an example of when these states occur normally, a volume can be
|
|
`busy' when it is being cloned (perhaps as the result of a
|
|
B<vos backup> or B<vos release> operation). A volume can be `offline'
|
|
if a non-DAFS fileserver has detected a problem in the volume, and an
|
|
administrator must manually schedule a salvage for that volume before
|
|
it becomes available again.
|
|
|
|
If B<-busy> is specified, the B<-sleep> option must also be specified, to
|
|
indicate for how long to keep the volume busy.
|
|
|
|
=item B<-cell> <I<cell name>>
|
|
|
|
Names the cell in which to run the command. Do not combine this argument
|
|
with the B<-localauth> flag. For more details, see L<vos(1)>.
|
|
|
|
=item B<-noauth>
|
|
|
|
Assigns the unprivileged identity anonymous to the issuer. Do not combine
|
|
this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
|
|
|
|
=item B<-localauth>
|
|
|
|
Constructs a server ticket using a key from the local
|
|
F</usr/afs/etc/KeyFile> file. The B<vos> 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<vos(1)>.
|
|
|
|
=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 command so that the operation's results are not transmitted
|
|
across the network in clear text. This option is available in OpenAFS
|
|
versions 1.4.11 or later and 1.5.60 or later.
|
|
|
|
=item B<-noresolve>
|
|
|
|
Shows all servers as IP addresses instead of the DNS name. This is very
|
|
useful when the server address is registered as 127.0.0.1 or when dealing
|
|
with multi-homed servers. This option is available in OpenAFS
|
|
versions 1.4.8 or later and 1.5.35 or later.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following example takes an online volume offline:
|
|
|
|
% vos offline -server sv7.example.org -partition /vicepb -id root.afs
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
|
|
machine specified with the B<-server> argument and 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<root>.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<vos(1)>,
|
|
L<vos_online(1)>,
|
|
L<bos_salvage(8)>,
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This man page was created by Steven Jenkins.
|