add-afs-man-pages-20010716
[openafs.git] / src / man / vos_listvldb.1
1 vos listvldb               AFS Commands            vos listvldb
2
3
4 NAME
5
6    vos listvldb -- show information from the VLDB.
7
8
9    vos listvldb  [-name <volume name or ID>]  [-server <machine
10    name>]       [-partition <partition name>]  [-locked]
11    [-quiet]
12    [-cell <cell name>]  [-noauth]  [-localauth]  [-verbose]
13    [-help]
14
15 ACCEPTABLE ABBREVIATIONS/ALIASES
16
17    vos listvl  [-na <volume name or ID>]  [-s <machine name>]
18              [-p <partition name>]  [-lock]  [-q]  [-c <cell
19    name>]  [-no]  [-loca]  [-v]  [-h]
20
21 DESCRIPTION
22
23    Formats and displays information from the VLDB entry for the
24    volume(s) indicated by  the  combination  of  the  arguments
25    provided.    The  possibilities are listed here from most to
26    least inclusive
27
28    To display:
29
30       - every entry in the  VLDB,  provide  no  arguments.
31         This  can  take a very long time, depending on the
32         number of entries.
33
34       - every VLDB entry  that  mentions  a  certain  file
35         server  machine  as  the  site  of  a ReadWrite or
36         ReadOnly  version  of  a   volume,   specify   the
37         machine's name with -server.
38
39       - every VLDB entry that mentions a certain partition
40         on any file  server  machine  as  the  site  of  a
41         ReadWrite or ReadOnly version of a volume, specify
42         the partition name with -partition.
43
44       - every VLDB entry that mentions a certain partition
45         on  a certain file server machine as the site of a
46         ReadWrite or ReadOnly version of a volume, combine
47         -server and -partition.
48
49       - a  single  VLDB entry, specify a volume name or ID
50         number with -name.
51
52       - the VLDB entry only for the  volumes  with  locked
53         VLDB  entries found at a certain site, combine the
54         -locked flag with any  of  arguments  that  define
55         sites.
56
57 ARGUMENTS
58
59    -name           specifies   either   the  complete  name  or
60                    volumeID number of a volume of  any  of  the
61                    three types.
62
63    -server         names  a  file  server machine.  Abbreviated
64                    forms  of  machine  names  may  be   allowed
65
66
67
68                    depending on the naming service available at
69                    the time the command is issued; see page xii
70                    in   the   introductory  About  This  Manual
71                    chapter.  This argument may be combined with
72                    -partition.
73
74    -partition      names  a partition.  In addition to the full
75                    /vicepx form  of  a  partition  name,  three
76                    shorter  forms  are acceptable; see page xii
77                    in  the  introductory  About   This   Manual
78                    chapter.  This argument may be combined with
79                    -server.
80
81    -locked         indicates that the  output  will  show  only
82                    locked  VLDB entries.  May be used alone, or
83                    combined with one or more of -name,  -server
84                    or -partition.
85
86    -quiet          suppresses  the  lines  that  appear  at the
87                    beginning  and  end  of  the  output,  which
88                    specify the machine/partition the listing is
89                    for,  and  the  total  number   of   entries
90                    reported.
91
92    -cell           specifies  the  cell  in  which  to  run the
93                    command.  See section 8.3 in  the  Reference
94                    Manual for more details.  -noauth
95                    tells the Volume and Volume Location Servers
96                    to  assign  the  identity  anonymous  to the
97                    issuer.  See section 8.3  in  the  Reference
98                    Manual for more details.  -localauth
99                    constructs a server ticket using a key  from
100                    /usr/afs/etc/KeyFile.    See  section 8.3 in
101                    the  Reference  Manual  for  more   details.
102                    -verbose
103                    tells the Volume and Volume Location Servers
104                    to  report  on  what  they are doing as they
105                    execute the command.  See section 8.3 in the
106                    Reference Manual for more details.  -help
107                    prints the online help for this command.  Do
108                    not  provide  any  other  arguments or flags
109                    with this one.    See  section  8.3  in  the
110                    Reference Manual for more details.
111
112 OUTPUT
113
114    The  first  line  specifies the machine and/or partition for
115    which output is given.  If the -quiet flag  is  added,  this
116    line does not appear.
117
118    The  VLDB  entry  for  each  volume  includes  the following
119    information:
120
121       - If the VLDB entry is locked,  a  LOCKED  indicator
122         appears alone on a line at the top of the output.
123
124       - The normal first line displays the volume's name.
125
126       - Next   appear   the   volumeID   numbers  for  the
127         ReadWrite, ReadOnly, Backup copies of the  volume,
128         and  for  the ReleaseClone copy if it exists.  The
129
130
131
132         first three types are also marked  with  a  status
133         flag  of  either valid or invalid.  The valid flag
134         indicates that at least one copy of  that  version
135         of  the  volume  exists at an actual site.  If the
136         ReleaseClone ID appears here, then one or more OLD
137         or  NEW flags should appear on the site definition
138         lines below.
139
140       - The next-to-last  line  indicates  the  number  of
141         separate   sites  (partition/file  server  machine
142         pairs) where copies exist.  It  should  match  the
143         number of sites shown on the following line(s).
144
145       - Each   of  the  remaining  lines  show  where  the
146         ReadWrite copy (and by  implication,  Backup)  and
147         each   ReadOnly   copy   of  the  volume  resides,
148         specified by file server machine  name,  partition
149         name  and type (RW or RO).  The presence of NEW or
150         OLD  flags  on  these  lines  indicates  a  failed
151         release;   they   should   appear   only   if  the
152         ReleaseClone ID also appears above.
153
154    If the output includes more than one VLDB  entry,  the  very
155    last  line  of  the output shows the total number of entries
156    reported.  This line does not appear if the -quiet  flag  is
157    used.
158
159 EXAMPLE(S)
160
161    The   following   displays  VLDB  information  the  Transarc
162    Corporation volume called usr, which has with  two  ReadOnly
163    replication sites:
164
165        % vos listvldb usr
166        usr
167                readWriteID  536870981  valid
168                readOnlyID   536870982  valid
169                backUpID     536870983  invalid
170            number of sites -> 3
171            server fs1.transarc.com partition /vicepa RO Site
172            server fs3.transarc.com partition /vicepa RO Site
173            server fs2.transarc.com partition /vicepb RW Site
174
175    The  following  shows  entries  for  two of the volumes that
176    reside on fs4.transarc.com.  The VLDB entry for the first is
177    currently locked.
178
179        % vos listvldb -s fs4.transarc.com
180            .       .           .        .
181            .       .           .        .
182                LOCKED
183        user.smith
184                readWriteID  278541326  valid
185                readOnlyID   278541327  invalid
186                backUpID     278542328  valid
187            number of sites -> 1
188            server fs4.transarc.com partition /vicepg RW Site
189
190
191
192        user.terry
193                readWriteID  354287190  valid
194                readOnlyID   354287191  invalid
195                backUpID     354287192  valid
196            number of sites -> 1
197            server fs4.transarc.com partition /vicepc RW Site
198            .       .           .        .
199            .       .           .        .
200
201 PRIVILEGE REQUIRED
202
203    None.
204
205 MORE INFORMATION
206
207    vos examine vos listvol vos lock vos unlock vos unlockvldb