mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 23:40:13 +00:00
e3dfba8e6c
This is the initial conversion of the AFS Adminstrators Reference into POD for use as man pages. The man pages are now generated via pod2man from regen.sh so that only those working from CVS have to have pod2man available. The Makefile only installs. The pages have also been sorted out into pod1, pod5, and pod8 directories, making conversion to the right section of man page easier without maintaining a separate list and allowing for names to be duplicated between pod5 and pod1 or pod8 (which will likely be needed in a few cases). This reconversion is done with a new script based on work by Chas Williams. In some cases, the output is worse than the previous POD pages, but this is a more comprehensive conversion. This is only the first step, and this initial conversion has various problems. In addition, the file man pages that didn't have simple names have not been converted in this pass and will be added later. Some of the man pages have syntax problems and all of them have formatting errors. The next editing pass, coming shortly, will clean up most of the remaining mess.
301 lines
8.1 KiB
Plaintext
301 lines
8.1 KiB
Plaintext
=head1 NAME
|
|
|
|
vos listvldb - Displays a volume's VLDB entry
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<vos listvldb> [B<-name> <I<volume name or ID>>] [-server <I<machine name>>]
|
|
[B<-partition> <I<partition name>>] [B<-locked>] [B<-quiet>] [B<-nosort>]
|
|
[B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-verbose>] [-help]
|
|
|
|
B<vos listvl> [B<-na> <I<volume name or ID>>] [-s <I<machine name>>]
|
|
[B<-p> <I<partition name>>] [B<-lock>] [B<-q>] [B<-nos>] [B<-c> <I<cell name>>]
|
|
[B<-noa>] [B<-loca>] [B<-v>] [-h]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The vos listvldb command formats and displays information from
|
|
the Volume Location Database (VLDB) entry for each volume specified.
|
|
The output depends on the combination of options supplied on the command
|
|
line. Combine options as indicated to display the desired type of VLDB
|
|
entries:
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
Every entry in the VLDB: provide no options
|
|
|
|
|
|
=item *
|
|
|
|
Every VLDB entry that mentions a certain file server machine as the site
|
|
for a volume: specify the machine's name as the B<-server>
|
|
argument
|
|
|
|
|
|
=item *
|
|
|
|
Every VLDB entry that mentions a certain partition on any file server
|
|
machine as the site for a volume: specify the partition name as the
|
|
B<-partition> argument
|
|
|
|
|
|
=item *
|
|
|
|
Every VLDB entry that mentions a certain partition on a certain file
|
|
server machine as the site for a volume: combine the B<-server>
|
|
and B<-partition> arguments
|
|
|
|
|
|
=item *
|
|
|
|
A single VLDB entry: specify a volume name or ID number with the
|
|
B<-name> argument
|
|
|
|
|
|
=item *
|
|
|
|
The VLDB entry only for the volumes with locked VLDB entries found at a
|
|
certain site: combine the B<-locked> flag with any of arguments
|
|
that define sites
|
|
|
|
|
|
=back
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -name
|
|
|
|
Specifies either the complete name or volume ID number of a volume of any
|
|
of the three types.
|
|
|
|
=item -server
|
|
|
|
Identifies the file server machine listed as a site in each VLDB entry to
|
|
display. Provide the machine's IP address or its host name (either
|
|
fully qualified or using an unambiguous abbreviation). For details, see
|
|
the introductory reference page for the B<vos> command suite.
|
|
|
|
This argument can be combined with the -partition argument, the
|
|
B<-locked> flag, or both.
|
|
|
|
=item -partition
|
|
|
|
Identifies the partition (on the file server machine specified by the
|
|
B<-server> argument) listed as a site in each VLDB entry to
|
|
display. Provide the partition's complete name with preceding
|
|
slash (for example, B</vicepa>) or use one of the three acceptable
|
|
abbreviated forms. For details, see the introductory reference page for
|
|
the B<vos> command suite.
|
|
|
|
This argument can be combined with the -server argument, the
|
|
B<-locked> flag, or both.
|
|
|
|
=item -locked
|
|
|
|
Displays only locked VLDB entries. This flag can be combined with
|
|
the B<-server> argument, the B<-partition> argument, or
|
|
both.
|
|
|
|
=item -quiet
|
|
|
|
Suppresses the lines that summarize the number of volumes listed and their
|
|
status, which otherwise appear at the beginning and end of the output when the
|
|
output includes more than one volume.
|
|
|
|
=item -nosort
|
|
|
|
Suppresses the default sorting of volume entries alphabetically by volume
|
|
name.
|
|
|
|
=item -cell
|
|
|
|
Names the cell in which to run the command. Do not combine this
|
|
argument with the B<-localauth> flag. For more details, see the
|
|
introductory B<vos> reference page.
|
|
|
|
=item -noauth
|
|
|
|
Assigns the unprivileged identity anonymous to the
|
|
issuer. Do not combine this flag with the B<-localauth>
|
|
flag. For more details, see the introductory B<vos> reference
|
|
page.
|
|
|
|
=item -localauth
|
|
|
|
Constructs a server ticket using a key from the local
|
|
B</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 the introductory B<vos> reference page.
|
|
|
|
=item -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 -help
|
|
|
|
Prints the online help for this command. All other valid options
|
|
are ignored.
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
If the output includes more than one VLDB entry, by default the first line
|
|
reports which file server machine, partition, or both, houses the
|
|
volumes. The final line of output reports the total number of entries
|
|
displayed. Including the B<-quiet> flag suppresses these
|
|
lines.
|
|
|
|
By default, volumes are sorted alphabetically by volume name.
|
|
Including the B<-nosort> flag skips the sorting step, which can speed
|
|
up the production of output if there are a large number of entries.
|
|
|
|
The VLDB entry for each volume includes the following information:
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
The base (read/write) volume name. The read-only and backup
|
|
versions have the same name with a B<.readonly> and
|
|
B<.backup> extension, respectively.
|
|
|
|
|
|
=item *
|
|
|
|
The volume ID numbers allocated to the versions of the volume that
|
|
actually exist, in fields labeled C<RWrite> for the read/write,
|
|
C<ROnly> for the read-only, C<Backup> for the backup, and
|
|
C<RClone> for the ReleaseClone. (If a field does not appear,
|
|
the corresponding version of the volume does not exist.) The appearance
|
|
of the C<RClone> field normally indicates that a release operation did
|
|
not complete successfully; the C<Old release> and C<New
|
|
release> flags often also appear on one or more of the site definition
|
|
lines described just following.
|
|
L<(1)>
|
|
L<(1)>
|
|
|
|
|
|
=item *
|
|
|
|
The number of sites that house a read/write or read-only copy of the
|
|
volume, following the string C<number of sites ->>.
|
|
L<(1)>
|
|
L<(1)>
|
|
L<(1)>
|
|
L<(1)>
|
|
L<(1)>
|
|
|
|
|
|
=item *
|
|
|
|
A line for each site that houses a read/write or read-only copy of the
|
|
volume, specifying the file server machine, partition, and type of volume
|
|
(C<RW> for read/write or C<RO> for read-only). If a
|
|
backup version exists, it is understood to share the read/write site.
|
|
Several flags can appear with a site definition:
|
|
|
|
|
|
=over 4
|
|
|
|
=item C<Not released
|
|
>
|
|
|
|
Indicates that the vos release command has not been issued
|
|
since the B<vos addsite> command was used to define the read-only
|
|
site.
|
|
L<(1)>
|
|
|
|
=item C<Old release
|
|
>
|
|
|
|
Indicates that a vos release command did not complete
|
|
successfully, leaving the previous, obsolete version of the volume at this
|
|
site.
|
|
L<(1)>
|
|
|
|
=item C<New release
|
|
>
|
|
|
|
Indicates that a vos release command did not complete
|
|
successfully, but that this site did receive the correct new version of the
|
|
volume.
|
|
|
|
=back
|
|
|
|
=item *
|
|
|
|
If the VLDB entry is locked, the string C<Volume is currently
|
|
LOCKED>.
|
|
|
|
|
|
=back
|
|
|
|
For further discussion of the C<New release> and C<Old
|
|
release> flags, see the reference page for the B<vos release>
|
|
command.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command displays VLDB information for the ABC Corporation
|
|
volume called B<usr>, which has two read-only replication sites:
|
|
|
|
% vos listvldb -name usr
|
|
usr
|
|
RWrite: 5360870981 ROnly: 536870982 Backup: 536870983
|
|
number of sites -> 3
|
|
server fs1.abc.com partition /vicepa RO Site
|
|
server fs3.abc.com partition /vicepa RO Site
|
|
server fs2.abc.com partition /vicepb RW Site
|
|
|
|
The following example shows entries for two of the volumes that reside on
|
|
the file server machine B<fs4.abc.com>. The first
|
|
VLDB entry is currently locked. There are 508 entries that mention the
|
|
machine as a volume site.
|
|
|
|
% vos listvldb -server fs4.abc.com
|
|
VLDB entries for server fs4.abc.com
|
|
. . . .
|
|
. . . .
|
|
user.smith
|
|
RWrite: 278541326 ROnly: 278541327 Backup: 278542328
|
|
number of sites -> 1
|
|
server fs4.abc.com partition /vicepg RW Site
|
|
Volume is currently LOCKED
|
|
user.terry
|
|
RWrite 354287190 ROnly 354287191 Backup 354287192
|
|
number of sites -> 1
|
|
server fs4.abc.com partition /vicepc RW Site
|
|
. . . .
|
|
. . . .
|
|
Total entries: 508
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<vos(1)>,
|
|
L<vos_examine(1)>,
|
|
L<vos_listvol(1)>,
|
|
L<vos_lock(1)>,
|
|
L<vos_unlock(1)>,
|
|
L<vos_unlockvldb(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.
|