mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
c717fcd32c
Larger collection of all vos suite commands, including but
not limited to:
-- documented all commands / options, verified against both 1.4 and 1.5 tree
(including the common -encrypt/-noresolve options)
-- correct order, POD formatting and synopsis for all commands' options
-- shorthand synopsis provided for all commands that missed it, with proper
non-ambiguous command abbreviations of all options
-- POD synopsis formatted to 80-columns in commands where it was running over
-- for newer options, documented which OpenAFS version they became available
-- proper manpage links using L<> in vos.pod
Reviewed-on: http://gerrit.openafs.org/609
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
181 lines
6.2 KiB
Plaintext
181 lines
6.2 KiB
Plaintext
=head1 NAME
|
|
|
|
vos_zap - Removes a volume from its site without writing to the VLDB
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<vos zap> S<<< B<-server> <I<machine name>> >>>
|
|
S<<< B<-partition> <I<partition name>> >>>
|
|
S<<< B<-id> <I<volume ID>> >>>
|
|
[B<-force>] [B<-backup>]
|
|
S<<< [B<-cell> <I<cell name>>] >>>
|
|
[B<-noauth>] [B<-localauth>]
|
|
[B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
|
|
|
|
B<vos z> S<<< B<-s> <I<machine name>> >>>
|
|
S<<< B<-p> <I<partition name>> >>>
|
|
S<<< B<-i> <I<volume ID>> >>>
|
|
[B<-f>] [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 zap> command removes the volume with the specified I<volume ID>
|
|
from the site defined by the B<-server> and B<-partition> arguments,
|
|
without attempting to change the corresponding Volume Location Database
|
|
(VLDB) entry. If removing the volume can possibly result in incorrect data
|
|
in the VLDB, a warning message is displayed.
|
|
|
|
The B<-force> flag removes a volume even if it cannot be "attached"
|
|
(brought online), which can happen either because the volume is extremely
|
|
damaged or because the Salvager functioned abnormally. Without this flag,
|
|
this command cannot remove volumes that are not attachable. See also
|
|
L<CAUTIONS>.
|
|
|
|
To remove the specified read/write volume's backup version at the same
|
|
time, include the B<-backup> flag.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Do not use this command as the standard way to remove a volume, as it is
|
|
likely to put the VLDB out of sync with the volumes on servers. Use the
|
|
B<vos remove> command instead.
|
|
|
|
This command is useful in situations where it is important to delete the
|
|
volume, but for some reason the VLDB is unreachable -- for example,
|
|
because the Volume Location Server is unavailable. The issuer can remove
|
|
the VLDB entry later with the B<vos remove> or B<vos delentry> command, or
|
|
it is removed automatically when the B<vos syncserv> and B<vos syncvldb>
|
|
commands run.
|
|
|
|
To remove a read-only site defined in the VLDB by mistake, before a copy
|
|
actually exists at the site, use the B<vos remsite> command. To remove an
|
|
entire VLDB entry without affecting volumes at their sites, use the B<vos
|
|
delentry> command.
|
|
|
|
Do not use the B<-force> flag if the volume is online, but only when
|
|
attempts to remove the volume with the B<vos remove> or the B<vos zap>
|
|
command have failed, or the volume definitely cannot be attached. After
|
|
using the B<-force> flag, make sure that the volume's VLDB entry is also
|
|
removed (issue the B<vos delentry> command if necessary).
|
|
|
|
Adding the B<-force> flag makes the command take considerably longer --
|
|
about as long as a salvage of the relevant partition -- since the Volume
|
|
Server examines all inodes on the partition for traces of the volume.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-server> <I<server name>>
|
|
|
|
Identifies the file server machine from which to remove the volume.
|
|
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 (on the file server machine specified by the
|
|
B<-server> argument) from which to remove the volume. 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 ID>>
|
|
|
|
Specifies the volume ID number of the volume to remove, which can be of
|
|
any of the three types. The volume name is not acceptable.
|
|
|
|
=item B<-force>
|
|
|
|
Removes the volume even though it cannot be attached (brought online). Use
|
|
only after the failure of previous attempts to remove the volume by using
|
|
the B<vos remove> command or the B<vos zap> command without this flag.
|
|
|
|
=item B<-backup>
|
|
|
|
Removes the backup version of the read/write volume specified by the
|
|
B<-id> argument. Do not use this flag if the B<-id> argument identifies a
|
|
read-only or backup volume.
|
|
|
|
=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 C<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 removes the volume with volume ID 536870988 from the
|
|
F</vicepf> partition of the file server machine C<fs6.abc.com>, without
|
|
noting the change in the VLDB.
|
|
|
|
% vos zap -server fs6.abc.com -partition f -id 536870988
|
|
|
|
=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_delentry(1)>,
|
|
L<vos_remove(1)>,
|
|
L<vos_remsite(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|